⋙ Create Batch

Creates and executes a batch from an uploaded file of requests.

msg.payload Properties

input_file_id string

The ID of an uploaded file that contains requests for the new batch.

endpoint string

The endpoint to be used for all requests in the batch. Supported values include /v1/responses, /v1/chat/completions, /v1/embeddings, /v1/completions, /v1/moderations, /v1/images/generations, /v1/images/edits, and /v1/videos.

completion_window string

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

metadata string

Optional custom metadata for the batch.

⋙ Retrieve Batch

Retrieves a batch.

msg.payload Properties

batch_id string

The ID of the batch to retrieve.

⋙ Cancel Batch

Cancels an in-progress batch.

msg.payload Properties

batch_id string

The ID of the batch to cancel.

⋙ List Batch

List your organization's batches.

msg.payload Properties

after string

A cursor for use in pagination. after is an object ID that defines your place in the list.

limit integer

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.