Skip to main content

The version is in the path

Every endpoint starts with /v1.
A breaking change ships under a new prefix. Changes that do not break existing clients are added to /v1.

OpenAPI

The API serves its own OpenAPI document. It is generated from the same schemas the API validates requests with. The API reference is built from this document.
Use only the paths listed in the API reference. Any other path that happens to answer is not part of the contract and can change without notice.

What is a breaking change

Write clients that last

  • Branch on code, outcome, verdict and level. Do not parse summary or detail.
  • Ignore response fields you do not know.
  • Treat an enum value you do not know as “other”, not as a failure.
  • Read cost.charged_credits for what a call cost. Do not hard-code credit costs.

Clients