Skip to main content
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": "<string>"
      }
    ],
    "any_of": [
      {
        "document_ids": [
          "<string>"
        ],
        "type": "<string>"
      }
    ],
    "none_of": [
      {
        "document_ids": [
          "<string>"
        ],
        "type": "<string>"
      }
    ]
  },
  "description": "<string>",
  "expected_input": {},
  "name": "<string>",
  "prompt": "<string>",
  "ranking_parameters": {
    "freshness_boost": 5,
    "source_boost": 5
  },
  "research_plan": {
    "title": "<string>",
    "steps": [
      {
        "description": "<string>",
        "status": "NOT_STARTED"
      }
    ]
  }
}
'
{
  "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"
      }
    ]
  }
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication.

Path Parameters

​
template_id
string
required

Body

application/json

Fields to update on an existing workflow template. All fields are optional.

​
content_filter
ContentFilter · object

Composable content filter using logical operators.

​
description
string | null
​
expected_input
Expected Input · object
​
name
string | null
​
prompt
string | null
​
ranking_parameters
RankingParameters · object

Parameters that influence how search results are ranked.

​
research_plan
Plan · object

A structured research plan with ordered steps.

Response

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

Content filters applied to all searches.

​
description
string | null

Brief description of what this template does.

​
expected_input
Expected Input · object

Input placeholders, keyed by placeholder name.

​
ranking_parameters
RankingParameters · object

Search result ranking configuration.

​
research_plan
Plan · object

Pre-defined research plan.