Zywavezywave.com
Zywave's API program shows strong foundations in API design, auth, and documentation parseability — partners can understand what the API does once they find it. However, two areas critically undermine partner and agent success: operational reliability (no idempotency, rate-limit signaling, pagination, or sandbox environment means agents hitting production are flying blind) and agent discoverability (no llms.txt, no registry presence, and no structured metadata means agents can't find or reason about the API without human intervention).
API DesignA clean, typed, well-governed API contract agents can reason about2 pass3 warn0 fail86A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Auth declared & discoverablevia docs | 22.5/25 | The spec declares no authentication scheme, so an agent can't tell how to authenticate a request. Investigated: docs 90%, spec 62%, wellknown 0%. | Agents can only authenticate when auth is declared, scoped, and discoverable. |
| warn | Machine-readable, versioned contractvia spec | 20.6/25 | The API sets a version ("v2.0") but exposes no versioning scheme in the URL, a header, or the media type, so an agent can't pin to a specific version. Investigated: spec 83%, docs 65%. | A current OpenAPI version with a declared versioning scheme lets agents reason about the contract. |
| warn | Schema coverage & depthvia spec | 15.8/25 | Only 68% of the 116 operations document request and response schemas, so an agent can't do function-calling against most endpoints. Investigated: spec 63%, sdk 0%. | Typed, complete request/response schemas are what make agent function-calling possible. |
| pass | Security & governance hygienevia spec | 15/15 | No credential-shaped strings detected in spec. Investigated: spec 100%, sdk 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 | Docs show code samples in 5 language(s) (top: shell, csharp, java), and 2 of 19 sampled pages offer ≥ 2 languages side by side. Investigated: docs 100%, spec 0%, sdk 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 pass1 warn1 fail79B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Self-service developer portalvia docs | 29/29 | Signup page found at https://zywave.cventevents.com/event/IG-Columbus/register, but no free tier or sandbox is documented in docs/pricing, so an agent may hit a paywall. Investigated: docs 100%. | Self-serve key/account creation is the fast first call for partners, with no sales gate. |
| pass | Code samples in docsvia docs | 18/18 | Docs show code samples in 5 language(s) (top: shell, csharp, java), and 2 of 19 sampled pages offer ≥ 2 languages side by side. Investigated: docs 100%. | Multi-language samples shorten time-to-first-call. |
| pass | Description completenessvia spec | 15/15 | Only 40% of operations and parameters have descriptions (21 of 30 ops, 10 of 107 params), leaving an agent to guess what most endpoints do. Investigated: spec 100%. | Complete descriptions are the context humans and agents need to use endpoints. |
| warn | Quickstart presentvia docs | 12.5/25 | Quickstart page is reachable at https://www.zywave.dev/apis/getting-started/ (1 variants scanned) but has no runnable code sample in its HTML or .md variant, so there's nothing to copy and run. Investigated: docs 50%. | A quickstart is the fastest path from landing page to first successful call. |
| fail | Changelog publishedvia spec | 0/13 | No changelog link or mention appears in the spec, so an agent can't tell what changed before something breaks. Investigated: spec 0%, docs 0%. | A published changelog lets partners track changes without surprise. |
Agent DiscoveryPartners and their agents can find your APIs — llms.txt, registries, crawlable and reachable docs1 pass1 warn2 fail52D
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Docs reachable, not hard auth-gatedvia docs | 22.5/30 | Server ignores Accept: text/markdown header (0/32 pages return markdown). Investigated: docs 75%. | Agents can only index and fetch docs they can reach — past auth gates and over correct HTTP semantics. |
| pass | Crawlable / AEOvia wellknown | 12/12 | No robots.txt on the docs host, so AI crawlers are unrestricted and can read the docs. Investigated: wellknown 100%. | Bots allowed plus a fresh sitemap make docs findable by agent crawlers. |
| fail | llms.txt present, valid & comprehensivevia docs | 0/30 | No llms.txt found at any candidate location (https://www.zywave.dev/apis/llms.txt, https://www.zywave.dev/llms.txt, https://www.zywave.dev/docs/llms.txt). Investigated: docs 0%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
| fail | Registry & SDK presencevia docs | 0/28 | Not indexed on Context7 — agents can't pull this API's docs on demand via Context7. Investigated: docs 0%, sdk 0%, cli 0%, mcp 0%, wellknown 0%. | Listing in MCP registries and publishing SDKs puts the API where agents and their tooling look. |
Agent UnderstandingAgents can correctly interpret your APIs — machine-readable errors, consistent descriptions, structured data, parseable docs1 pass3 warn1 fail80A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Machine-readable errors (RFC 9457)via docs | 28/28 | Only 3 distinct 4xx/5xx error codes are documented (plus 0 catch-all "default" responses), so an agent has limited failure branching. Investigated: docs 100%, spec 50%. | RFC 9457 problem details and a documented error-code inventory let agents parse failures without burning tokens. |
| warn | Operation purpose clarityvia spec | 21.3/25 | Only 13% of operations (1 of 8) have a clear summary plus descriptive name, so an agent must guess purpose from the URL path for most. Investigated: spec 85%. | 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 | 17.3/22 | No pages support .md URLs (0/32 tested). Investigated: docs 79%. | Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly. |
| warn | Agent instructions file (AGENTS.md)via sdk | 5/10 | No agents.md or skill.md context file found (nice-to-have for agent operation). Investigated: sdk 50%, 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 | No JSON-LD or OpenGraph/meta tags found across 2 assessed pages (2 JS-rendered), so answer engines have nothing to cite. 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 1 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 them0 pass0 warn5 fail40F
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| fail | Idempotency documentedvia spec | 0/27 | Only 0% of mutating operations (0 of 60) document idempotency, so an agent's retries can create duplicate writes. Investigated: spec 0%, docs 0%. | Documented idempotency lets agents retry safely. |
| fail | Rate-limit signalingvia spec | 0/22 | No rate-limit response headers are documented, so an agent can't tell when it is approaching a limit and will get throttled. Investigated: spec 0%, docs 0%. | Machine-readable rate-limit headers let agents throttle adaptively. |
| fail | Pagination documented & consistentvia spec | 0/22 | List endpoints offer no pagination, so an agent can't page through large collections. Investigated: spec 0%, docs 0%. | Consistent, documented pagination lets agents traverse collections. |
| fail | Sandbox separationvia spec | 0/20 | None of the 1 declared server(s) is a sandbox/test host, and no test-key prefixes are documented, so agents can only hit production. Investigated: spec 0%, docs 0%. | An isolated environment lets agents exercise destructive operations safely. |
| fail | Runnable collection with test scriptsvia sdk | 0/9 | No README found. Investigated: sdk 0%, platform 0%. | A public, maintained collection with assertions is runnable truth agents validate against. |
Resources Discovered
The public resources we found for Zywave — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.
| APIs analyzed | 10 — Policies API, BKB API, Client Engagement API v1.0, Accounts API - 3.0, Plans API, CommercialPolicyBenchmark API, Content API, Agencies API v2.0, Lead Insights API, Profiles API v2.1 |
|---|