Skip to main content
GET
/
v1
/
workflow
/
templates
List Templates
curl --request GET \
  --url https://agents.bigdata.com/v1/workflow/templates \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://agents.bigdata.com/v1/workflow/templates"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

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 => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)

func main() {

url := "https://agents.bigdata.com/v1/workflow/templates"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("X-API-Key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://agents.bigdata.com/v1/workflow/templates")
.header("X-API-Key", "<api-key>")
.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::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "templates": [
    {
      "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>"
    }
  ]
}

Authorizations

X-API-Key
string
header
required

API key for authentication.

Response

200 - application/json

Successful Response

List of workflow templates.

templates
WorkflowTemplate · object[]
required

Available templates.