OpenAI API
🇺🇸 English
  • 🇨🇳 简体中文
  • 🇺🇸 English
  • 🇯🇵 日本語
Home
Home
twitter/X
Discord
🇺🇸 English
  • 🇨🇳 简体中文
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. Runs (v1)
  • Get started
  • Introduction
  • Authentication
  • Making requests
  • Streaming
  • Audio
    • Create transcription
      POST
    • Create translation
      POST
    • Create speech
      POST
  • Batch
    • Create batch
      POST
    • Retrieve batch
      GET
    • Cancel batch
      POST
    • List batch
      GET
  • Models
    • List models
      GET
    • Retrieve model
      GET
    • Delete a fine-tuned model
      DELETE
  • Invites
    • List invites
    • Create invite
    • Retrieve invite
    • Delete invite
  • Chat
    • Create chat completion
  • Users
    • List users
    • Modify user
    • Retrieve user
  • Projects
    • List projects
    • Create project
    • Retrieve project
    • Modify project
    • Archive project
  • Project users
    • List project users
    • Create project user
    • Retrieve project user
    • Modify project user
    • Delete project user
    • Create project service account
  • Project service accounts
    • List project service accounts
    • Create project service account
    • Retrieve project service account
    • Delete project service account
  • Project API keys
    • List project API keys
    • Retrieve project API key
    • Delete project API key
  • Audit logs
    • List audit logs
  • Usage
    • Completions
    • Embeddings
    • Moderations
    • Images
    • Audio speeches
    • Audio transcriptions
    • Vector stores
    • Code interpreter sessions
    • Costs
  • Project rate limits
    • List project rate limits
    • Modify project rate limit
  • Completions
    • Create completion
  • Uploads
    • Create upload
    • Add upload part
    • Complete upload
  • Embeddings
    • Create embeddings
  • Files
    • README
    • Retrieve file content
    • List files
    • Upload file
    • Delete file
    • Retrieve file
  • Moderations
    • Create moderation
  • Assistants (v1)
    • Create assistant (v1)
    • Create assistant file (v1)
    • List assistants (v1)
    • List assistant files (v1)
    • Retrieve assistant (v1)
    • Retrieve assistant file (v1)
    • Modify assistant (v1)
    • Delete assistant (v1)
    • Delete assistant file (v1)
  • Threads (v1)
    • Create thread (v1)
    • Retrieve thread (v1)
    • Modify thread (v1)
    • Delete thread (v1)
  • Messages (v1)
    • Create message (v1)
    • List messages (v1)
    • List message files (v1)
    • Retrieve message (v1)
    • Retrieve message file (v1)
    • Modify message (v1)
  • Runs (v1)
    • Backward compatibility
    • Debugging requests
    • Create run (v1)
      POST
    • Retrieve run step (v1)
      GET
    • Create thread and run (v1)
      POST
    • List runs (v1)
      GET
    • List run steps (v1)
      GET
    • Retrieve run (v1)
      GET
    • Modify run (v1)
      POST
    • Submit tool outputs to run (v1)
      POST
    • Cancel a run (v1)
      POST
  • Images
    • README
    • Create image
    • Create image edit
    • Create image variation
  • Fine-tuning
    • Create fine-tuning job
    • List fine-tuning jobs
    • List fine-tuning events
    • List fine-tuning checkpoints
    • Retrieve fine-tuning job
    • Cancel fine-tuning
  1. Runs (v1)

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

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

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request 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'

Responses

🟢200Success
application/json
Body
id
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
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,
}
Modified at 2024-12-13 10:20:37
Previous
Submit tool outputs to run (v1)
Next
README