v1

latestOpenAPI 3.0.02026-07-26300209.6 KB

Runs

Cancel run by ID

Cancel a run by ID. Only runs created via /v1/automation/run-async or /v1/automation/run-sse can be cancelled. Runs created via the synchronous /v1/automation/run endpoint cannot be cancelled.

post/v1/runs/{id}/cancel

Path parameters

idstring required

Run ID

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Run ID

Response

Run cancelled successfully, or already in terminal state (idempotent)

run_idstring required

The unique identifier of the run

status'CANCELLED' | 'COMPLETED' | 'FAILED' required

The current status of the run. Returns actual status for idempotent responses (e.g., COMPLETED if run already finished)

cancelled_atstring nullable required

ISO 8601 timestamp when the run was cancelled, or null if not cancelled

messagestring nullable required

Additional context about the cancellation result (e.g., "Run already cancelled", "Run already finished")

Example response

{
  "run_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "CANCELLED",
  "cancelled_at": "2026-01-14T10:30:55Z",
  "message": "Run already cancelled"
}