POST
/
apps
/
{app_id}
/
workflows
/
{workflow_id}
/
runs

Path Parameters

app_id
string
required

The ID of the app

workflow_id
string
required

The ID of the workflow

Query Parameters

verbose
enum<string>[]
Available options:
all

Body

input
object | null

Input values for the run

stream
boolean

Indicates if the run should stream output to the client as it becomes available

workflow_version_id
string

ID of the workflow version to run

Response

200 - application/json
id
string
required

Unique identifier for the run

result
any | null

Result of the run

input
object | null
required

Input values used for the run

output
object | null
required

Output of the run

status
enum<string>
required

Status of the run

Available options:
PENDING,
RUNNING,
CANCELLED,
COMPLETED,
SKIPPED,
FAILED
origin
enum<string>
required

Origin of the run

Available options:
WORKFLOW,
RECORD,
TEST
error
string

Error message if the run failed

started_at
string | null
required

Timestamp of when the run started

ended_at
string | null
required

Timestamp of when the run ended

app_id
string
required

ID of the associated app where the run was triggered from

workflow_app_id
string
required

ID of the associated app where the workflow belongs to

workflow_id
string
required

ID of the associated workflow

workflow_version_draft
object | null
required

Draft version of the workflow

workflow_version
object | null
required

Details of the workflow version used for the run

usage
object

Credits usage of the run

created_at
string | null
required

Timestamp of when the run was created

updated_at
string | null
required

Timestamp of when the run was last updated

Was this page helpful?

Run a Workflow TestRun Workflow Tests