Skip to content

HTTP API

Everything the console and the Python package do goes through one HTTP API, and every server describes its own: open Settings › API documentation in the console, or fetch the OpenAPI 3.1 description from /v3/api-docs/openapi with any key.

  • Send Authorization: Bearer dk_… with every call.
  • Errors are RFC 7807 problem bodies (application/problem+json), with a detail that says what to change.
  • GET /api/version (no key needed) answers the server version, the API version it speaks and whether keys are on. The Python package checks it on its first call and tells you which side to upgrade if the two do not match.