Cancel a batch
POST /v1/batches/{id}/cancel
POST
/v1/batches/{id}/cancel
Cancels pending jobs; running jobs finish. Workflow-stage batches must be canceled through their workflow run.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” id
required
string
Batch ID
Responses
Section titled “ Responses ”Batch canceled.
object
batch_id
string
state
string
jobs_canceled
integer
Missing or invalid API key.
object
error
required
string
Example
invalid request field
Field that failed validation.
string
detail
string
hint
string
Resource missing or not owned by this account.
object
error
required
string
Example
invalid request field
Field that failed validation.
string
detail
string
hint
string
Validation failed.
object
error
required
string
Example
invalid request field
Field that failed validation.
string
detail
string
hint
string