Open AI (ChatGPT)
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ Japanese
  • πŸ‡΅πŸ‡Ή Portuguese
  • πŸ‡°πŸ‡· Korea
  • πŸ‡©πŸ‡ͺ German
  1. Batch
Open AI (ChatGPT)
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ Japanese
  • πŸ‡΅πŸ‡Ή Portuguese
  • πŸ‡°πŸ‡· Korea
  • πŸ‡©πŸ‡ͺ German
  • README
  • Introduction
  • Authentication
  • Making requests
  • Streaming
  • Debugging requests
  • Backward compatibility
  • Administration
  • Audio
    • Create speech
      POST
    • Create transcription
      POST
    • Create translation
      POST
  • Chat
    • Create chat completion
      POST
  • Embeddings
    • Create embeddings
      POST
  • Fine-tuning
    • Create fine-tuning job
      POST
    • List fine-tuning jobs
      GET
    • List fine-tuning events
      GET
    • List fine-tuning checkpoints
      GET
    • Retrieve fine-tuning job
      GET
    • Cancel fine-tuning
      POST
  • Batch
    • Create batch
      POST
    • Retrieve batch
      GET
    • Cancel batch
      POST
    • List batch
      GET
  • Files
    • README
    • Upload file
      POST
    • List files
      GET
    • Retrieve file
      GET
    • Delete file
      DELETE
    • Retrieve file content
      GET
  • Uploads
    • Create upload
    • Add upload part
    • Complete upload
  • Images
    • README
    • Create image
    • Create image edit
    • Create image variation
  • Models
    • List models
    • Retrieve model
    • Delete a fine-tuned model
  • Moderations
    • Create moderation
  • Invites
    • List invites
    • Create invite
    • Retrieve invite
    • Delete invite
  • 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
  • Project rate limits
    • List project rate limits
    • Modify project rate limit
  • Audit logs
    • List audit logs
  • Usage
    • Completions
    • Embeddings
    • Moderations
    • Images
    • Audio speeches
    • Audio transcriptions
    • Vector stores
    • Code interpreter sessions
    • Costs
  • Completions
    • Create completion
  • 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)
    • Create run (v1)
    • Create thread and run (v1)
    • List runs (v1)
    • List run steps (v1)
    • Retrieve run (v1)
    • Retrieve run step (v1)
    • Modify run (v1)
    • Submit tool outputs to run (v1)
    • Cancel a run (v1)
  1. Batch

Cancel batch

POST
https://api.openai.com/v1/batches/batch_abc123/cancel
Cancels an in-progress batch. The batch will be in status cancelling for up to 10 minutes, before changing to cancelled, where it will have partial results (if any) available in the output file.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.openai.com/v1/batches/batch_abc123/cancel' \
--header 'Authorization: Bearer $OPENAI_API_KEY'
Response Response Example
{
  "id": "batch_abc123",
  "object": "batch",
  "endpoint": "/v1/chat/completions",
  "errors": null,
  "input_file_id": "file-abc123",
  "completion_window": "24h",
  "status": "cancelling",
  "output_file_id": null,
  "error_file_id": null,
  "created_at": 1711471533,
  "in_progress_at": 1711471538,
  "expires_at": 1711557933,
  "finalizing_at": null,
  "completed_at": null,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": 1711475133,
  "cancelled_at": null,
  "request_counts": {
    "total": 100,
    "completed": 23,
    "failed": 1
  },
  "metadata": {
    "customer_id": "user_123456789",
    "batch_description": "Nightly eval job",
  }
}

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
Content-Type
stringΒ 
required
Example:
application/json
Body Params multipart/form-data
objectΒ {0}

Responses

🟒200Success
application/json
Body
id
stringΒ 
required
object
stringΒ 
required
endpoint
stringΒ 
required
errors
nullΒ 
required
input_file_id
stringΒ 
required
completion_window
stringΒ 
required
status
stringΒ 
required
output_file_id
nullΒ 
required
error_file_id
nullΒ 
required
created_at
integerΒ 
required
in_progress_at
integerΒ 
required
expires_at
integerΒ 
required
finalizing_at
nullΒ 
required
completed_at
nullΒ 
required
failed_at
nullΒ 
required
expired_at
nullΒ 
required
cancelling_at
integerΒ 
required
cancelled_at
nullΒ 
required
request_counts
objectΒ 
required
total
integerΒ 
required
completed
integerΒ 
required
failed
integerΒ 
required
metadata
objectΒ 
required
customer_id
stringΒ 
required
batch_description
stringΒ 
required
Modified atΒ 2024-12-11 09:13:46
Previous
Retrieve batch
Next
List batch
Built with