Creates and executes a batch from an uploaded file of requests. [Learn more](/docs/batch).
Request body
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 be up to 100 MB in size.
The endpoint to be used for all requests in the batch. Currently /v1/chat/completions is supported.
The time frame within which the batch should be processed. Durations from 24h to 7d are supported.
Optional custom metadata for the batch.
Response
Batch created successfully.
The object type, which is always batch.
The API endpoint used by the batch.
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.
Set of 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.