> ## Documentation Index
> Fetch the complete documentation index at: https://docs.bigdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Template

> Update an existing workflow template. Only provided fields are modified.



## OpenAPI

````yaml /api-rest/openapi/openapi_workflows.json put /v1/workflow/templates/{template_id}
openapi: 3.1.0
info:
  description: HTTP API for Bigdata Research Agent and Deep-Research capabilities
  title: Bigdata Research Agent API
  version: 1.0.0
servers:
  - description: Production server
    url: https://agents.bigdata.com
security: []
paths:
  /v1/workflow/templates/{template_id}:
    put:
      tags:
        - Workflow Templates
      summary: Update Template
      description: Update an existing workflow template. Only provided fields are modified.
      operationId: update_template_v1_workflow_templates__template_id__put
      parameters:
        - in: path
          name: template_id
          required: true
          schema:
            title: Template Id
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWorkflowTemplateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowTemplate'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - API Key Authentication: []
components:
  schemas:
    UpdateWorkflowTemplateRequest:
      description: >-
        Fields to update on an existing workflow template. All fields are
        optional.
      properties:
        content_filter:
          anyOf:
            - $ref: '#/components/schemas/ContentFilter'
            - type: 'null'
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        expected_input:
          anyOf:
            - additionalProperties:
                $ref: '#/components/schemas/WorkflowInputSchema'
              type: object
            - type: 'null'
          title: Expected Input
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        prompt:
          anyOf:
            - type: string
            - type: 'null'
          title: Prompt
        ranking_parameters:
          anyOf:
            - $ref: '#/components/schemas/RankingParameters'
            - type: 'null'
        research_plan:
          anyOf:
            - $ref: '#/components/schemas/Plan-Input'
            - type: 'null'
      title: UpdateWorkflowTemplateRequest
      type: object
    WorkflowTemplate:
      description: A complete workflow template with all metadata.
      properties:
        content_filter:
          anyOf:
            - $ref: '#/components/schemas/ContentFilter'
            - type: 'null'
          description: Content filters applied to all searches.
        created_at:
          description: When the template was created.
          format: date-time
          title: Created At
          type: string
        description:
          anyOf:
            - type: string
            - type: 'null'
          description: Brief description of what this template does.
          title: Description
        expected_input:
          anyOf:
            - additionalProperties:
                $ref: '#/components/schemas/WorkflowInputSchema'
              type: object
            - type: 'null'
          description: Input placeholders, keyed by placeholder name.
          title: Expected Input
        id:
          description: Unique template identifier.
          title: Id
          type: string
        is_community:
          description: Whether this is a community-shared template.
          title: Is Community
          type: boolean
        name:
          description: Template display name.
          title: Name
          type: string
        prompt:
          description: The research prompt with optional placeholders.
          title: Prompt
          type: string
        ranking_parameters:
          anyOf:
            - $ref: '#/components/schemas/RankingParameters'
            - type: 'null'
          description: Search result ranking configuration.
        research_plan:
          anyOf:
            - $ref: '#/components/schemas/Plan-Output'
            - type: 'null'
          description: Pre-defined research plan.
        updated_at:
          description: When the template was last modified.
          format: date-time
          title: Updated At
          type: string
      required:
        - id
        - name
        - prompt
        - is_community
        - created_at
        - updated_at
      title: WorkflowTemplate
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ContentFilter:
      description: Composable content filter using logical operators.
      properties:
        all_of:
          description: Match content satisfying all of these filters.
          items:
            anyOf:
              - $ref: '#/components/schemas/DocumentIdFilter'
              - $ref: '#/components/schemas/SourceFilter'
          title: All Of
          type: array
        any_of:
          description: Match content satisfying at least one of these filters.
          items:
            anyOf:
              - $ref: '#/components/schemas/DocumentIdFilter'
              - $ref: '#/components/schemas/SourceFilter'
          title: Any Of
          type: array
        none_of:
          description: Exclude content matching any of these filters.
          items:
            anyOf:
              - $ref: '#/components/schemas/DocumentIdFilter'
              - $ref: '#/components/schemas/SourceFilter'
          title: None Of
          type: array
      title: ContentFilter
      type: object
    WorkflowInputSchema:
      description: Defines an input placeholder in a workflow template.
      properties:
        type:
          $ref: '#/components/schemas/WorkflowInputTypes'
          description: Expected input type for this placeholder.
      required:
        - type
      title: WorkflowInputSchema
      type: object
    RankingParameters:
      description: Parameters that influence how search results are ranked.
      properties:
        freshness_boost:
          anyOf:
            - maximum: 10
              minimum: 1
              type: integer
            - type: 'null'
          description: Prioritize more recent content (1-10).
          title: Freshness Boost
        source_boost:
          anyOf:
            - maximum: 10
              minimum: 1
              type: integer
            - type: 'null'
          description: Boost results from high-quality, authoritative sources (1-10).
          title: Source Boost
      title: RankingParameters
      type: object
    Plan-Input:
      description: A structured research plan with ordered steps.
      properties:
        steps:
          description: Ordered list of research steps.
          items:
            $ref: '#/components/schemas/Step'
          title: Steps
          type: array
        title:
          description: Short title summarizing the research objective.
          title: Title
          type: string
      required:
        - title
      title: Plan
      type: object
    Plan-Output:
      description: A structured research plan with ordered steps.
      properties:
        steps:
          description: Ordered list of research steps.
          items:
            $ref: '#/components/schemas/Step'
          title: Steps
          type: array
        title:
          description: Short title summarizing the research objective.
          title: Title
          type: string
      required:
        - title
      title: Plan
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
    DocumentIdFilter:
      description: Filter by specific document identifiers.
      properties:
        document_ids:
          description: Set of document IDs to match.
          items:
            type: string
          maxItems: 1000
          minItems: 1
          title: Document Ids
          type: array
          uniqueItems: true
        type:
          const: DOCUMENT_ID
          description: Filter type identifier.
          title: Type
          type: string
      required:
        - type
        - document_ids
      title: DocumentIdFilter
      type: object
    SourceFilter:
      description: Filter by content source identifiers.
      properties:
        sources_ids:
          description: Set of source IDs to match.
          items:
            type: string
          maxItems: 1000
          minItems: 1
          title: Sources Ids
          type: array
          uniqueItems: true
        type:
          const: SOURCE_TYPE
          description: Filter type identifier.
          title: Type
          type: string
      required:
        - type
        - sources_ids
      title: SourceFilter
      type: object
    WorkflowInputTypes:
      description: Supported input types for workflow template placeholders.
      enum:
        - rp_entity_id
        - string
      title: WorkflowInputTypes
      type: string
    Step:
      description: A single step within a research plan.
      properties:
        description:
          description: What this step will investigate or produce.
          title: Description
          type: string
        status:
          $ref: '#/components/schemas/StepStatus'
          default: NOT_STARTED
          description: Current status of this step.
      required:
        - description
      title: Step
      type: object
    StepStatus:
      description: Status of a research plan step.
      enum:
        - NOT_STARTED
        - IN_PROGRESS
        - COMPLETED
        - SKIPPED
        - FAILED
      title: StepStatus
      type: string
  securitySchemes:
    API Key Authentication:
      description: API key for authentication.
      in: header
      name: X-API-Key
      type: apiKey

````