Update Template

Update an existing workflow template.

PUT /v1/workflow/templates/{template_id}

Update Template

cURL

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 '
{
  "name": "<string>",
  "prompt": "<string>",
  "description": "<string>",
  "expected_input": {},
  "content_filter": {
    "any_of": [
      {
        "type": "<string>",
        "document_ids": [
          "<string>"
        ]
      }
    ],
    "all_of": [
      {
        "type": "<string>",
        "document_ids": [
          "<string>"
        ]
      }
    ],
    "none_of": [
      {
        "type": "<string>",
        "document_ids": [
          "<string>"
        ]
      }
    ]
  },
  "research_plan": {
    "title": "<string>",
    "steps": [
      {
        "description": "<string>",
        "status": "NOT_STARTED"
      }
    ]
  }
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "prompt": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "expected_input": {},
  "content_filter": {
    "any_of": [
      {
        "type": "<string>",
        "document_ids": [
          "<string>"
        ]
      }
    ],
    "all_of": [
      {
        "type": "<string>",
        "document_ids": [
          "<string>"
        ]
      }
    ],
    "none_of": [
      {
        "type": "<string>",
        "document_ids": [
          "<string>"
        ]
      }
    ]
  },
  "research_plan": {
    "title": "<string>",
    "steps": [
      {
        "description": "<string>",
        "status": "NOT_STARTED"
      }
    ]
  }
}

Authorizations

X-API-Key · string · header · required

Enter your API key

Path Parameters

template_id · string · required

Body

application/json

Request model for updating user workflow templates - all fields optional for FastAPI.

name · string | null

prompt · string | null

description · string | null

expected_input · Expected Input · object

Show child attributes

content_filter · ContentFilter · object

Show child attributes

research_plan · WFPlan · object

Show child attributes

Response

200

application/json

Successful Response

Complete workflow template model for API responses.

Represents a template with all data loaded from both DynamoDB and S3. This is the model returned to users with complete information.

id · string · required

name · string · required

prompt · string · required

created_at · string<date-time> · required

updated_at · string<date-time> · required

description · string | null

expected_input · Expected Input · object

Show child attributes

content_filter · WFContentFilter · object

Show child attributes

research_plan · WFPlan · object

Show child attributes