Bulk queue item error: format_run_canceled vs format_run_failed

In a Sume bulk queue, a failed child reads format_run_failed and a canceled child reads format_run_canceled. The real reason is in the child run receipt.

3 min readSume
All posts

When a child run settles, its queue item carries a fixed error. A failed child shows format_run_failed with the message "The Format run failed." A canceled child shows format_run_canceled with "The Format run was canceled." A completed child has error: null. These are labels, not diagnoses. To find why something failed, read the child receipt.

The mapping

The queue is a server-side list of ordinary Format runs, up to 100 items with concurrency 1 to 16. Each item has an index, a status, a run_id and an error.

Item error by child outcome, read 2026-10-07
Child runItem statusItem error code
completedcompletednull
failedfailedformat_run_failed
canceledcanceledformat_run_canceled
could not startfailed, run_id nullCreate-run failure code

Where the reason is

For any item with a run_id, poll GET /v1/format-runs/{run_id} for the full receipt. A skipped child is recorded in the queue as failed. An item that never started has run_id: null and its own error from the create attempt, for example format_run_failed_to_start, and the rest of the queue continues.

Queue status is not success

A queue is completed when every item is terminal, not when every item worked. Branch on counts.failed and counts.canceled.

There is no list-queues or cancel-queue endpoint. To stop one child, cancel it with POST /v1/format-runs/{run_id}/cancel; the freed slot then starts the next item.

Sources

Related posts

More in Formats

All Formats posts

Written by Sume