Skip to main content
POST
/
threads
/
{thread_id}
/
runs
/
{run_id}
/
cancel
Cancel Run Endpoint
curl --request POST \
  --url https://api.example.com/threads/{thread_id}/runs/{run_id}/cancel
import requests

url = "https://api.example.com/threads/{thread_id}/runs/{run_id}/cancel"

response = requests.post(url)

print(response.text)
const options = {method: 'POST'};

fetch('https://api.example.com/threads/{thread_id}/runs/{run_id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/threads/{thread_id}/runs/{run_id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/threads/{thread_id}/runs/{run_id}/cancel"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/threads/{thread_id}/runs/{run_id}/cancel")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/threads/{thread_id}/runs/{run_id}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
{
  "run_id": "<string>",
  "thread_id": "<string>",
  "assistant_id": "<string>",
  "user_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "status": "pending",
  "input": {},
  "output": {},
  "error_message": "<string>",
  "config": {},
  "context": {}
}
{
  "error": "<string>",
  "message": "<string>",
  "details": {}
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

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.

Pattern: ^(cancel|interrupt)$

Response

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.

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.

input
Input · object | null

Input data provided to the run. None for checkpoint-only resume.

output
Output · object | null

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 | null

Configuration passed to the graph at runtime.

context
Context · object | null

Context variables available during execution.