Zocdoczocdoc.com
Zocdoc's API program has a strong foundation in machine-readable contract design and documentation reachability, but partners and their agents face two critical blockers: the absence of runnable, self-serve onboarding materials means partners cannot get hands-on without a sales conversation, and missing reliability signals (idempotency guidance, rate-limit feedback) make it unsafe for agents to run real workflows autonomously. md file and structured docs metadata) will also ensure AI coding tools can accurately discover and act on Zocdoc's API surface without guessing.
API DesignA clean, typed, well-governed API contract agents can reason about3 pass2 warn0 fail91A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Auth declared & discoverablevia spec | 25/25 | authentication documented in the docs site at https://api-docs.zocdoc.com/guides/authentication. Investigated: spec 100%, docs 100%, wellknown 0%. | Agents can only authenticate when auth is declared, scoped, and discoverable. |
| warn | Schema coverage & depthvia spec | 20.8/25 | Medium parameter complexity (avg 2.5 params/op; nested/body schemas present). Investigated: spec 83%. | Typed, complete request/response schemas are what make agent function-calling possible. |
| warn | Machine-readable, versioned contractvia spec | 18.8/25 | info.version="1.177" set but no versioning scheme (URL / header / media type) detected. Investigated: spec 75%, docs 50%. | A current OpenAPI version with a declared versioning scheme lets agents reason about the contract. |
| pass | Security & governance hygienevia spec | 15/15 | No credential-shaped strings detected in spec. Investigated: spec 100%, wellknown 0%. | No leaked secrets, no critical lint violations, no OWASP API Top-10 spec smells, and a published vulnerability-disclosure channel. |
| pass | Example coveragevia docs | 10/10 | Code samples present on 4/16 pages across 1 language(s); broader multi-language coverage missing. Investigated: docs 100%, spec 0%. | Examples carry shape semantics schemas under-specify — for humans and agents alike. |
Developer ExperienceThe context both developers and agents need to integrate fast — onboarding, code samples, complete descriptions and worked examples3 pass0 warn2 fail59D
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Code samples in docsvia docs | 18/18 | Code samples present on 4/16 pages across 1 language(s); broader multi-language coverage missing. Investigated: docs 100%. | Multi-language samples shorten time-to-first-call. |
| pass | Description completenessvia spec | 15/15 | 90% of operations + parameters have substantive descriptions. Investigated: spec 100%. | Complete descriptions are the context humans and agents need to use endpoints. |
| pass | Changelog publishedvia spec | 13/13 | changelog documented in the docs site at https://api-docs.zocdoc.com/changelog. Investigated: spec 100%, docs 100%. | A published changelog lets partners track changes without surprise. |
| fail | Self-service developer portalvia docs | 0/29 | No self-service signup detected: no signup link found on the homepage or docs, and no conventional signup path (/signup, /sign-up, /register, /get-started, /console/signup, /dashboard/signup, /try, /try-free, /free, /free-trial, /start, /start-free, /join, /create-account, /account/signup, /auth/signup, /users/sign_up) resolved. Investigated: docs 0%. | Self-serve key/account creation is the fast first call for partners, with no sales gate. |
| fail | Quickstart presentvia docs | 0/25 | No quickstart/getting-started page found at the conventional paths. Investigated: docs 0%. | A quickstart is the fastest path from landing page to first successful call. |
Agent DiscoveryPartners and their agents can find your APIs — llms.txt, registries, crawlable and reachable docs1 pass3 warn0 fail81A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Registry & SDK presencevia sdk | 28/28 | Discovered SDKs in 4 distinct languages. Investigated: sdk 100%, docs 0%, cli 0%. | Listing in MCP registries and publishing SDKs puts the API where agents and their tooling look. |
| warn | Docs reachable, not hard auth-gatedvia docs | 22.5/30 | Server ignores Accept: text/markdown header (0/14 pages return markdown). Investigated: docs 75%. | Agents can only index and fetch docs they can reach — past auth gates and over correct HTTP semantics. |
| warn | llms.txt present, valid & comprehensivevia docs | 21.4/30 | No llms.txt directive found in HTML of any of 14 pages. Investigated: docs 71%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
| warn | Crawlable / AEOvia wellknown | 6/12 | No sitemap discoverable via robots.txt or /sitemap.xml on the docs host. Investigated: wellknown 50%. | Bots allowed plus a fresh sitemap make docs findable by agent crawlers. |
Agent UnderstandingAgents can correctly interpret your APIs — machine-readable errors, consistent descriptions, structured data, parseable docs2 pass1 warn2 fail82A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Machine-readable errors (RFC 9457)via docs | 28/28 | 6 distinct 4xx/5xx response codes documented. Investigated: docs 100%, spec 50%. | RFC 9457 problem details and a documented error-code inventory let agents parse failures without burning tokens. |
| pass | Operation purpose clarityvia spec | 25/25 | 100% of operations have a clear summary + operationId an agent can select on. Investigated: spec 100%. | Agents select the right endpoint from its summary + operationId; clear, named operations make tool-selection reliable — the strongest driver of correct tool choice. |
| warn | Agent-navigable, token-efficient docsvia docs | 19.8/22 | 9 of 14 pages have substantive content differences between markdown and HTML (avg 28% missing). Investigated: docs 90%. | Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly. |
| fail | Agent instructions file (AGENTS.md)via wellknown | 0/10 | No AGENTS.md at the site root or /.well-known/. Investigated: wellknown 0%. | An AGENTS.md gives coding agents explicit setup, auth, and usage instructions to interpret and operate the API — beyond llms.txt's link index. |
| fail | Docs structured datavia docs | 0/8 | Neither JSON-LD nor OpenGraph/meta tags detected across 1 assessed pages (1 JS-rendered). Investigated: docs 0%. | Structured data (JSON-LD/schema.org) on docs pages gives agents an unambiguous parse target and is what answer engines cite. Detected on the JS-rendered head (Firecrawl) for a bounded page budget, so JS-injected JSON-LD is now caught; pages we can't render are excluded rather than failed. |
| na | Description consistency across surfaces | —/7 | Only 0 surface description(s) with ≥6 tokens available; need at least 2 to compare. | Every surface tells the same story about what the product is. |
Agent UsabilityAgents have the context to use your APIs reliably, not just find them1 pass0 warn3 fail48F
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Sandbox separationvia spec | 20/20 | Sandbox server declared but no distinguishable test credentials in scheme descriptions. Investigated: spec 100%, docs 100%. | An isolated environment lets agents exercise destructive operations safely. |
| fail | Idempotency documentedvia spec | 0/27 | 0% of mutating operations document idempotency. Investigated: spec 0%, docs 0%. | Documented idempotency lets agents retry safely. |
| fail | Rate-limit signalingvia spec | 0/22 | No rate-limit response headers documented. Investigated: spec 0%, docs 0%. | Machine-readable rate-limit headers let agents throttle adaptively. |
| fail | Runnable collection with test scriptsvia platform | 0/9 | No public Postman workspace discovered for the org. Investigated: platform 0%. | A public, maintained collection with assertions is runnable truth agents validate against. |
| na | Pagination documented & consistent | —/22 | No surface produced evidence for this capability in this run. | Consistent, documented pagination lets agents traverse collections. |
Resources Discovered
The public resources we found for Zocdoc — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.
| APIs analyzed | 1 — API Documentation |
|---|