Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Voice & Audio Production API reference
API Dashboard
Try ChatGPT
API Reference
Beta
Threads
Runs

Cancel a run

beta.threads.runs.cancel(strrun_id, RunCancelParams**kwargs) -> Run
POST/threads/{thread_id}/runs/{run_id}/cancel

Cancels a run that is in_progress.

ParametersExpand Collapse
thread_id: str
run_id: str
ReturnsExpand Collapse
class Run: …

Represents an execution run on a thread.

id: str

The identifier, which can be referenced in API endpoints.

assistant_id: str

The ID of the assistant used for execution of this run.

cancelled_at: Optional[int]

The Unix timestamp (in seconds) for when the run was cancelled.

formatunixtime
completed_at: Optional[int]

The Unix timestamp (in seconds) for when the run was completed.

formatunixtime
created_at: int

The Unix timestamp (in seconds) for when the run was created.

formatunixtime
expires_at: Optional[int]

The Unix timestamp (in seconds) for when the run will expire.

formatunixtime
failed_at: Optional[int]

The Unix timestamp (in seconds) for when the run failed.

formatunixtime
incomplete_details: Optional[IncompleteDetails]

Details on why the run is incomplete. Will be null if the run is not incomplete.

instructions: str

The instructions that the assistant used for this run.

last_error: Optional[LastError]

The last error associated with this run. Will be null if there are no errors.

max_completion_tokens: Optional[int]

The maximum number of completion tokens specified to have been used over the course of the run.

minimum256
max_prompt_tokens: Optional[int]

The maximum number of prompt tokens specified to have been used over the course of the run.

minimum256
metadata: Optional[Metadata]

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

model: str

The model that the assistant used for this run.

object: Literal["thread.run"]

The object type, which is always thread.run.

parallel_tool_calls: bool

Whether to enable parallel function calling during tool use.

required_action: Optional[RequiredAction]

Details on the action required to continue the run. Will be null if no action is required.

response_format: Optional[AssistantResponseFormatOption]

Specifies the format that the model must output. Compatible with GPT-4o, GPT-4 Turbo, and all GPT-3.5 Turbo models since gpt-3.5-turbo-1106.

Setting to { "type": "json_schema", "json_schema": {...} } enables Structured Outputs which ensures the model will match your supplied JSON schema. Learn more in the Structured Outputs guide.

Setting to { "type": "json_object" } enables JSON mode, which ensures the message the model generates is valid JSON.

Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly “stuck” request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

started_at: Optional[int]

The Unix timestamp (in seconds) for when the run was started.

formatunixtime
status: RunStatus

The status of the run, which can be either queued, in_progress, requires_action, cancelling, cancelled, failed, completed, incomplete, or expired.

thread_id: str

The ID of the thread that was executed on as a part of this run.

tool_choice: Optional[AssistantToolChoiceOption]

Controls which (if any) tool is called by the model. none means the model will not call any tools and instead generates a message. auto is the default value and means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools before responding to the user. Specifying a particular tool like {"type": "file_search"} or {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.

tools: List[AssistantTool]

The list of tools that the assistant used for this run.

truncation_strategy: Optional[TruncationStrategy]

Controls for how a thread will be truncated prior to the run. Use this to control the initial context window of the run.

usage: Optional[Usage]

Usage statistics related to the run. This value will be null if the run is not in a terminal state (i.e. in_progress, queued, etc.).

temperature: Optional[float]

The sampling temperature used for this run. If not set, defaults to 1.

top_p: Optional[float]

The nucleus sampling value used for this run. If not set, defaults to 1.

Cancel a run

from openai import OpenAI
client = OpenAI()

run = client.beta.threads.runs.cancel(
  thread_id="thread_abc123",
  run_id="run_abc123"
)

print(run)

{
  "id": "run_abc123",
  "object": "thread.run",
  "created_at": 1699076126,
  "assistant_id": "asst_abc123",
  "thread_id": "thread_abc123",
  "status": "cancelling",
  "started_at": 1699076126,
  "expires_at": 1699076726,
  "cancelled_at": null,
  "failed_at": null,
  "completed_at": null,
  "last_error": null,
  "model": "gpt-4o",
  "instructions": "You summarize books.",
  "tools": [
    {
      "type": "file_search"
    }
  ],
  "tool_resources": {
    "file_search": {
      "vector_store_ids": ["vs_123"]
    }
  },
  "metadata": {},
  "usage": null,
  "temperature": 1.0,
  "top_p": 1.0,
  "response_format": "auto",
  "tool_choice": "auto",
  "parallel_tool_calls": true
}
Returns Examples
{
  "id": "run_abc123",
  "object": "thread.run",
  "created_at": 1699076126,
  "assistant_id": "asst_abc123",
  "thread_id": "thread_abc123",
  "status": "cancelling",
  "started_at": 1699076126,
  "expires_at": 1699076726,
  "cancelled_at": null,
  "failed_at": null,
  "completed_at": null,
  "last_error": null,
  "model": "gpt-4o",
  "instructions": "You summarize books.",
  "tools": [
    {
      "type": "file_search"
    }
  ],
  "tool_resources": {
    "file_search": {
      "vector_store_ids": ["vs_123"]
    }
  },
  "metadata": {},
  "usage": null,
  "temperature": 1.0,
  "top_p": 1.0,
  "response_format": "auto",
  "tool_choice": "auto",
  "parallel_tool_calls": true
}