Skip to main content
The version is in the path.
A v1 request keeps the documented v1 behavior.

​
Additive changes

Clients must tolerate:
  • a new response field;
  • a new endpoint;
  • a new optional request parameter;
  • a new enum or error.code value.
Ignore response fields your integration does not use. Every enum switch needs a default branch.

​
Breaking changes

A new path version is required before we:
  • remove or rename a field;
  • change a field’s type or meaning;
  • remove or move an endpoint;
  • make an optional parameter required;
  • change the error envelope.

​
Deprecation

No v1 retirement is scheduled. A future retirement will be announced in the API changelog with Deprecation, Sunset and migration guidance.

​
Rate limits

Limits apply per key and environment. Exceeding the limit returns 429 with error.code set to rate_limit_exceeded and a Retry-After header.
Last modified on August 24, 2026