Cancel Run Endpoint

Cancel or interrupt a running execution.

Use action=cancel to hard-cancel the run immediately, or action=interrupt to cooperatively interrupt (the graph can handle the interrupt and save partial state). Set wait=1 to block until the background task has fully settled before returning the updated run.

POST /threads/{thread_id}/runs/{run_id}/cancel

Cancel Run Endpoint

cURL

curl --request POST \
  --url https://api.example.com/threads/{thread_id}/runs/{run_id}/cancel

200

{
  "run_id": "<string>",
  "thread_id": "<string>",
  "assistant_id": "<string>",
  "input": {},
  "user_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "status": "pending",
  "output": {},
  "error_message": "<string>",
  "config": {},
  "context": {}
}

Path Parameters

thread_id · string · required

run_id · string · required

Query Parameters

wait · integer · default: 0

Set to 1 to wait for the run task to settle before returning.

Required range: 0 <= x <= 1

action · string · default: cancel

Cancellation strategy: 'cancel' for hard cancel, 'interrupt' for cooperative interrupt.

Response

200

application/json

Successful Response

Run entity model

Status values: pending, running, error, success, timeout, interrupted

run_id · string · required

Unique identifier for the run.

thread_id · string · required

Thread this run belongs to.

assistant_id · string · required

Assistant that is executing this run.

input · Input · object · required

Input data provided to the run.

user_id · string · required

Identifier of the user who owns this run.

created_at · string<date-time> · required

Timestamp when the run was created.

updated_at · string<date-time> · required

Timestamp when the run was last updated.

status · string · default: pending

Current run status: pending, running, error, success, timeout, or interrupted.

output · Output · object

Final output produced by the run, or null if not yet complete.

error_message · string | null

Error message if the run failed.

config · Config · object

Configuration passed to the graph at runtime.

context · Context · object

Context variables available during execution.