Cancel a batch’s queued pictures
cancel_batchDestructiveIdempotent
Cancel every picture of a batch that has not started yet; they are never charged and cannot be run again from this batch. Runs already started finish and are charged as usual (cancel_job stops one). Safe to repeat.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| batch_id | Yes | The batch id start_batch returned. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| items | Yes | ||
| model | Yes | ||
| scene | Yes | ||
| counts | Yes | ||
| status | Yes | ||
| batch_id | Yes | ||
| cancelled | Yes | Pictures cancelled by this call. | |
| created_at | Yes | ||
| item_count | Yes | ||
| settled_at | Yes | ||
| quoted_credits | Yes | What the batch costs if every picture runs. | |
| charged_credits | Yes | What its runs were charged so far. | |
| per_item_credits | Yes |