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

# Get Workflows Public



## OpenAPI

````yaml get /v1/workflows
openapi: 3.1.0
info:
  title: Noxus Backend
  description: >-
    Backend API for the Noxus Platform. More information can be found at
    https://docs.noxus.ai
  version: 1.1.0
servers: []
security: []
paths:
  /v1/workflows:
    get:
      tags:
        - V1 - Workflows
      summary: Get Workflows Public
      operationId: get_workflows_public
      parameters:
        - name: query
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Query
        - name: status
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Status
        - name: order_by
          in: query
          required: false
          schema:
            type: string
            default: last_updated_at
            title: Order By
        - name: sort
          in: query
          required: false
          schema:
            type: string
            default: desc
            title: Sort
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            description: Page number
            default: 1
            title: Page
          description: Page number
        - name: size
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Page size
            default: 50
            title: Size
          description: Page size
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_WorkflowWithTriggers_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    Page_WorkflowWithTriggers_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/WorkflowWithTriggers'
          type: array
          title: Items
        total:
          type: integer
          minimum: 0
          title: Total
        page:
          type: integer
          minimum: 1
          title: Page
        size:
          type: integer
          minimum: 1
          title: Size
        pages:
          type: integer
          minimum: 0
          title: Pages
      type: object
      required:
        - items
        - total
        - page
        - size
        - pages
      title: Page[WorkflowWithTriggers]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WorkflowWithTriggers:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        group_id:
          type: string
          format: uuid
          title: Group Id
        name:
          type: string
          title: Name
        type:
          $ref: '#/components/schemas/WorkflowType'
        definition:
          additionalProperties: true
          type: object
          title: Definition
        workflow_hash:
          anyOf:
            - type: string
            - type: 'null'
          title: Workflow Hash
        meta:
          anyOf:
            - $ref: '#/components/schemas/WorkflowMeta'
            - type: 'null'
        settings:
          anyOf:
            - $ref: '#/components/schemas/ChatflowSettingsConfig-Output'
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Settings
        last_updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Updated At
        last_run_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Run At
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Created At
        deleted_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Deleted At
        runs_count:
          anyOf:
            - type: integer
            - type: 'null'
          title: Runs Count
        author_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Author Name
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        saved:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Saved
        error_handler:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Error Handler
        is_app_published:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Is App Published
        app_settings_v2:
          anyOf:
            - $ref: '#/components/schemas/AppSettingsV2'
            - type: 'null'
        flow_version:
          type: string
          title: Flow Version
          default: v1
        triggers:
          items:
            $ref: '#/components/schemas/Trigger'
          type: array
          title: Triggers
          default: []
      type: object
      required:
        - id
        - group_id
        - name
        - type
        - definition
      title: WorkflowWithTriggers
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    WorkflowType:
      type: string
      enum:
        - flow
        - agent_flow
        - handler
        - ingestion
        - inbox_process
        - inbox_filtering
        - inbox_extraction
        - task_automation
      title: WorkflowType
    WorkflowMeta:
      properties:
        tags:
          items:
            $ref: '#/components/schemas/WorkflowTag'
          type: array
          title: Tags
          default: []
        icon:
          anyOf:
            - type: string
            - type: 'null'
          title: Icon
        log_sync_sheet:
          anyOf:
            - $ref: '#/components/schemas/WorkflowLogSheet'
            - type: 'null'
        columns:
          anyOf:
            - items:
                $ref: '#/components/schemas/WorkflowLogColumn'
              type: array
            - type: 'null'
          title: Columns
        spreadsheet:
          anyOf:
            - $ref: '#/components/schemas/WorkflowLogSpreadsheet'
            - type: 'null'
        chatflow_settings:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Chatflow Settings
          deprecated: true
        template_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Template Id
        variables:
          anyOf:
            - items:
                additionalProperties: true
                type: object
              type: array
            - type: 'null'
          title: Variables
        source:
          anyOf:
            - $ref: '#/components/schemas/EntitySource'
            - type: 'null'
      type: object
      title: WorkflowMeta
    ChatflowSettingsConfig-Output:
      properties:
        pii_banner:
          type: string
          title: Pii Banner
          description: Information about PII anonymization
          default: ''
          accordion: Safety
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_optional_label: false
            style: info
            type: banner
          tab: Model
          tool_mode: hidden
          visible: false
        pii_info:
          type: string
          title: Pii Info
          description: Information about PII anonymization
          default: ''
          accordion: Safety
          display:
            col_span: 10
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_optional_label: false
            small_text: Choose which PII types to anonymize.
            title: PII Anonymization Settings
            type: ui_text_display
          tab: Model
          tool_mode: hidden
          visible: false
        pii_lock:
          type: boolean
          title: Pii Lock
          description: Information about the guardrails
          default: false
          accordion: Safety
          display:
            col_align: start
            col_justify: end
            col_span: 2
            icon: Unlock
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_optional_label: false
            toggledIcon: Lock
            tooltip: Lock PII settings so they cannot be changed
            type: toggle_button
          tab: Model
          tool_mode: hidden
          visible: false
        pii_anonimization:
          items:
            additionalProperties:
              type: string
            type: object
          type: array
          title: Pii Anonimization
          description: Preferred anonymization method for PII values.
          default:
            - value: PERSON
              label: Name
            - value: EMAIL_ADDRESS
              label: Email
            - value: PHONE_NUMBER
              label: Phone Number
            - value: CREDIT_CARD
              label: Credit Card
          accordion: Safety
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Anonymize PII
            needs_confirmation: false
            show_optional_label: false
            type: multi_select
            values:
              - label: Person
                value: PERSON
              - label: Email Address
                value: EMAIL_ADDRESS
              - label: Phone Number
                value: PHONE_NUMBER
              - label: Credit Card
                value: CREDIT_CARD
              - label: Cryptocurrency
                value: CRYPTO
              - label: IP Address
                value: IP_ADDRESS
              - label: Date Time
                value: DATE_TIME
              - label: NRP
                value: NRP
              - label: Location
                value: LOCATION
              - label: Medical License
                value: MEDICAL_LICENSE
              - label: URL
                value: URL
              - label: IBAN Code
                value: IBAN_CODE
          rules:
            - config_source: pii_lock
              type: disabled_if
              value: true
          tab: Model
          tool_mode: hidden
          visible: false
        divider1:
          type: string
          title: Divider1
          default: ''
          accordion: Safety
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_line: true
            show_optional_label: false
            spacing: 0
            type: divider
          tab: Model
          tool_mode: hidden
          visible: false
        guardrail_info:
          type: string
          title: Guardrail Info
          description: Information about the guardrails
          default: ''
          accordion: Safety
          display:
            col_span: 10
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_optional_label: false
            small_text: >-
              Set the strictness level of guardrails to ensure the AI model's
              behavior and responses remain safe and appropriate — from 'Off'
              (no protection) to 'High' (maximum protection).
            title: Guardrails
            type: ui_text_display
          tab: Model
          tool_mode: hidden
        guardrail_lock:
          type: boolean
          title: Guardrail Lock
          description: Locks the guardrails settings.
          default: false
          accordion: Safety
          display:
            col_align: start
            col_justify: end
            col_span: 2
            icon: Unlock
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_optional_label: false
            toggledIcon: Lock
            tooltip: Lock guardrails settings so they cannot be changed
            type: toggle_button
          tab: Model
          tool_mode: hidden
          visible: false
        guardrail_latency_banner:
          type: string
          title: Guardrail Latency Banner
          description: ''
          default: ''
          accordion: Safety
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: >-
              Each enabled guardrail makes its own LLM call before the model can
              reply. Expect noticeably slower responses while any of these are
              on.
            needs_confirmation: false
            show_optional_label: false
            style: warning
            title: Guardrails add response latency
            type: banner
          rules:
            - conds:
                - config_source: violence_and_hate
                  type: visible_if_not
                  value: 'Off'
                - config_source: sexual_content
                  type: visible_if_not
                  value: 'Off'
                - config_source: guns_and_weapons
                  type: visible_if_not
                  value: 'Off'
                - config_source: suicide
                  type: visible_if_not
                  value: 'Off'
                - config_source: crime
                  type: visible_if_not
                  value: 'Off'
                - config_source: toxicity
                  type: visible_if_not
                  value: 'Off'
                - config_source: bias
                  type: visible_if_not
                  value: 'Off'
                - config_source: profanity
                  type: visible_if_not
                  value: 'Off'
                - config_source: jailbreak
                  type: visible_if
                  value: true
                - config_source: prompt_injection
                  type: visible_if
                  value: true
              mode: or
              type: visible_if_group
          tab: Model
          tool_mode: hidden
        violence_and_hate:
          $ref: '#/components/schemas/GuardrailValue'
          default:
            value: 'Off'
            context: ''
          accordion: Safety
          display:
            accordion_label: Additional context
            col_span: 12
            context_placeholder: >-
              E.g. This is a news agency — reporting on conflict zones is
              expected and should not be flagged.
            is_disabled: false
            is_subconfig: false
            label: Violence and Hate
            needs_confirmation: false
            off_value: 'Off'
            show_optional_label: false
            type: guardrail_card
            values:
              - 'Off'
              - Low
              - Medium
              - High
          rules:
            - config_source: guardrail_lock
              type: disabled_if
              value: true
          tab: Model
          tool_mode: hidden
        sexual_content:
          $ref: '#/components/schemas/GuardrailValue'
          default:
            value: 'Off'
            context: ''
          accordion: Safety
          display:
            accordion_label: Additional context
            col_span: 12
            context_placeholder: >-
              E.g. This is an airline booking system — mentions of children
              traveling are normal and should not be flagged.
            is_disabled: false
            is_subconfig: false
            label: Sexual Content
            needs_confirmation: false
            off_value: 'Off'
            show_optional_label: false
            type: guardrail_card
            values:
              - 'Off'
              - Low
              - Medium
              - High
          rules:
            - config_source: guardrail_lock
              type: disabled_if
              value: true
          tab: Model
          tool_mode: hidden
        guns_and_weapons:
          $ref: '#/components/schemas/GuardrailValue'
          default:
            value: 'Off'
            context: ''
          accordion: Safety
          display:
            accordion_label: Additional context
            col_span: 12
            context_placeholder: >-
              E.g. This is a sporting goods store — discussion of hunting
              equipment is expected.
            is_disabled: false
            is_subconfig: false
            label: Guns and Illegal Weapons
            needs_confirmation: false
            off_value: 'Off'
            show_optional_label: false
            type: guardrail_card
            values:
              - 'Off'
              - Low
              - Medium
              - High
          rules:
            - config_source: guardrail_lock
              type: disabled_if
              value: true
          tab: Model
          tool_mode: hidden
        suicide:
          $ref: '#/components/schemas/GuardrailValue'
          default:
            value: 'Off'
            context: ''
          accordion: Safety
          display:
            accordion_label: Additional context
            col_span: 12
            context_placeholder: >-
              E.g. This is a mental health support platform — discussing
              symptoms is expected and should not be blocked.
            is_disabled: false
            is_subconfig: false
            label: Suicide and Self-Harm
            needs_confirmation: false
            off_value: 'Off'
            show_optional_label: false
            type: guardrail_card
            values:
              - 'Off'
              - Low
              - Medium
              - High
          rules:
            - config_source: guardrail_lock
              type: disabled_if
              value: true
          tab: Model
          tool_mode: hidden
        crime:
          $ref: '#/components/schemas/GuardrailValue'
          default:
            value: 'Off'
            context: ''
          accordion: Safety
          display:
            accordion_label: Additional context
            col_span: 12
            context_placeholder: >-
              E.g. This is a legal firm assistant — discussing criminal cases
              and charges is part of normal operation.
            is_disabled: false
            is_subconfig: false
            label: Crime and Criminal Planning
            needs_confirmation: false
            off_value: 'Off'
            show_optional_label: false
            type: guardrail_card
            values:
              - 'Off'
              - Low
              - Medium
              - High
          rules:
            - config_source: guardrail_lock
              type: disabled_if
              value: true
          tab: Model
          tool_mode: hidden
        toxicity:
          $ref: '#/components/schemas/GuardrailValue'
          default:
            value: 'Off'
            context: ''
          accordion: Safety
          display:
            accordion_label: Additional context
            col_span: 12
            context_placeholder: >-
              E.g. This is a gaming community moderator — competitive banter and
              trash talk is normal.
            is_disabled: false
            is_subconfig: false
            label: Toxicity
            needs_confirmation: false
            off_value: 'Off'
            show_optional_label: false
            type: guardrail_card
            values:
              - 'Off'
              - Low
              - Medium
              - High
          rules:
            - config_source: guardrail_lock
              type: disabled_if
              value: true
          tab: Model
          tool_mode: hidden
        bias:
          $ref: '#/components/schemas/GuardrailValue'
          default:
            value: 'Off'
            context: ''
          accordion: Safety
          display:
            accordion_label: Additional context
            col_span: 12
            context_placeholder: >-
              E.g. This assistant serves a diversity and inclusion team —
              discussing demographic differences is expected.
            is_disabled: false
            is_subconfig: false
            label: Bias
            needs_confirmation: false
            off_value: 'Off'
            show_optional_label: false
            type: guardrail_card
            values:
              - 'Off'
              - Low
              - Medium
              - High
          rules:
            - config_source: guardrail_lock
              type: disabled_if
              value: true
          tab: Model
          tool_mode: hidden
        profanity:
          $ref: '#/components/schemas/GuardrailValue'
          default:
            value: 'Off'
            context: ''
          accordion: Safety
          display:
            accordion_label: Additional context
            col_span: 12
            context_placeholder: >-
              E.g. This is a content moderation tool — quoting flagged content
              for review is expected.
            is_disabled: false
            is_subconfig: false
            label: Profanity
            needs_confirmation: false
            off_value: 'Off'
            show_optional_label: false
            type: guardrail_card
            values:
              - 'Off'
              - Low
              - Medium
              - High
          rules:
            - config_source: guardrail_lock
              type: disabled_if
              value: true
          tab: Model
          tool_mode: hidden
        guardrails_scan_output:
          type: boolean
          title: Guardrails Scan Output
          description: >-
            Scan the model's response with the same semantic guardrails applied
            to input. Catches sensitive content sourced from Knowledge Base
            documents or tools that the input scan cannot see.
          default: false
          accordion: Safety
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Scan responses (output guardrails)
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          rules:
            - config_source: guardrail_lock
              type: disabled_if
              value: true
          tab: Model
          tool_mode: hidden
        guardrails_output_mode:
          type: string
          enum:
            - post_stream
            - pre_stream
          title: Guardrails Output Mode
          description: >-
            How output guardrails are enforced. 'post_stream' streams the
            response in real-time and warns/clears after the fact. 'pre_stream'
            buffers the full response, validates it against guardrails, and only
            emits it if it passes.
          default: post_stream
          accordion: Safety
          display:
            col_span: 12
            icons: false
            is_clearable: false
            is_disabled: false
            is_horizontal: false
            is_searchable: true
            is_subconfig: false
            label: Output guardrail mode
            needs_confirmation: false
            show_optional_label: false
            type: select
            values:
              - label: Post-stream (warn after response)
                value: post_stream
              - label: Pre-stream (validate before showing)
                value: pre_stream
          rules:
            - config_source: guardrail_lock
              type: disabled_if
              value: true
            - config_source: guardrails_scan_output
              type: visible_if
              value: true
          tab: Model
          tool_mode: hidden
        divider2:
          type: string
          title: Divider2
          default: ''
          accordion: Safety
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_line: true
            show_optional_label: false
            spacing: 0
            type: divider
          tab: Model
          tool_mode: hidden
        guardrail_action:
          anyOf:
            - additionalProperties:
                type: string
              type: object
            - type: string
          title: Guardrail Action
          description: Choose the action to take when a guardrail is triggered.
          default:
            value: fail
            label: Fail/block run
          accordion: Safety
          display:
            col_span: 12
            icons: false
            is_clearable: false
            is_disabled: false
            is_horizontal: false
            is_searchable: true
            is_subconfig: false
            label: Guardrail action
            needs_confirmation: false
            show_optional_label: false
            type: select
            values:
              - label: Fail/block run
                value: fail
              - label: Flag with warning but proceed
                value: flag
          rules:
            - config_source: guardrail_lock
              type: disabled_if
              value: true
          tab: Model
          tool_mode: hidden
          visible: false
        guardrail_action_replace:
          type: string
          title: Guardrail Action Replace
          default: ''
          accordion: Safety
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: Replace with
            needs_confirmation: false
            number_of_lines: 1
            placeholder: E.g. <REDACTED>
            show_optional_label: false
            show_refresh: false
            type: text
          rules:
            - config_source: guardrail_action
              type: visible_if
              value: replace
            - config_source: guardrail_lock
              type: disabled_if
              value: true
          tab: Model
          tool_mode: hidden
          visible: false
        guardrail_action_human:
          type: string
          title: Guardrail Action Human
          default: ''
          accordion: Safety
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: true
            label: Human task template
            needs_confirmation: false
            number_of_lines: 1
            placeholder: E.g. <REDACTED>
            show_optional_label: false
            show_refresh: false
            type: text
          rules:
            - config_source: guardrail_action
              type: visible_if
              value: human
            - config_source: guardrail_lock
              type: disabled_if
              value: true
          tab: Model
          tool_mode: hidden
          visible: false
        block_after_violations:
          type: integer
          title: Block After Violations
          description: >-
            Block the chat after this many turns with guardrail violations. Set
            to 0 to never block (per-turn warnings still surface).
          default: 0
          accordion: Safety
          display:
            col_span: 12
            hide_number: false
            is_disabled: false
            is_subconfig: false
            label: Block chat after N violations
            max: 20
            min: 0
            needs_confirmation: false
            show_optional_label: false
            step: 1
            tooltip: >-
              Once a conversation accumulates this many turns with any guardrail
              violation (flag or fail mode), the chat input locks. Set to 0 to
              disable.
            type: number_slider
          rules:
            - config_source: guardrail_lock
              type: disabled_if
              value: true
          tab: Model
          tool_mode: hidden
        block_message:
          type: string
          title: Block Message
          description: Message shown to the user when the chat is locked.
          default: >-
            This conversation has been locked due to repeated safety violations.
            Please start a new conversation.
          accordion: Safety
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: true
            label: Block message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: >-
              This conversation has been locked due to repeated safety
              violations.
            show_optional_label: false
            show_refresh: false
            type: text
          rules:
            - config_source: block_after_violations
              type: visible_if_not
              value: 0
            - config_source: guardrail_lock
              type: disabled_if
              value: true
          tab: Model
          tool_mode: hidden
        divider3:
          type: string
          title: Divider3
          default: ''
          accordion: Safety
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_line: true
            show_optional_label: false
            spacing: 0
            type: divider
          tab: Model
          tool_mode: hidden
          visible: false
        prompt_defense:
          type: string
          title: Prompt Defense
          default: ''
          accordion: Safety
          display:
            col_span: 10
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_optional_label: false
            small_text: >-
              Configurations to ensure the model behaves as expected and is
              protected against attacks, like jailbreak or prompt injection.
            title: Prompt Defense
            type: ui_text_display
          tab: Model
          tool_mode: hidden
        prompt_lock:
          type: boolean
          title: Prompt Lock
          description: Locks the prompt defense settings
          default: false
          accordion: Safety
          display:
            col_align: start
            col_justify: end
            col_span: 2
            icon: Unlock
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_optional_label: false
            toggledIcon: Lock
            tooltip: Lock prompt settings so they cannot be changed
            type: toggle_button
          tab: Model
          tool_mode: hidden
          visible: false
        jailbreak:
          type: boolean
          title: Jailbreak
          description: >-
            Prevents attempts to manipulate or "jailbreak" the model into
            ignoring safety rules or system instructions (e.g., prompts like
            "ignore previous instructions").
          default: false
          accordion: Safety
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Jailbreak
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          rules:
            - config_source: prompt_lock
              type: disabled_if
              value: true
          tab: Model
          tool_mode: hidden
        prompt_injection:
          type: boolean
          title: Prompt Injection
          description: >-
            Detects and blocks strategies where users attempt to get around
            restrictions indirectly (e.g., asking the model to 'pretend' or
            speak as a fictional character to evade policies).
          default: false
          accordion: Safety
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Prompt Injection
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          rules:
            - config_source: prompt_lock
              type: disabled_if
              value: true
          tab: Model
          tool_mode: hidden
        context_leak:
          type: boolean
          title: Context Leak
          description: >-
            Prevents the model from unintentionally revealing internal context,
            instructions, or system messages that are not meant to be shared
            with the user.
          default: false
          accordion: Safety
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Context Leak
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          rules:
            - config_source: prompt_lock
              type: disabled_if
              value: true
          tab: Model
          tool_mode: hidden
          visible: false
        auto_model_pick:
          type: boolean
          title: Auto Model Pick
          description: AI selects the optimal model for performance, cost savings or length
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Smart model selection
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Model
          tool_mode: hidden
          visible: false
        auto_model_preference:
          type: string
          title: Auto Model Preference
          default: cost
          display:
            can_wrap: true
            col_span: 12
            endpoint: /models/llms
            is_disabled: false
            is_multi: false
            is_subconfig: true
            needs_confirmation: false
            show_optional_label: false
            type: select_chips
            values:
              - custom_fields:
                  icon: gauge
                label: Performance
                value: performance
              - custom_fields:
                  icon: dollar
                label: Cost
                value: cost
              - custom_fields:
                  icon: text
                label: Length
                value: length
          optional: true
          tab: Model
          tool_mode: hidden
          visible: false
        model:
          items:
            type: string
          type: array
          title: Model
          description: Model configuration
          default:
            - preset:cost
          display:
            col_span: 12
            default_preset: cost
            endpoint: /models/llms
            hide_disabled_models: true
            is_disabled: false
            is_subconfig: true
            label: Choose from our recommended models
            layout: side_by_side
            model_type: text
            needs_confirmation: false
            show_inline_presets: true
            show_optional_label: false
            show_presets: false
            type: model_select
          optional: true
          tab: Model
          tool_mode: hidden
        parameter_preset:
          type: string
          enum:
            - default
            - creative
            - precise
            - custom
          title: Parameter Preset
          description: >-
            Controls randomness, diversity, and repetition of the model's
            output.
          default: default
          accordion: Model Parameters
          display:
            button_size: sm
            button_variant: outline
            col_span: 12
            is_disabled: false
            is_horizontal: true
            is_subconfig: false
            label: Model parameters preset
            needs_confirmation: false
            show_optional_label: false
            type: menu_select
            values:
              - description: Provider-recommended settings for general use
                icon: settings2
                label: Default
                value: default
              - description: Higher randomness for diverse, imaginative outputs
                icon: sparkles
                label: Creative
                value: creative
              - description: Deterministic and focused for factual tasks
                icon: target
                label: Precise
                value: precise
              - description: Fine-tune each parameter manually
                icon: sliders-horizontal
                label: Custom
                value: custom
          rules:
            - target_fields:
                - temperature
                - top_p
                - top_k
                - presence_penalty
                - frequency_penalty
              type: sets_field_values
              value_map:
                creative:
                  frequency_penalty: 0.3
                  presence_penalty: 0.3
                  temperature: 0.7
                  top_k: 40
                  top_p: 0.95
                custom: {}
                default: {}
                precise:
                  frequency_penalty: 0
                  presence_penalty: 0
                  temperature: 0
                  top_k: 5
                  top_p: 0.1
          tab: Model
          tool_mode: hidden
        intro:
          type: string
          title: Intro
          default: ''
          accordion: Model Parameters
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_optional_label: false
            text: >-
              Fine-tune the selected model's behavior with advanced controls.
              Not all of the settings apply to all models.
            type: ui_text_display
          rules:
            - config_source: parameter_preset
              type: visible_if
              value: custom
          tab: Model
          tool_mode: hidden
        basic_params_section:
          type: string
          title: Basic Params Section
          default: ''
          accordion: Model Parameters
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_optional_label: false
            text: >-
              Control the model's output length, randomness, and response time
              limits.
            title: Basic parameters
            type: ui_text_display
          rules:
            - config_source: parameter_preset
              type: visible_if
              value: custom
          tab: Model
          tool_mode: hidden
        max_tokens:
          type: integer
          title: Max Tokens
          description: The maximum number of tokens per request
          default: 64000
          accordion: Model Parameters
          display:
            col_span: 12
            hide_number: true
            is_disabled: false
            is_subconfig: false
            label: Max tokens
            max: 128000
            min: 0
            needs_confirmation: false
            show_optional_label: false
            step: 100
            type: number_slider
          rules:
            - config_source: parameter_preset
              type: visible_if
              value: custom
          tab: Model
          tool_mode: hidden
        temperature:
          type: number
          title: Temperature
          description: The temperature of the model
          default: 0.7
          accordion: Model Parameters
          display:
            col_span: 12
            hide_number: true
            is_disabled: false
            is_subconfig: false
            label: Temperature
            max: 1
            min: 0
            needs_confirmation: false
            show_optional_label: false
            step: 0.01
            type: number_slider
          rules:
            - config_source: parameter_preset
              type: visible_if
              value: custom
          tab: Model
          tool_mode: hidden
        top_p:
          type: number
          title: Top P
          description: The top P of the model
          default: 1
          accordion: Model Parameters
          display:
            col_span: 12
            hide_number: true
            is_disabled: false
            is_subconfig: false
            label: Top P
            max: 1
            min: 0.01
            needs_confirmation: false
            show_optional_label: false
            step: 0.01
            type: number_slider
          rules:
            - config_source: parameter_preset
              type: visible_if
              value: custom
          tab: Model
          tool_mode: hidden
        top_k:
          type: integer
          title: Top K
          description: The top K of the model
          default: 40
          accordion: Model Parameters
          display:
            col_span: 12
            hide_number: true
            is_disabled: false
            is_subconfig: false
            label: Top K
            max: 100
            min: 1
            needs_confirmation: false
            show_optional_label: false
            step: 1
            type: number_slider
          rules:
            - config_source: parameter_preset
              type: visible_if
              value: custom
          tab: Model
          tool_mode: hidden
        timeout:
          type: number
          title: Timeout
          description: The base timeout of the model
          default: 120
          accordion: Model Parameters
          display:
            col_span: 12
            hide_number: true
            is_disabled: false
            is_subconfig: false
            label: Timeout
            max: 600
            min: 1
            needs_confirmation: false
            show_optional_label: false
            step: 1
            type: number_slider
          rules:
            - config_source: parameter_preset
              type: visible_if
              value: custom
          tab: Model
          tool_mode: hidden
        divider_7:
          type: string
          title: Divider 7
          default: ''
          accordion: Model Parameters
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_line: true
            show_optional_label: false
            spacing: 0
            type: divider
          rules:
            - config_source: parameter_preset
              type: visible_if
              value: custom
          tab: Model
          tool_mode: hidden
        penalty_section:
          type: string
          title: Penalty Section
          default: ''
          accordion: Model Parameters
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_optional_label: false
            text: >-
              Adjust penalties and stop sequences to control the model's
              generation.
            title: Generation control
            type: ui_text_display
          rules:
            - config_source: parameter_preset
              type: visible_if
              value: custom
          tab: Model
          tool_mode: hidden
        presence_penalty:
          type: number
          title: Presence Penalty
          description: The presence penalty of the model
          default: 0.3
          accordion: Model Parameters
          display:
            col_span: 12
            hide_number: true
            is_disabled: false
            is_subconfig: false
            label: Presence penalty
            max: 2
            min: -2
            needs_confirmation: false
            show_optional_label: false
            step: 0.1
            type: number_slider
          rules:
            - config_source: parameter_preset
              type: visible_if
              value: custom
          tab: Model
          tool_mode: hidden
        frequency_penalty:
          type: number
          title: Frequency Penalty
          description: The frequency penalty of the model
          default: 0.6
          accordion: Model Parameters
          display:
            col_span: 12
            hide_number: true
            is_disabled: false
            is_subconfig: false
            label: Frequency penalty
            max: 2
            min: -2
            needs_confirmation: false
            show_optional_label: false
            step: 0.1
            type: number_slider
          rules:
            - config_source: parameter_preset
              type: visible_if
              value: custom
          tab: Model
          tool_mode: hidden
        stop_sequences:
          items:
            type: string
          type: array
          title: Stop Sequences
          description: >-
            The model will stop generating text when it encounters any of these
            stop sequences
          default: []
          accordion: Model Parameters
          display:
            chips_are_closable: false
            col_span: 12
            hide_toolbar: false
            is_disabled: false
            is_subconfig: false
            label: Stop sequences
            needs_confirmation: false
            show_optional_label: false
            type: chips_list_text
          rules:
            - config_source: parameter_preset
              type: visible_if
              value: custom
          tab: Model
          tool_mode: hidden
        divider_8:
          type: string
          title: Divider 8
          default: ''
          accordion: Model Parameters
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_line: true
            show_optional_label: false
            spacing: 0
            type: divider
          rules:
            - config_source: parameter_preset
              type: visible_if
              value: custom
          tab: Model
          tool_mode: hidden
        reasoning_section:
          type: string
          title: Reasoning Section
          default: ''
          accordion: Model Parameters
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_optional_label: false
            text: >-
              Configure the model's reasoning capabilities and computational
              effort level.
            title: Model reasoning
            type: ui_text_display
          rules:
            - config_source: parameter_preset
              type: visible_if
              value: custom
          tab: Model
          tool_mode: hidden
        enable_reasoning:
          type: boolean
          title: Enable Reasoning
          description: Whether to enable reasoning
          default: true
          accordion: Model Parameters
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Enable reasoning
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          rules:
            - config_source: parameter_preset
              type: visible_if
              value: custom
          tab: Model
          tool_mode: hidden
        reasoning_effort:
          type: string
          title: Reasoning Effort
          description: The reasoning effort of the model
          default: Low
          accordion: Model Parameters
          display:
            col_span: 12
            is_disabled: false
            is_horizontal: false
            is_subconfig: false
            label: Reasoning effort
            needs_confirmation: false
            show_optional_label: false
            type: enum_slider
            values:
              - low
              - medium
              - high
          rules:
            - conds:
                - config_source: parameter_preset
                  type: visible_if
                  value: custom
                - config_source: enable_reasoning
                  type: visible_if
                  value: true
              mode: and
              type: visible_if_group
          tab: Model
          tool_mode: hidden
        divider:
          type: string
          title: Divider
          default: ''
          accordion: Model Parameters
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_line: true
            show_optional_label: false
            spacing: 0
            type: divider
          rules:
            - config_source: parameter_preset
              type: visible_if
              value: custom
          tab: Model
          tool_mode: hidden
        reliability_section:
          type: string
          title: Reliability Section
          default: ''
          accordion: Model Parameters
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_optional_label: false
            text: >-
              Configure retry behavior and fallback options for improved
              reliability.
            title: Reliability
            type: ui_text_display
          tab: Model
          tool_mode: hidden
        max_retries_per_model:
          type: integer
          title: Max Retries Per Model
          description: The maximum number of retries per model
          default: 3
          accordion: Model Parameters
          display:
            col_span: 12
            hide_number: true
            is_disabled: false
            is_subconfig: false
            label: Max retries
            max: 5
            min: 0
            needs_confirmation: false
            show_optional_label: false
            step: 1
            type: number_slider
          tab: Model
          tool_mode: hidden
        retry_on_status_codes:
          items:
            type: integer
          type: array
          title: Retry On Status Codes
          description: The status codes to retry on
          default:
            - 429
            - 500
            - 502
            - 503
            - 504
          accordion: Model Parameters
          display:
            chips_are_closable: false
            col_span: 12
            hide_toolbar: false
            is_disabled: false
            is_subconfig: false
            label: Retry on status codes
            needs_confirmation: false
            show_optional_label: false
            type: chips_list_text
          tab: Model
          tool_mode: hidden
        datacenter_fallback:
          type: boolean
          title: Datacenter Fallback
          description: >-
            Whether to fallback to a different datacenter of the same model if
            the current one is down
          default: true
          accordion: Model Parameters
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Datacenter fallback
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Model
          tool_mode: hidden
        exclude_user_identity_from_prompt:
          type: boolean
          title: Exclude User Identity From Prompt
          description: >-
            Omit the user's name from the system prompt. Keeps the cached
            instruction prefix identical across users so it can be reused, and
            avoids sending user identity to the model.
          default: false
          accordion: Advanced
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Exclude user identity from prompt
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Prompt
          tool_mode: hidden
        enable_prompt_caching:
          type: boolean
          title: Enable Prompt Caching
          description: >-
            Cache the stable instruction prefix at the model provider to cut
            input cost and latency on repeated turns. Disable to send every
            request uncached.
          default: true
          accordion: Model Parameters
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Prompt caching
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Model
          tool_mode: hidden
        protect_instructions_in_preview:
          type: boolean
          title: Protect Instructions In Preview
          description: >-
            Deployed conversations always keep the agent's system instructions,
            persona, tools, and configuration confidential. Turn this on to also
            protect them in the preview/dev page — otherwise the safeguard is
            dropped there so builders can inspect the agent they are
            configuring.
          default: false
          accordion: Safety
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Protect instructions in preview
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          rules:
            - config_source: prompt_lock
              type: disabled_if
              value: true
          tab: Model
          tool_mode: hidden
        agentflow_enabled:
          type: boolean
          title: Agentflow Enabled
          description: Whether to enable chat flow
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Enable chat flow
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        usage_limits_section:
          type: string
          title: Usage Limits Section
          default: ''
          accordion: Model Parameters
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_optional_label: false
            text: Set limits on resource usage to control costs and prevent overuse.
            title: Agent usage limits
            tooltip: Applies to each conversation.
            type: ui_text_display
          tab: Model
          tool_mode: hidden
        usage_limits_maximum_request:
          type: integer
          title: Usage Limits Maximum Request
          description: The maximum number of requests
          default: 1000
          accordion: Model Parameters
          display:
            col_span: 12
            hide_number: true
            is_disabled: false
            is_subconfig: false
            label: Total Max Requests
            max: 10000
            min: 0
            needs_confirmation: false
            show_optional_label: false
            step: 50
            tooltip: Applies to each conversation.
            type: number_slider
          tab: Model
          tool_mode: hidden
        usage_limits_maximum_tokens:
          type: integer
          title: Usage Limits Maximum Tokens
          description: The maximum number of tokens
          default: 2000000
          accordion: Model Parameters
          display:
            col_span: 12
            hide_number: true
            is_disabled: false
            is_subconfig: false
            label: Total max tokens
            max: 2000000
            min: 100
            needs_confirmation: false
            show_optional_label: false
            step: 500
            tooltip: Applies to each conversation.
            type: number_slider
          tab: Model
          tool_mode: hidden
        usage_limits_max_messages:
          type: integer
          title: Usage Limits Max Messages
          description: The maximum number of messages
          default: 100
          accordion: Model Parameters
          display:
            col_span: 12
            hide_number: true
            is_disabled: false
            is_subconfig: false
            label: Total max messages
            max: 1000
            min: 0
            needs_confirmation: false
            show_optional_label: false
            step: 10
            tooltip: Applies to each conversation.
            type: number_slider
          tab: Model
          tool_mode: hidden
        usage_limits_agent_timeout:
          type: integer
          title: Usage Limits Agent Timeout
          description: The maximum number of seconds the agent can run for
          default: 120
          accordion: Model Parameters
          display:
            col_span: 12
            hide_number: true
            is_disabled: false
            is_subconfig: false
            label: Agent timeout
            max: 600
            min: 0
            needs_confirmation: false
            show_optional_label: false
            step: 1
            tooltip: Applies to each message.
            type: number_slider
          tab: Model
          tool_mode: hidden
        divider_11:
          type: string
          title: Divider 11
          default: ''
          accordion: Model Parameters
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_line: true
            show_optional_label: false
            spacing: 0
            type: divider
          tab: Model
          tool_mode: hidden
        compaction_enabled:
          type: boolean
          title: Compaction Enabled
          description: >-
            Automatically summarize old messages when context limit is
            approached.
          default: true
          accordion: Compaction Settings
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Conversation compaction
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Model
          tool_mode: hidden
        compaction_strategy:
          type: string
          title: Compaction Strategy
          description: How to compact conversation history when it grows too long.
          default: auto
          accordion: Compaction Settings
          display:
            col_span: 12
            icons: false
            is_clearable: false
            is_disabled: false
            is_horizontal: false
            is_searchable: false
            is_subconfig: false
            label: Compaction strategy
            needs_confirmation: false
            show_optional_label: false
            type: select
            values:
              - label: Auto (prefer provider-native)
                value: auto
              - label: Provider-native only
                value: provider
              - label: LLM summarization
                value: summarization
          rules:
            - config_source: compaction_enabled
              type: visible_if
              value: true
          tab: Model
          tool_mode: hidden
        compaction_threshold:
          type: number
          title: Compaction Threshold
          description: Fraction of context window that triggers compaction (0.01–0.95).
          default: 0.75
          accordion: Compaction Settings
          display:
            col_span: 12
            hide_number: true
            is_disabled: false
            is_subconfig: false
            label: Compaction threshold
            max: 0.95
            min: 0.01
            needs_confirmation: false
            show_optional_label: false
            step: 0.01
            tooltip: >-
              When token usage reaches this fraction of the context window,
              older messages are summarized.
            type: number_slider
          rules:
            - conds:
                - config_source: compaction_enabled
                  type: visible_if
                  value: true
                - conds:
                    - config_source: compaction_strategy
                      type: visible_if
                      value: auto
                    - config_source: compaction_strategy
                      type: visible_if
                      value: summarization
                  mode: or
                  type: visible_if_group
              mode: and
              type: visible_if_group
          tab: Model
          tool_mode: hidden
        compaction_tool_enabled:
          type: boolean
          title: Compaction Tool Enabled
          description: Expose a tool that lets the agent request compaction manually.
          default: false
          accordion: Compaction Settings
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Compaction tool
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            tooltip: >-
              When on, the agent can call `compact_conversation` to compact at
              will.
            type: toggle
          rules:
            - conds:
                - config_source: compaction_enabled
                  type: visible_if
                  value: true
                - conds:
                    - config_source: compaction_strategy
                      type: visible_if
                      value: auto
                    - config_source: compaction_strategy
                      type: visible_if
                      value: summarization
                  mode: or
                  type: visible_if_group
              mode: and
              type: visible_if_group
          tab: Model
          tool_mode: hidden
        tool_calling_section:
          type: string
          title: Tool Calling Section
          default: ''
          accordion: Model Parameters
          display:
            col_span: 10
            is_disabled: false
            is_subconfig: false
            label: ''
            needs_confirmation: false
            show_optional_label: false
            small_text: Configure how the agent handles tool execution and function calls.
            title: Tool calling
            type: ui_text_display
          tab: Model
          tool_mode: hidden
        parallel_tool_calls:
          type: boolean
          title: Parallel Tool Calls
          description: Whether to allow the agent to call multiple tools at the same time.
          default: true
          accordion: Model Parameters
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Parallel tool calls
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Model
          tool_mode: hidden
        tool_timeout:
          type: number
          title: Tool Timeout
          description: Maximum seconds a single tool call can run before timing out.
          default: 15
          accordion: Model Parameters
          display:
            col_span: 12
            hide_number: true
            is_disabled: false
            is_subconfig: false
            label: Tool timeout
            max: 300
            min: 1
            needs_confirmation: false
            show_optional_label: false
            step: 1
            tooltip: Per-tool-call timeout. The model retries on timeout.
            type: number_slider
          tab: Model
          tool_mode: hidden
        agent_flow_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Agent Flow Id
          description: The agent flow to use for the conversation
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: Agent flow
            needs_confirmation: false
            number_of_lines: 1
            placeholder: The agent flow to use for the conversation
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
          visible: false
        is_coworker:
          type: boolean
          title: Is Coworker
          description: Whether the agent is a co-worker
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Is co-worker
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        preset_selector:
          anyOf:
            - type: string
            - type: 'null'
          title: Preset Selector
          description: Choose a preset to get started quickly.
          display:
            button_label: Choose preset
            button_size: default
            button_variant: outline
            col_span: 12
            confirmation_message: >-
              Loading a preset will overwrite your persona, tone, instructions,
              and some model settings. Continue?
            is_disabled: false
            is_horizontal: true
            is_subconfig: false
            label: Quick start
            mixpanel_event: AGENT_PRESET_SELECTOR_CLICK
            needs_confirmation: true
            show_optional_label: false
            type: menu_select
            values:
              - description: Customer service agent for issue resolution
                label: Customer Operations
                value: customer_operations
              - description: Technical support specialist for troubleshooting
                label: IT Helpdesk
                value: it_helpdesk
              - description: Case management specialist for claims and workflows
                label: Case Management
                value: case_management
          rules:
            - target_fields:
                - persona
                - tone
                - extra_instructions
                - temperature
                - top_p
                - top_k
                - presence_penalty
                - frequency_penalty
                - parameter_preset
                - preset_selector
              type: sets_field_values
              value_map:
                case_management:
                  extra_instructions:
                    definition:
                      content:
                        - content:
                            - text: >-
                                - Review all case details thoroughly before
                                proceeding
                              type: text
                          type: paragraph
                        - content:
                            - text: >-
                                - Follow established procedures and compliance
                                requirements
                              type: text
                          type: paragraph
                        - content:
                            - text: '- Document all actions and decisions clearly'
                              type: text
                          type: paragraph
                        - content:
                            - text: >-
                                - Maintain accuracy and attention to detail
                                throughout the process
                              type: text
                          type: paragraph
                      type: doc
                    isRaw: false
                    text: >-
                      - Review all case details thoroughly before proceeding

                      - Follow established procedures and compliance
                      requirements

                      - Document all actions and decisions clearly

                      - Maintain accuracy and attention to detail throughout the
                      process
                  frequency_penalty: 0.5
                  parameter_preset: custom
                  persona:
                    definition:
                      content:
                        - content:
                            - text: >-
                                You are a detail-oriented case management
                                specialist with expertise in claims processing,
                                case review, and regulatory compliance. You are
                                methodical, thorough, and skilled at managing
                                complex workflows while ensuring accuracy and
                                adherence to procedures.
                              type: text
                          type: paragraph
                      type: doc
                    isRaw: false
                    text: >-
                      You are a detail-oriented case management specialist with
                      expertise in claims processing, case review, and
                      regulatory compliance. You are methodical, thorough, and
                      skilled at managing complex workflows while ensuring
                      accuracy and adherence to procedures.
                  presence_penalty: 0.3
                  temperature: 0.2
                  tone:
                    definition:
                      content:
                        - content:
                            - text: >-
                                Maintain a formal and professional tone at all
                                times. Use precise, business-appropriate
                                language. Be respectful and maintain clear
                                boundaries in all interactions.
                              type: text
                          type: paragraph
                      type: doc
                    isRaw: false
                    text: >-
                      Maintain a formal and professional tone at all times. Use
                      precise, business-appropriate language. Be respectful and
                      maintain clear boundaries in all interactions.
                  top_k: 25
                  top_p: 0.85
                customer_operations:
                  extra_instructions:
                    definition:
                      content:
                        - content:
                            - text: >-
                                - Always confirm customer details before taking
                                action
                              type: text
                          type: paragraph
                        - content:
                            - text: '- Provide concise step-by-step guidance'
                              type: text
                          type: paragraph
                        - content:
                            - text: '- Escalate complex cases politely when needed'
                              type: text
                          type: paragraph
                        - content:
                            - text: >-
                                - Maintain empathy and professionalism in all
                                interactions
                              type: text
                          type: paragraph
                      type: doc
                    isRaw: false
                    text: |-
                      - Always confirm customer details before taking action
                      - Provide concise step-by-step guidance
                      - Escalate complex cases politely when needed
                      - Maintain empathy and professionalism in all interactions
                  frequency_penalty: 0.6
                  parameter_preset: custom
                  persona:
                    definition:
                      content:
                        - content:
                            - text: >-
                                You are a knowledgeable and empathetic customer
                                operations agent who helps users resolve issues
                                quickly and clearly. You have deep expertise in
                                customer service best practices, issue
                                resolution, and maintaining positive customer
                                relationships.
                              type: text
                          type: paragraph
                      type: doc
                    isRaw: false
                    text: >-
                      You are a knowledgeable and empathetic customer operations
                      agent who helps users resolve issues quickly and clearly.
                      You have deep expertise in customer service best
                      practices, issue resolution, and maintaining positive
                      customer relationships.
                  presence_penalty: 0.4
                  temperature: 0.2
                  tone:
                    definition:
                      content:
                        - content:
                            - text: >-
                                Be professional yet personable. Provide clear
                                and engaging communication. Exercise good
                                judgment in matching tone to context.
                              type: text
                          type: paragraph
                      type: doc
                    isRaw: false
                    text: >-
                      Be professional yet personable. Provide clear and engaging
                      communication. Exercise good judgment in matching tone to
                      context.
                  top_k: 20
                  top_p: 0.85
                it_helpdesk:
                  extra_instructions:
                    definition:
                      content:
                        - content:
                            - text: >-
                                - Gather system information and error details
                                first
                              type: text
                          type: paragraph
                        - content:
                            - text: >-
                                - Provide step-by-step troubleshooting
                                instructions
                              type: text
                          type: paragraph
                        - content:
                            - text: '- Explain technical concepts in simple terms'
                              type: text
                          type: paragraph
                        - content:
                            - text: '- Document solutions for future reference'
                              type: text
                          type: paragraph
                      type: doc
                    isRaw: false
                    text: |-
                      - Gather system information and error details first
                      - Provide step-by-step troubleshooting instructions
                      - Explain technical concepts in simple terms
                      - Document solutions for future reference
                  frequency_penalty: 0.7
                  parameter_preset: custom
                  persona:
                    definition:
                      content:
                        - content:
                            - text: >-
                                You are an experienced IT helpdesk support
                                specialist with comprehensive knowledge of
                                technical troubleshooting, common software and
                                hardware issues, and system administration. You
                                excel at translating complex technical concepts
                                into simple, actionable guidance.
                              type: text
                          type: paragraph
                      type: doc
                    isRaw: false
                    text: >-
                      You are an experienced IT helpdesk support specialist with
                      comprehensive knowledge of technical troubleshooting,
                      common software and hardware issues, and system
                      administration. You excel at translating complex technical
                      concepts into simple, actionable guidance.
                  presence_penalty: 0.3
                  temperature: 0.2
                  tone:
                    definition:
                      content:
                        - content:
                            - text: >-
                                Be professional yet personable. Provide clear
                                and engaging communication. Exercise good
                                judgment in matching tone to context.
                              type: text
                          type: paragraph
                      type: doc
                    isRaw: false
                    text: >-
                      Be professional yet personable. Provide clear and engaging
                      communication. Exercise good judgment in matching tone to
                      context.
                  top_k: 25
                  top_p: 0.85
          tab: Prompt
          tool_mode: hidden
          visible: false
        introductory_message:
          anyOf:
            - items:
                $ref: '#/components/schemas/NoxusTipTapDocument-Output'
              type: array
            - type: 'null'
          title: Introductory Message
          description: The introductory message to use for the conversation.
          display:
            col_span: 12
            connector_name: ''
            hide_chip_options: false
            hide_toolbar: false
            is_disabled: false
            is_simple_text: false
            is_subconfig: false
            label: Introductory message
            needs_confirmation: false
            no_space_on_insert: false
            number_of_lines: 5
            placeholder: Hello, how can I help you today?
            show_optional_label: false
            type: rich_text_variables
          rules:
            - config_source: is_coworker
              type: visible_if
              value: true
          tab: Prompt
          tool_mode: hidden
        persona:
          anyOf:
            - items:
                $ref: '#/components/schemas/NoxusTipTapDocument-Output'
              type: array
            - type: 'null'
          title: Persona
          description: >-
            Describe who the co-worker is — their background, role, or point of
            view.
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Agent persona defining the AI's character, background, role, and
              point of view
            heuristic_types:
              - clarity
              - specificity
              - roleplaying
            improver_context: >-
              This is an AGENT PERSONA definition — a description of who the AI
              agent is. The output must read as a natural character description,
              NOT a structured task prompt. Do NOT include output format specs,
              JSON schemas, edge case sections, or task-type templates. Focus
              on: identity, background, personality traits, expertise, and point
              of view. Keep it concise (2-4 short paragraphs max). Write in
              second person ('You are...'). Be specific about the character but
              avoid copying any real or copyrighted personas.
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Persona
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Prompt
          tool_mode: hidden
        tone:
          anyOf:
            - items:
                $ref: '#/components/schemas/NoxusTipTapDocument-Output'
              type: array
            - type: 'null'
          title: Tone
          description: >-
            Define how the co-worker should communicate — its voice, attitude,
            and style.
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Agent tone and communication style defining voice, attitude, and
              writing style
            heuristic_types:
              - clarity
              - specificity
              - roleplaying
            improver_context: >-
              This is an AGENT TONE & STYLE definition — how the AI agent should
              communicate. The output must be a concise set of voice and style
              guidelines, NOT a structured task prompt. Do NOT include output
              format specs, JSON schemas, edge case sections, or task-type
              templates. Focus on: communication style, vocabulary level,
              formality, pacing, and attitude. Keep it concise (a short list of
              guidelines or 1-2 paragraphs max). Use direct instructions ('Use
              short sentences', 'Be encouraging', etc.).
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Tone & style
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Prompt
          tool_mode: hidden
        extra_instructions:
          anyOf:
            - additionalProperties: true
              type: object
            - type: string
            - type: 'null'
          title: Extra Instructions
          description: The main instructions that define how the chat flow should behave.
          display:
            class_name: h-[10rem]
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: true
            label: Instructions
            needs_confirmation: false
            number_of_lines: 1
            placeholder: >-
              What does this chat flow do? How should it behave? What are its
              capabilities? What are its limitations?
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        tools:
          items:
            oneOf:
              - $ref: '#/components/schemas/WebResearchSettings-Output'
              - $ref: '#/components/schemas/NoxusQaSettings-Output'
              - $ref: '#/components/schemas/KnowledgeBaseSelectorSettings-Output'
              - $ref: '#/components/schemas/KnowledgeBaseQaSettings-Output'
              - $ref: '#/components/schemas/WorkflowSettings-Output'
              - $ref: '#/components/schemas/AttachFileSettings'
              - $ref: '#/components/schemas/FlowTransitionSettings-Output'
              - $ref: '#/components/schemas/ChatflowSettings-Output'
              - $ref: '#/components/schemas/ChatflowExtractionSettings-Output'
              - $ref: '#/components/schemas/HumanInTheLoopSettings-Output'
              - $ref: '#/components/schemas/ChatflowTransitionSettings'
              - $ref: '#/components/schemas/AgentToolSettings-Output'
              - $ref: '#/components/schemas/MemorySettings-Output'
              - $ref: '#/components/schemas/ActionToolSettings-Output'
              - $ref: '#/components/schemas/ExcelSettings-Output'
              - $ref: '#/components/schemas/DocxSettings-Output'
              - $ref: '#/components/schemas/FileSystemSettings-Output'
              - $ref: '#/components/schemas/FileSettings-Output'
              - $ref: '#/components/schemas/TodoSettings-Output'
              - $ref: '#/components/schemas/SandboxSettings-Output'
              - $ref: '#/components/schemas/ScheduleToolSettings-Output'
              - $ref: '#/components/schemas/SubAgentSettings-Output'
              - $ref: '#/components/schemas/CodeExecutionSettings-Output'
              - $ref: '#/components/schemas/AgentMemorySettings-Output'
              - $ref: '#/components/schemas/CreateFilesSettings-Output'
              - $ref: '#/components/schemas/DocumentationSettings-Output'
              - $ref: '#/components/schemas/ImageGenerationSettings-Output'
            discriminator:
              propertyName: type
              mapping:
                action:
                  $ref: '#/components/schemas/ActionToolSettings-Output'
                agent_memory:
                  $ref: '#/components/schemas/AgentMemorySettings-Output'
                agent_tool:
                  $ref: '#/components/schemas/AgentToolSettings-Output'
                attach_file:
                  $ref: '#/components/schemas/AttachFileSettings'
                chatflow:
                  $ref: '#/components/schemas/ChatflowSettings-Output'
                chatflow_extraction:
                  $ref: '#/components/schemas/ChatflowExtractionSettings-Output'
                chatflow_transition:
                  $ref: '#/components/schemas/ChatflowTransitionSettings'
                code_execution:
                  $ref: '#/components/schemas/CodeExecutionSettings-Output'
                create_files:
                  $ref: '#/components/schemas/CreateFilesSettings-Output'
                documentation:
                  $ref: '#/components/schemas/DocumentationSettings-Output'
                docx:
                  $ref: '#/components/schemas/DocxSettings-Output'
                excel:
                  $ref: '#/components/schemas/ExcelSettings-Output'
                files:
                  $ref: '#/components/schemas/FileSettings-Output'
                filesystem:
                  $ref: '#/components/schemas/FileSystemSettings-Output'
                flow_transition:
                  $ref: '#/components/schemas/FlowTransitionSettings-Output'
                human_in_the_loop:
                  $ref: '#/components/schemas/HumanInTheLoopSettings-Output'
                image_generation:
                  $ref: '#/components/schemas/ImageGenerationSettings-Output'
                kb_qa:
                  $ref: '#/components/schemas/KnowledgeBaseQaSettings-Output'
                kb_selector:
                  $ref: '#/components/schemas/KnowledgeBaseSelectorSettings-Output'
                memory:
                  $ref: '#/components/schemas/MemorySettings-Output'
                noxus_qa:
                  $ref: '#/components/schemas/NoxusQaSettings-Output'
                sandbox:
                  $ref: '#/components/schemas/SandboxSettings-Output'
                schedule_tool:
                  $ref: '#/components/schemas/ScheduleToolSettings-Output'
                subagent:
                  $ref: '#/components/schemas/SubAgentSettings-Output'
                todos:
                  $ref: '#/components/schemas/TodoSettings-Output'
                web_research:
                  $ref: '#/components/schemas/WebResearchSettings-Output'
                workflow:
                  $ref: '#/components/schemas/WorkflowSettings-Output'
          type: array
          title: Tools
          default: []
          tab: Configuration
          tool_mode: hidden
          visible: false
        mcp_servers:
          items:
            $ref: '#/components/schemas/MCPServerBinding'
          type: array
          title: Mcp Servers
          description: Workspace MCP credentials this agent can call tools on.
          default: []
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: MCP Servers
            needs_confirmation: false
            show_optional_label: false
            type: mcp_credential_select
          tab: Actions
          tool_mode: hidden
        skills_enabled:
          type: boolean
          title: Skills Enabled
          description: Extend agent capabilities with markdown-based skill packages.
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Skills
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Knowledge
          tool_mode: hidden
          visible: false
        convert_unsupported_files_to_text:
          type: boolean
          title: Convert Unsupported Files To Text
          description: >-
            When an attached file's type can't be sent to the model as a native
            attachment (e.g. JSON, CSV, XML, Markdown), inline its text content
            into the prompt instead of failing the run. PDFs and images are
            always sent as attachments.
          default: true
          accordion: Advanced
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Convert unsupported files to text
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Prompt
          tool_mode: hidden
        skills:
          items:
            $ref: '#/components/schemas/SkillConfig'
          type: array
          title: Skills
          default: []
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Skills
            needs_confirmation: false
            show_optional_label: false
            type: skills_list
          tab: Knowledge
          tool_mode: hidden
        subagents_enabled:
          type: boolean
          title: Subagents Enabled
          description: Delegate tasks to specialized subagents for parallel execution.
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Subagents
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Actions
          tool_mode: hidden
          visible: false
        subagents:
          items:
            $ref: '#/components/schemas/SubAgentDefinition'
          type: array
          title: Subagents
          default: []
          accordion: Subagent options
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Subagents
            needs_confirmation: false
            show_optional_label: false
            type: subagents_list
          tab: Actions
          tool_mode: hidden
        subagents_instructions:
          anyOf:
            - items:
                $ref: '#/components/schemas/NoxusTipTapDocument-Output'
              type: array
            - type: 'null'
          title: Subagents Instructions
          description: Tell the agent when to hand work to a subagent.
          accordion: Subagent options
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: false
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: When to delegate
            needs_confirmation: false
            number_of_lines: 4
            placeholder: >-
              e.g. Delegate research that needs more than a few searches. Keep
              drafting and formatting for yourself.
            show_optional_label: false
            type: rich_text_variables_ai
          rules:
            - config_source: subagents_enabled
              type: visible_if
              value: true
          tab: Actions
          tool_mode: hidden
        subagents_model:
          items:
            type: string
          type: array
          title: Subagents Model
          description: >-
            Model the subagents run on. Specialists that pick their own model
            override this; an empty selection falls back to the agent's model.
          default:
            - preset:cost
          accordion: Subagent options
          display:
            col_span: 12
            default_preset: cost
            endpoint: /models/llms
            hide_disabled_models: true
            is_disabled: false
            is_subconfig: false
            label: Subagent model
            layout: side_by_side
            model_limit: 3
            model_type: text
            needs_confirmation: false
            show_inline_presets: true
            show_optional_label: false
            show_presets: true
            type: model_select
          optional: true
          rules:
            - config_source: subagents_enabled
              type: visible_if
              value: true
          tab: Actions
          tool_mode: hidden
        guidelines_enabled:
          type: boolean
          title: Guidelines Enabled
          description: Enable behavioral guidelines that shape how the agent responds.
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Enable Guidelines
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Prompt
          tool_mode: hidden
          visible: false
        guidelines:
          items:
            $ref: '#/components/schemas/GuidelineConfig'
          type: array
          title: Guidelines
          default: []
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Guidelines
            needs_confirmation: false
            show_optional_label: false
            type: guidelines_list
          tab: Prompt
          tool_mode: hidden
        glossary:
          items:
            $ref: '#/components/schemas/GlossaryTermConfig'
          type: array
          title: Glossary
          default: []
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Glossary
            needs_confirmation: false
            show_optional_label: false
            type: glossary_list
          tab: Prompt
          tool_mode: hidden
        memories:
          items:
            $ref: '#/components/schemas/AgentMemoryEntry'
          type: array
          title: Memories
          description: Persistent memory across all conversations
          default: []
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Agent Memory
            needs_confirmation: false
            show_optional_label: false
            type: agent_memory_field
          tab: Knowledge
          tool_mode: hidden
        hidden_tools:
          items:
            type: string
          type: array
          title: Hidden Tools
          description: Tool calls that never appear in the chat activity feed.
          default:
            - todos_read_todos
            - todos_add_todo
            - todos_write_todos
            - todos_update_todo_status
            - todos_remove_todo
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Hidden tools
            needs_confirmation: false
            show_optional_label: false
            tooltip: Toggled-on tools never appear in the chat activity feed.
            type: tool_select
          tab: Display
          tool_mode: hidden
          visible: false
      type: object
      title: ChatflowSettingsConfig
    AppSettingsV2:
      properties:
        is_active:
          type: boolean
          title: Is Active
          default: false
        version_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Version Id
        interface_type:
          anyOf:
            - $ref: '#/components/schemas/AppInterfaceType'
            - type: 'null'
        extra_settings:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Extra Settings
        published_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Published At
      type: object
      title: AppSettingsV2
    Trigger:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        group_id:
          type: string
          format: uuid
          title: Group Id
        workflow_id:
          type: string
          format: uuid
          title: Workflow Id
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        definition:
          additionalProperties: true
          type: object
          title: Definition
        routing_key:
          type: string
          title: Routing Key
        workflow_version_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Workflow Version Id
        last_run_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Run At
        last_fired_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Fired At
        last_error:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Last Error
      type: object
      required:
        - id
        - group_id
        - workflow_id
        - definition
        - routing_key
      title: Trigger
    WorkflowTag:
      properties:
        value:
          type: string
          title: Value
        color:
          type: string
          title: Color
      type: object
      required:
        - value
        - color
      title: WorkflowTag
    WorkflowLogSheet:
      properties:
        name:
          type: string
          title: Name
        id:
          type: string
          title: Id
        time_created:
          type: string
          title: Time Created
      type: object
      required:
        - name
        - id
        - time_created
      title: WorkflowLogSheet
    WorkflowLogColumn:
      properties:
        name:
          type: string
          title: Name
        visible:
          type: boolean
          title: Visible
          default: true
      type: object
      required:
        - name
      title: WorkflowLogColumn
    WorkflowLogSpreadsheet:
      properties:
        name:
          type: string
          title: Name
        id:
          type: string
          title: Id
        timestamp:
          type: string
          title: Timestamp
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
      type: object
      required:
        - name
        - id
        - timestamp
      title: WorkflowLogSpreadsheet
    EntitySource:
      type: string
      enum:
        - genie
        - user
      title: EntitySource
      description: >-
        Who authored an entity (or version). Absent/``user`` means a person made

        it; ``genie`` marks something the platform assistant created on their
        behalf,

        so the frontend can badge it.
    GuardrailValue:
      properties:
        value:
          type: string
          title: Value
          default: 'Off'
        context:
          type: string
          title: Context
          default: ''
      type: object
      title: GuardrailValue
    NoxusTipTapDocument-Output:
      properties:
        text:
          type: string
          title: Text
        definition:
          $ref: '#/components/schemas/TiptapDocument-Output'
      type: object
      required:
        - text
      title: NoxusTipTapDocument
    WebResearchSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Web Research
        description:
          type: string
          title: Description
          default: Search the web for information
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          description: The category of the tool
          default: QuickAction
        enabled:
          type: boolean
          title: Enabled
          description: Whether the tool is enabled
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Enabled
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: Globe
          tab: Configuration
          tool_mode: hidden
          visible: false
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Searching the web...
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: Start message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when the web search starts.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Searched the web
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: End message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when the web search completes.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          description: Whether the tool is visible
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Visible
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        icon:
          type: string
          title: Icon
          default: Globe
        bg_color:
          type: string
          title: Bg Color
          default: '#D1FADF'
        icon_color:
          type: string
          title: Icon Color
          default: '#027A48'
        chatflow_usable:
          type: boolean
          title: Chatflow Usable
          description: Whether the tool is usable in a chatflow
          default: true
        deprecated:
          type: boolean
          title: Deprecated
          description: >-
            Whether this tool type is deprecated and should be hidden from the
            UI
          default: false
        type:
          type: string
          const: web_research
          title: Type
          default: web_research
      type: object
      title: WebResearchSettings
    NoxusQaSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Noxus Q&A
        description:
          type: string
          title: Description
          default: Noxus Q&A
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          default: QuickAction
        enabled:
          type: boolean
          title: Enabled
          default: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: Bot
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Noxus Q&A
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Noxus Q&A complete
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          description: Whether the tool is visible
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Visible
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        icon:
          type: string
          title: Icon
          default: Bot
        bg_color:
          type: string
          title: Bg Color
          default: '#EFF6FF'
        icon_color:
          type: string
          title: Icon Color
          default: '#2B7FFF'
        chatflow_usable:
          type: boolean
          title: Chatflow Usable
          default: false
        deprecated:
          type: boolean
          title: Deprecated
          default: true
        type:
          type: string
          const: noxus_qa
          title: Type
          default: noxus_qa
      type: object
      title: NoxusQaSettings
    KnowledgeBaseSelectorSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: KB Selector
        description:
          type: string
          title: Description
          default: Allows the user to select a knowledge base for your co-worker
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          description: The category of the tool
          default: QuickAction
        enabled:
          type: boolean
          title: Enabled
          description: Whether the tool is enabled
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Enabled
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: Search
          tab: Configuration
          tool_mode: hidden
          visible: false
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Searching knowledge base...
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: Start message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when the knowledge base search starts.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Knowledge base search complete
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: End message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when the knowledge base search completes.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          description: Whether the tool is visible
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Visible
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        icon:
          type: string
          title: Icon
          default: Folder
        bg_color:
          type: string
          title: Bg Color
          default: '#FEF9C2'
        icon_color:
          type: string
          title: Icon Color
          default: '#894B00'
        chatflow_usable:
          type: boolean
          title: Chatflow Usable
          default: false
        deprecated:
          type: boolean
          title: Deprecated
          default: true
        type:
          type: string
          const: kb_selector
          title: Type
          default: kb_selector
      type: object
      title: KnowledgeBaseSelectorSettings
      description: >-
        Tool that allows the user to select a knowledge base to answer questions
        about
    KnowledgeBaseQaSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Knowledge Base Q&A
          tab: Configuration
          tool_mode: hidden
          visible: false
        description:
          type: string
          title: Description
          default: Answer questions about the knowledge base
          tab: Configuration
          tool_mode: hidden
          visible: false
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          default: Knowledge
          tab: Configuration
          tool_mode: hidden
          visible: false
        enabled:
          type: boolean
          title: Enabled
          description: Whether the tool is enabled
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Enabled
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: Search
          tab: Configuration
          tool_mode: hidden
          visible: false
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Searching knowledge base...
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: Start message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when the knowledge base search starts.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Knowledge base search complete
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: End message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when the knowledge base search completes.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          description: Whether the tool is visible
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Visible
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        type:
          type: string
          const: kb_qa
          title: Type
          default: kb_qa
          tab: Configuration
          tool_mode: hidden
          visible: false
        kb_id:
          type: string
          format: uuid
          title: Kb Id
          tab: Configuration
          tool_mode: hidden
          visible: false
        advanced_search:
          type: boolean
          title: Advanced Search
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Advanced search tools
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            tooltip: >-
              The agent chooses the best search method (overrides the KB
              configured retrieval method).
            type: toggle
          tab: Configuration
          tool_mode: hidden
        private:
          type: boolean
          title: Private
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Private knowledge base
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            tooltip: The agent won’t cite this knowledge base as a source.
            type: toggle
          tab: Configuration
          tool_mode: hidden
        enable_browse_tools:
          type: boolean
          title: Enable Browse Tools
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Enable File system tools
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            tooltip: >-
              Enable kb_tree and kb_ls tools for navigating the knowledge base
              file system.
            type: toggle
          tab: Configuration
          tool_mode: hidden
        include_tree_in_instructions:
          type: boolean
          title: Include Tree In Instructions
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Include File system structure in instructions
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            tooltip: >-
              Inline this KB's folder tree into the system prompt every turn.
              Saves the agent a kb_tree round-trip but increases prompt size —
              keep depth low for large KBs.
            type: toggle
          rules:
            - config_source: enable_browse_tools
              type: visible_if
              value: true
          tab: Configuration
          tool_mode: hidden
        tree_depth_in_instructions:
          type: integer
          title: Tree Depth In Instructions
          default: 3
          display:
            col_span: 12
            hide_number: true
            is_disabled: false
            is_subconfig: false
            label: Tree depth in instructions
            max: 10
            min: 1
            needs_confirmation: false
            show_optional_label: false
            step: 1
            tooltip: How many folder levels to include (1-10).
            type: number_slider
          rules:
            - config_source: enable_browse_tools
              type: visible_if
              value: true
            - config_source: include_tree_in_instructions
              type: visible_if
              value: true
          tab: Configuration
          tool_mode: hidden
        link_references_to_noxus_file:
          type: boolean
          title: Link References To Noxus File
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Link references to the file in Noxus
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            tooltip: >-
              Point citations at the copy stored in Noxus instead of the
              document's original source (e.g. Google Drive). Use when users may
              not have access to the source location.
            type: toggle
          tab: Configuration
          tool_mode: hidden
      type: object
      required:
        - kb_id
      title: KnowledgeBaseQaSettings
      description: >-
        Tool that allows the user to answer questions about a specific
        pre-selected knowledge base
    WorkflowSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Workflow Runner
          tab: Configuration
          tool_mode: hidden
          visible: false
        description:
          type: string
          title: Description
          default: Run a workflow
          tab: Configuration
          tool_mode: hidden
          visible: false
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          default: Flows
          tab: Configuration
          tool_mode: hidden
          visible: false
        enabled:
          type: boolean
          title: Enabled
          description: Whether the tool is enabled
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Enabled
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          description: The lucide icon to display for this tool
          default: Cog
          tab: Configuration
          tool_mode: hidden
          visible: false
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Running a workflow
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: Start message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when the workflow starts.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Workflow run complete
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: End message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when the workflow finishes.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          description: Whether the tool is visible
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Visible
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        type:
          type: string
          const: workflow
          title: Type
          default: workflow
          tab: Configuration
          tool_mode: hidden
          visible: false
        workflow_id:
          type: string
          format: uuid
          title: Workflow Id
          description: >-
            The ID of the workflow to run. Comes unselected, and should be
            selected by the user.
          tab: Configuration
          tool_mode: hidden
          visible: false
        inputs_descriptions:
          additionalProperties:
            type: string
          type: object
          title: Inputs Descriptions
          description: A dictionary of input names to descriptions.
          tab: Configuration
          tool_mode: hidden
          visible: false
        version_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Version Id
          description: >-
            The ID of the version of the workflow to run. Comes unselected, and
            should be selected by the user.
          tab: Configuration
          tool_mode: hidden
          visible: false
      type: object
      required:
        - workflow_id
      title: WorkflowSettings
    AttachFileSettings:
      properties:
        title:
          type: string
          title: Title
          default: Add Files
        description:
          type: string
          title: Description
          default: >-
            Allows the user to add files to the conversation for the agent to
            access.
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          description: The category of the tool
          default: QuickAction
        enabled:
          type: boolean
          title: Enabled
          default: true
        tool_display_icon:
          type: string
          title: Tool Display Icon
          description: The lucide icon to display for this tool
          default: Cog
          tab: Configuration
          tool_mode: hidden
          visible: false
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          description: The message to display to the user when the tool is called.
          default: Running tool...
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: Start message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when the tool starts.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          description: The message to display to the user when the tool completes.
          default: Tool complete
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: End message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when the tool completes.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        extra_instructions:
          anyOf:
            - type: string
            - type: 'null'
          title: Extra Instructions
        requires_approval:
          type: boolean
          title: Requires Approval
          default: false
        visible:
          type: boolean
          title: Visible
          default: false
        icon:
          type: string
          title: Icon
          default: Paperclip
        bg_color:
          type: string
          title: Bg Color
          default: '#EFF6FF'
        icon_color:
          type: string
          title: Icon Color
          default: '#2B7FFF'
        chatflow_usable:
          type: boolean
          title: Chatflow Usable
          default: false
        deprecated:
          type: boolean
          title: Deprecated
          default: true
        type:
          type: string
          const: attach_file
          title: Type
          default: attach_file
      type: object
      title: AttachFileSettings
    FlowTransitionSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Flow Transition
        description:
          type: string
          title: Description
          default: Transition to a different flow
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          default: Chatflow
        enabled:
          type: boolean
          title: Enabled
          description: Whether the tool is enabled
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Enabled
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          description: The lucide icon to display for this tool
          default: Cog
          tab: Configuration
          tool_mode: hidden
          visible: false
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          description: The message to display to the user when the tool is called.
          default: Running tool...
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: Start message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when the tool starts.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          description: The message to display to the user when the tool completes.
          default: Tool complete
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: End message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when the tool completes.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          description: Whether the tool is visible
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Visible
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        type:
          type: string
          const: flow_transition
          title: Type
          default: flow_transition
        transition:
          $ref: '#/components/schemas/Transition'
          description: The transition to make
      type: object
      required:
        - transition
      title: FlowTransitionSettings
    ChatflowSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Chatflow
        description:
          type: string
          title: Description
          default: Chatflow
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          default: Chatflow
        enabled:
          type: boolean
          title: Enabled
          description: Whether the tool is enabled
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Enabled
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          description: The lucide icon to display for this tool
          default: Cog
          tab: Configuration
          tool_mode: hidden
          visible: false
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          description: The message to display to the user when the tool is called.
          default: Running tool...
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: Start message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when the tool starts.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          description: The message to display to the user when the tool completes.
          default: Tool complete
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: End message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when the tool completes.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          description: Whether the tool is visible
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Visible
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        type:
          type: string
          const: chatflow
          title: Type
          default: chatflow
        chatflow_instructions:
          type: string
          title: Chatflow Instructions
          description: The instructions for the chatflow
        chatflow_criteria:
          anyOf:
            - type: string
            - type: 'null'
          title: Chatflow Criteria
          description: The criteria for the chatflow
        mode:
          type: string
          enum:
            - choose_path
            - extract
            - response
          title: Mode
      type: object
      required:
        - chatflow_instructions
        - chatflow_criteria
        - mode
      title: ChatflowSettings
    ChatflowExtractionSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Chatflow Extraction
        description:
          type: string
          title: Description
          default: Extract data in a chatflow
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          default: Chatflow
        enabled:
          type: boolean
          title: Enabled
          description: Whether the tool is enabled
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Enabled
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          description: The lucide icon to display for this tool
          default: Cog
          tab: Configuration
          tool_mode: hidden
          visible: false
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          description: The message to display to the user when the tool is called.
          default: Running tool...
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: Start message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when the tool starts.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          description: The message to display to the user when the tool completes.
          default: Tool complete
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: End message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when the tool completes.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          description: Whether the tool is visible
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Visible
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        type:
          type: string
          const: chatflow_extraction
          title: Type
          default: chatflow_extraction
        response_format:
          title: Response Format
          description: The transition to make
      type: object
      required:
        - response_format
      title: ChatflowExtractionSettings
    HumanInTheLoopSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Human in the Loop
        description:
          type: string
          title: Description
          default: Human in the Loop
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          description: The category of the tool
          default: QuickAction
        enabled:
          type: boolean
          title: Enabled
          default: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: PersonStanding
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Escalating to human operator...
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Escalated to human operator
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          description: Whether the tool is visible
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Visible
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        icon:
          type: string
          title: Icon
          default: PersonStanding
        bg_color:
          type: string
          title: Bg Color
          default: blue.50
        icon_color:
          type: string
          title: Icon Color
          default: blue.500
        chatflow_usable:
          type: boolean
          title: Chatflow Usable
          description: Whether the tool is usable in a chatflow
          default: true
        deprecated:
          type: boolean
          title: Deprecated
          description: >-
            Whether this tool type is deprecated and should be hidden from the
            UI
          default: false
        type:
          type: string
          const: human_in_the_loop
          title: Type
          default: human_in_the_loop
        has_timeout:
          type: boolean
          title: Has Timeout
          default: false
        timeout:
          anyOf:
            - type: integer
            - type: 'null'
          title: Timeout
        handover_message:
          type: string
          title: Handover Message
          default: You are now talking to the co-worker.
      type: object
      title: HumanInTheLoopSettings
    ChatflowTransitionSettings:
      properties:
        title:
          type: string
          title: Title
          default: Chatflow Transition
          tab: Configuration
          tool_mode: hidden
          visible: false
        description:
          type: string
          title: Description
          default: Transition to a different chatflow state
          tab: Configuration
          tool_mode: hidden
          visible: false
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          default: Chatflow
          tab: Configuration
          tool_mode: hidden
          visible: false
        enabled:
          type: boolean
          title: Enabled
          description: Whether the tool is enabled
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Enabled
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          description: The lucide icon to display for this tool
          default: Cog
          tab: Configuration
          tool_mode: hidden
          visible: false
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          description: The message to display to the user when the tool is called.
          default: Running tool...
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: Start message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when the tool starts.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          description: The message to display to the user when the tool completes.
          default: Tool complete
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: End message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when the tool completes.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        extra_instructions:
          anyOf:
            - type: string
            - type: 'null'
          title: Extra Instructions
          description: The condition for the chat flow to proceed out of this node.
          default: You are done when the user has confirmed that you can proceed.
          display:
            class_name: h-[10rem]
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: true
            label: Transition criteria
            needs_confirmation: false
            number_of_lines: 5
            placeholder: >-
              E.g. You are done when the user has confirmed that you can
              proceed.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          description: Whether the tool is visible
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Visible
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        type:
          type: string
          const: chatflow_transition
          title: Type
          default: chatflow_transition
          tab: Configuration
          tool_mode: hidden
          visible: false
        transition_key:
          type: string
          title: Transition Key
          description: >-
            A unique name that identifies the transition and maps to an output
            of the node.
          display:
            class_name: h-[1rem]
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: Transition name
            needs_confirmation: false
            number_of_lines: 1
            placeholder: A name for the transition
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
      type: object
      required:
        - transition_key
      title: ChatflowTransitionSettings
    AgentToolSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Agent Tool
          tab: Configuration
          tool_mode: hidden
          visible: false
        description:
          type: string
          title: Description
          default: Call another co-worker
          tab: Configuration
          tool_mode: hidden
          visible: false
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          default: Agents
          tab: Configuration
          tool_mode: hidden
          visible: false
        enabled:
          type: boolean
          title: Enabled
          description: Whether the tool is enabled
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Enabled
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: Bot
          tab: Configuration
          tool_mode: hidden
          visible: false
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Calling co-worker
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: Start message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when calling the co-worker.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Co-worker responded
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: End message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed after the co-worker responds.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          description: Whether the tool is visible
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Visible
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        type:
          type: string
          const: agent_tool
          title: Type
          default: agent_tool
          tab: Configuration
          tool_mode: hidden
          visible: false
        agent_id:
          type: string
          format: uuid
          title: Agent Id
          description: >-
            The ID of the agent to call. Comes unselected, and should be
            selected by the user.
          tab: Configuration
          tool_mode: hidden
          visible: false
        max_clarification_turns:
          type: integer
          title: Max Clarification Turns
          description: >-
            How many times this co-worker can ask follow-up questions before
            giving a final answer. Set to 0 to require an immediate response
            with no back-and-forth.
          default: 2
          display:
            col_span: 12
            hide_number: false
            is_disabled: false
            is_subconfig: false
            label: Follow-up questions allowed
            max: 10
            min: 0
            needs_confirmation: false
            show_optional_label: false
            step: 1
            type: number_slider
          tab: Configuration
          tool_mode: hidden
      type: object
      required:
        - agent_id
      title: AgentToolSettings
    MemorySettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Memory
        description:
          type: string
          title: Description
          default: Persistent memory during a single conversation
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          description: The category of the tool
          default: QuickAction
        enabled:
          type: boolean
          title: Enabled
          default: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: Brain
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Accessing memory...
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Memory operation complete
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          description: Whether the tool is visible
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Visible
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        icon:
          type: string
          title: Icon
          default: Brain
        bg_color:
          type: string
          title: Bg Color
          default: '#f5f3ff'
        icon_color:
          type: string
          title: Icon Color
          default: '#8e51ff'
        chatflow_usable:
          type: boolean
          title: Chatflow Usable
          description: Whether the tool is usable in a chatflow
          default: true
        deprecated:
          type: boolean
          title: Deprecated
          description: >-
            Whether this tool type is deprecated and should be hidden from the
            UI
          default: false
        type:
          type: string
          const: memory
          title: Type
          default: memory
      type: object
      title: MemorySettings
    ActionToolSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Actions
        description:
          type: string
          title: Description
          default: Execute workflow actions
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          default: Actions
        enabled:
          type: boolean
          title: Enabled
          default: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: Zap
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Running action...
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Action complete
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          description: Whether the tool is visible
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Visible
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        type:
          type: string
          const: action
          title: Type
          default: action
        icon:
          type: string
          title: Icon
          default: Zap
        bg_color:
          type: string
          title: Bg Color
          default: '#FEF3C7'
        icon_color:
          type: string
          title: Icon Color
          default: '#F59E0B'
        node_name:
          type: string
          title: Node Name
          description: The name of the node/action to execute
        tool_config:
          anyOf:
            - $ref: '#/components/schemas/ActionToolConfig'
            - type: 'null'
      type: object
      required:
        - node_name
      title: ActionToolSettings
    ExcelSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Excel
        description:
          type: string
          title: Description
          default: Read, analyze, and modify Excel spreadsheets
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          description: The category of the tool
          default: QuickAction
        enabled:
          type: boolean
          title: Enabled
          default: true
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: FileSpreadsheet
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Analyzing spreadsheet...
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Spreadsheet analysis complete
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          default: false
        icon:
          type: string
          title: Icon
          default: FileSpreadsheet
        bg_color:
          type: string
          title: Bg Color
          default: '#dcfce7'
        icon_color:
          type: string
          title: Icon Color
          default: '#16a34a'
        chatflow_usable:
          type: boolean
          title: Chatflow Usable
          description: Whether the tool is usable in a chatflow
          default: true
        deprecated:
          type: boolean
          title: Deprecated
          default: true
        type:
          type: string
          const: excel
          title: Type
          default: excel
        enable_python_sandbox:
          type: boolean
          title: Enable Python Sandbox
          default: false
        enable_formula_eval:
          type: boolean
          title: Enable Formula Eval
          default: false
        experimental:
          type: boolean
          title: Experimental
          default: false
      type: object
      title: ExcelSettings
    DocxSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Word Document
        description:
          type: string
          title: Description
          default: Read, edit, and comment on Word (.docx) files using track changes.
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          description: The category of the tool
          default: QuickAction
        enabled:
          type: boolean
          title: Enabled
          default: true
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: FileText
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Editing Word document...
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Word document edit complete
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          default: false
        icon:
          type: string
          title: Icon
          default: FileText
        bg_color:
          type: string
          title: Bg Color
          default: '#dbeafe'
        icon_color:
          type: string
          title: Icon Color
          default: '#2563eb'
        chatflow_usable:
          type: boolean
          title: Chatflow Usable
          description: Whether the tool is usable in a chatflow
          default: true
        deprecated:
          type: boolean
          title: Deprecated
          default: true
        type:
          type: string
          const: docx
          title: Type
          default: docx
        author_name:
          type: string
          title: Author Name
          description: Author shown on track-change revisions and comments.
          default: Docx Agent
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: Track-change author
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Docx Agent
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
      type: object
      title: DocxSettings
    FileSystemSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: File System
        description:
          type: string
          title: Description
          default: Access and read files in the current session
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          description: The category of the tool
          default: QuickAction
        enabled:
          type: boolean
          title: Enabled
          default: true
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: FolderOpen
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Accessing file system...
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: File system operation complete
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          default: false
        icon:
          type: string
          title: Icon
          default: FolderOpen
        bg_color:
          type: string
          title: Bg Color
          default: '#fef3c7'
        icon_color:
          type: string
          title: Icon Color
          default: '#f59e0b'
        chatflow_usable:
          type: boolean
          title: Chatflow Usable
          description: Whether the tool is usable in a chatflow
          default: true
        deprecated:
          type: boolean
          title: Deprecated
          description: >-
            Whether this tool type is deprecated and should be hidden from the
            UI
          default: false
        type:
          type: string
          const: filesystem
          title: Type
          default: filesystem
      type: object
      title: FileSystemSettings
    FileSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Files
        description:
          type: string
          title: Description
          default: Attach, generate, and work with files.
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          description: The category of the tool
          default: QuickAction
        enabled:
          type: boolean
          title: Enabled
          default: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: Files
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Working with files...
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Done
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          description: Whether the tool is visible
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Visible
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        icon:
          type: string
          title: Icon
          default: Files
        bg_color:
          type: string
          title: Bg Color
          default: '#EFF6FF'
        icon_color:
          type: string
          title: Icon Color
          default: '#2B7FFF'
        chatflow_usable:
          type: boolean
          title: Chatflow Usable
          description: Whether the tool is usable in a chatflow
          default: true
        deprecated:
          type: boolean
          title: Deprecated
          description: >-
            Whether this tool type is deprecated and should be hidden from the
            UI
          default: false
        type:
          type: string
          const: files
          title: Type
          default: files
        allow_html_graphs:
          type: boolean
          title: Allow Html Graphs
          description: >-
            Instruct the agent to use self-contained HTML (Plotly, Chart.js,
            ...) when generating charts and visualizations.
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Use HTML for charts
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        show_inline:
          type: boolean
          title: Show Inline
          description: Render HTML and images directly in the chat instead of as a card.
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Render artifacts inline
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        custom_author_name:
          type: boolean
          title: Custom Author Name
          description: >-
            Use a custom author for track-change revisions and comments. When
            off, the agent's name is used.
          default: false
          accordion: Word documents (.docx)
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Custom track-change author
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        author_name:
          type: string
          title: Author Name
          description: >-
            Author shown on track-change revisions and comments. Defaults to the
            agent's name when left unset.
          default: ''
          accordion: Word documents (.docx)
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: Track-change author
            needs_confirmation: false
            number_of_lines: 1
            placeholder: The agent's name
            show_optional_label: false
            show_refresh: false
            type: text
          rules:
            - config_source: custom_author_name
              type: visible_if
              value: true
          tab: Configuration
          tool_mode: hidden
        enable_python_sandbox:
          type: boolean
          title: Enable Python Sandbox
          description: Run pandas/Python over the workbook in the sandbox.
          default: false
          accordion: Spreadsheets (Excel)
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Python sandbox
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        enable_formula_eval:
          type: boolean
          title: Enable Formula Eval
          description: Evaluate spreadsheet formulas via the formulas library.
          default: false
          accordion: Spreadsheets (Excel)
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Formula evaluation
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        experimental:
          type: boolean
          title: Experimental
          description: Enable every experimental spreadsheet tool above.
          default: false
          accordion: Spreadsheets (Excel)
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: All experimental spreadsheet tools
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
      type: object
      title: FileSettings
      description: >-
        Unified file capability for the agent.


        One master toggle that, when on, lets the user attach files and lets the

        agent generate + present them (``create_file``, ``present_file``,

        ``sandbox_publish_file``). Word (.docx) and Excel editing are offered

        on-demand whenever a matching file is in the session — no separate
        toggles.


        The always-on session-file reader (``list_files``/``read_file``) is a

        separate, hidden capability (``FileSystemSettings``) and is unaffected.
    TodoSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Task Tracking
        description:
          type: string
          title: Description
          default: Track and manage tasks during the conversation
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          description: The category of the tool
          default: QuickAction
        enabled:
          type: boolean
          title: Enabled
          default: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: ListTodo
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Managing tasks...
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Tasks updated
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          description: Whether the tool is visible
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Visible
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        icon:
          type: string
          title: Icon
          default: ListTodo
        bg_color:
          type: string
          title: Bg Color
          default: '#f0fdf4'
        icon_color:
          type: string
          title: Icon Color
          default: '#16a34a'
        chatflow_usable:
          type: boolean
          title: Chatflow Usable
          description: Whether the tool is usable in a chatflow
          default: true
        deprecated:
          type: boolean
          title: Deprecated
          description: >-
            Whether this tool type is deprecated and should be hidden from the
            UI
          default: false
        type:
          type: string
          const: todos
          title: Type
          default: todos
        enable_subtasks:
          type: boolean
          title: Enable Subtasks
          description: Enable subtask hierarchy and dependency features
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Enable Subtasks
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
      type: object
      title: TodoSettings
      description: |-
        Settings for the task tracking toolset.

        Wraps pydantic-ai-todo's create_todo_toolset() with Noxus settings.
        Todos are persisted in conversation.memory["todos"].
    SandboxSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Sandbox
        description:
          type: string
          title: Description
          default: File operations and command execution in isolated sandbox
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          description: The category of the tool
          default: QuickAction
        enabled:
          type: boolean
          title: Enabled
          default: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: Terminal
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Working in sandbox...
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Command complete
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          description: Whether the tool is visible
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Visible
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        icon:
          type: string
          title: Icon
          default: Terminal
        bg_color:
          type: string
          title: Bg Color
          default: '#fef3c7'
        icon_color:
          type: string
          title: Icon Color
          default: '#d97706'
        chatflow_usable:
          type: boolean
          title: Chatflow Usable
          description: Whether the tool is usable in a chatflow
          default: true
        deprecated:
          type: boolean
          title: Deprecated
          description: >-
            Whether this tool type is deprecated and should be hidden from the
            UI
          default: false
        type:
          type: string
          const: sandbox
          title: Type
          default: sandbox
        persistent:
          type: boolean
          title: Persistent
          description: Keep sandbox running permanently (no idle timeout)
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Keep Running
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        include_execute:
          type: boolean
          title: Include Execute
          description: Include shell command execution tool
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Shell Execution
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        require_write_approval:
          type: boolean
          title: Require Write Approval
          description: Require user approval for file write/edit operations
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Approve Writes
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        require_execute_approval:
          type: boolean
          title: Require Execute Approval
          description: Require user approval for shell command execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Approve Execution
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
      type: object
      title: SandboxSettings
      description: >-
        Settings for the sandbox console toolset.


        Wraps pydantic-ai-backend's create_console_toolset() with Noxus
        settings.

        Provides file operations (ls, read, write, edit, glob, grep) and
        optional

        shell execution in an isolated sandbox environment.
    ScheduleToolSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Periodic Tasks
        description:
          type: string
          title: Description
          default: Create periodic tasks that call this agent on a schedule
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          description: The category of the tool
          default: QuickAction
        enabled:
          type: boolean
          title: Enabled
          default: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: Clock
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Managing schedule...
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Schedule updated
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          description: Whether the tool is visible
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Visible
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        icon:
          type: string
          title: Icon
          default: Clock
        bg_color:
          type: string
          title: Bg Color
          default: '#eff6ff'
        icon_color:
          type: string
          title: Icon Color
          default: '#2563eb'
        chatflow_usable:
          type: boolean
          title: Chatflow Usable
          description: Whether the tool is usable in a chatflow
          default: true
        deprecated:
          type: boolean
          title: Deprecated
          description: >-
            Whether this tool type is deprecated and should be hidden from the
            UI
          default: false
        type:
          type: string
          const: schedule_tool
          title: Type
          default: schedule_tool
      type: object
      title: ScheduleToolSettings
    SubAgentSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Task Delegation
        description:
          type: string
          title: Description
          default: Delegate tasks to specialized subagents
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          description: The category of the tool
          default: QuickAction
        enabled:
          type: boolean
          title: Enabled
          default: true
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: Users
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Delegating task...
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Task delegated
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          default: false
        icon:
          type: string
          title: Icon
          default: Users
        bg_color:
          type: string
          title: Bg Color
          default: '#f0f9ff'
        icon_color:
          type: string
          title: Icon Color
          default: '#0284c7'
        chatflow_usable:
          type: boolean
          title: Chatflow Usable
          description: Whether the tool is usable in a chatflow
          default: true
        deprecated:
          type: boolean
          title: Deprecated
          description: >-
            Whether this tool type is deprecated and should be hidden from the
            UI
          default: false
        type:
          type: string
          const: subagent
          title: Type
          default: subagent
        subagents:
          items:
            $ref: '#/components/schemas/SubAgentDefinition'
          type: array
          title: Subagents
          default: []
      type: object
      title: SubAgentSettings
      description: >-
        Settings for the subagent task delegation toolset.


        The roster and the delegation guidance live on the agent settings

        (``subagents``, ``subagents_instructions``); this variant only carries
        the

        tool's chat display.
    CodeExecutionSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Code Execution
        description:
          type: string
          title: Description
          default: Run Python code in a sandboxed environment
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          description: The category of the tool
          default: QuickAction
        enabled:
          type: boolean
          title: Enabled
          default: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: Terminal
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Running code...
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Code executed
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          description: Whether the tool is visible
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Visible
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        icon:
          type: string
          title: Icon
          default: Terminal
        bg_color:
          type: string
          title: Bg Color
          default: '#fef9c3'
        icon_color:
          type: string
          title: Icon Color
          default: '#ca8a04'
        chatflow_usable:
          type: boolean
          title: Chatflow Usable
          description: Whether the tool is usable in a chatflow
          default: true
        deprecated:
          type: boolean
          title: Deprecated
          description: >-
            Whether this tool type is deprecated and should be hidden from the
            UI
          default: false
        type:
          type: string
          const: code_execution
          title: Type
          default: code_execution
        timeout:
          type: integer
          title: Timeout
          description: Maximum execution time in seconds
          default: 60
          display:
            col_span: 12
            hide_number: false
            is_disabled: false
            is_subconfig: false
            label: Timeout (seconds)
            max: 300
            min: 10
            needs_confirmation: false
            show_optional_label: false
            step: 10
            type: number_slider
          tab: Configuration
          tool_mode: hidden
      type: object
      title: CodeExecutionSettings
    AgentMemorySettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Agent Memory
        description:
          type: string
          title: Description
          default: Persistent memory across all conversations
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          description: The category of the tool
          default: QuickAction
        enabled:
          type: boolean
          title: Enabled
          default: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: BookOpen
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Accessing agent memory...
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Memory operation complete
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          default: false
        icon:
          type: string
          title: Icon
          default: BookOpen
        bg_color:
          type: string
          title: Bg Color
          default: '#fef3c7'
        icon_color:
          type: string
          title: Icon Color
          default: '#d97706'
        chatflow_usable:
          type: boolean
          title: Chatflow Usable
          description: Whether the tool is usable in a chatflow
          default: true
        deprecated:
          type: boolean
          title: Deprecated
          description: >-
            Whether this tool type is deprecated and should be hidden from the
            UI
          default: false
        type:
          type: string
          const: agent_memory
          title: Type
          default: agent_memory
      type: object
      title: AgentMemorySettings
      description: |-
        Settings for the persistent agent memory toolset.

        Memories are stored in assistant.definition["memories"] JSONB
        and persist across all conversations with this agent.
    CreateFilesSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Create Files
        description:
          type: string
          title: Description
          default: Generate files and surface them in the chat.
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          description: The category of the tool
          default: QuickAction
        enabled:
          type: boolean
          title: Enabled
          default: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: FileInput
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Working with files...
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Done
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          default: false
        icon:
          type: string
          title: Icon
          default: FileInput
        bg_color:
          type: string
          title: Bg Color
          default: '#EFF6FF'
        icon_color:
          type: string
          title: Icon Color
          default: '#2B7FFF'
        chatflow_usable:
          type: boolean
          title: Chatflow Usable
          description: Whether the tool is usable in a chatflow
          default: true
        deprecated:
          type: boolean
          title: Deprecated
          default: true
        type:
          type: string
          const: create_files
          title: Type
          default: create_files
        allow_html_graphs:
          type: boolean
          title: Allow Html Graphs
          description: >-
            Instruct the agent to use self-contained HTML (Plotly, Chart.js,
            ...) when generating charts and visualizations.
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Use HTML for charts
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        show_inline:
          type: boolean
          title: Show Inline
          description: Render HTML and images directly in the chat instead of as a card.
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Render artifacts inline
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
      type: object
      title: CreateFilesSettings
      description: >-
        Unified setting for the file creation + presentation tools.


        Enables ``create_file`` (generate text/markdown/html/json/csv/code into
        the

        session) and ``present_file`` (surface a session file as a
        preview/download

        card in the chat). They share one toggle because they're useless apart —

        creating a file the user can't see is dead weight, and presenting
        nothing

        is a no-op.
    DocumentationSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Documentation
        description:
          type: string
          title: Description
          default: Search and read Noxus platform documentation
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          description: The category of the tool
          default: QuickAction
        enabled:
          type: boolean
          title: Enabled
          default: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: BookOpen
          tab: Configuration
          tool_mode: hidden
          visible: false
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Searching documentation...
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: Start message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when searching docs.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Documentation found
          col_span: 6
          display:
            col_span: 12
            is_code: false
            is_disabled: false
            is_subconfig: false
            is_textarea: false
            label: End message
            needs_confirmation: false
            number_of_lines: 1
            placeholder: Message displayed when search completes.
            show_optional_label: false
            show_refresh: false
            type: text
          tab: Configuration
          tool_mode: hidden
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          description: Whether the tool is visible
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Visible
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        icon:
          type: string
          title: Icon
          default: BookOpen
        bg_color:
          type: string
          title: Bg Color
          default: '#EFF6FF'
        icon_color:
          type: string
          title: Icon Color
          default: '#2B7FFF'
        chatflow_usable:
          type: boolean
          title: Chatflow Usable
          description: Whether the tool is usable in a chatflow
          default: true
        deprecated:
          type: boolean
          title: Deprecated
          description: >-
            Whether this tool type is deprecated and should be hidden from the
            UI
          default: false
        type:
          type: string
          const: documentation
          title: Type
          default: documentation
      type: object
      title: DocumentationSettings
    ImageGenerationSettings-Output:
      properties:
        title:
          type: string
          title: Title
          default: Image Generation
        description:
          type: string
          title: Description
          default: Generate images from text prompts, shown inline in the chat.
        category:
          type: string
          enum:
            - QuickAction
            - Flows
            - Knowledge
            - Actions
            - MCP
            - Chatflow
            - Agents
          title: Category
          description: The category of the tool
          default: QuickAction
        enabled:
          type: boolean
          title: Enabled
          default: false
        tool_display_icon:
          type: string
          title: Tool Display Icon
          default: ImagePlus
        tool_display_message_start:
          type: string
          title: Tool Display Message Start
          default: Generating image...
        tool_display_message_end:
          type: string
          title: Tool Display Message End
          default: Image generated
        extra_instructions:
          anyOf:
            - $ref: '#/components/schemas/NoxusTipTapDocument-Output'
            - type: 'null'
          description: Any extra instructions for the tool
          display:
            allow_reference_mentions: false
            col_span: 12
            connector_name: ''
            enable_heuristics: true
            heuristic_context: >-
              Tool execution conditions specifying when and how the agent should
              use this tool
            heuristic_types:
              - clarity
              - specificity
              - actionability
            improver_prompt: PromptImproverPromptV2
            is_disabled: false
            is_subconfig: false
            label: Execution Conditions
            needs_confirmation: false
            number_of_lines: 5
            show_optional_label: false
            type: rich_text_variables_ai
          tab: Configuration
          tool_mode: hidden
        requires_approval:
          type: boolean
          title: Requires Approval
          description: Whether tool calls require user approval before execution
          default: false
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Require Approval
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
        visible:
          type: boolean
          title: Visible
          description: Whether the tool is visible
          default: true
          display:
            col_span: 12
            is_disabled: false
            is_subconfig: false
            label: Visible
            needs_confirmation: false
            show_optional_label: false
            toggle_position: right
            type: toggle
          tab: Configuration
          tool_mode: hidden
          visible: false
        icon:
          type: string
          title: Icon
          default: ImagePlus
        bg_color:
          type: string
          title: Bg Color
          default: '#FDF4FF'
        icon_color:
          type: string
          title: Icon Color
          default: '#C026D3'
        chatflow_usable:
          type: boolean
          title: Chatflow Usable
          description: Whether the tool is usable in a chatflow
          default: true
        deprecated:
          type: boolean
          title: Deprecated
          description: >-
            Whether this tool type is deprecated and should be hidden from the
            UI
          default: false
        type:
          type: string
          const: image_generation
          title: Type
          default: image_generation
      type: object
      title: ImageGenerationSettings
      description: |-
        Image generation quick action.

        When on, the agent can generate images from text prompts with any
        image-generation-capable model in the registry; results are surfaced
        inline in the chat.
    MCPServerBinding:
      properties:
        credential_id:
          type: string
          format: uuid
          title: Credential Id
        enabled:
          type: boolean
          title: Enabled
          default: true
        selected_tools:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Selected Tools
      type: object
      required:
        - credential_id
      title: MCPServerBinding
      description: >-
        Per-agent binding to a workspace MCP credential.


        ``selected_tools=None`` means "every tool the server exposes minus the

        credential's ``disabled_tools``" — new server tools flow through without
        a

        re-probe. An explicit list is a per-agent allowlist narrowed further by
        the

        workspace denials.
    SkillConfig:
      properties:
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
          default: ''
        tags:
          items:
            type: string
          type: array
          title: Tags
        version:
          type: string
          title: Version
          default: 1.0.0
        author:
          type: string
          title: Author
          default: ''
        instructions:
          type: string
          title: Instructions
          default: ''
        enabled:
          type: boolean
          title: Enabled
          default: true
        resources:
          additionalProperties:
            type: string
          type: object
          title: Resources
      type: object
      required:
        - name
      title: SkillConfig
      description: |-
        Full skill definition stored in agent settings.

        Skills are markdown-based instruction packages that extend agent
        capabilities.  Stored directly in the agent's ``definition`` JSONB
        column — no separate table or migration needed.
    SubAgentDefinition:
      properties:
        name:
          type: string
          title: Name
        description:
          type: string
          title: Description
        instructions:
          type: string
          title: Instructions
        model:
          items:
            type: string
          type: array
          title: Model
          default: []
        enabled:
          type: boolean
          title: Enabled
          default: true
      type: object
      required:
        - name
        - description
        - instructions
      title: SubAgentDefinition
      description: Single subagent config from frontend.
    GuidelineConfig:
      properties:
        id:
          type: string
          title: Id
        condition:
          type: string
          title: Condition
        action:
          type: string
          title: Action
        priority:
          type: string
          title: Priority
          default: NORMAL
        tags:
          items:
            type: string
          type: array
          title: Tags
        enabled:
          type: boolean
          title: Enabled
          default: true
        tool_association:
          anyOf:
            - $ref: '#/components/schemas/ToolAssociationConfig'
            - type: 'null'
        tool_associations:
          items:
            $ref: '#/components/schemas/ToolAssociationConfig'
          type: array
          title: Tool Associations
      type: object
      required:
        - id
        - condition
        - action
      title: GuidelineConfig
      description: A single When/Then behavioral guideline stored in agent settings.
    GlossaryTermConfig:
      properties:
        term:
          type: string
          title: Term
        definition:
          type: string
          title: Definition
        synonyms:
          items:
            type: string
          type: array
          title: Synonyms
      type: object
      required:
        - term
        - definition
      title: GlossaryTermConfig
      description: A glossary term definition stored in agent settings.
    AgentMemoryEntry:
      properties:
        id:
          type: string
          title: Id
        content:
          type: string
          title: Content
        category:
          type: string
          title: Category
          default: general
        created_at:
          type: string
          title: Created At
          default: ''
        updated_at:
          type: string
          title: Updated At
          default: ''
      type: object
      required:
        - id
        - content
      title: AgentMemoryEntry
      description: A single persistent memory entry stored in agent settings.
    AppInterfaceType:
      type: string
      enum:
        - slack
        - teams
        - chat
        - form
        - whatsapp
        - embed_widget
        - telegram
      title: AppInterfaceType
    TiptapDocument-Output:
      properties:
        type:
          type: string
          title: Type
          default: doc
        content:
          items:
            $ref: '#/components/schemas/Node-Output'
          type: array
          title: Content
          default: []
      type: object
      title: TiptapDocument
    Transition:
      properties:
        node_label:
          type: string
          title: Node Label
        transition_key:
          anyOf:
            - type: string
            - type: 'null'
          title: Transition Key
        transition_criteria:
          type: string
          title: Transition Criteria
      type: object
      required:
        - node_label
        - transition_criteria
      title: Transition
    ActionToolConfig:
      properties:
        config_overrides:
          additionalProperties: true
          type: object
          title: Config Overrides
        input_overrides:
          additionalProperties: true
          type: object
          title: Input Overrides
        exposed_configs:
          items:
            type: string
          type: array
          title: Exposed Configs
        exposed_inputs:
          items:
            type: string
          type: array
          title: Exposed Inputs
      type: object
      title: ActionToolConfig
      description: >-
        Configuration for hardcoded values and exposed parameters in action
        tools.


        For each config parameter or input connector, you either:

        1. Hardcode it (store value in overrides, don't expose to LLM)

        2. Expose it to LLM (add to exposed list, LLM provides value)
    ToolAssociationConfig:
      properties:
        tool_names:
          items:
            type: string
          type: array
          title: Tool Names
        mode:
          type: string
          title: Mode
          default: PREFER
      type: object
      title: ToolAssociationConfig
      description: Tool enforcement configuration for a guideline.
    Node-Output:
      properties:
        type:
          type: string
          title: Type
        attrs:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Attrs
        content:
          anyOf:
            - items:
                $ref: '#/components/schemas/Node-Output'
              type: array
            - type: 'null'
          title: Content
        marks:
          anyOf:
            - items:
                $ref: '#/components/schemas/Mark'
              type: array
            - type: 'null'
          title: Marks
        text:
          anyOf:
            - type: string
            - type: 'null'
          title: Text
      type: object
      required:
        - type
      title: Node
    Mark:
      properties:
        type:
          type: string
          title: Type
        attrs:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Attrs
      type: object
      required:
        - type
      title: Mark
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````