This reference is generated from the platform’s own OpenAPI, produced from the FastAPI app in the
repository. Everything here is the versioned v1 surface: the platform publishes its own
changelog at
GET /api/v1/system/changelog, its limits at /system/limits, and the webhook event
catalogue at /system/webhook-events, so a client can discover what it is talking to rather than
trust a doc. The dashboard’s own internal routes under /api/* are not part of this contract and
are not listed.Where to start
Preview, then trigger
POST /jobs/preview shows what a job would do without running it; POST /trigger runs it.
Use preview first — a computer-use job acts on real software.Wait for the result
Poll a job, or subscribe to a webhook and let the platform tell you. The outcome carries its
evidence — screenshots and the action log.
Approve what needs a human
Approval policies decide which steps pause for a person; the approvals endpoints are where
that person says yes or no.
Make it repeatable
A template is a job definition you trigger by name, with its own limits and approval policy.
The groups
Related
- Computer Use Agent — architecture, agent types, and how a job executes
- Computer Use MCP server — the same surface as nine agent tools, plus a local server
- Computer-use engines — running under NSR governance