Skip to content

Reference

The public content API (https://api.canverly.com, ck_ and pk_ keys) has a written reference, with examples, errors and limits for every route: all endpoints.

These pages are generated at build time from the OpenAPI specification each service versions in its own repository, without the internal routes. None is copied by hand, and the portal’s staleness gate fails when a specification changes without the reference being regenerated.

The forms, sites and identity routes are the ones the admin uses, with a logged-in user’s session. The API open to integrations is the content API.

The interactive reference loads the contract served by the API itself and lets you try calls.