Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Voice & Audio Production API reference
API Dashboard
Try ChatGPT
API Reference
Batches

Retrieve batch

$ openai batches retrieve
GET/batches/{batch_id}

Retrieves a batch.

ParametersExpand Collapse
--batch-id: string

The ID of the batch to retrieve.

ReturnsExpand Collapse
batch: object { id, completion_window, created_at, 19 more }
id: string
completion_window: string

The time frame within which the batch should be processed.

created_at: number

The Unix timestamp (in seconds) for when the batch was created.

endpoint: string

The OpenAI API endpoint used by the batch.

input_file_id: string

The ID of the input file for the batch.

object: "batch"

The object type, which is always batch.

status: "validating" or "failed" or "in_progress" or 5 more

The current status of the batch.

cancelled_at: optional number

The Unix timestamp (in seconds) for when the batch was cancelled.

cancelling_at: optional number

The Unix timestamp (in seconds) for when the batch started cancelling.

completed_at: optional number

The Unix timestamp (in seconds) for when the batch was completed.

error_file_id: optional string

The ID of the file containing the outputs of requests with errors.

errors: optional object { data, object }
expired_at: optional number

The Unix timestamp (in seconds) for when the batch expired.

expires_at: optional number

The Unix timestamp (in seconds) for when the batch will expire.

failed_at: optional number

The Unix timestamp (in seconds) for when the batch failed.

finalizing_at: optional number

The Unix timestamp (in seconds) for when the batch started finalizing.

in_progress_at: optional number

The Unix timestamp (in seconds) for when the batch started processing.

metadata: optional map[string]

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

model: optional string

Model ID used to process the batch, like gpt-5-2025-08-07. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.

output_file_id: optional string

The ID of the file containing the outputs of successfully executed requests.

request_counts: optional object { completed, failed, total }

The request counts for different statuses within the batch.

usage: optional object { input_tokens, input_tokens_details, output_tokens, 2 more }

Represents token usage details including input tokens, output tokens, a breakdown of output tokens, and the total tokens used. Only populated on batches created after September 7, 2025.

Retrieve batch

openai batches retrieve \
  --api-key 'My API Key' \
  --batch-id batch_id
{
  "id": "batch_abc123",
  "object": "batch",
  "endpoint": "/v1/completions",
  "errors": null,
  "input_file_id": "file-abc123",
  "completion_window": "24h",
  "status": "completed",
  "output_file_id": "file-cvaTdG",
  "error_file_id": "file-HOWS94",
  "created_at": 1711471533,
  "in_progress_at": 1711471538,
  "expires_at": 1711557933,
  "finalizing_at": 1711493133,
  "completed_at": 1711493163,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": null,
  "cancelled_at": null,
  "request_counts": {
    "total": 100,
    "completed": 95,
    "failed": 5
  },
  "metadata": {
    "customer_id": "user_123456789",
    "batch_description": "Nightly eval job",
  }
}
Returns Examples
{
  "id": "batch_abc123",
  "object": "batch",
  "endpoint": "/v1/completions",
  "errors": null,
  "input_file_id": "file-abc123",
  "completion_window": "24h",
  "status": "completed",
  "output_file_id": "file-cvaTdG",
  "error_file_id": "file-HOWS94",
  "created_at": 1711471533,
  "in_progress_at": 1711471538,
  "expires_at": 1711557933,
  "finalizing_at": 1711493133,
  "completed_at": 1711493163,
  "failed_at": null,
  "expired_at": null,
  "cancelling_at": null,
  "cancelled_at": null,
  "request_counts": {
    "total": 100,
    "completed": 95,
    "failed": 5
  },
  "metadata": {
    "customer_id": "user_123456789",
    "batch_description": "Nightly eval job",
  }
}