Skip to main content
POST
Cancel an item or a batch

Authorizations

Authorization
string
header
required

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

Body

application/json

Provide exactly one of task_id or batch_id.

task_id
string

Cancel this one item.

batch_id
string

Cancel every queued item of this batch.

Response

The queued items are cancelled.

Every Batch API route answers with this envelope. A failure carries message instead of data.

status
string
Allowed value: "success"
data
object
request_id
string