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