Cancel a task
Tasks
Cancel task
Mark a non-terminal task as stopped. Any step currently running on the
worker is not interrupted — it finishes naturally, but no further steps
are scheduled.
Idempotent: calling on a task that is already terminal (completed,
failed, stopped) returns 200 with the current state. No-op for tasks
that don’t belong to the caller’s workspace (returns 403).
POST
Cancel a task
Authorizations
Workspace API key issued from the web app. Pass as
Authorization: Bearer YOUR_API_KEY.
Path Parameters
UUID of the task.
Response
Cancellation accepted; returns the task's current state.
Lifecycle status of a task.
pending— created, not yet picked upqueued— held back by admission control (agent at concurrent-task limit)running— being processed by the workerwaiting_for_input— agent calledask_user; reply withPOST /tasks/{id}/messageawaiting_review— agent is paused for human approval of a sensitive stepcompleted— terminal: finished successfullyfailed— terminal: errored outstopped— terminal: cancelled by a user or system
Available options:
pending, queued, running, waiting_for_input, awaiting_review, completed, failed, stopped Title derived from the first user message. Omitted until set.