Sign in

v27

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-2193427579.9 KB
Batches

Cancel a batch that is in progress.

Cancel a batch that is in progress.

post/v1/batches/{batch_id}/cancel

Path parameters

batch_idstring required

The ID of the batch to cancel.

The ID of the batch to cancel.

Response

The updated batch object.

idstring required
completion_windowstring required
created_atinteger required
endpointstring required
input_file_idstring required
object'batch' required
status'validating' | 'failed' | 'in_progress' | 'finalizing' | 'completed' | 'expired' | 'cancelling' | 'cancelled' required
cancelled_atinteger nullable
cancelling_atinteger nullable
completed_atinteger nullable
error_file_idstring nullable
expired_atinteger nullable
expires_atinteger nullable
failed_atinteger nullable
finalizing_atinteger nullable
in_progress_atinteger nullable
metadataobject nullable
modelstring nullable
output_file_idstring nullable