Cancel a run (v1)

POST

https://api.openai.com/v1/threads/thread_abc123/runs/run_abc123/cancel

Cancels a run that is in_progress.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.openai.com/v1/threads/thread_abc123/runs/run_abc123/cancel' \
--header 'Authorization: Bearer $OPENAI_API_KEY' \
--header 'OpenAI-Beta: assistants=v1'

Response Example

{
  "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-4-turbo",
  "instructions": "You summarize books.",
  "tools": [
    {
      "type": "retrieval"
    }
  ],
  "file_ids": [],
  "metadata": {},
  "usage": null,
  "temperature": 1.0,
  "top_p": 1.0,
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

Authorization

string

required

Example:

Bearer $OPENAI_API_KEY

OpenAI-Beta

string

required

Example:

assistants=v1

Responses

🟢200Success

application/json

Body

string

required

object

string

required

created_at

integer

required

assistant_id

string

required

thread_id

string

required

status

string

required

started_at

integer

required

expires_at

integer

required

cancelled_at

null

required

failed_at

null

required

completed_at

null

required

last_error

null

required

model

string

required

instructions

string

required

tools

array [object {1}]

required

type

string

optional

file_ids

array[string]

required

metadata

object

required

usage

null

required

temperature

integer

required

top_p

integer

required

Modified at 2024-12-25 10:23:57

Submit tool outputs to run (v1)