OpenAI API

Batches

batches

Methods

Cancel Batch ->
Batch
post/batches/{batch_id}/cancel

Cancels an in-progress batch. The batch will be in status cancelling for up to 10 minutes, before changing to cancelled, where it will have partial results (if any) available in the output file.

Create Batch ->
Batch
post/batches

Creates and executes a batch from an uploaded file of requests

List Batch -> CursorPage<
Batch
>
get/batches

List your organization's batches.

Retrieve Batch ->
Batch
get/batches/{batch_id}

Retrieves a batch.

Domain types

Batch = { id, completion_window, created_at, 17 more... }
BatchError = { code, line, message, 1 more... }
BatchRequestCounts = { completed, failed, total }