Skip to main content
The API is versioned in the path. Everything documented here lives under /v1.

Additive only

Inside /v1 we only add. These are not breaking and can happen at any time:
  • new endpoints;
  • new optional request fields and new response fields;
  • new values for model, and new error.code categories on generations.
Write your client to ignore fields it does not know.

Breaking changes mean /v2

Removing or renaming a field, changing a field’s type, or changing a status code is breaking and only happens in a new version. /v1 keeps working when /v2 exists.

Retiring something

If an endpoint is ever retired, its responses carry Deprecation and Sunset headers for at least 90 days before removal, and the changelog says what to use instead.