Skip to content

Versioning

The API version is part of the path: /v1.

Within v1, we only make backward-compatible changes, such as:

  • adding endpoints,
  • adding optional request fields,
  • adding response fields,
  • adding enum values,
  • adding error codes or webhook event types.

Write clients that ignore unknown fields and handle unknown enum values gracefully.

Breaking changes ship in a new version (/v2). The previous version stays supported for at least 12 months after the new one is released. Deprecated endpoints return Deprecation and Sunset headers, and every change is announced in the changelog.

The matching model is versioned separately. Each screening returns model_version, and model changes are listed in the changelog.