OpenAI API | Batches › Create 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.

Create Batch ->

Batch

post/batches

Creates and executes a batch from an uploaded file of requests

Security

Bearer Auth

Example: Authorization: Bearer My API Key

Body parameters

completion_window: "24h"

The time frame within which the batch should be processed. Currently only 24h is supported.

endpoint: "/v1/chat/completions" | "/v1/embeddings" | "/v1/completions"

The endpoint to be used for all requests in the batch. Currently /v1/chat/completions, /v1/embeddings, and /v1/completions are supported. Note that /v1/embeddings batches are also restricted to a maximum of 50,000 embedding inputs across all requests in the batch.

input_file_id: string

The ID of an uploaded file that contains requests for the new batch.

See upload file for how to upload a file.

Your input file must be formatted as a JSONL file, and must be uploaded with the purpose batch. The file can contain up to 50,000 requests, and can be up to 100 MB in size.

metadata?: Record<string, string>

Optional custom metadata for the batch.

Response fields

Batch

Request example

curl https://api.openai.com/v1/batches \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $OPENAI_API_KEY" \
    -d '{
      "completion_window": "24h",
      "endpoint": "/v1/chat/completions",
      "input_file_id": "input_file_id"
    }'

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
  }
}

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 }