Skip to content

HTTP API reference

Find HTTP endpoints, workspace permissions and retry instructions.

Use the API reference

Use the linked API reference and OpenAPI document for exact paths, request bodies, response types, scopes, pagination, and errors. Use the documented versioned endpoints for your integration.

Create, edit and publish safely

  • Use the documented idempotency key when retrying an uncertain mutation; keep the original request body.
  • Read saved progress after a disconnect rather than creating another job.
  • Supply the reviewed version or content identity required by publication and editing operations.
  • Submit the task directly; read its usage receipt to follow measured credit costs.
  • Cancellation, publication, external tests, and payment confirmation are separate authorized actions.

API reference

API base
/api/v1
OpenAPI schema
OpenAPI document
Read this guide as MarkdownContact support