Update Template
curl --request PUT \
--url https://agents.bigdata.com/v1/workflow/templates/{template_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"content_filter": {
"all_of": [
{
"document_ids": [
"<string>"
],
"type": "DOCUMENT_ID"
}
],
"any_of": [
{
"document_ids": [
"<string>"
],
"type": "DOCUMENT_ID"
}
],
"none_of": [
{
"document_ids": [
"<string>"
],
"type": "DOCUMENT_ID"
}
]
},
"description": "<string>",
"expected_input": {},
"expected_output": "<string>",
"name": "<string>",
"prompt": "<string>",
"ranking_parameters": {
"freshness_boost": 5,
"source_boost": 5
},
"research_plan": {
"title": "<string>",
"steps": []
},
"tools_configs": {
"factset__FactSet_Fundamentals": {
"enabled": true
},
"python_code_execution": {
"chart_generation_enabled": false,
"enabled": true
}
}
}
'import requests
url = "https://agents.bigdata.com/v1/workflow/templates/{template_id}"
payload = {
"content_filter": {
"all_of": [
{
"document_ids": ["<string>"],
"type": "DOCUMENT_ID"
}
],
"any_of": [
{
"document_ids": ["<string>"],
"type": "DOCUMENT_ID"
}
],
"none_of": [
{
"document_ids": ["<string>"],
"type": "DOCUMENT_ID"
}
]
},
"description": "<string>",
"expected_input": {},
"expected_output": "<string>",
"name": "<string>",
"prompt": "<string>",
"ranking_parameters": {
"freshness_boost": 5,
"source_boost": 5
},
"research_plan": {
"title": "<string>",
"steps": []
},
"tools_configs": {
"factset__FactSet_Fundamentals": { "enabled": True },
"python_code_execution": {
"chart_generation_enabled": False,
"enabled": True
}
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
content_filter: {
all_of: [{document_ids: ['<string>'], type: 'DOCUMENT_ID'}],
any_of: [{document_ids: ['<string>'], type: 'DOCUMENT_ID'}],
none_of: [{document_ids: ['<string>'], type: 'DOCUMENT_ID'}]
},
description: '<string>',
expected_input: {},
expected_output: '<string>',
name: '<string>',
prompt: '<string>',
ranking_parameters: {freshness_boost: 5, source_boost: 5},
research_plan: {title: '<string>', steps: []},
tools_configs: {
factset__FactSet_Fundamentals: {enabled: true},
python_code_execution: {chart_generation_enabled: false, enabled: true}
}
})
};
fetch('https://agents.bigdata.com/v1/workflow/templates/{template_id}', 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/templates/{template_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'content_filter' => [
'all_of' => [
[
'document_ids' => [
'<string>'
],
'type' => 'DOCUMENT_ID'
]
],
'any_of' => [
[
'document_ids' => [
'<string>'
],
'type' => 'DOCUMENT_ID'
]
],
'none_of' => [
[
'document_ids' => [
'<string>'
],
'type' => 'DOCUMENT_ID'
]
]
],
'description' => '<string>',
'expected_input' => [
],
'expected_output' => '<string>',
'name' => '<string>',
'prompt' => '<string>',
'ranking_parameters' => [
'freshness_boost' => 5,
'source_boost' => 5
],
'research_plan' => [
'title' => '<string>',
'steps' => [
]
],
'tools_configs' => [
'factset__FactSet_Fundamentals' => [
'enabled' => true
],
'python_code_execution' => [
'chart_generation_enabled' => false,
'enabled' => true
]
]
]),
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/templates/{template_id}"
payload := strings.NewReader("{\n \"content_filter\": {\n \"all_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"DOCUMENT_ID\"\n }\n ],\n \"any_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"DOCUMENT_ID\"\n }\n ],\n \"none_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"DOCUMENT_ID\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"expected_input\": {},\n \"expected_output\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"ranking_parameters\": {\n \"freshness_boost\": 5,\n \"source_boost\": 5\n },\n \"research_plan\": {\n \"title\": \"<string>\",\n \"steps\": []\n },\n \"tools_configs\": {\n \"factset__FactSet_Fundamentals\": {\n \"enabled\": true\n },\n \"python_code_execution\": {\n \"chart_generation_enabled\": false,\n \"enabled\": true\n }\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://agents.bigdata.com/v1/workflow/templates/{template_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"content_filter\": {\n \"all_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"DOCUMENT_ID\"\n }\n ],\n \"any_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"DOCUMENT_ID\"\n }\n ],\n \"none_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"DOCUMENT_ID\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"expected_input\": {},\n \"expected_output\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"ranking_parameters\": {\n \"freshness_boost\": 5,\n \"source_boost\": 5\n },\n \"research_plan\": {\n \"title\": \"<string>\",\n \"steps\": []\n },\n \"tools_configs\": {\n \"factset__FactSet_Fundamentals\": {\n \"enabled\": true\n },\n \"python_code_execution\": {\n \"chart_generation_enabled\": false,\n \"enabled\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://agents.bigdata.com/v1/workflow/templates/{template_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"content_filter\": {\n \"all_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"DOCUMENT_ID\"\n }\n ],\n \"any_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"DOCUMENT_ID\"\n }\n ],\n \"none_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"DOCUMENT_ID\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"expected_input\": {},\n \"expected_output\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"ranking_parameters\": {\n \"freshness_boost\": 5,\n \"source_boost\": 5\n },\n \"research_plan\": {\n \"title\": \"<string>\",\n \"steps\": []\n },\n \"tools_configs\": {\n \"factset__FactSet_Fundamentals\": {\n \"enabled\": true\n },\n \"python_code_execution\": {\n \"chart_generation_enabled\": false,\n \"enabled\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"is_community": true,
"name": "<string>",
"prompt": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"content_filter": {
"all_of": [
{
"document_ids": [
"<string>"
],
"type": "DOCUMENT_ID"
}
],
"any_of": [
{
"document_ids": [
"<string>"
],
"type": "DOCUMENT_ID"
}
],
"none_of": [
{
"document_ids": [
"<string>"
],
"type": "DOCUMENT_ID"
}
]
},
"description": "<string>",
"expected_input": {},
"expected_output": "<string>",
"ranking_parameters": {
"freshness_boost": 5,
"source_boost": 5
},
"research_plan": {
"title": "<string>",
"steps": []
},
"tools_configs": {
"factset__FactSet_Fundamentals": {
"enabled": true
},
"python_code_execution": {
"chart_generation_enabled": false,
"enabled": true
}
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Workflows
Update Template
Update an existing workflow template. Only provided fields are modified.
PUT
/
v1
/
workflow
/
templates
/
{template_id}
Update Template
curl --request PUT \
--url https://agents.bigdata.com/v1/workflow/templates/{template_id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"content_filter": {
"all_of": [
{
"document_ids": [
"<string>"
],
"type": "DOCUMENT_ID"
}
],
"any_of": [
{
"document_ids": [
"<string>"
],
"type": "DOCUMENT_ID"
}
],
"none_of": [
{
"document_ids": [
"<string>"
],
"type": "DOCUMENT_ID"
}
]
},
"description": "<string>",
"expected_input": {},
"expected_output": "<string>",
"name": "<string>",
"prompt": "<string>",
"ranking_parameters": {
"freshness_boost": 5,
"source_boost": 5
},
"research_plan": {
"title": "<string>",
"steps": []
},
"tools_configs": {
"factset__FactSet_Fundamentals": {
"enabled": true
},
"python_code_execution": {
"chart_generation_enabled": false,
"enabled": true
}
}
}
'import requests
url = "https://agents.bigdata.com/v1/workflow/templates/{template_id}"
payload = {
"content_filter": {
"all_of": [
{
"document_ids": ["<string>"],
"type": "DOCUMENT_ID"
}
],
"any_of": [
{
"document_ids": ["<string>"],
"type": "DOCUMENT_ID"
}
],
"none_of": [
{
"document_ids": ["<string>"],
"type": "DOCUMENT_ID"
}
]
},
"description": "<string>",
"expected_input": {},
"expected_output": "<string>",
"name": "<string>",
"prompt": "<string>",
"ranking_parameters": {
"freshness_boost": 5,
"source_boost": 5
},
"research_plan": {
"title": "<string>",
"steps": []
},
"tools_configs": {
"factset__FactSet_Fundamentals": { "enabled": True },
"python_code_execution": {
"chart_generation_enabled": False,
"enabled": True
}
}
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
content_filter: {
all_of: [{document_ids: ['<string>'], type: 'DOCUMENT_ID'}],
any_of: [{document_ids: ['<string>'], type: 'DOCUMENT_ID'}],
none_of: [{document_ids: ['<string>'], type: 'DOCUMENT_ID'}]
},
description: '<string>',
expected_input: {},
expected_output: '<string>',
name: '<string>',
prompt: '<string>',
ranking_parameters: {freshness_boost: 5, source_boost: 5},
research_plan: {title: '<string>', steps: []},
tools_configs: {
factset__FactSet_Fundamentals: {enabled: true},
python_code_execution: {chart_generation_enabled: false, enabled: true}
}
})
};
fetch('https://agents.bigdata.com/v1/workflow/templates/{template_id}', 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/templates/{template_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'content_filter' => [
'all_of' => [
[
'document_ids' => [
'<string>'
],
'type' => 'DOCUMENT_ID'
]
],
'any_of' => [
[
'document_ids' => [
'<string>'
],
'type' => 'DOCUMENT_ID'
]
],
'none_of' => [
[
'document_ids' => [
'<string>'
],
'type' => 'DOCUMENT_ID'
]
]
],
'description' => '<string>',
'expected_input' => [
],
'expected_output' => '<string>',
'name' => '<string>',
'prompt' => '<string>',
'ranking_parameters' => [
'freshness_boost' => 5,
'source_boost' => 5
],
'research_plan' => [
'title' => '<string>',
'steps' => [
]
],
'tools_configs' => [
'factset__FactSet_Fundamentals' => [
'enabled' => true
],
'python_code_execution' => [
'chart_generation_enabled' => false,
'enabled' => true
]
]
]),
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/templates/{template_id}"
payload := strings.NewReader("{\n \"content_filter\": {\n \"all_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"DOCUMENT_ID\"\n }\n ],\n \"any_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"DOCUMENT_ID\"\n }\n ],\n \"none_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"DOCUMENT_ID\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"expected_input\": {},\n \"expected_output\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"ranking_parameters\": {\n \"freshness_boost\": 5,\n \"source_boost\": 5\n },\n \"research_plan\": {\n \"title\": \"<string>\",\n \"steps\": []\n },\n \"tools_configs\": {\n \"factset__FactSet_Fundamentals\": {\n \"enabled\": true\n },\n \"python_code_execution\": {\n \"chart_generation_enabled\": false,\n \"enabled\": true\n }\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://agents.bigdata.com/v1/workflow/templates/{template_id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"content_filter\": {\n \"all_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"DOCUMENT_ID\"\n }\n ],\n \"any_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"DOCUMENT_ID\"\n }\n ],\n \"none_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"DOCUMENT_ID\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"expected_input\": {},\n \"expected_output\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"ranking_parameters\": {\n \"freshness_boost\": 5,\n \"source_boost\": 5\n },\n \"research_plan\": {\n \"title\": \"<string>\",\n \"steps\": []\n },\n \"tools_configs\": {\n \"factset__FactSet_Fundamentals\": {\n \"enabled\": true\n },\n \"python_code_execution\": {\n \"chart_generation_enabled\": false,\n \"enabled\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://agents.bigdata.com/v1/workflow/templates/{template_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"content_filter\": {\n \"all_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"DOCUMENT_ID\"\n }\n ],\n \"any_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"DOCUMENT_ID\"\n }\n ],\n \"none_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"DOCUMENT_ID\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"expected_input\": {},\n \"expected_output\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"ranking_parameters\": {\n \"freshness_boost\": 5,\n \"source_boost\": 5\n },\n \"research_plan\": {\n \"title\": \"<string>\",\n \"steps\": []\n },\n \"tools_configs\": {\n \"factset__FactSet_Fundamentals\": {\n \"enabled\": true\n },\n \"python_code_execution\": {\n \"chart_generation_enabled\": false,\n \"enabled\": true\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"created_at": "2023-11-07T05:31:56Z",
"id": "<string>",
"is_community": true,
"name": "<string>",
"prompt": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"content_filter": {
"all_of": [
{
"document_ids": [
"<string>"
],
"type": "DOCUMENT_ID"
}
],
"any_of": [
{
"document_ids": [
"<string>"
],
"type": "DOCUMENT_ID"
}
],
"none_of": [
{
"document_ids": [
"<string>"
],
"type": "DOCUMENT_ID"
}
]
},
"description": "<string>",
"expected_input": {},
"expected_output": "<string>",
"ranking_parameters": {
"freshness_boost": 5,
"source_boost": 5
},
"research_plan": {
"title": "<string>",
"steps": []
},
"tools_configs": {
"factset__FactSet_Fundamentals": {
"enabled": true
},
"python_code_execution": {
"chart_generation_enabled": false,
"enabled": true
}
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Authorizations
API key for authentication.
Path Parameters
Body
application/json
Fields to update on an existing workflow template. All fields are optional.
Composable content filter using logical operators.
Show child attributes
Show child attributes
Inputs the template expects. Each key is an abstract snake_case NAME, not a value. Reference a key as {{ key }} in the prompt to substitute its value inline; an unreferenced key is still provided to the model as attached context.
Show child attributes
Show child attributes
Minimum string length:
1Parameters that influence how search results are ranked.
Show child attributes
Show child attributes
A structured research plan with ordered steps.
Show child attributes
Show child attributes
Per-tool configuration stored with the template, keyed by tool id. Two key families are supported: python_code_execution (toggles sandboxed Python and chart rendering for every run) and connector tool ids in the <connector>__<tool> form (e.g. "factset__FactSet_Fundamentals": {"enabled": true}). Search settings belong in content_filter, ranking_parameters, or the execution request — not here. See GET /v1/tools for each connector tool's config schema.
Example:
{
"factset__FactSet_Fundamentals": { "enabled": true },
"python_code_execution": {
"chart_generation_enabled": false,
"enabled": true
}
}
Response
Successful Response
A complete workflow template with all metadata.
When the template was created.
Unique template identifier.
Whether this is a community-shared template.
Template display name.
The research prompt with optional placeholders.
When the template was last modified.
Content filters applied to all searches.
Show child attributes
Show child attributes
Brief description of what this template does.
Inputs keyed by abstract snake_case NAME. Reference a key as {{ key }} in the prompt to substitute its value inline; an unreferenced key is still provided to the model as attached context.
Show child attributes
Show child attributes
Optional guidance for the final answer's tone, structure, and format.
Minimum string length:
1Search result ranking configuration.
Show child attributes
Show child attributes
Pre-defined research plan.
Show child attributes
Show child attributes
Per-tool configuration stored with the template, keyed by tool id. Two key families are supported: python_code_execution (toggles sandboxed Python and chart rendering for every run) and connector tool ids in the <connector>__<tool> form (e.g. "factset__FactSet_Fundamentals": {"enabled": true}). Search settings belong in content_filter, ranking_parameters, or the execution request — not here. See GET /v1/tools for each connector tool's config schema.
Example:
{
"factset__FactSet_Fundamentals": { "enabled": true },
"python_code_execution": {
"chart_generation_enabled": false,
"enabled": true
}
}
Was this page helpful?