Sign in
Batches

Cancel a batch

Request cancellation while status is in_progress or validating.

post/v1/batches/{batch_id}/cancel

Path parameters

batch_idstring required

Headers

x-project-idstring

Optional project identifier. Scopes the request to a specific project when provided.

Response

Batch cancellation requested

idstring
object'batch'
endpointstring
status'validating' | 'in_progress' | 'finalizing' | 'completed' | 'failed' | 'expired' | 'cancelling' | 'cancelled'
input_file_idstring
output_file_idstring nullable
error_file_idstring nullable
completion_windowstring
created_atinteger
expires_atinteger
metadataobject

Changes

No recorded changes to this endpoint across all 1 revision of this API.