Static PDF API docs are dead. Here's why agencies — and the AI tools they're adopting — now demand a machine-readable, always-current OpenAPI 3.1 spec.
For two decades, "API documentation" meant a PDF or a confluence page that drifted out of sync with reality the day after it was published. Modern AI tooling has killed that pattern.
The Shift
ChatGPT Custom GPTs ingest OpenAPI specs to auto-generate Actions. Postman and Insomnia import OpenAPI to seed collections. Stainless, Speakeasy, and Fern generate typed SDKs from OpenAPI. Cursor and Claude can reference OpenAPI to ground tool calls. Without a live, versioned OpenAPI 3.1 document, your CRM is invisible to all of these.
Why 3.1 Specifically
OpenAPI 3.1 is fully aligned with JSON Schema 2020-12, supports nullable types properly, and adds the webhooks object for documenting outbound events alongside inbound endpoints. Earlier versions force ugly workarounds.
What "Live" Means
The spec must be served from the same deployment as the API itself, generated from code (not hand-maintained), and updated on every deploy. unLocked CRM ships its OpenAPI 3.1 doc from an Edge Function that introspects the route table at request time — drift is structurally impossible.
Buying Checklist
- Public OpenAPI 3.1 URL (not gated behind login)
- Versioned via
X-Api-Versionheader - Includes the
webhooksobject - Imports cleanly into Postman, ChatGPT Custom GPTs, and Stainless
Where This Fits In unLocked
- best CRM for insurance agents: How insurance CRMs compare on quoting, commissions, AI and price.