Cancel a queued or running batch

View as Markdown

Cancel all queued or running runs in a prior group-run batch. Finished runs are left unchanged, making the endpoint idempotent when the batch has already completed.

Authentication

AuthorizationBearer
API key authentication using Bearer token format

Path parameters

batchIdstringRequiredformat: "uuid"
Batch ID

Response

Batch cancellation summary
batchIdstringformat: "uuid"
cancelledinteger>=0
alreadyFinishedinteger>=0
cancelledRunIdslist of strings
alreadyFinishedRunIdslist of strings

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
504
Gateway Timeout Error