Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
The commitments behind API version lifecycles
| Commitment | Rule |
|---|---|
| Version scheme | Major version in the URL (/api/v1/). No date-based or header-based versioning. |
| Inside a major | Additive-only. Adding endpoints, optional request fields, response fields and enum values is allowed at any time. |
| Breaking change definition | Removing or renaming a path, parameter or field; changing a type; narrowing an enum; making something optional required; changing a status code; renaming an operation id. |
| Support window | A deprecated major keeps working for 12 months after its successor ships (pending sign-off). |
| Notice period | Deprecation is announced at least 6 months before sunset (pending sign-off). |
| Machine-readable signals | Every response of a deprecated version carries Deprecation (RFC 9745), Sunset (RFC 8594) and Link rel="deprecation" headers. |
| After sunset | Every route of the version returns 410 version-gone with a migration link. |
| Rate limit changes | Allowance reductions are announced to credential holders with lead time; increases may happen at any time. |
Deprecation header. That single line of client code converts every future migration from a surprise into a scheduled task.