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
  • Chat
    • Create chat completion
      POST
    • Get chat completion
      GET
    • Get chat messages
      GET
    • List Chat Completions
      GET
    • Update chat completion
      POST
    • Delete chat completion
      DELETE
  • Audio
    • Create speech
      POST
    • Create transcription
      POST
    • Create translation
      POST
  • Images
    • README
    • Create image
      POST
    • Create image edit
      POST
    • Create image variation
      POST
  • Embeddings
    • Create embeddings
      POST
  • 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
  • Batch
    • Create batch
      POST
    • Retrieve batch
      GET
    • Cancel batch
      POST
    • List batch
      GET
  • Files
    • README
    • Upload file
    • List files
    • Retrieve file
    • Delete file
    • Retrieve file content
  • Uploads
    • Create upload
    • Add upload part
    • Complete upload
  • 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
  • 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
  • Usage
    • Completions
    • Embeddings
    • Moderations
    • Images
    • Audio speeches
    • Audio transcriptions
    • Vector stores
    • Code interpreter sessions
    • Costs
  • Assistants (v1)
    • Create assistant
    • List assistants
    • Delete assistant
    • Modify assistant
    • Retrieve assistant
    • Create assistant file (v1)
    • List assistant files (v1)
    • Retrieve assistant file (v1)
    • Delete assistant file (v1)
  1. Batch

Cancel batch

POST
/batches/{batch_id}/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

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params

Body Params multipart/form-data

Responses

🟒200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.openai.com/v1/batches//cancel' \
--header 'Authorization: Bearer <token>'
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",
  }
}
Modified atΒ 2025-09-17 10:05:53
Previous
Retrieve batch
Next
List batch
Built with