Run Discoverable Workflow

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

Data to create a new run

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

ID of the workflow version. Also you can use "latest", "draft" or "version number" to use a specific version

Available options:

draft,

latest

Response

200 - application/json

app_id

string

required

ID of the associated app where the run was triggered from

created_at

string | null

required

Timestamp of when the run was created

ended_at

string | null

required

Timestamp of when the run ended

string

required

Unique identifier for the run

input

object | null

required

Input values used for the run

origin

enum<string>

required

Origin of the run

Available options:

WORKFLOW,

RECORD,

TEST,

ENDPOINT

output

object | null

required

Output of the run

started_at

string | null

required

Timestamp of when the run started

status

enum<string>

required

Status of the run

Available options:

PENDING,

RUNNING,

CANCELLED,

COMPLETED,

SKIPPED,

FAILED

updated_at

string | null

required

Timestamp of when the run was last updated

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

object | null

required

Details of the workflow version used for the run

workflow_version.app_id

string

required

App id where the workflow version belongs to

workflow_version.created_at

string | null

required

Date when the version was deployed

workflow_version.description

string | null

required

Description of the workflow at the time this version was deployed

workflow_version.id

string

required

Unique identifier for the workflow version

workflow_version.input

object

required

Input definition of the workflow

workflow_version.input.{key}

object

The file type allows users to upload files

workflow_version.input_default

object | null

required

Default config input values of the workflow

workflow_version.input_options

object | null

required

Input options of the workflow

workflow_version.key

string

required

Unique key for the workflow version

workflow_version.notes

string | null

required

Release notes

workflow_version.steps

object[]

required

Steps of the workflow at the time this version was deployed

workflow_version.version

number

required

Version number

workflow_version.workflow_id

string

required

Workflow id where the version belongs to

workflow_version.created_by

object

User who deployed the version

workflow_version.rollback_version

number

Version number from which this version was rolled back

workflow_version_draft

object | null

required

Draft version of the workflow

workflow_version_draft.input

object

required

Input definition of the workflow

workflow_version_draft.input.{key}

object

The file type allows users to upload files

workflow_version_draft.input_default

object | null

required

Default config input values of the workflow

workflow_version_draft.input_options

object | null

required

Input options of the workflow

workflow_version_draft.key

string

required

Unique key for the workflow version

workflow_version_draft.steps

object[]

required

Steps of the workflow at the time this version was deployed

collection_id

string

ID of the associated collection

error

string

Error message if the run failed

record_id

string

ID of the associated record

result

any | null

Result of the run

usage

object

Credits usage of the run

version

number

Version number of the workflow

API Reference

Collections

Records

Workflows

Tests

Variables

Files

Webhooks

Run Discoverable Workflow

Path Parameters

Query Parameters

Body

Response