Sign in
Workflow

Execute Workflow

Execute a workflow with support for sync, stream, and background modes

post/api/v2/workflows

Request body

backgroundboolean
streamboolean
flow_idstring required
inputsobject nullable

Component-specific inputs in flat format: 'component_id.param_name': value

Example request

{
  "background": false,
  "flow_id": "flow_67ccd2be17f0819081ff3bb2cf6508e60bb6a6b452d3795b",
  "inputs": {
    "ChatInput-abc.input_value": "Hello, how can you help me today?",
    "ChatInput-abc.session_id": "session-123",
    "LLM-xyz.max_tokens": 100,
    "LLM-xyz.temperature": 0.7,
    "OpenSearch-def.opensearch_url": "https://opensearch:9200"
  },
  "stream": false
}

Response

Workflow execution response

OR

Changes