OMomnistack-sh
Batch

Create batch

Changed on

Creates and executes a batch from an uploaded file of requests

post/batches

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/batches
  • Auth
    HTTP bearer

Request body

input_file_idstring required

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 200 MB in size.

endpoint'/v1/responses' | '/v1/chat/completions' | '/v1/embeddings' | '/v1/completions' | '/v1/moderations' | '/v1/images/generations' | '/v1/images/edits' | '/v1/videos' required

The endpoint to be used for all requests in the batch. Currently /v1/responses, /v1/chat/completions, /v1/embeddings, /v1/completions, /v1/moderations, /v1/images/generations, /v1/images/edits, and /v1/videos are supported. Note that /v1/embeddings batches are also restricted to a maximum of 50,000 embedding inputs across all requests in the batch.

completion_window'24h' required

The time frame within which the batch should be processed. Currently only 24h is supported.

metadataMetadata nullable

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.

Response

Batch created successfully.

idstring required
object'batch' required

The object type, which is always batch.

endpointstring required

The OpenAI API endpoint used by the batch.

modelstring

Model ID used to process the batch, like gpt-6-astra. 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.

input_file_idstring required

The ID of the input file for the batch.

completion_windowstring required

The time frame within which the batch should be processed.

status'validating' | 'failed' | 'in_progress' | 'finalizing' | 'completed' | 'expired' | 'cancelling' | 'cancelled' required

The current status of the batch.

output_file_idstring nullable

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

error_file_idstring nullable

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

created_atinteger required

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

in_progress_atinteger nullable

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

expires_atinteger nullable

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

finalizing_atinteger nullable

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

completed_atinteger nullable

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

failed_atinteger nullable

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

expired_atinteger nullable

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

cancelling_atinteger nullable

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

cancelled_atinteger nullable

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

metadataMetadata nullable

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.

Changes

  • 487892d3954eRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 7f654af7f94fRevision changes
    • breaking

      the request property became not nullable

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      response property errors/data/items/line list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property errors/data/items/param list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property metadata list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the response's property type changed from integer to integer null, and format from no format to unixtime for status

    • breaking

      the response's property type changed from integer to integer null, and format from no format to unixtime for status

    • breaking

      the response's property type changed from integer to integer null, and format from no format to unixtime for status

    • breaking

      the response's property type changed from integer to integer null, and format from no format to unixtime for status

    • breaking

      the response's property type changed from integer to integer null, and format from no format to unixtime for status

    • breaking

      the response's property type changed from integer to integer null, and format from no format to unixtime for status

    • breaking

      the response's property type changed from integer to integer null, and format from no format to unixtime for status

    • breaking

      the response's property type changed from integer to integer null, and format from no format to unixtime for status

    • info

      added the new optional request property

    • info

      added the new /v1/images/edits enum value to the request property

    • info

      added the new /v1/images/generations enum value to the request property

    • info

      added the new /v1/moderations enum value to the request property

    • info

      added the new /v1/responses enum value to the request property

    • info

      added the new /v1/videos enum value to the request property

    • info

      request property list-of-types was widened by adding types null to media type application/json

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status