Docs index
Versioning and changes
How long a version is supported, how a breaking change is announced, and where to read what changed.
How the API is versioned
The major version is in the path: /api/v1. Every response carries X-TAVONEL-API-Version, and a client that wants to pin can send Accept: application/vnd.tavonel.v1+json. The dated version beside it — 2026-09-02.1 in the footer of every page here — names the contract build, not a second axis to negotiate: it moves when the document changes and it never changes what /api/v1 accepts.
What can change without notice
Additive changes ship in any release. New fields on a response, new optional parameters, new endpoints, and new members of a response enum. Ignore fields you do not recognise, and do not switch on an exhaustive match over a response enum — that is the one client habit an additive change breaks.
What counts as breaking, and what you are owed
| Commitment | What it is |
|---|---|
| What is breaking | Removing or renaming a published field, parameter, error code or endpoint; narrowing what a field accepts; changing the meaning of a value. Anything in that list takes a new path major. |
| How you hear | The current major is announced as deprecated in the API changelog below and in the Atom feed, before the new major becomes the default. Nothing is removed in place. |
| Support window | A deprecated path major keeps answering for at least 180 days from the announcement. |
| Migration | A breaking entry carries the migration beside it, not in a separate document. An entry that names a breaking change and no migration is a bug in this page. |
Note No version has been deprecated. v1 is the only major, it is current, and no sunset date exists for it. This section states the policy that will apply when one does — it is not a notice that one has started.
The API changelog
Changes are published on the Changelog page, filterable by surface: choose API for the contract and Developer tools for the CLI, the MCP server and the published files. Both feed the same Atom feed at /changelog/feed.xml, which is the one to subscribe to if you maintain an integration. The machine-readable contract at /api/openapi remains the authority for what a version contains — the changelog says what moved, the contract says what is there.
Note The contract publishes this same policy under x-tavonel-version-policy, and the whole error catalogue under x-tavonel-error-catalogue, so a generated client can carry both without scraping this page.
API version 2026-09-02.1 · reviewed 11 September 2026
Something here out of date or wrong? Report an issue with this page.