API ReferenceOpen AI Batch

Cancel a batch

Cancel an in-progress batch. Already completed requests in the batch are not affected.

Path parameters

batch_idstringRequired

The unique identifier of the batch to cancel. Format: batch_xxxxx

Headers

AuthorizationstringRequired

Bearer token. Use Bearer YOUR_API_KEY.

Request

This endpoint expects an object.

Response

Batch cancellation initiated.
idstring
Batch ID.
statusenum
Batch status.
input_file_idstring
output_file_idstring or null

Output file ID (available when completed).

error_file_idstring or null

Error file ID (if errors occurred).

endpointstring
completion_windowstring
created_atinteger
completed_atinteger or null
request_countsobject
metadataobject

Errors

401
Unauthorized Error
404
Not Found Error