Clone Template

Create a copy of an existing template with optional field overrides.

POST /v1/workflow/templates/{template_id}/clone

Clone Template

cURL

curl --request POST \
  --url https://agents.bigdata.com/v1/workflow/templates/{template_id}/clone \
  --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
    }
  }
}
'

200

{
  "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
    }
  }
}

Authorizations

X-API-Key · string · header · required

API key for authentication.

Path Parameters

template_id · string · required

Body

application/json

Optional overrides when cloning a workflow template.

content_filter · ContentFilter · object | null

Composable content filter using logical operators.

Show child attributes

description · string | null

expected_input · Expected Input · object | null

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

expected_output · string | null

Minimum string length: 1

name · string | null

prompt · string | null

ranking_parameters · RankingParameters · object | null

Parameters that influence how search results are ranked.

Show child attributes

research_plan · Plan · object | null

A structured research plan with ordered steps.

Show child attributes

tools_configs · Tools Configs · object | null

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

200

application/json

Successful Response

A complete workflow template with all metadata.

created_at · string<date-time> · required

When the template was created.

id · string · required

Unique template identifier.

is_community · boolean · required

Whether this is a community-shared template.

name · string · required

Template display name.

prompt · string · required

The research prompt with optional placeholders.

updated_at · string<date-time> · required

When the template was last modified.

content_filter · ContentFilter · object | null

Content filters applied to all searches.

Show child attributes

description · string | null

Brief description of what this template does.

expected_input · Expected Input · object | null

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

expected_output · string | null

Optional guidance for the final answer's tone, structure, and format.

Minimum string length: 1

ranking_parameters · RankingParameters · object | null

Search result ranking configuration.

Show child attributes

research_plan · Plan · object | null

Pre-defined research plan.

Show child attributes

tools_configs · Tools Configs · object | null

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
  }
}