loading
Loading content
loading
API
Bearer JWT or API token. JSON in and out. Async runs you poll. Live OpenAPI from the route handlers.
JWTs use Authorization: Bearer. API tokens without dots use Token. Programmatic callers fetch a personal token from GET /api/users/me/token and rotate with POST /api/users/me/token/regenerate.
Prefer the CLI? Device authorization via trickest auth login. CLI overview. Check the current session with GET /api/auth/session.
curl https://trickest.io/api/auth/session \ -H "Authorization: Bearer $TRICKEST_TOKEN" # { "user": { … }, "expiresAt": "…" }POST returns 201 immediately. Observe with GET run and subjobs. Subjob console is poll-based (mode=live or final), not SSE.
curl https://trickest.io/api/runs \ -H "Authorization: Bearer $TRICKEST_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "workflow_id": "<workflow-uuid>", "use_latest_version": true, "fleet": "<fleet-uuid>", "machines": { "small": 4 }, "inputs": { "target": "example.com" } }' # 201 Created# { "id": "<run-uuid>", "status": "PENDING" }curl https://trickest.io/api/runs/<run-uuid> \ -H "Authorization: Bearer $TRICKEST_TOKEN" curl https://trickest.io/api/runs/<run-uuid>/subjobs \ -H "Authorization: Bearer $TRICKEST_TOKEN" # Lists use page + page_size (default 20)Recurring work: POST /api/schedule with an ISO date and integer repeat_period in seconds. No webhooks. Files: POST /api/files streaming proxy.
Orientation only. The live OpenAPI catalog is the system of record.
Read workflow metadata and node graphs, copy into another space, list versions. A run binds a version to inputs.
versions · copy · graph
POST /api/runs starts an async execution. Poll the run, walk subjobs, read console snapshots, stop, or retry.
execute · poll · subjobs
POST /api/files streams an upload through the API edge and injects auth server-side. No bearer handed to the browser for a direct PUT.
streaming proxy
List and create fleets typed MANAGED or HOSTED, scoped to a vault, then query machines reporting into each one.
managed · hosted
POST /api/schedule takes a workflow, a fleet, an ISO start date, an integer repeat period in seconds, and a parallelism cap. No cron expressions. No webhooks.
ISO date · repeat_period
Reporting, workspaces, notifications, variables, teams, integrations, billing, memory, and the workflow library round out the surface.
browse OpenAPI tags
Scalar over the generated OpenAPI. Typed access via the SDK.
HTTP is one mode. CLI and SDK share the same BFF.
Get a personalized demo
A 30-minute walkthrough. We map the platform to your stack and answer pricing and deployment questions for your environment.