Skip to main content
POST
/
threads
/
{thread_id}
/
runs
/
{run_id}
/
cancel
Cancel Run
curl --request POST \
  --url https://api.example.com/threads/{thread_id}/runs/{run_id}/cancel
{
  "detail": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://langchain-5e9cc07a-preview-hunter-1779825596-dac3ae1.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
thread_id
string<uuid>
required

The ID of the thread.

​
run_id
string<uuid>
required

The ID of the run.

Query Parameters

​
wait
boolean
default:false
​
action
enum<string>
default:interrupt

Action to take when cancelling the run. Possible values are interrupt or rollback. interrupt will simply cancel the run. rollback will cancel the run and delete the run and associated checkpoints afterwards.

Available options:
interrupt,
rollback

Response

Success