Creates and executes a batch from an uploaded file of requests
POST /batches
Authorizations
Request Body required
object
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.
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.
The time frame within which the batch should be processed. Currently only 24h is supported.
Optional custom metadata for the batch.
object
Responses
200
Batch created successfully.
object
The object type, which is always batch.
The OpenAI API endpoint used by the batch.
object
The object type, which is always list.
object
An error code identifying the error type.
A human-readable message providing more details about the error.
The name of the parameter that caused the error, if applicable.
The line number of the input file where the error occurred, if applicable.
The ID of the input file for the batch.
The time frame within which the batch should be processed.
The current status of the batch.
The ID of the file containing the outputs of successfully executed requests.
The ID of the file containing the outputs of requests with errors.
The Unix timestamp (in seconds) for when the batch was created.
The Unix timestamp (in seconds) for when the batch started processing.
The Unix timestamp (in seconds) for when the batch will expire.
The Unix timestamp (in seconds) for when the batch started finalizing.
The Unix timestamp (in seconds) for when the batch was completed.
The Unix timestamp (in seconds) for when the batch failed.
The Unix timestamp (in seconds) for when the batch expired.
The Unix timestamp (in seconds) for when the batch started cancelling.
The Unix timestamp (in seconds) for when the batch was cancelled.
The request counts for different statuses within the batch.
object
Total number of requests in the batch.
Number of requests that have been completed successfully.
Number of requests that have failed.
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. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long.