Interactive OpenAPI Reference

The full machine-readable OpenAPI 3.1 schema is served by the API itself at:

https://api.canverly.com/openapi.json

The interactive viewer below is rendered by Scalar, which pulls the schema directly at page load. Every endpoint is browsable, every response is documented, and you can paste a ck_test_... key into the auth widget to make live requests against staging.

Alternatives

If Scalar fails to load (e.g. corporate CSP, offline reading), try these:

• Raw schema: https://api.canverly.com/openapi.json — pipe into any OpenAPI tool (Postman, Insomnia, openapi-generator).
• Stoplight Elements: drop the schema URL into https://elements-demo.stoplight.io.
• Swagger Editor: https://editor.swagger.io → File → Import URL.

Schema stability

The OpenAPI schema is the source of truth for the API surface. Breaking changes are versioned by URL prefix (/v1, /v2, …) and announced at least 90 days in advance via the changelog. Additive changes (new optional fields, new endpoints, new enum members) ship without notice.