Skip to main content
The REST API is the same one the web app, the CLI, and the MCP server use. Every endpoint in this reference comes from the API’s OpenAPI contract, so the reference changes whenever the API does.

Authentication

Get a bearer token with OAuth.

Workflows

Upload frames, stack them, download the master.

OpenAPI spec

The live spec as JSON, for code generators. It includes operator endpoints.

​
Conventions

  • JSON in and out. Send Content-Type: application/json on requests with a body.
  • IDs are UUIDs. Timestamps are ISO 8601 strings in UTC.
  • Your data only. Endpoints act on the signed-in user’s data. Another user’s integration set, post, or rig looks the same as one that doesn’t exist: 404.
  • Long work is asynchronous. Stacks, analyses, frame QA, and exports return 202 with a job. Poll the job until its status is READY, FAILED, or CANCELLED.
  • Files go straight to storage. Uploads and downloads use presigned URLs that expire after an hour. The API never streams frame data itself.

​
Errors

Errors return a JSON body with a stable code and a readable message:

​
What’s not in this reference

Operator endpoints (/admin/*) and the sign-in plumbing the CLI and the web app use internally (/auth/cli/*, the OAuth consent endpoints) are left out. The OAuth endpoints you need to get a token are described with authentication.