Understand API compatibility, migration windows, and retries.
Stable product endpoints use /v1. Additions may include endpoints, optional fields, response fields, enum values, and error codes. Removing a supported operation or changing a field's meaning requires a new versioned path or a documented migration.
Generally available operations receive at least 90 days between public deprecation notice and sunset. Preview, beta, unused compatibility files, and security or legal changes may use a shorter documented window.
Deprecated operations are marked in OpenAPI and signal migration through response headers:
| Header | Meaning |
|---|---|
Deprecation | Announcement date as an RFC 9745 structured date. |
Sunset | Final support date as an RFC 8594 HTTP date. |
Link with rel="deprecation" | Migration guidance. |
There is no global API request quota today. Operations with a concrete quota publish RateLimit-Policy and RateLimit. A 429 response includes Retry-After, which takes precedence over other timing hints. See errors for the error envelope and request IDs.