Batch

Creates and executes a batch from an uploaded file of requests. [Learn more](/docs/batch).

Changed on
post/openai/v1/batches

Request

  • Base URL
    https://api.groq.com
  • URL
    https://api.groq.com/openai/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 be up to 100 MB in size.

endpoint'/v1/chat/completions' required

The endpoint to be used for all requests in the batch. Currently /v1/chat/completions is supported.

completion_windowstring required

The time frame within which the batch should be processed. Durations from 24h to 7d are supported.

metadataobject nullable

Optional custom metadata for the batch.

Response

Batch created successfully.

idstring required
object'batch' required

The object type, which is always batch.

endpointstring required

The API endpoint used by the batch.

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

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

error_file_idstring

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

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

expires_atinteger

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

finalizing_atinteger

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

completed_atinteger

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

failed_atinteger

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

expired_atinteger

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

cancelling_atinteger

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

cancelled_atinteger

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

metadataobject nullable

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.

Changes