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",
"persistence_mode": "disabled"
}
'import requests
url = "https://agents.bigdata.com/v1/workflow/execute"
payload = {
"template": "<string>",
"execution_id": "<string>",
"input": {},
"model_name": "base",
"persistence_mode": "disabled"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
template: '<string>',
execution_id: '<string>',
input: {},
model_name: 'base',
persistence_mode: 'disabled'
})
};
fetch('https://agents.bigdata.com/v1/workflow/execute', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://agents.bigdata.com/v1/workflow/execute",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'template' => '<string>',
'execution_id' => '<string>',
'input' => [
],
'model_name' => 'base',
'persistence_mode' => 'disabled'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://agents.bigdata.com/v1/workflow/execute"
payload := strings.NewReader("{\n \"template\": \"<string>\",\n \"execution_id\": \"<string>\",\n \"input\": {},\n \"model_name\": \"base\",\n \"persistence_mode\": \"disabled\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://agents.bigdata.com/v1/workflow/execute")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"template\": \"<string>\",\n \"execution_id\": \"<string>\",\n \"input\": {},\n \"model_name\": \"base\",\n \"persistence_mode\": \"disabled\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://agents.bigdata.com/v1/workflow/execute")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"template\": \"<string>\",\n \"execution_id\": \"<string>\",\n \"input\": {},\n \"model_name\": \"base\",\n \"persistence_mode\": \"disabled\"\n}"
response = http.request(request)
puts response.read_body{
"delta": {
"content": "<string>",
"message_id": "<string>",
"role": "assistant",
"type": "THINKING"
},
"execution_id": "<string>",
"request_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Execute Workflow
Execute a workflow with an inline template definition or a stored template ID. Returns a streaming response via Server-Sent Events.
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",
"persistence_mode": "disabled"
}
'import requests
url = "https://agents.bigdata.com/v1/workflow/execute"
payload = {
"template": "<string>",
"execution_id": "<string>",
"input": {},
"model_name": "base",
"persistence_mode": "disabled"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
template: '<string>',
execution_id: '<string>',
input: {},
model_name: 'base',
persistence_mode: 'disabled'
})
};
fetch('https://agents.bigdata.com/v1/workflow/execute', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://agents.bigdata.com/v1/workflow/execute",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'template' => '<string>',
'execution_id' => '<string>',
'input' => [
],
'model_name' => 'base',
'persistence_mode' => 'disabled'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://agents.bigdata.com/v1/workflow/execute"
payload := strings.NewReader("{\n \"template\": \"<string>\",\n \"execution_id\": \"<string>\",\n \"input\": {},\n \"model_name\": \"base\",\n \"persistence_mode\": \"disabled\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://agents.bigdata.com/v1/workflow/execute")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"template\": \"<string>\",\n \"execution_id\": \"<string>\",\n \"input\": {},\n \"model_name\": \"base\",\n \"persistence_mode\": \"disabled\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://agents.bigdata.com/v1/workflow/execute")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"template\": \"<string>\",\n \"execution_id\": \"<string>\",\n \"input\": {},\n \"model_name\": \"base\",\n \"persistence_mode\": \"disabled\"\n}"
response = http.request(request)
puts response.read_body{
"delta": {
"content": "<string>",
"message_id": "<string>",
"role": "assistant",
"type": "THINKING"
},
"execution_id": "<string>",
"request_id": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Authorizations
API key for authentication.
Body
Request to execute a workflow and stream the result on the same connection.
Template ID (string) or inline template definition (object).
Provide a previous execution ID to resume a workflow conversation.
Input values for template placeholders.
Show child attributes
Show child attributes
Selects the model capability tier. Use "base" for the default routing strategy, or "pro" to allow the most capable available model when higher reasoning or accuracy is required. Model selection is dynamic and may vary based on task type, availability, and failover.
base, pro Set to "enabled" to store the run so you can list and retrieve it after the connection closes. Fixed for the life of a conversation: a resume request must pass the same value.
enabled, disabled Predefined rolling time windows for filtering data.
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.
The agent's intermediate reasoning while researching.
- ThinkingMessage
- ActionMessage
- AnswerMessage
- CompleteMessage
- ErrorMessage
- AuditMessage
- GroundingMessage
- ChartMessage
- ToolErrorMessage
- PlanningMessage
- LlmRetryMessage
- StructuredOutputMessage
- StreamRollbackMessage
Show child attributes
Show child attributes
Workflow conversation identifier. Use this to resume the conversation.
Unique identifier for this request.
Was this page helpful?