API reference

Authentication

Create a key in Settings → API keys. Send it as Authorization: Bearer tak_…. The key pins every request to that application. Store it on your server.

# Replace the origin with your deployment; locally use http://localhost:3000.
export TRICKROOM_API_URL="https://your-domain.example/v1"
export TRICKROOM_API_KEY="tak_REPLACE_WITH_YOUR_KEY"

Examples use cURL or server-side TypeScript with native fetch. Replace sample resource IDs with IDs returned by your application. For an end-to-end example, follow the quickstart.

Requests and responses

JSON

Send Content-Type: application/json for request bodies. The body limit is 64,000 bytes. Event streams and artifact downloads use their documented media types.

Pagination

Users, jobs, and event history accept after and limit. Pass next_cursor as the next request’s cursor; stop on an empty page or a null cursor.

Retries

Reuse the same Idempotency-Key and body when retrying job or flow submissions. A key is optional for jobs and required for flow runs, in the header or body. Conflicting inputs return 409.

Errors

Errors contain error.code, error.message, and error.request_id. Branch on the code. The X-Request-Id response header identifies the request for troubleshooting.

Compatibility

Ignore unknown fields and event types. Breaking changes require a new major API version. Flows run within jobs; durable step recovery is not provided.

Endpoints