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 Audio & voice Production API reference
API Reference

Batches

Create large batches of API requests to run asynchronously.

Cancel batch
POST/batches/{batch_id}/cancel
Create batch
POST/batches
List batches
GET/batches
Retrieve batch
GET/batches/{batch_id}
ModelsExpand 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.

formatunixtime
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.

One of the following:
"validating"
"failed"
"in_progress"
"finalizing"
"completed"
"expired"
"cancelling"
"cancelled"
cancelled_at: optional number

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

formatunixtime
cancelling_at: optional number

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

formatunixtime
completed_at: optional number

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

formatunixtime
error_file_id: optional string

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

errors: optional object { data, object }
data: optional array of BatchError {