Vonagevonage.com
Vonage's API program shows strong foundations in API design, operational reliability, and agent usability — partners building on this surface can trust the contract. The two areas that need urgent attention are agent understanding and developer experience: AI agents lack the structured context files and machine-readable signals needed to interpret and act on the APIs correctly, while partners face a self-service gap that slows their first successful call.
API DesignA clean, typed, well-governed API contract agents can reason about1 pass4 warn0 fail88A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Machine-readable, versioned contractvia spec | 21.9/25 | info.version="1.0.0" set but no versioning scheme (URL / header / media type) detected. Investigated: spec 88%, docs 75%. | A current OpenAPI version with a declared versioning scheme lets agents reason about the contract. |
| warn | Schema coverage & depthvia sdk | 21.4/25 | 0/1 (0%) enum-like params are realized as constrained types (not bare strings). Investigated: sdk 86%, spec 65%. | Typed, complete request/response schemas are what make agent function-calling possible. |
| warn | Auth declared & discoverablevia docs | 20.3/25 | No securitySchemes declared. Investigated: docs 81%, spec 41%. | Agents can only authenticate when auth is declared, scoped, and discoverable. |
| warn | Security & governance hygienevia spec | 13.1/15 | 10 credential-shaped strings detected in spec: bearer-jwt (×10). Investigated: spec 88%, 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 spec | 10/10 | 10% example coverage. Investigated: spec 100%, docs 100%, sdk 100%. | 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 in 10 language(s) across docs (top: curl, shell, javascript); 1/20 pages have ≥ 2 languages on the same page. Investigated: docs 100%. | Multi-language samples shorten time-to-first-call. |
| pass | Description completenessvia spec | 15/15 | 59% description completeness. Investigated: spec 100%, sdk 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://developer.vonage.com/en/changelogs. Investigated: spec 100%, docs 100%, sdk 100%. | A published changelog lets partners track changes without surprise. |
| fail | Self-service developer portalvia docs | 0/29 | No signup page detected across conventional paths (/signup, /sign-up, /register, /get-started, /console/signup, /dashboard/signup, /try, /try-free, /free, /free-trial, /start, /start-free). 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 fail77B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Registry & SDK presencevia docs | 28/28 | Indexed on Context7 (websites/developer_vonage_en_api, 2676 snippets). Investigated: docs 100%, sdk 100%, cli 100%. | Listing in MCP registries and publishing SDKs puts the API where agents and their tooling look. |
| warn | llms.txt present, valid & comprehensivevia docs | 20/30 | No llms.txt directive found in HTML of any of 1 pages. Investigated: docs 67%, sdk 0%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
| warn | Docs reachable, not hard auth-gatedvia docs | 15/30 | 1 of 1 pages return 200 for non-existent URLs (soft 404). Investigated: docs 50%. | Agents can only index and fetch docs they can reach — past auth gates and over correct HTTP semantics. |
| warn | Crawlable / AEOvia wellknown | 9/12 | Sitemap present (2 entries) but carries no lastmod values. Investigated: wellknown 75%. | 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 pass2 warn2 fail73B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Machine-readable errors (RFC 9457)via docs | 28/28 | No 4xx/5xx response codes (or default error response) documented anywhere in the spec. Investigated: docs 100%, sdk 100%, spec 63%. | 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 | 13.8/22 | 1 of 1 pages appear to be client-side rendered SPA shells (__nuxt detected); agents using HTTP fetches will see no content. Investigated: docs 63%. | Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly. |
| warn | Description consistency across surfaces | 0.9/7 | Mean pairwise description similarity across 3 surfaces (spec, docs, sdk) is 4% (threshold 35% for full credit). | Every surface tells the same story about what the product is. |
| 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 2 assessed pages (2 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. |
Agent UsabilityAgents have the context to use your APIs reliably, not just find them3 pass2 warn0 fail80A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Idempotency documentedvia sdk | 27/27 | Built-in retry machinery is present (grep-derived). Investigated: sdk 100%, spec 0%, docs 0%. | Documented idempotency lets agents retry safely. |
| pass | Pagination documented & consistentvia docs | 22/22 | Pagination params detected on 5 list endpoint(s). Investigated: docs 100%, spec 75%, sdk 0%. | Consistent, documented pagination lets agents traverse collections. |
| pass | Sandbox separationvia sdk | 20/20 | Sandbox environments are exposed (sandbox). Investigated: sdk 100%, spec 0%, docs 0%. | An isolated environment lets agents exercise destructive operations safely. |
| warn | Runnable collection with test scriptsvia platform | 4.5/9 | No test scripts found in the workspace's collections. Investigated: platform 50%. | A public, maintained collection with assertions is runnable truth agents validate against. |
| warn | Rate-limit signalingvia spec | 2.8/22 | No rate-limit response headers documented. Investigated: spec 13%, docs 13%. | Machine-readable rate-limit headers let agents throttle adaptively. |
Resources Discovered
The public resources we found for Vonage — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.
| Agent hints | Context7 (2,676) |
|---|---|
| APIs analyzed | 8 — Vonage Contact Center APIs, Video, Programmable SIP API, Verify API, Voice API, Numbers API, Messages API, Identity Insights API |