Skip to main content
POST

Authorizations

Authorization
string
header
required

API key as bearer token in Authorization header

Body

application/json

The batch to create. Each item in requests has a unique custom_id and a body in the request format of the chosen endpoint.

Batch submit request body.

endpoint
enum<string>
required
Available options:
/v1/chat/completions,
/v1/responses,
/v1/messages,
/v1/embeddings
model
string
required
Minimum string length: 1
requests
object[]
required
Minimum array length: 1
completion_window
enum<string>
default:24h
Available options:
24h
provider
object | null

Batch provider routing preferences. Only provider.only is supported.

Example:

Response

Batch payload durably persisted and queued for asynchronous validation and provider submission (status: "validating").

completion_window
enum<string>
required
Available options:
24h
created_at
integer
required
endpoint
string
required
error
object | null
required
finalized_at
integer | null
required
id
string
required
model
string
required
object
enum<string>
required
Available options:
batch
request_counts
object
required
results
object[] | null
required
status
enum<string>
required
Available options:
validating,
in_progress,
finalizing,
completed,
failed,
expired,
cancelling,
cancelled
usage
object | null
required