Execute Workflow
Execute a workflow with the provided input data. Workflows can run in streaming or batch mode.
Execution Modes:
- Streaming (
stream=true): Real-time step-by-step execution updates via SSE - Non-Streaming (
stream=false): Complete workflow execution with final result
Workflow Execution Process:
- Input validation against workflow schema
- Sequential or parallel step execution based on workflow design
- Data flow between steps with transformation
- Error handling and automatic retries where configured
- Final result compilation and response
Session Management: Workflows support session continuity for stateful execution across multiple runs.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
The input message or prompt to send to the workflow
Enable streaming responses via Server-Sent Events (SSE)
Run workflow in background (survives client disconnect). Requires database. Use /resume to reconnect.
Session ID for conversation continuity. If not provided, a new session is created
User identifier for tracking and personalization
Workflow version to use for this run
JSON object with factory-specific parameters for dynamic workflow construction
Response
Workflow executed successfully
Unique identifier for the workflow run
Input provided to the workflow
Events generated during the workflow
Workflow ID that was executed
User ID associated with the run
Output content from the workflow
Type of content returned
Status of the workflow run
Results from each workflow step
Executor runs for each step
HITL step requirements (resolved state for historical display)
Kind of HITL pause: 'step' or 'executor'
Name of the step that caused the pause
Index of the step that caused the pause
Performance and usage metrics
Run creation timestamp
Reasoning content if reasoning was enabled
List of reasoning steps
References cited in the workflow
Citations from the model (e.g., from Gemini grounding/search)
Reasoning process messages
Images included in the workflow
Videos included in the workflow
Audio files included in the workflow
Files included in the workflow
Audio response if generated