Read a run
Returns one run's status and counters. Poll this, or follow the events endpoint, while a run is in flight.
Returns one run's status and counters. Poll this, or follow the events endpoint, while a run is in flight.
Path Parameters
The project the run belongs to.
The run to read.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/projects/string/runs/string"{ "id": "string", "projectId": "string", "status": "queued", "prompt": "string", "model": "string", "recipeId": "string", "steps": 0, "tokensIn": 0, "tokensOut": 0, "sandboxMs": 0, "error": "string", "startedAt": "string", "finishedAt": "string", "createdAt": "string"}Start a run POST
Accepts an instruction and queues a run against the project. The response is returned as soon as the run is recorded, not when it completes: the client then follows progress on `GET /projects/{projectId}/runs/{runId}/events` (paged) or the SSE stream. A project has at most one queued-or-running run at a time; starting a second answers 409 until the first finishes or is cancelled. Name a `recipe` to run one explicitly; a recipe this deployment has disabled is refused with 403 `recipe_disabled` and nothing is queued.
Cancel a run POST
Requests cancellation of a queued or running run. A queued run is cancelled immediately. A running run is marked cancelled and the worker observes it at its next heartbeat, so this call does not wait for the agent to stop. Cancelling a run that has already finished is a no-op that returns the finished run unchanged, so a client that cancels twice does not get an error.