Skip to main content
POST
Execute Workflow

Authorizations

Authorization
string
header
required

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

Path Parameters

workflow_id
string
required

Body

application/x-www-form-urlencoded
message
string
required

The input message or prompt to send to the workflow

stream
boolean
default:true

Enable streaming responses via Server-Sent Events (SSE)

background
boolean
default:false

Run workflow in background (survives client disconnect). Requires database. Use /resume to reconnect.

session_id
string | null

Session ID for conversation continuity. If not provided, a new session is created

user_id
string | null

User identifier for tracking and personalization

version
integer | null

Workflow version to use for this run

factory_input
string | null

JSON object with factory-specific parameters for dynamic workflow construction

Response

Workflow executed successfully

run_id
string
required

Unique identifier for the workflow run

run_input
string | null

Input provided to the workflow

events
Events · object[] | null

Events generated during the workflow

workflow_id
string | null

Workflow ID that was executed

user_id
string | null

User ID associated with the run

content

Output content from the workflow

content_type
string | null

Type of content returned

status
string | null

Status of the workflow run

step_results
Step Results · object[] | null

Results from each workflow step

step_executor_runs
Step Executor Runs · object[] | null

Executor runs for each step

step_requirements
Step Requirements · object[] | null

HITL step requirements (resolved state for historical display)

pause_kind
string | null

Kind of HITL pause: 'step' or 'executor'

paused_step_name
string | null

Name of the step that caused the pause

paused_step_index
integer | null

Index of the step that caused the pause

metrics
Metrics · object | null

Performance and usage metrics

created_at
string<date-time> | null

Run creation timestamp

reasoning_content
string | null

Reasoning content if reasoning was enabled

reasoning_steps
Reasoning Steps · object[] | null

List of reasoning steps

references
References · object[] | null

References cited in the workflow

citations
Citations · object | null

Citations from the model (e.g., from Gemini grounding/search)

reasoning_messages
Reasoning Messages · object[] | null

Reasoning process messages

images
Images · object[] | null

Images included in the workflow

videos
Videos · object[] | null

Videos included in the workflow

audio
Audio · object[] | null

Audio files included in the workflow

files
Files · object[] | null

Files included in the workflow

response_audio
Response Audio · object | null

Audio response if generated