curl --request POST \
--url https://agents.bigdata.com/v1/workflow/templates \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"prompt": "<string>",
"content_filter": {
"all_of": [
{
"document_ids": [
"<string>"
],
"type": "<string>"
}
],
"any_of": [
{
"document_ids": [
"<string>"
],
"type": "<string>"
}
],
"none_of": [
{
"document_ids": [
"<string>"
],
"type": "<string>"
}
]
},
"description": "<string>",
"expected_input": {},
"ranking_parameters": {
"freshness_boost": 5,
"source_boost": 5
},
"research_plan": {
"title": "<string>",
"steps": [
{
"description": "<string>",
"status": "NOT_STARTED"
}
]
},
"expected_output": "<string>"
}
'import requests
url = "https://agents.bigdata.com/v1/workflow/templates"
payload = {
"name": "<string>",
"prompt": "<string>",
"content_filter": {
"all_of": [
{
"document_ids": ["<string>"],
"type": "<string>"
}
],
"any_of": [
{
"document_ids": ["<string>"],
"type": "<string>"
}
],
"none_of": [
{
"document_ids": ["<string>"],
"type": "<string>"
}
]
},
"description": "<string>",
"expected_input": {},
"ranking_parameters": {
"freshness_boost": 5,
"source_boost": 5
},
"research_plan": {
"title": "<string>",
"steps": [
{
"description": "<string>",
"status": "NOT_STARTED"
}
]
},
"expected_output": "<string>"
}
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({
name: '<string>',
prompt: '<string>',
content_filter: {
all_of: [{document_ids: ['<string>'], type: '<string>'}],
any_of: [{document_ids: ['<string>'], type: '<string>'}],
none_of: [{document_ids: ['<string>'], type: '<string>'}]
},
description: '<string>',
expected_input: {},
ranking_parameters: {freshness_boost: 5, source_boost: 5},
research_plan: {title: '<string>', steps: [{description: '<string>', status: 'NOT_STARTED'}]},
expected_output: '<string>'
})
};
fetch('https://agents.bigdata.com/v1/workflow/templates', 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",
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([
'name' => '<string>',
'prompt' => '<string>',
'content_filter' => [
'all_of' => [
[
'document_ids' => [
'<string>'
],
'type' => '<string>'
]
],
'any_of' => [
[
'document_ids' => [
'<string>'
],
'type' => '<string>'
]
],
'none_of' => [
[
'document_ids' => [
'<string>'
],
'type' => '<string>'
]
]
],
'description' => '<string>',
'expected_input' => [
],
'ranking_parameters' => [
'freshness_boost' => 5,
'source_boost' => 5
],
'research_plan' => [
'title' => '<string>',
'steps' => [
[
'description' => '<string>',
'status' => 'NOT_STARTED'
]
]
],
'expected_output' => '<string>'
]),
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"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"content_filter\": {\n \"all_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ],\n \"any_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ],\n \"none_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"expected_input\": {},\n \"ranking_parameters\": {\n \"freshness_boost\": 5,\n \"source_boost\": 5\n },\n \"research_plan\": {\n \"title\": \"<string>\",\n \"steps\": [\n {\n \"description\": \"<string>\",\n \"status\": \"NOT_STARTED\"\n }\n ]\n },\n \"expected_output\": \"<string>\"\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/templates")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"content_filter\": {\n \"all_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ],\n \"any_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ],\n \"none_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"expected_input\": {},\n \"ranking_parameters\": {\n \"freshness_boost\": 5,\n \"source_boost\": 5\n },\n \"research_plan\": {\n \"title\": \"<string>\",\n \"steps\": [\n {\n \"description\": \"<string>\",\n \"status\": \"NOT_STARTED\"\n }\n ]\n },\n \"expected_output\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://agents.bigdata.com/v1/workflow/templates")
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 \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"content_filter\": {\n \"all_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ],\n \"any_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ],\n \"none_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"expected_input\": {},\n \"ranking_parameters\": {\n \"freshness_boost\": 5,\n \"source_boost\": 5\n },\n \"research_plan\": {\n \"title\": \"<string>\",\n \"steps\": [\n {\n \"description\": \"<string>\",\n \"status\": \"NOT_STARTED\"\n }\n ]\n },\n \"expected_output\": \"<string>\"\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": "<string>"
}
],
"any_of": [
{
"document_ids": [
"<string>"
],
"type": "<string>"
}
],
"none_of": [
{
"document_ids": [
"<string>"
],
"type": "<string>"
}
]
},
"description": "<string>",
"expected_input": {},
"ranking_parameters": {
"freshness_boost": 5,
"source_boost": 5
},
"research_plan": {
"title": "<string>",
"steps": [
{
"description": "<string>",
"status": "NOT_STARTED"
}
]
},
"expected_output": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Create Template
Create a new workflow template.
curl --request POST \
--url https://agents.bigdata.com/v1/workflow/templates \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"prompt": "<string>",
"content_filter": {
"all_of": [
{
"document_ids": [
"<string>"
],
"type": "<string>"
}
],
"any_of": [
{
"document_ids": [
"<string>"
],
"type": "<string>"
}
],
"none_of": [
{
"document_ids": [
"<string>"
],
"type": "<string>"
}
]
},
"description": "<string>",
"expected_input": {},
"ranking_parameters": {
"freshness_boost": 5,
"source_boost": 5
},
"research_plan": {
"title": "<string>",
"steps": [
{
"description": "<string>",
"status": "NOT_STARTED"
}
]
},
"expected_output": "<string>"
}
'import requests
url = "https://agents.bigdata.com/v1/workflow/templates"
payload = {
"name": "<string>",
"prompt": "<string>",
"content_filter": {
"all_of": [
{
"document_ids": ["<string>"],
"type": "<string>"
}
],
"any_of": [
{
"document_ids": ["<string>"],
"type": "<string>"
}
],
"none_of": [
{
"document_ids": ["<string>"],
"type": "<string>"
}
]
},
"description": "<string>",
"expected_input": {},
"ranking_parameters": {
"freshness_boost": 5,
"source_boost": 5
},
"research_plan": {
"title": "<string>",
"steps": [
{
"description": "<string>",
"status": "NOT_STARTED"
}
]
},
"expected_output": "<string>"
}
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({
name: '<string>',
prompt: '<string>',
content_filter: {
all_of: [{document_ids: ['<string>'], type: '<string>'}],
any_of: [{document_ids: ['<string>'], type: '<string>'}],
none_of: [{document_ids: ['<string>'], type: '<string>'}]
},
description: '<string>',
expected_input: {},
ranking_parameters: {freshness_boost: 5, source_boost: 5},
research_plan: {title: '<string>', steps: [{description: '<string>', status: 'NOT_STARTED'}]},
expected_output: '<string>'
})
};
fetch('https://agents.bigdata.com/v1/workflow/templates', 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",
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([
'name' => '<string>',
'prompt' => '<string>',
'content_filter' => [
'all_of' => [
[
'document_ids' => [
'<string>'
],
'type' => '<string>'
]
],
'any_of' => [
[
'document_ids' => [
'<string>'
],
'type' => '<string>'
]
],
'none_of' => [
[
'document_ids' => [
'<string>'
],
'type' => '<string>'
]
]
],
'description' => '<string>',
'expected_input' => [
],
'ranking_parameters' => [
'freshness_boost' => 5,
'source_boost' => 5
],
'research_plan' => [
'title' => '<string>',
'steps' => [
[
'description' => '<string>',
'status' => 'NOT_STARTED'
]
]
],
'expected_output' => '<string>'
]),
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"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"content_filter\": {\n \"all_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ],\n \"any_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ],\n \"none_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"expected_input\": {},\n \"ranking_parameters\": {\n \"freshness_boost\": 5,\n \"source_boost\": 5\n },\n \"research_plan\": {\n \"title\": \"<string>\",\n \"steps\": [\n {\n \"description\": \"<string>\",\n \"status\": \"NOT_STARTED\"\n }\n ]\n },\n \"expected_output\": \"<string>\"\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/templates")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"content_filter\": {\n \"all_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ],\n \"any_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ],\n \"none_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"expected_input\": {},\n \"ranking_parameters\": {\n \"freshness_boost\": 5,\n \"source_boost\": 5\n },\n \"research_plan\": {\n \"title\": \"<string>\",\n \"steps\": [\n {\n \"description\": \"<string>\",\n \"status\": \"NOT_STARTED\"\n }\n ]\n },\n \"expected_output\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://agents.bigdata.com/v1/workflow/templates")
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 \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"content_filter\": {\n \"all_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ],\n \"any_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ],\n \"none_of\": [\n {\n \"document_ids\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ]\n },\n \"description\": \"<string>\",\n \"expected_input\": {},\n \"ranking_parameters\": {\n \"freshness_boost\": 5,\n \"source_boost\": 5\n },\n \"research_plan\": {\n \"title\": \"<string>\",\n \"steps\": [\n {\n \"description\": \"<string>\",\n \"status\": \"NOT_STARTED\"\n }\n ]\n },\n \"expected_output\": \"<string>\"\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": "<string>"
}
],
"any_of": [
{
"document_ids": [
"<string>"
],
"type": "<string>"
}
],
"none_of": [
{
"document_ids": [
"<string>"
],
"type": "<string>"
}
]
},
"description": "<string>",
"expected_input": {},
"ranking_parameters": {
"freshness_boost": 5,
"source_boost": 5
},
"research_plan": {
"title": "<string>",
"steps": [
{
"description": "<string>",
"status": "NOT_STARTED"
}
]
},
"expected_output": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"ctx": {},
"input": "<unknown>"
}
]
}Authorizations
API key for authentication.
Body
Inline workflow template definition.
Template display name.
The research prompt with optional placeholders.
Content filters applied to all searches.
Show child attributes
Show child attributes
Brief description of what this template does.
Input placeholders the template expects, keyed by placeholder name.
Show child attributes
Show child attributes
Search result ranking configuration.
Show child attributes
Show child attributes
Pre-defined research plan for the workflow.
Show child attributes
Show child attributes
Optional guidance for the final answer's tone, structure, and format.
1Response
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.
Input placeholders, keyed by placeholder name.
Show child attributes
Show child attributes
Search result ranking configuration.
Show child attributes
Show child attributes
Pre-defined research plan.
Show child attributes
Show child attributes
Optional guidance for the final answer's tone, structure, and format.
1Was this page helpful?