Documentation is being updated. Some sections may not reflect the latest features.
Looking for step-by-step guides? Explore Tutorials →

Execute Workflow

Run a workflow programmatically via the API.

Endpoint

POST /api/v1/execute

Request

Headers

Header Value
Authorization Bearer YOUR_API_KEY
Content-Type application/json

Body

{
  "workflow_id": "wf_abc123",
  "inputs": {
    "prompt": "Analyze this text...",
    "user_id": "user_456"
  },
  "async": false
}
Field Type Description
workflow_id string Required. The workflow to execute
inputs object Input variables for the workflow
async boolean If true, returns immediately with execution_id

Response

Synchronous (async: false)

{
  "success": true,
  "execution_id": "exec_789",
  "status": "completed",
  "output": {
    "result": "Analysis complete..."
  },
  "duration_ms": 1250
}

Asynchronous (async: true)

{
  "success": true,
  "execution_id": "exec_789",
  "status": "running"
}

Poll /api/v1/executions/{execution_id} to check status.

AI AssistantPowered by Ubex
Beta
Ask me anything about Ubex workflows, nodes, or the API.