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>",
  "time_range": "last_24_hours",
  "input": {},
  "model_name": "base"
}
'
{
  "delta": {
    "content": "I need to search for",
    "message_id": "thinking_123",
    "role": "assistant",
    "type": "THINKING"
  },
  "request_id": "req_12345"
}

Authorizations

​
X-API-Key
string
header
required

Enter your API key

Body

application/json

Request model for workflow execution.

The template can be either:

  • str: ID of an existing stored template (by reference)
  • CreateUserWorkflowTemplate: Full inline template definition (by value)
​
template
required

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

​
time_range

Rolling time ranges for data analysis periods.

Available options:
last_24_hours,
last_7_days,
last_30_days,
last_60_days,
last_90_days,
last_180_days,
last_365_days
​
input
Input · object

Input values for template placeholders. Keys must match template's expected_input keys.

​
model_name
enum<string>
default:base

The model to use for the workflow execution.

Available options:
base,
pro

Response

Successful Response

Streaming response delta (streaming mode).

Contains a single event/message delta sent via Server-Sent Events.

​
request_id
string
required

Unique identifier for this request

​
delta
WFThinkingMessage · object
required

The message delta for this event