Skip to main content
POST
Cancel a batch

Authorizations

chariotai-api-key
string
header
required

Your Chariot API key, generated from the dashboard. Send it in the chariotai-api-key header on every request.

Path Parameters

batch_id
string<uuid>
required

Response

Accepted.

id
string<uuid>
required
status
enum<string>
required
Available options:
queued,
processing,
cancelling,
completed,
partially_completed,
failed,
cancelled
created_at
string<date-time>
required
started_at
string<date-time> | null
required
finished_at
string<date-time> | null
required
cancel_requested_at
string<date-time> | null
required
counts
Counts · object
required
items_url
string
required