Skip to main content
POST
Execute Flow

Authorizations

x-api-key
string
header
required

Body

application/json

Request model for creating a flow execution.

flow_id
string
required

ID of the flow to execute

trigger_type
enum<string>
required

How the execution was triggered

Available options:
manual,
event,
scheduled,
api,
webhook,
test
trigger_data
Trigger Data · object

Data from the trigger event

variables
Variables · object

Additional variables for execution

priority
enum<string>
default:normal

Execution priority

Available options:
low,
normal,
high,
urgent
scheduled_at
string<date-time> | null

When to execute (for scheduled executions)

timeout_seconds
integer | null
default:300

Execution timeout in seconds

retry_config
Retry Config · object | null

Retry configuration

metadata
Metadata · object

Additional execution metadata

Response

Successful Response

Response model for flow execution operations.

execution
FlowExecution · object
required

Execution details

message
string
required

Response message