Skip to main content
Use the OpenAPI files when generating clients, validating payloads, or giving API context to AI tools.

Specification files

The published REST API currently contains 47 unique HTTP operations.

Use with AI tools

Give the model the OpenAPI file plus this instruction:

Authentication rules

  • Most REST endpoints use Authorization: Bearer <token>.
  • session endpoints that explicitly document session auth use x-session-token.
  • Do not send both credentials unless the endpoint documentation says it accepts both.

Implementation checklist

  1. Find the operation by operationId, method, or path.
  2. Read every path, query, header, and body parameter.
  3. Build the request from typed fields, not string concatenation where a structured client is available.
  4. Parse the success response according to the documented schema.
  5. Parse error responses as JSON, Problem Details, or text because gateway/backend errors can vary.