Sume Format run routes that do not exist, and the call to use instead

There is no GET /v1/format-runs, no per-Format GET for one run, and no /messages route. Use the per-Format runs list and GET /v1/format-runs/{run_id}.

4 min readSume
All posts

Three routes people guess for Format runs do not exist: GET /v1/format-runs, GET /v1/formats/{handle}/{slug}/runs/{run_id} and GET /v1/format-runs/{id}/messages. A guess at any of them will not work, so build from the routes below.

The reason is that the run id alone identifies a run; the Format is reached through the receipt.

Guessed route and replacement

Taken from the Runs and results page (read 2026-10-03).

Guessed Format run routes and the documented replacement (read 2026-10-03)
GuessUse instead
GET /v1/format-runsGET /v1/formats/{handle}/{slug}/runs, once per Format
GET /v1/formats/{handle}/{slug}/runs/{run_id}GET /v1/format-runs/{run_id}
GET /v1/format-runs/{id}/messagesGET /v1/format-runs/{run_id}/events for the phase timeline
Result inside the receipt of a running runGET /v1/format-runs/{run_id}/result once status is completed

Walking a workspace

If you need every run in a workspace, loop over the Formats you own and page each runs list. The list needs formats:read and returns receipts, so the walk does not need a second call per run.

The events route is a phase timeline with preparing, running and finalizing; it is not a chat transcript.

RUN=run_example
curl -s https://api.sume.com/v1/format-runs/$RUN \
  -H "Authorization: Bearer $SUME_API_KEY" | jq '.data | {status, next_action}'
curl -s https://api.sume.com/v1/format-runs/$RUN/events \
  -H "Authorization: Bearer $SUME_API_KEY"

Why this matters for clients

A generated client that adds the guessed routes will produce 404s that look like missing data. Check the route against the API reference before wiring a dashboard. For the envelope URLs you should follow rather than build, see the job response URLs.

Sources

Related posts

More in Formats

All Formats posts

Written by Sume