Skip to main content
POST
Cancel a batch
Request cancellation while a batch is in_progress or validating. Terminal batches return 409. Poll status on Retrieve batch. Full reference: Batches API.

Authorizations

x-api-key
string
header
required

Headers

x-project-id
string

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

Path Parameters

batch_id
string
required

Response

Batch cancellation requested

id
string
object
enum<string>
Available options:
batch
endpoint
string
status
enum<string>
Available options:
validating,
in_progress,
finalizing,
completed,
failed,
expired,
cancelling,
cancelled
input_file_id
string
output_file_id
string | null
error_file_id
string | null
completion_window
string
created_at
integer
expires_at
integer
request_counts
object
metadata
object