Skip to main content
POST
/
v1
/
workflow
/
execute
Execute Workflow
curl --request POST \
  --url https://agents.bigdata.com/v1/workflow/execute \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "template": "<string>",
  "execution_id": "<string>",
  "input": {},
  "model_name": "base",
  "time_range": "last_24_hours"
}
'
{
  "delta": {
    "content": "<string>",
    "message_id": "<string>",
    "role": "assistant",
    "type": "THINKING"
  },
  "execution_id": "<string>",
  "request_id": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication.

Body

application/json

Request to execute a workflow.

​
template
required

Template ID (string) or inline template definition (object).

​
execution_id
string | null

Provide a previous execution ID to resume a workflow conversation.

​
input
Input · object

Input values for template placeholders.

​
model_name
enum<string>
default:base

Model to use for this workflow execution.

Available options:
base,
pro
​
time_range

Predefined rolling time windows for filtering data.

Available options:
last_24_hours,
last_7_days,
last_30_days,
last_60_days,
last_90_days,
last_180_days,
last_365_days

Response

Streaming SSE response with workflow results.

A single streaming event from a workflow execution.

​
delta
ThinkingMessage · object
required

The agent's intermediate reasoning while researching.

​
execution_id
string
required

Workflow conversation identifier. Use this to resume the conversation.

​
request_id
string
required

Unique identifier for this request.