Skip to main content
GET
List workflow runs

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

promptId
string<uuid>
required

Canvas id.

promptVersionId
string<uuid>
status
enum<string>

Filter by run status. Only these five values are accepted here even though runs can also be in requires-action, timeout or waiting-for-review.

Available options:
pending,
running,
completed,
failed,
cancelled
environment
enum<string>

Filter by the surface that started the run.

Available options:
test-case,
craft-preview,
api,
workstation
recentTerminalSeconds
number

Only used with status=running. Also returns runs that reached a terminal state within the last N seconds.

rootOnly
boolean

When true, only top-level runs (no parentId) are returned.

limit
number
offset
number
orderBy
enum<string>

Accepted for forward compatibility but currently ignored; ordering is always by createdAt.

Available options:
createdAt,
updatedAt,
completedAt
orderDirection
enum<string>

Defaults to desc.

Available options:
asc,
desc

Response

Workflow runs.

id
string
required

External execution id when the run was started through the public API, otherwise the internal run id.

promptVersionId
string<uuid>
required
status
enum<string>
required

Lifecycle status of a workflow run. Terminal statuses are completed, cancelled, failed and timeout. requires-action and waiting-for-review are active states where the run is paused for external input.

Available options:
pending,
running,
completed,
failed,
requires-action,
cancelled,
timeout,
waiting-for-review
startedAt
string<date-time>
required
completedAt
string<date-time> | null
required
input
object
required

Runtime variables the run was started with, keyed by variable name.

steps
object[]
required

Visible steps in topological order. Steps on unselected condition branches or outside a partial run's start/end range are reported as skipped.

environment
enum<string>

Surface that started the run.

Available options:
test-case,
craft-preview,
api,
workstation
output
object | null

The completed leaf step whose output is the run's result. null while no leaf step has completed.