API versioning and deprecation.

Current stable version: v1, served at https://api.canonn.ai/v1. Additive changes may be introduced within v1: new optional fields, endpoints, event types, enum values, response headers, and optional request parameters. Integrations should ignore response fields they do not recognize and must not treat an enum as permanently closed unless the OpenAPI schema says so.

Breaking changes

A change that removes or renames an endpoint or field, changes an existing field's type or meaning, makes an optional input required, or otherwise invalidates a conforming integration requires a new major API path. Security fixes and changes needed to prevent abuse may ship faster when preserving the old behavior would create material risk.

Notice and migration

Canonn aims to provide at least 90 days' public notice before retiring a stable endpoint. Notices appear in the API documentation and developer index. A deprecated HTTP endpoint may also return the standard Deprecation response header and a Sunset header containing the planned retirement date, with a Link header pointing to migration guidance. Enterprise agreements may specify a longer support window.

Machine-readable contract

The canonical contract is the published OpenAPI 3.1 YAML specification, also available as JSON. Its info.version identifies the document revision; the URL path identifies API compatibility. Agents can discover current resources through llms.txt. Questions about a migration can be sent to hello@canonn.ai.