Skip to main content
POST
Cancel a batch

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

batch_id
string
required

Batch identifier (batch_...)

Response

The batch

id
string
required
object
enum<string>
required
Available options:
batch
endpoint
string
required
input_file_id
string
required
completion_window
string
required
status
enum<string>
required
Available options:
validating,
in_progress,
finalizing,
completed,
expired,
cancelling,
cancelled,
failed
created_at
integer<int64>
required

Unix seconds

request_counts
object
required
usage
object
required
errors
object | null
output_file_id
string | null
error_file_id
string | null
in_progress_at
integer<int64> | null
expires_at
integer<int64> | null
finalizing_at
integer<int64> | null
completed_at
integer<int64> | null
failed_at
integer<int64> | null
expired_at
integer<int64> | null
cancelling_at
integer<int64> | null
cancelled_at
integer<int64> | null
metadata
object | null