For the complete documentation index, see llms.txt. This page is also available as Markdown.

Runs

List runs (framework + conversation)

get

Paginated, newest-first list of runs for the workspace behind the unified Run contract. Federates framework runs (Delta world.runs MV) and conversation runs (Lakebase world.conversations) at read time. Filter by kind (conversation / framework), channel (voice/text/sms/email/web — conversation runs only), and status (live expands to running + paused). continuation_token is an opaque page cursor.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
sort_bystring[]OptionalDefault: []
limitinteger · max: 200OptionalDefault: 50
continuation_tokenanyOptional
statusstring · enum · nullableOptionalPossible values:
kindstring · enum · nullableOptionalPossible values:
channelstring · enum · nullableOptionalPossible values:
Responses
200

Successful Response

application/json
has_morebooleanRequired
continuation_tokenanyOptional
get/v1/{workspace_id}/runs

Run counts (framework + conversation)

get

Aggregate counts for the workspace's runs behind the unified Run contract: total, live (running + paused), each canonical status, a full by_status map, and by_kind (conversation vs framework). Federates the Delta world.runs MV and Lakebase world.conversations with a cheap GROUP BY. Optional kind / channel filters mirror the list; a channel filter restricts to conversation runs.

Authorizations
AuthorizationstringRequired

API key issued via POST /v1/{workspace_id}/api-keys. Pass the returned api_key value as a Bearer token.

Path parameters
workspace_idstring · uuidRequired
Query parameters
kindstring · enum · nullableOptionalPossible values:
channelstring · enum · nullableOptionalPossible values:
Responses
200

Successful Response

application/json

Aggregate run counts for the Runs page summary strip.

Honest workspace totals the paginated list cannot derive client-side (it only holds the loaded page). by_status carries the full canonical breakdown (incl. any status beyond the named convenience fields); by_kind splits framework vs conversation. live = running + paused.

totalintegerRequired
liveintegerRequired
runningintegerRequired
pausedintegerRequired
completedintegerRequired
failedintegerRequired
timed_outintegerRequired
get/v1/{workspace_id}/runs/summary

Last updated

Was this helpful?