OpenAI API | Batches › Cancel Batch

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.

Security

Bearer Auth

Example: Authorization: Bearer My API Key

Parameters

batch_id: string

Response fields

Batch

Request example

curl https://api.openai.com/v1/batches/$BATCH_ID/cancel \
    -X POST \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $OPENAI_API_KEY"

200Example

{
  "id": "id",
  "completion_window": "completion_window",
  "created_at": 0,
  "endpoint": "endpoint",
  "input_file_id": "input_file_id",
  "object": "batch",
  "status": "validating",
  "cancelled_at": 0,
  "cancelling_at": 0,
  "completed_at": 0,
  "error_file_id": "error_file_id",
  "errors": {
    "data": [
      {
        "code": "code",
        "line": 0,
        "message": "message",
        "param": "param"
      }
    ],
    "object": "object"
  },
  "expired_at": 0,
  "expires_at": 0,
  "failed_at": 0,
  "finalizing_at": 0,
  "in_progress_at": 0,
  "metadata": {},
  "output_file_id": "output_file_id",
  "request_counts": {
    "completed": 0,
    "failed": 0,
    "total": 0
  }
}

Create Batch ->

Batch

post/batches

Creates and executes a batch from an uploaded file of requests

List Batch -> CursorPage<

Batch

get/batches

List your organization's batches.

Retrieve Batch ->

Batch

get/batches/{batch_id}

Retrieves a batch.

Domain types

Batch = { id, completion_window, created_at, 17 more... }

BatchError = { code, line, message, 1 more... }

BatchRequestCounts = { completed, failed, total }