> ## 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 Conversation > Get a conversation by it's ID ## OpenAPI ````yaml get /v1/conversations/{conversation_id} 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/conversations/{conversation_id}: get: tags: - V1 - Conversations summary: Get Conversation operationId: get_conversation parameters: - name: conversation_id in: path required: true schema: type: string format: uuid title: Conversation Id - name: assistant_id in: query required: false schema: anyOf: - type: string format: uuid - type: 'null' title: Assistant Id responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConversationWithMessages' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - APIKeyHeader: [] components: schemas: ConversationWithMessages: properties: id: type: string format: uuid title: Id user_id: anyOf: - type: string format: uuid - type: 'null' title: User Id api_key_id: anyOf: - type: string format: uuid - type: 'null' title: Api Key Id name: anyOf: - type: string - type: 'null' title: Name created_at: type: string format: date-time title: Created At last_updated_at: type: string format: date-time title: Last Updated At etag: anyOf: - type: string - type: 'null' title: Etag settings: $ref: '#/components/schemas/CoWorkerSettings-Output' assistant_id: anyOf: - type: string format: uuid - type: 'null' title: Assistant Id status: $ref: '#/components/schemas/RunStatus' manual: type: boolean title: Manual default: false preview: type: boolean title: Preview default: false assistant_version_id: anyOf: - type: string format: uuid - type: 'null' title: Assistant Version Id chat_transport: anyOf: - type: string - type: 'null' title: Chat Transport public_access_token: anyOf: - type: string - type: 'null' title: Public Access Token messages: items: $ref: '#/components/schemas/Message' type: array title: Messages vercel_messages: items: $ref: '#/components/schemas/UIMessage' type: array title: Vercel Messages default: [] type: object required: - id - user_id - api_key_id - name - created_at - last_updated_at - etag - settings - status - messages title: ConversationWithMessages HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError CoWorkerSettings-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 violence_and_hate: type: string title: Violence And Hate default: 'Off' accordion: Safety display: col_span: 12 is_disabled: false is_horizontal: true is_subconfig: false label: Violence and Hate needs_confirmation: false show_optional_label: false type: enum_slider values: - 'Off' - Low - Medium - High rules: - config_source: guardrail_lock type: disabled_if value: true tab: Model tool_mode: hidden sexual_content: type: string title: Sexual Content default: 'Off' accordion: Safety display: col_span: 12 is_disabled: false is_horizontal: true is_subconfig: false label: Sexual Content needs_confirmation: false show_optional_label: false type: enum_slider values: - 'Off' - Low - Medium - High rules: - config_source: guardrail_lock type: disabled_if value: true tab: Model tool_mode: hidden guns_and_weapons: type: string title: Guns And Weapons default: 'Off' accordion: Safety display: col_span: 12 is_disabled: false is_horizontal: true is_subconfig: false label: Guns and Illegal Weapons needs_confirmation: false show_optional_label: false type: enum_slider values: - 'Off' - Low - Medium - High rules: - config_source: guardrail_lock type: disabled_if value: true tab: Model tool_mode: hidden suicide: type: string title: Suicide default: 'Off' accordion: Safety display: col_span: 12 is_disabled: false is_horizontal: true is_subconfig: false label: Suicide and Self-Harm needs_confirmation: false show_optional_label: false type: enum_slider values: - 'Off' - Low - Medium - High rules: - config_source: guardrail_lock type: disabled_if value: true tab: Model tool_mode: hidden crime: type: string title: Crime default: 'Off' accordion: Safety display: col_span: 12 is_disabled: false is_horizontal: true is_subconfig: false label: Crime and Criminal Planning needs_confirmation: false show_optional_label: false type: enum_slider values: - 'Off' - Low - Medium - High rules: - config_source: guardrail_lock type: disabled_if value: true tab: Model tool_mode: hidden toxicity: type: string title: Toxicity default: 'Off' accordion: Safety display: col_span: 12 is_disabled: false is_horizontal: true is_subconfig: false label: Toxicity needs_confirmation: false show_optional_label: false type: enum_slider values: - 'Off' - Low - Medium - High rules: - config_source: guardrail_lock type: disabled_if value: true tab: Model tool_mode: hidden bias: type: string title: Bias default: 'Off' accordion: Safety display: col_span: 12 is_disabled: false is_horizontal: true is_subconfig: false label: Bias needs_confirmation: false show_optional_label: false type: enum_slider values: - 'Off' - Low - Medium - High rules: - config_source: guardrail_lock type: disabled_if value: true tab: Model tool_mode: hidden profanity: type: string title: Profanity description: >- Blocks or filters out user prompts or model responses that contain inappropriate, offensive, or profane language. default: 'Off' accordion: Safety display: col_span: 12 is_disabled: false is_horizontal: true is_subconfig: false label: Profanity needs_confirmation: false show_optional_label: false type: enum_slider values: - 'Off' - Low - Medium - High rules: - config_source: guardrail_lock type: disabled_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: flag label: Flag with warning but proceed accordion: Safety display: col_span: 12 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 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. 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. 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 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 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 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 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 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 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_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 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: 64000 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 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 rules: - config_source: parameter_preset type: visible_if value: custom 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 rules: - config_source: parameter_preset type: visible_if value: custom 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 rules: - config_source: parameter_preset type: visible_if value: custom 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 type: toggle rules: - config_source: parameter_preset type: visible_if value: custom tab: Model tool_mode: hidden agentflow_enabled: type: boolean title: Agentflow Enabled description: Whether to enable chat flow default: false display: col_span: 12 is_disabled: false is_subconfig: false label: Enable chat flow needs_confirmation: false show_optional_label: false 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 rules: - config_source: parameter_preset type: visible_if value: custom 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 rules: - config_source: parameter_preset type: visible_if value: custom 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 rules: - config_source: parameter_preset type: visible_if value: custom 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 rules: - config_source: parameter_preset type: visible_if value: custom 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 rules: - config_source: parameter_preset type: visible_if value: custom 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 rules: - config_source: parameter_preset type: visible_if value: custom 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 rules: - config_source: parameter_preset type: visible_if value: custom 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 type: toggle rules: - config_source: parameter_preset type: visible_if value: custom tab: Model tool_mode: hidden visuals_section: type: string title: Visuals Section default: '' display: col_span: 10 is_disabled: false is_subconfig: false label: '' needs_confirmation: false show_optional_label: false small_text: >- Control what information is displayed to users during agent interactions. title: Visual preferences type: ui_text_display tab: Display tool_mode: hidden hide_reasoning: type: boolean title: Hide Reasoning description: Whether to hide the reasoning messages default: false display: col_span: 12 is_disabled: false is_subconfig: false label: Hide reasoning messages needs_confirmation: false show_optional_label: false type: toggle rules: - config_source: enable_reasoning type: visible_if value: true tab: Display tool_mode: hidden hide_workflow_progress: type: boolean title: Hide Workflow Progress description: Whether to hide the flow progress default: false display: col_span: 12 is_disabled: false is_subconfig: false label: Hide flow progress needs_confirmation: false show_optional_label: false type: toggle tab: Display tool_mode: hidden tool_display_preset: type: string title: Tool Display Preset description: Controls how tool executions are shown during conversations default: execution display: col_span: 12 cols: 3 is_disabled: false is_subconfig: false items: - description: Minimalist loading state. Best for end-users image: >- https://storage.googleapis.com/image-storage-spot-manual/tool-display/minimal.svg label: Minimal value: minimal - description: Step-by-step execution visibility image: >- https://storage.googleapis.com/image-storage-spot-manual/tool-display/execution.svg label: Execution value: execution - description: Tool inputs, outputs, and system trace image: >- https://storage.googleapis.com/image-storage-spot-manual/tool-display/trace.svg label: Trace value: tracing label: Tool display preset needs_confirmation: false show_optional_label: false type: card_select variant: preview tab: Display tool_mode: hidden minimal_caret_only: type: boolean title: Minimal Caret Only description: Show a loading message while tools are running. default: true display: col_span: 12 is_disabled: false is_subconfig: false label: Enable loading message needs_confirmation: false show_optional_label: false type: toggle rules: - config_source: tool_display_preset type: visible_if value: minimal tab: Display tool_mode: hidden minimal_tool_message: type: string title: Minimal Tool Message default: Thinking... display: col_span: 12 is_code: false is_disabled: false is_subconfig: false is_textarea: false label: Loading message max_length: 50 needs_confirmation: false number_of_lines: 1 placeholder: Thinking... show_optional_label: false show_refresh: false type: text rules: - conds: - config_source: tool_display_preset type: visible_if value: minimal - config_source: minimal_caret_only type: visible_if value: true mode: and type: visible_if_group tab: Display tool_mode: hidden citation_style: type: string title: Citation Style description: How inline citation references are displayed default: text display: col_span: 12 is_clearable: false is_disabled: false is_horizontal: false is_searchable: false is_subconfig: false label: Citation style needs_confirmation: false show_optional_label: false type: select values: - label: Text (hostname / title) value: text - label: Numbered (1, 2, 3) value: numbered - label: Hidden value: hidden tab: Display tool_mode: hidden chat_input_placeholder: type: string title: Chat Input Placeholder default: Ask me anything... display: col_span: 12 is_code: false is_disabled: false is_subconfig: false is_textarea: false label: Chat input hint max_length: 50 needs_confirmation: false number_of_lines: 1 placeholder: Ask me anything... show_optional_label: false show_refresh: false type: text tab: Display tool_mode: hidden divider_visuals: type: string title: Divider Visuals default: '' 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: Display tool_mode: hidden conversation_title_section: type: string title: Conversation Title Section default: '' display: col_span: 10 is_disabled: false is_subconfig: false label: '' needs_confirmation: false show_optional_label: false small_text: Configure how the agent conversation title is displayed. title: Conversation title display type: ui_text_display tab: Display tool_mode: hidden agent_title_mode: type: string title: Agent Title Mode description: >- Configure how the agent conversation titlte is displayed in the conversation history default: generate display: col_span: 12 is_clearable: false is_disabled: false is_horizontal: false is_searchable: true is_subconfig: false label: Title mode needs_confirmation: false show_optional_label: false type: select values: - label: Generate from first messages value: generate - label: Use first message value: first_message - label: Use last message value: last_message tab: Display tool_mode: hidden divider_conversation_title: type: string title: Divider Conversation Title default: '' 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: Display tool_mode: hidden agentflow_section: type: string title: Agentflow 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 chat flow handles state transitions type: ui_text_display rules: - config_source: agentflow_enabled type: visible_if value: true tab: Display tool_mode: hidden hide_state_transitions: type: boolean title: Hide State Transitions description: Whether to hide the state transitions default: false accordion: Model Parameters display: col_span: 12 is_disabled: false is_subconfig: false label: Hide state transitions needs_confirmation: false show_optional_label: false type: toggle rules: - config_source: agentflow_enabled type: visible_if value: true tab: Display tool_mode: hidden divider_13: type: string title: Divider 13 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: agentflow_enabled type: visible_if value: true tab: Display 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 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 default: temperature: 0.3 top_p: 0.9 top_k: 40 presence_penalty: 0 frequency_penalty: 0 parameter_preset: custom 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 introductory_message: anyOf: - type: string - type: 'null' title: Introductory Message description: The introductory message to use for the conversation. display: class_name: min-h-[10rem] col_span: 12 is_code: false is_disabled: false is_subconfig: false is_textarea: true label: Introductory message needs_confirmation: false number_of_lines: 1 placeholder: Hello, how can I help you today? show_optional_label: false show_refresh: false type: text 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: 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_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: 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_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: - items: $ref: '#/components/schemas/NoxusTipTapDocument-Output' type: array - type: 'null' title: Extra Instructions description: >- Provide specific rules, goals, or context to guide the co-worker's behavior. display: col_span: 12 connector_name: '' enable_heuristics: true heuristic_context: >- Agent behavior instructions providing specific rules, goals, and operational guidelines heuristic_types: - clarity - specificity - actionability - task_breakdown improver_prompt: PromptImproverPromptV2 is_disabled: false is_subconfig: false label: Instructions needs_confirmation: false number_of_lines: 5 show_optional_label: false type: rich_text_variables_ai tab: Prompt tool_mode: hidden tools: items: oneOf: - $ref: '#/components/schemas/WebResearchSettings' - $ref: '#/components/schemas/NoxusQaSettings' - $ref: '#/components/schemas/KnowledgeBaseSelectorSettings' - $ref: '#/components/schemas/KnowledgeBaseQaSettings' - $ref: '#/components/schemas/WorkflowSettings' - $ref: '#/components/schemas/AttachFileSettings' - $ref: '#/components/schemas/FlowTransitionSettings' - $ref: '#/components/schemas/ChatflowSettings' - $ref: '#/components/schemas/ChatflowExtractionSettings' - $ref: '#/components/schemas/HumanInTheLoopSettings' - $ref: '#/components/schemas/ChatflowTransitionSettings' - $ref: '#/components/schemas/AgentToolSettings' - $ref: '#/components/schemas/MemorySettings' - $ref: '#/components/schemas/ActionToolSettings' - $ref: '#/components/schemas/FileSystemSettings' - $ref: '#/components/schemas/CodeExecutionSettings' discriminator: propertyName: type mapping: action: $ref: '#/components/schemas/ActionToolSettings' agent_tool: $ref: '#/components/schemas/AgentToolSettings' attach_file: $ref: '#/components/schemas/AttachFileSettings' chatflow: $ref: '#/components/schemas/ChatflowSettings' chatflow_extraction: $ref: '#/components/schemas/ChatflowExtractionSettings' chatflow_transition: $ref: '#/components/schemas/ChatflowTransitionSettings' code_execution: $ref: '#/components/schemas/CodeExecutionSettings' filesystem: $ref: '#/components/schemas/FileSystemSettings' flow_transition: $ref: '#/components/schemas/FlowTransitionSettings' human_in_the_loop: $ref: '#/components/schemas/HumanInTheLoopSettings' kb_qa: $ref: '#/components/schemas/KnowledgeBaseQaSettings' kb_selector: $ref: '#/components/schemas/KnowledgeBaseSelectorSettings' memory: $ref: '#/components/schemas/MemorySettings' noxus_qa: $ref: '#/components/schemas/NoxusQaSettings' web_research: $ref: '#/components/schemas/WebResearchSettings' workflow: $ref: '#/components/schemas/WorkflowSettings' type: array title: Tools default: [] display: col_span: 12 is_disabled: false is_subconfig: false label: Tools needs_confirmation: false show_optional_label: false show_sections: [] type: tools_select tab: Configuration tool_mode: hidden visible: false mcp_servers: items: oneOf: - $ref: '#/components/schemas/JiraSettings' - $ref: '#/components/schemas/LinearSettings' - $ref: '#/components/schemas/CustomMCPSettings-Output' - $ref: '#/components/schemas/PlaywrightSettings' discriminator: propertyName: type mapping: custom: $ref: '#/components/schemas/CustomMCPSettings-Output' jira: $ref: '#/components/schemas/JiraSettings' linear: $ref: '#/components/schemas/LinearSettings' playwright: $ref: '#/components/schemas/PlaywrightSettings' type: array title: Mcp Servers default: [] display: col_span: 12 is_disabled: false is_subconfig: false label: Available MCP Servers needs_confirmation: false show_optional_label: false show_sections: - MCP type: tools_select tab: Actions tool_mode: hidden workflows: items: $ref: '#/components/schemas/WorkflowSettings' type: array title: Workflows description: Workflows the agent can run default: [] display: col_span: 12 is_disabled: false is_subconfig: false label: Workflows needs_confirmation: false show_optional_label: false type: workflows_field tab: Actions tool_mode: hidden knowledge_bases: items: $ref: '#/components/schemas/KnowledgeBaseQaSettings' type: array title: Knowledge Bases description: Knowledge bases the agent can search default: [] display: col_span: 12 is_disabled: false is_subconfig: false label: Knowledge Bases needs_confirmation: false show_optional_label: false type: knowledge_bases_field tab: Actions tool_mode: hidden coworkers: items: $ref: '#/components/schemas/AgentToolSettings' type: array title: Coworkers description: Co-workers the agent can call default: [] display: col_span: 12 is_disabled: false is_subconfig: false label: Co-workers needs_confirmation: false show_optional_label: false type: coworkers_field tab: Actions tool_mode: hidden base_tools: items: oneOf: - $ref: '#/components/schemas/WebResearchSettings' - $ref: '#/components/schemas/HumanInTheLoopSettings' - $ref: '#/components/schemas/MemorySettings' - $ref: '#/components/schemas/AttachFileSettings' - $ref: '#/components/schemas/FileSystemSettings' - $ref: '#/components/schemas/CodeExecutionSettings' - $ref: '#/components/schemas/NoxusQaSettings' - $ref: '#/components/schemas/KnowledgeBaseSelectorSettings' discriminator: propertyName: type mapping: attach_file: $ref: '#/components/schemas/AttachFileSettings' code_execution: $ref: '#/components/schemas/CodeExecutionSettings' filesystem: $ref: '#/components/schemas/FileSystemSettings' human_in_the_loop: $ref: '#/components/schemas/HumanInTheLoopSettings' kb_selector: $ref: '#/components/schemas/KnowledgeBaseSelectorSettings' memory: $ref: '#/components/schemas/MemorySettings' noxus_qa: $ref: '#/components/schemas/NoxusQaSettings' web_research: $ref: '#/components/schemas/WebResearchSettings' type: array title: Base Tools description: Quick action tools the agent can use default: - title: Human in the Loop description: Human in the Loop category: QuickAction enabled: false tool_display_icon: PersonStanding tool_display_message_start: Escalating to human operator... tool_display_message_end: Escalated to human operator visible: true icon: PersonStanding bg_color: blue.50 icon_color: blue.500 chatflow_usable: true deprecated: false type: human_in_the_loop has_timeout: false handover_message: You are now talking to the co-worker. - title: Web Research description: Search the web for information category: QuickAction enabled: false tool_display_icon: Globe tool_display_message_start: Searching the web... tool_display_message_end: Searched the web visible: true icon: Globe bg_color: '#D1FADF' icon_color: '#027A48' chatflow_usable: true deprecated: false type: web_research - title: Attach File description: Attach a file to the conversation category: QuickAction enabled: false tool_display_icon: Cog tool_display_message_start: Running tool... tool_display_message_end: Tool complete visible: true icon: Paperclip bg_color: '#EFF6FF' icon_color: '#2B7FFF' chatflow_usable: false deprecated: false type: attach_file - title: Memory description: Persistent memory during a single conversation category: QuickAction enabled: false tool_display_icon: Brain tool_display_message_start: Accessing memory... tool_display_message_end: Memory operation complete visible: true icon: Brain bg_color: '#f5f3ff' icon_color: '#8e51ff' chatflow_usable: true deprecated: false type: memory - title: File System description: Access and read files in the current session category: QuickAction enabled: true tool_display_icon: FolderOpen tool_display_message_start: Accessing file system... tool_display_message_end: File system operation complete visible: false icon: FolderOpen bg_color: '#fef3c7' icon_color: '#f59e0b' chatflow_usable: true deprecated: false type: filesystem - title: Code Execution description: Run Python code in a sandboxed environment category: QuickAction enabled: false tool_display_icon: Terminal tool_display_message_start: Running code... tool_display_message_end: Code executed visible: true icon: Terminal bg_color: '#fef9c3' icon_color: '#ca8a04' chatflow_usable: true deprecated: false type: code_execution timeout: 120 display: col_span: 12 is_disabled: false is_subconfig: false label: Quick Actions needs_confirmation: false show_optional_label: false type: base_tools_field tab: Actions tool_mode: hidden actions: items: $ref: '#/components/schemas/ActionToolSettings' type: array title: Actions description: Action nodes the agent can execute default: [] display: col_span: 12 is_disabled: false is_subconfig: false label: Actions needs_confirmation: false show_optional_label: false type: actions_field tab: Actions tool_mode: hidden chatflow_tools: items: oneOf: - $ref: '#/components/schemas/FlowTransitionSettings' - $ref: '#/components/schemas/ChatflowSettings' - $ref: '#/components/schemas/ChatflowExtractionSettings' - $ref: '#/components/schemas/ChatflowTransitionSettings' discriminator: propertyName: type mapping: chatflow: $ref: '#/components/schemas/ChatflowSettings' chatflow_extraction: $ref: '#/components/schemas/ChatflowExtractionSettings' chatflow_transition: $ref: '#/components/schemas/ChatflowTransitionSettings' flow_transition: $ref: '#/components/schemas/FlowTransitionSettings' type: array title: Chatflow Tools default: [] tab: Configuration tool_mode: hidden visible: false type: object title: CoWorkerSettings RunStatus: type: string enum: - queued - running - failed - completed - stopped - awaiting_human_feedback title: RunStatus Message: properties: id: type: string format: uuid title: Id created_at: type: string format: date-time title: Created At message_parts: items: oneOf: - $ref: '#/components/schemas/UserMessage' - $ref: '#/components/schemas/ToolCallMessage' - $ref: '#/components/schemas/ToolCalledMessage' - $ref: '#/components/schemas/ToolCalledMessageEnd' - $ref: '#/components/schemas/MessageEnd' - $ref: '#/components/schemas/MarkdownMessage' - $ref: '#/components/schemas/AudioReferenceMessage' - $ref: '#/components/schemas/ImageReferenceMessage' - $ref: '#/components/schemas/VideoReferenceMessage' - $ref: '#/components/schemas/DocumentReferenceMessage' - $ref: '#/components/schemas/WebReferenceMessage' - $ref: '#/components/schemas/ImageCarouselMessage' - $ref: '#/components/schemas/SourceReferenceMessage' - $ref: '#/components/schemas/SystemMessage' - $ref: '#/components/schemas/ErrorMessage' - $ref: '#/components/schemas/WarningMessage' - $ref: '#/components/schemas/InfoMessage' - $ref: '#/components/schemas/SuccessMessage' - $ref: '#/components/schemas/SetConversationTitle' - $ref: '#/components/schemas/InternalToolResultMessage' - $ref: '#/components/schemas/YoutubeReferenceMessage' - $ref: '#/components/schemas/StateTransitionMessage' - $ref: '#/components/schemas/ChatflowExtractionMessage' - $ref: '#/components/schemas/ConversationEndMessage' - $ref: '#/components/schemas/HumanInTheLoopMessage' - $ref: '#/components/schemas/MemoryMessage' - $ref: '#/components/schemas/KBContextMessage' - $ref: '#/components/schemas/WebpageContextMessage' - $ref: '#/components/schemas/HumanInTheLoopAssignedMessage' - $ref: '#/components/schemas/ThinkingMessage' - $ref: '#/components/schemas/ThinkingEndedMessage' - $ref: '#/components/schemas/ClearConversationStreamMessage' - $ref: '#/components/schemas/WorkflowRunningMessage' - $ref: '#/components/schemas/ChatflowTransitionMessage' discriminator: propertyName: type mapping: audio: $ref: '#/components/schemas/AudioReferenceMessage' chatflow_extraction: $ref: '#/components/schemas/ChatflowExtractionMessage' chatflow_transition: $ref: '#/components/schemas/ChatflowTransitionMessage' clear_conversation_stream: $ref: '#/components/schemas/ClearConversationStreamMessage' conversation_end: $ref: '#/components/schemas/ConversationEndMessage' document: $ref: '#/components/schemas/DocumentReferenceMessage' error: $ref: '#/components/schemas/ErrorMessage' human_in_the_loop: $ref: '#/components/schemas/HumanInTheLoopMessage' human_in_the_loop_assigned: $ref: '#/components/schemas/HumanInTheLoopAssignedMessage' image: $ref: '#/components/schemas/ImageReferenceMessage' image_carousel: $ref: '#/components/schemas/ImageCarouselMessage' info: $ref: '#/components/schemas/InfoMessage' kb_context: $ref: '#/components/schemas/KBContextMessage' markdown: $ref: '#/components/schemas/MarkdownMessage' memory: $ref: '#/components/schemas/MemoryMessage' message_end: $ref: '#/components/schemas/MessageEnd' set_conversation_title: $ref: '#/components/schemas/SetConversationTitle' source_reference: $ref: '#/components/schemas/SourceReferenceMessage' state_transition: $ref: '#/components/schemas/StateTransitionMessage' success: $ref: '#/components/schemas/SuccessMessage' system: $ref: '#/components/schemas/SystemMessage' thinking: $ref: '#/components/schemas/ThinkingMessage' thinking_ended: $ref: '#/components/schemas/ThinkingEndedMessage' tool_call: $ref: '#/components/schemas/ToolCallMessage' tool_called: $ref: '#/components/schemas/ToolCalledMessage' tool_called_end: $ref: '#/components/schemas/ToolCalledMessageEnd' tool_result: $ref: '#/components/schemas/InternalToolResultMessage' user: $ref: '#/components/schemas/UserMessage' video: $ref: '#/components/schemas/VideoReferenceMessage' warning: $ref: '#/components/schemas/WarningMessage' web_reference: $ref: '#/components/schemas/WebReferenceMessage' webpage_context: $ref: '#/components/schemas/WebpageContextMessage' workflow_running: $ref: '#/components/schemas/WorkflowRunningMessage' youtube_reference: $ref: '#/components/schemas/YoutubeReferenceMessage' type: array title: Message Parts pydantic_message_parts: items: oneOf: - $ref: '#/components/schemas/ModelRequest' - $ref: '#/components/schemas/ModelResponse' discriminator: propertyName: kind mapping: request: $ref: '#/components/schemas/ModelRequest' response: $ref: '#/components/schemas/ModelResponse' type: array title: Pydantic Message Parts is_positive: anyOf: - type: boolean - type: 'null' title: Is Positive type: object required: - id - created_at - message_parts - pydantic_message_parts - is_positive title: Message UIMessage: properties: id: type: string title: Id role: type: string enum: - system - user - assistant title: Role metadata: anyOf: - {} - type: 'null' title: Metadata parts: items: anyOf: - $ref: '#/components/schemas/TextUIPart' - $ref: '#/components/schemas/ReasoningUIPart' - $ref: '#/components/schemas/ToolInputStreamingPart' - $ref: '#/components/schemas/ToolInputAvailablePart' - $ref: '#/components/schemas/ToolOutputAvailablePart' - $ref: '#/components/schemas/ToolOutputErrorPart' - $ref: '#/components/schemas/ToolApprovalRequestedPart' - $ref: '#/components/schemas/ToolApprovalRespondedPart' - $ref: '#/components/schemas/ToolOutputDeniedPart' - $ref: '#/components/schemas/DynamicToolInputStreamingPart' - $ref: '#/components/schemas/DynamicToolInputAvailablePart' - $ref: '#/components/schemas/DynamicToolOutputAvailablePart' - $ref: '#/components/schemas/DynamicToolOutputErrorPart' - $ref: '#/components/schemas/DynamicToolApprovalRequestedPart' - $ref: '#/components/schemas/DynamicToolApprovalRespondedPart' - $ref: '#/components/schemas/DynamicToolOutputDeniedPart' - $ref: '#/components/schemas/SourceUrlUIPart' - $ref: '#/components/schemas/SourceDocumentUIPart' - $ref: '#/components/schemas/FileUIPart' - $ref: '#/components/schemas/DataUIPart' - $ref: '#/components/schemas/StepStartUIPart' type: array title: Parts additionalProperties: false type: object required: - id - role - parts title: UIMessage description: A message as displayed in the UI by Vercel AI Elements. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError NoxusTipTapDocument-Output: properties: text: type: string title: Text definition: $ref: '#/components/schemas/TiptapDocument-Output' type: object required: - text - definition title: NoxusTipTapDocument WebResearchSettings: 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 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: - type: string - type: 'null' title: Extra Instructions description: Any extra instructions for the tool display: 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 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 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: 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: - type: string - type: 'null' title: Extra Instructions description: Any extra instructions for the tool display: 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 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 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: 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 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: - type: string - type: 'null' title: Extra Instructions description: Any extra instructions for the tool display: 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 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 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: 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 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: - type: string - type: 'null' title: Extra Instructions description: Any extra instructions for the tool display: 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 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 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 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 tooltip: The agent won’t cite this knowledge base as a source. 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: 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 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: - type: string - type: 'null' title: Extra Instructions description: Any extra instructions for the tool display: 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 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 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: Attach File description: type: string title: Description default: Attach a file to 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: 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 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 type: toggle tab: Configuration tool_mode: hidden visible: 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 description: >- Whether this tool type is deprecated and should be hidden from the UI default: false type: type: string const: attach_file title: Type default: attach_file type: object title: AttachFileSettings FlowTransitionSettings: 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 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: Any extra instructions for the tool display: 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 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 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: 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 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: Any extra instructions for the tool display: 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 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 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: 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 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: Any extra instructions for the tool display: 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 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 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: 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: - type: string - type: 'null' title: Extra Instructions description: Any extra instructions for the tool display: 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 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 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 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 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 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: 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 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: - type: string - type: 'null' title: Extra Instructions description: Any extra instructions for the tool display: 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 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 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: 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: - type: string - type: 'null' title: Extra Instructions description: Any extra instructions for the tool display: 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 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 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: 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: - type: string - type: 'null' title: Extra Instructions description: Any extra instructions for the tool display: 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 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 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 FileSystemSettings: 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: - type: string - type: 'null' title: Extra Instructions description: Any extra instructions for the tool display: 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 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 CodeExecutionSettings: 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: true 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: - type: string - type: 'null' title: Extra Instructions description: Any extra instructions for the tool display: 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 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 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 default: 120 type: object title: CodeExecutionSettings JiraSettings: properties: enabled: type: boolean title: Enabled default: true display: col_span: 12 is_disabled: false is_subconfig: false label: Enabled needs_confirmation: false show_optional_label: false tooltip: Enable MCP type: toggle tab: Configuration tool_mode: hidden integration: type: string title: Integration default: jira tab: Configuration tool_mode: hidden visible: false image: type: string title: Image default: >- https://storage.googleapis.com/image-storage-spot-manual/logos/external-integrations/external-integrations/jira.png tab: Configuration tool_mode: hidden visible: false type: type: string const: jira title: Type default: jira tab: Configuration tool_mode: hidden visible: false type: object title: JiraSettings LinearSettings: properties: enabled: type: boolean title: Enabled default: true display: col_span: 12 is_disabled: false is_subconfig: false label: Enabled needs_confirmation: false show_optional_label: false tooltip: Enable MCP type: toggle tab: Configuration tool_mode: hidden integration: type: string title: Integration default: linear tab: Configuration tool_mode: hidden visible: false image: type: string title: Image default: >- https://storage.googleapis.com/image-storage-spot-manual/logos/external-integrations/external-integrations/linear.png tab: Configuration tool_mode: hidden visible: false type: type: string const: linear title: Type default: linear tab: Configuration tool_mode: hidden visible: false oauth_token: type: string title: Oauth Token default: '' tab: Configuration tool_mode: hidden visible: false type: object title: LinearSettings CustomMCPSettings-Output: properties: enabled: type: boolean title: Enabled default: true display: col_span: 12 is_disabled: false is_subconfig: false label: Enabled needs_confirmation: false show_optional_label: false tooltip: Enable MCP type: toggle tab: Configuration tool_mode: hidden integration: type: string title: Integration default: custom tab: Configuration tool_mode: hidden visible: false image: type: string title: Image default: icon:Globe tab: Configuration tool_mode: hidden visible: false type: type: string const: custom title: Type default: custom tab: Configuration tool_mode: hidden visible: false instructions: $ref: '#/components/schemas/NoxusTipTapDocument-Output' default: text: '' definition: content: [] type: doc display: col_span: 12 hide_toolbar: false is_disabled: false is_subconfig: false label: Instructions needs_confirmation: false number_of_lines: 10 placeholder: Enter the instructions for the Custom MCP show_optional_label: false type: big_text tab: Configuration tool_mode: hidden command: type: string title: Command default: npx display: col_span: 12 is_clearable: false is_disabled: false is_horizontal: false is_searchable: true is_subconfig: false label: Command needs_confirmation: false show_optional_label: false type: select values: - npx - uvx tab: Configuration tool_mode: hidden args: type: string title: Args default: '-y @modelcontextprotocol/server-sequential-thinking' display: col_span: 12 is_code: false is_disabled: false is_subconfig: false is_textarea: false label: Arguments needs_confirmation: false number_of_lines: 10 placeholder: Enter the arguments for the Custom MCP show_optional_label: false show_refresh: false type: text tab: Configuration tool_mode: hidden type: object title: CustomMCPSettings PlaywrightSettings: properties: enabled: type: boolean title: Enabled default: true display: col_span: 12 is_disabled: false is_subconfig: false label: Enabled needs_confirmation: false show_optional_label: false tooltip: Enable MCP type: toggle tab: Configuration tool_mode: hidden integration: type: string title: Integration default: '' tab: Configuration tool_mode: hidden visible: false image: type: string title: Image default: >- https://storage.googleapis.com/image-storage-spot-manual/logos/external-integrations/external-integrations/playwright-logo.svg tab: Configuration tool_mode: hidden visible: false type: type: string const: playwright title: Type default: playwright tab: Configuration tool_mode: hidden visible: false use_proxy: type: boolean title: Use Proxy description: Use a proxy to connect to the browser default: true advanced: true display: col_span: 12 is_disabled: false is_subconfig: false label: Use Proxy needs_confirmation: false show_optional_label: false type: toggle tab: Configuration tool_mode: hidden use_custom_proxy: type: boolean title: Use Custom Proxy description: Use a custom proxy to connect to the browser default: false advanced: true display: col_span: 12 is_disabled: false is_subconfig: false label: Use Custom Proxy needs_confirmation: false show_optional_label: false type: toggle rules: - config_source: use_proxy type: visible_if value: true tab: Configuration tool_mode: hidden cdp_endpoint: anyOf: - type: string - type: 'null' title: Cdp Endpoint description: This is a CDP endpoint URL, not just a regular proxy URL. advanced: true display: col_span: 12 is_code: false is_disabled: false is_subconfig: false is_textarea: false label: CDP Endpoint URL needs_confirmation: false number_of_lines: 1 placeholder: wss://browser.zenrows.com?apikey=YOUR_API_KEY show_optional_label: false show_refresh: false type: text rules: - config_source: use_custom_proxy type: visible_if value: true tab: Configuration tool_mode: hidden type: object title: PlaywrightSettings UserMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: user timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: user title: Type default: user content: type: string title: Content default: '' tool: anyOf: - type: string enum: - kb_qa - web_research - workflow - list_workflows - run_integration - noxus_qa - human_in_the_loop - type: string - type: 'null' title: Tool kb_id: anyOf: - type: string - type: 'null' title: Kb Id workflow_id: anyOf: - type: string - type: 'null' title: Workflow Id files: anyOf: - items: $ref: '#/components/schemas/ConversationFile' type: array - type: 'null' title: Files model_selection: anyOf: - items: type: string type: array - type: string - type: 'null' title: Model Selection images: anyOf: - items: type: string type: array - type: 'null' title: Images refresh_message: type: boolean title: Refresh Message default: false new_chat: type: boolean title: New Chat default: false type: object title: UserMessage ToolCallMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: function timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id tool_type: anyOf: - type: string enum: - kb_qa - web_research - workflow - list_workflows - run_integration - noxus_qa - human_in_the_loop - type: string title: Tool Type type: type: string const: tool_call title: Type default: tool_call display_message_start: type: string title: Display Message Start default: Running tool... display_message_end: type: string title: Display Message End default: Tool finished running icon: type: string title: Icon default: Cog run_id: anyOf: - type: string - type: 'null' title: Run Id type: object required: - tool_type title: ToolCallMessage ToolCalledMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: function timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id tool_type: anyOf: - type: string enum: - kb_qa - web_research - workflow - list_workflows - run_integration - noxus_qa - human_in_the_loop - type: string title: Tool Type type: type: string const: tool_called title: Type default: tool_called content: type: string title: Content type: object required: - tool_type - content title: ToolCalledMessage ToolCalledMessageEnd: properties: role: $ref: '#/components/schemas/MessageRole' default: function timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id tool_type: anyOf: - type: string enum: - kb_qa - web_research - workflow - list_workflows - run_integration - noxus_qa - human_in_the_loop - type: string title: Tool Type type: type: string const: tool_called_end title: Type default: tool_called_end content: type: string title: Content type: object required: - tool_type - content title: ToolCalledMessageEnd MessageEnd: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: message_end title: Type default: message_end content: type: string title: Content default: '' pydantic_messages: anyOf: - {} - type: 'null' title: Pydantic Messages noxus_messages: anyOf: - items: $ref: '#/components/schemas/BaseMessage' type: array - type: 'null' title: Noxus Messages type: object title: MessageEnd MarkdownMessage: properties: role: $ref: '#/components/schemas/MessageRole' timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: markdown title: Type default: markdown content: type: string title: Content default: '' type: object required: - role title: MarkdownMessage AudioReferenceMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id kb_id: anyOf: - type: string format: uuid - type: 'null' title: Kb Id doc_id: anyOf: - type: string format: uuid - type: 'null' title: Doc Id file_id: anyOf: - type: string format: uuid - type: 'null' title: File Id file_name: anyOf: - type: string - type: 'null' title: File Name from_timestamp: type: string format: duration title: From Timestamp to_timestamp: type: string format: duration title: To Timestamp type: type: string const: audio title: Type default: audio type: object required: - from_timestamp - to_timestamp title: AudioReferenceMessage ImageReferenceMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id kb_id: anyOf: - type: string format: uuid - type: 'null' title: Kb Id doc_id: anyOf: - type: string format: uuid - type: 'null' title: Doc Id file_id: anyOf: - type: string format: uuid - type: 'null' title: File Id file_name: anyOf: - type: string - type: 'null' title: File Name type: type: string const: image title: Type default: image type: object title: ImageReferenceMessage VideoReferenceMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id kb_id: anyOf: - type: string format: uuid - type: 'null' title: Kb Id doc_id: anyOf: - type: string format: uuid - type: 'null' title: Doc Id file_id: anyOf: - type: string format: uuid - type: 'null' title: File Id file_name: anyOf: - type: string - type: 'null' title: File Name from_timestamp: type: string format: duration title: From Timestamp to_timestamp: type: string format: duration title: To Timestamp type: type: string const: video title: Type default: video type: object required: - from_timestamp - to_timestamp title: VideoReferenceMessage DocumentReferenceMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id kb_id: anyOf: - type: string format: uuid - type: 'null' title: Kb Id doc_id: anyOf: - type: string format: uuid - type: 'null' title: Doc Id file_id: anyOf: - type: string format: uuid - type: 'null' title: File Id file_name: anyOf: - type: string - type: 'null' title: File Name type: type: string const: document title: Type default: document quote: type: string title: Quote page_label: type: string title: Page Label ref_num: type: integer title: Ref Num content_type: anyOf: - type: string - type: 'null' title: Content Type url: anyOf: - type: string - type: 'null' title: Url type: object required: - quote - page_label - ref_num title: DocumentReferenceMessage WebReferenceMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: web_reference title: Type default: web_reference quote: type: string title: Quote title: type: string title: Title ref_label: type: string title: Ref Label url: type: string title: Url image_url: anyOf: - type: string - type: 'null' title: Image Url type: object required: - quote - title - ref_label - url title: WebReferenceMessage ImageCarouselMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: image_carousel title: Type default: image_carousel images: items: anyOf: - $ref: '#/components/schemas/ImageReferenceMessage' - $ref: '#/components/schemas/DocumentReferenceMessage' type: array title: Images type: object required: - images title: ImageCarouselMessage SourceReferenceMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: source_reference title: Type default: source_reference references: items: anyOf: - $ref: '#/components/schemas/DocumentReferenceMessage' - $ref: '#/components/schemas/WebReferenceMessage' - $ref: '#/components/schemas/YoutubeReferenceMessage' type: array title: References type: object required: - references title: SourceReferenceMessage SystemMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: system timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: system title: Type default: system content: type: string title: Content default: '' type: object title: SystemMessage ErrorMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id content: type: string title: Content show_to_user: type: boolean title: Show To User default: true close_delay: anyOf: - type: integer - type: 'null' title: Close Delay type: type: string const: error title: Type default: error error_type: anyOf: - type: string - type: 'null' title: Error Type type: object required: - content title: ErrorMessage WarningMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id content: type: string title: Content show_to_user: type: boolean title: Show To User default: true close_delay: anyOf: - type: integer - type: 'null' title: Close Delay type: type: string const: warning title: Type default: warning warning_type: anyOf: - type: string - type: 'null' title: Warning Type type: object required: - content title: WarningMessage InfoMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id content: type: string title: Content show_to_user: type: boolean title: Show To User default: true close_delay: anyOf: - type: integer - type: 'null' title: Close Delay type: type: string const: info title: Type default: info type: object required: - content title: InfoMessage SuccessMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id content: type: string title: Content show_to_user: type: boolean title: Show To User default: true close_delay: anyOf: - type: integer - type: 'null' title: Close Delay type: type: string const: success title: Type default: success type: object required: - content title: SuccessMessage SetConversationTitle: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: set_conversation_title title: Type default: set_conversation_title content: type: string title: Content type: object required: - content title: SetConversationTitle InternalToolResultMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: function timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id tool_type: anyOf: - type: string enum: - kb_qa - web_research - workflow - list_workflows - run_integration - noxus_qa - human_in_the_loop - type: string title: Tool Type type: type: string const: tool_result title: Type default: tool_result content: type: string title: Content type: object required: - tool_type - content title: InternalToolResultMessage YoutubeReferenceMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: youtube_reference title: Type default: youtube_reference url: type: string title: Url type: object required: - url title: YoutubeReferenceMessage StateTransitionMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: state_transition title: Type default: state_transition data: additionalProperties: true type: object title: Data next_state_key: type: string title: Next State Key type: object required: - data - next_state_key title: StateTransitionMessage ChatflowExtractionMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: chatflow_extraction title: Type default: chatflow_extraction data: additionalProperties: true type: object title: Data type: object required: - data title: ChatflowExtractionMessage ConversationEndMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: conversation_end title: Type default: conversation_end type: object title: ConversationEndMessage HumanInTheLoopMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: human_in_the_loop title: Type default: human_in_the_loop title: type: string title: Title description: type: string title: Description reason: type: string title: Reason priority: type: string enum: - low - medium - high - critical title: Priority type: object required: - title - description - reason - priority title: HumanInTheLoopMessage MemoryMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: memory title: Type default: memory content: additionalProperties: true type: object title: Content type: object required: - content title: MemoryMessage KBContextMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: kb_context title: Type default: kb_context context: $ref: '#/components/schemas/QAContext' type: object required: - context title: KBContextMessage WebpageContextMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: webpage_context title: Type default: webpage_context context: $ref: '#/components/schemas/WebpageContext' type: object required: - context title: WebpageContextMessage HumanInTheLoopAssignedMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: human_in_the_loop_assigned title: Type default: human_in_the_loop_assigned assigned_to: type: string format: uuid title: Assigned To type: object required: - assigned_to title: HumanInTheLoopAssignedMessage ThinkingMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: assistant timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: thinking title: Type default: thinking content: type: string title: Content default: '' type: object title: ThinkingMessage ThinkingEndedMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: thinking_ended title: Type default: thinking_ended seconds_duration: type: integer title: Seconds Duration type: object required: - seconds_duration title: ThinkingEndedMessage ClearConversationStreamMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: clear_conversation_stream title: Type default: clear_conversation_stream content: type: string title: Content default: '' type: object title: ClearConversationStreamMessage WorkflowRunningMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: workflow_running title: Type default: workflow_running workflow_id: type: string title: Workflow Id run_id: type: string title: Run Id display_message_start: type: string title: Display Message Start default: Running workflow... display_message_end: type: string title: Display Message End default: Workflow finished running type: object required: - workflow_id - run_id title: WorkflowRunningMessage ChatflowTransitionMessage: properties: role: $ref: '#/components/schemas/MessageRole' default: noxus timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: type: string const: chatflow_transition title: Type default: chatflow_transition content: type: string title: Content type: object required: - content title: ChatflowTransitionMessage ModelRequest: properties: parts: items: oneOf: - $ref: '#/components/schemas/SystemPromptPart' - $ref: '#/components/schemas/UserPromptPart' - $ref: '#/components/schemas/ToolReturnPart' - $ref: '#/components/schemas/RetryPromptPart' discriminator: propertyName: part_kind mapping: retry-prompt: $ref: '#/components/schemas/RetryPromptPart' system-prompt: $ref: '#/components/schemas/SystemPromptPart' tool-return: $ref: '#/components/schemas/ToolReturnPart' user-prompt: $ref: '#/components/schemas/UserPromptPart' type: array title: Parts timestamp: anyOf: - type: string format: date-time - type: 'null' title: Timestamp instructions: anyOf: - type: string - type: 'null' title: Instructions kind: type: string const: request title: Kind default: request run_id: anyOf: - type: string - type: 'null' title: Run Id metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata type: object required: - parts title: ModelRequest ModelResponse: properties: parts: items: oneOf: - $ref: '#/components/schemas/TextPart' - $ref: '#/components/schemas/ToolCallPart' - $ref: '#/components/schemas/BuiltinToolCallPart' - $ref: '#/components/schemas/BuiltinToolReturnPart' - $ref: '#/components/schemas/ThinkingPart' - $ref: '#/components/schemas/FilePart' discriminator: propertyName: part_kind mapping: builtin-tool-call: $ref: '#/components/schemas/BuiltinToolCallPart' builtin-tool-return: $ref: '#/components/schemas/BuiltinToolReturnPart' file: $ref: '#/components/schemas/FilePart' text: $ref: '#/components/schemas/TextPart' thinking: $ref: '#/components/schemas/ThinkingPart' tool-call: $ref: '#/components/schemas/ToolCallPart' type: array title: Parts usage: $ref: '#/components/schemas/RequestUsage' model_name: anyOf: - type: string - type: 'null' title: Model Name timestamp: type: string format: date-time title: Timestamp kind: type: string const: response title: Kind default: response provider_name: anyOf: - type: string - type: 'null' title: Provider Name provider_url: anyOf: - type: string - type: 'null' title: Provider Url provider_details: anyOf: - additionalProperties: true type: object - type: 'null' title: Provider Details provider_response_id: anyOf: - type: string - type: 'null' title: Provider Response Id finish_reason: anyOf: - type: string enum: - stop - length - content_filter - tool_call - error - type: 'null' title: Finish Reason run_id: anyOf: - type: string - type: 'null' title: Run Id metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata type: object required: - parts title: ModelResponse TextUIPart: properties: type: type: string const: text title: Type default: text text: type: string title: Text state: anyOf: - type: string enum: - streaming - done - type: 'null' title: State providerMetadata: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Providermetadata additionalProperties: false type: object required: - text title: TextUIPart description: A text part of a message. ReasoningUIPart: properties: type: type: string const: reasoning title: Type default: reasoning text: type: string title: Text state: anyOf: - type: string enum: - streaming - done - type: 'null' title: State providerMetadata: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Providermetadata additionalProperties: false type: object required: - text title: ReasoningUIPart description: A reasoning part of a message. ToolInputStreamingPart: properties: type: type: string pattern: ^tool- title: Type toolCallId: type: string title: Toolcallid state: type: string const: input-streaming title: State default: input-streaming input: anyOf: - {} - type: 'null' title: Input providerExecuted: anyOf: - type: boolean - type: 'null' title: Providerexecuted callProviderMetadata: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Callprovidermetadata approval: anyOf: - $ref: '#/components/schemas/ToolApprovalRequested' - $ref: '#/components/schemas/ToolApprovalResponded' - type: 'null' title: Approval additionalProperties: false type: object required: - type - toolCallId title: ToolInputStreamingPart description: Tool part in input-streaming state. ToolInputAvailablePart: properties: type: type: string pattern: ^tool- title: Type toolCallId: type: string title: Toolcallid state: type: string const: input-available title: State default: input-available input: anyOf: - {} - type: 'null' title: Input providerExecuted: anyOf: - type: boolean - type: 'null' title: Providerexecuted callProviderMetadata: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Callprovidermetadata approval: anyOf: - $ref: '#/components/schemas/ToolApprovalRequested' - $ref: '#/components/schemas/ToolApprovalResponded' - type: 'null' title: Approval additionalProperties: false type: object required: - type - toolCallId title: ToolInputAvailablePart description: Tool part in input-available state. ToolOutputAvailablePart: properties: type: type: string pattern: ^tool- title: Type toolCallId: type: string title: Toolcallid state: type: string const: output-available title: State default: output-available input: anyOf: - {} - type: 'null' title: Input output: anyOf: - {} - type: 'null' title: Output providerExecuted: anyOf: - type: boolean - type: 'null' title: Providerexecuted callProviderMetadata: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Callprovidermetadata preliminary: anyOf: - type: boolean - type: 'null' title: Preliminary approval: anyOf: - $ref: '#/components/schemas/ToolApprovalRequested' - $ref: '#/components/schemas/ToolApprovalResponded' - type: 'null' title: Approval additionalProperties: false type: object required: - type - toolCallId title: ToolOutputAvailablePart description: Tool part in output-available state. ToolOutputErrorPart: properties: type: type: string pattern: ^tool- title: Type toolCallId: type: string title: Toolcallid state: type: string const: output-error title: State default: output-error input: anyOf: - {} - type: 'null' title: Input rawInput: anyOf: - {} - type: 'null' title: Rawinput errorText: type: string title: Errortext providerExecuted: anyOf: - type: boolean - type: 'null' title: Providerexecuted callProviderMetadata: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Callprovidermetadata approval: anyOf: - $ref: '#/components/schemas/ToolApprovalRequested' - $ref: '#/components/schemas/ToolApprovalResponded' - type: 'null' title: Approval additionalProperties: false type: object required: - type - toolCallId - errorText title: ToolOutputErrorPart description: Tool part in output-error state. ToolApprovalRequestedPart: properties: type: type: string pattern: ^tool- title: Type toolCallId: type: string title: Toolcallid state: type: string const: approval-requested title: State default: approval-requested input: anyOf: - {} - type: 'null' title: Input providerExecuted: anyOf: - type: boolean - type: 'null' title: Providerexecuted callProviderMetadata: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Callprovidermetadata approval: anyOf: - $ref: '#/components/schemas/ToolApprovalRequested' - $ref: '#/components/schemas/ToolApprovalResponded' - type: 'null' title: Approval additionalProperties: false type: object required: - type - toolCallId title: ToolApprovalRequestedPart description: Tool part in approval-requested state (awaiting user decision). ToolApprovalRespondedPart: properties: type: type: string pattern: ^tool- title: Type toolCallId: type: string title: Toolcallid state: type: string const: approval-responded title: State default: approval-responded input: anyOf: - {} - type: 'null' title: Input providerExecuted: anyOf: - type: boolean - type: 'null' title: Providerexecuted callProviderMetadata: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Callprovidermetadata approval: anyOf: - $ref: '#/components/schemas/ToolApprovalRequested' - $ref: '#/components/schemas/ToolApprovalResponded' - type: 'null' title: Approval additionalProperties: false type: object required: - type - toolCallId title: ToolApprovalRespondedPart description: >- Tool part in approval-responded state (user approved/denied, execution pending). ToolOutputDeniedPart: properties: type: type: string pattern: ^tool- title: Type toolCallId: type: string title: Toolcallid state: type: string const: output-denied title: State default: output-denied input: anyOf: - {} - type: 'null' title: Input providerExecuted: anyOf: - type: boolean - type: 'null' title: Providerexecuted callProviderMetadata: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Callprovidermetadata approval: anyOf: - $ref: '#/components/schemas/ToolApprovalRequested' - $ref: '#/components/schemas/ToolApprovalResponded' - type: 'null' title: Approval additionalProperties: false type: object required: - type - toolCallId title: ToolOutputDeniedPart description: Tool part in output-denied state (tool was denied, terminal state). DynamicToolInputStreamingPart: properties: type: type: string const: dynamic-tool title: Type default: dynamic-tool toolName: type: string title: Toolname toolCallId: type: string title: Toolcallid state: type: string const: input-streaming title: State default: input-streaming input: anyOf: - {} - type: 'null' title: Input callProviderMetadata: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Callprovidermetadata approval: anyOf: - $ref: '#/components/schemas/ToolApprovalRequested' - $ref: '#/components/schemas/ToolApprovalResponded' - type: 'null' title: Approval additionalProperties: false type: object required: - toolName - toolCallId title: DynamicToolInputStreamingPart description: Dynamic tool part in input-streaming state. DynamicToolInputAvailablePart: properties: type: type: string const: dynamic-tool title: Type default: dynamic-tool toolName: type: string title: Toolname toolCallId: type: string title: Toolcallid state: type: string const: input-available title: State default: input-available input: title: Input callProviderMetadata: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Callprovidermetadata approval: anyOf: - $ref: '#/components/schemas/ToolApprovalRequested' - $ref: '#/components/schemas/ToolApprovalResponded' - type: 'null' title: Approval additionalProperties: false type: object required: - toolName - toolCallId - input title: DynamicToolInputAvailablePart description: Dynamic tool part in input-available state. DynamicToolOutputAvailablePart: properties: type: type: string const: dynamic-tool title: Type default: dynamic-tool toolName: type: string title: Toolname toolCallId: type: string title: Toolcallid state: type: string const: output-available title: State default: output-available input: title: Input output: title: Output callProviderMetadata: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Callprovidermetadata preliminary: anyOf: - type: boolean - type: 'null' title: Preliminary approval: anyOf: - $ref: '#/components/schemas/ToolApprovalRequested' - $ref: '#/components/schemas/ToolApprovalResponded' - type: 'null' title: Approval additionalProperties: false type: object required: - toolName - toolCallId - input - output title: DynamicToolOutputAvailablePart description: Dynamic tool part in output-available state. DynamicToolOutputErrorPart: properties: type: type: string const: dynamic-tool title: Type default: dynamic-tool toolName: type: string title: Toolname toolCallId: type: string title: Toolcallid state: type: string const: output-error title: State default: output-error input: title: Input errorText: type: string title: Errortext callProviderMetadata: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Callprovidermetadata approval: anyOf: - $ref: '#/components/schemas/ToolApprovalRequested' - $ref: '#/components/schemas/ToolApprovalResponded' - type: 'null' title: Approval additionalProperties: false type: object required: - toolName - toolCallId - input - errorText title: DynamicToolOutputErrorPart description: Dynamic tool part in output-error state. DynamicToolApprovalRequestedPart: properties: type: type: string const: dynamic-tool title: Type default: dynamic-tool toolName: type: string title: Toolname toolCallId: type: string title: Toolcallid state: type: string const: approval-requested title: State default: approval-requested input: title: Input callProviderMetadata: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Callprovidermetadata approval: anyOf: - $ref: '#/components/schemas/ToolApprovalRequested' - $ref: '#/components/schemas/ToolApprovalResponded' - type: 'null' title: Approval additionalProperties: false type: object required: - toolName - toolCallId - input title: DynamicToolApprovalRequestedPart description: Dynamic tool part in approval-requested state (awaiting user decision). DynamicToolApprovalRespondedPart: properties: type: type: string const: dynamic-tool title: Type default: dynamic-tool toolName: type: string title: Toolname toolCallId: type: string title: Toolcallid state: type: string const: approval-responded title: State default: approval-responded input: title: Input callProviderMetadata: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Callprovidermetadata approval: anyOf: - $ref: '#/components/schemas/ToolApprovalRequested' - $ref: '#/components/schemas/ToolApprovalResponded' - type: 'null' title: Approval additionalProperties: false type: object required: - toolName - toolCallId - input title: DynamicToolApprovalRespondedPart description: >- Dynamic tool part in approval-responded state (user approved/denied, execution pending). DynamicToolOutputDeniedPart: properties: type: type: string const: dynamic-tool title: Type default: dynamic-tool toolName: type: string title: Toolname toolCallId: type: string title: Toolcallid state: type: string const: output-denied title: State default: output-denied input: title: Input callProviderMetadata: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Callprovidermetadata approval: anyOf: - $ref: '#/components/schemas/ToolApprovalRequested' - $ref: '#/components/schemas/ToolApprovalResponded' - type: 'null' title: Approval additionalProperties: false type: object required: - toolName - toolCallId - input title: DynamicToolOutputDeniedPart description: >- Dynamic tool part in output-denied state (tool was denied, terminal state). SourceUrlUIPart: properties: type: type: string const: source-url title: Type default: source-url sourceId: type: string title: Sourceid url: type: string title: Url title: anyOf: - type: string - type: 'null' title: Title providerMetadata: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Providermetadata additionalProperties: false type: object required: - sourceId - url title: SourceUrlUIPart description: A source part of a message. SourceDocumentUIPart: properties: type: type: string const: source-document title: Type default: source-document sourceId: type: string title: Sourceid mediaType: type: string title: Mediatype title: type: string title: Title filename: anyOf: - type: string - type: 'null' title: Filename providerMetadata: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Providermetadata additionalProperties: false type: object required: - sourceId - mediaType - title title: SourceDocumentUIPart description: A document source part of a message. FileUIPart: properties: type: type: string const: file title: Type default: file mediaType: type: string title: Mediatype filename: anyOf: - type: string - type: 'null' title: Filename url: type: string title: Url providerMetadata: anyOf: - additionalProperties: additionalProperties: true type: object type: object - type: 'null' title: Providermetadata additionalProperties: false type: object required: - mediaType - url title: FileUIPart description: A file part of a message. DataUIPart: properties: type: type: string pattern: ^data- title: Type id: anyOf: - type: string - type: 'null' title: Id data: title: Data additionalProperties: false type: object required: - type - data title: DataUIPart description: Data part with dynamic type based on data name. StepStartUIPart: properties: type: type: string const: step-start title: Type default: step-start additionalProperties: false type: object title: StepStartUIPart description: A step boundary part of a message. 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) MessageRole: type: string enum: - system - user - assistant - function - noxus - controller title: MessageRole ConversationFile: properties: id: anyOf: - type: string format: uuid - type: 'null' title: Id name: type: string title: Name size: anyOf: - type: integer - type: 'null' title: Size type: anyOf: - type: string - type: 'null' title: Type status: type: string enum: - pending - success - error title: Status url: anyOf: - type: string - type: 'null' title: Url b64_content: anyOf: - type: string - type: 'null' title: B64 Content type: object required: - id - name - size - type - status - url title: ConversationFile BaseMessage: properties: role: $ref: '#/components/schemas/MessageRole' timestamp: type: string format: date-time title: Timestamp model: type: string title: Model trace_id: anyOf: - type: string - type: 'null' title: Trace Id message_id: anyOf: - type: string - type: 'null' title: Message Id span_id: anyOf: - type: string - type: 'null' title: Span Id type: object required: - role title: BaseMessage QAContext: properties: file_name: type: string title: File Name doc_id: anyOf: - type: string - type: 'null' title: Doc Id page_num: anyOf: - type: integer - type: string - type: 'null' title: Page Num context: type: string title: Context type: object required: - file_name - context title: QAContext WebpageContext: properties: url: type: string title: Url context: type: string title: Context type: object required: - url - context title: WebpageContext SystemPromptPart: properties: content: type: string title: Content timestamp: type: string format: date-time title: Timestamp dynamic_ref: anyOf: - type: string - type: 'null' title: Dynamic Ref part_kind: type: string const: system-prompt title: Part Kind default: system-prompt type: object required: - content title: SystemPromptPart UserPromptPart: properties: content: anyOf: - type: string - items: anyOf: - type: string - oneOf: - $ref: '#/components/schemas/ImageUrl' - $ref: '#/components/schemas/AudioUrl' - $ref: '#/components/schemas/DocumentUrl' - $ref: '#/components/schemas/VideoUrl' - $ref: '#/components/schemas/BinaryContent' - $ref: '#/components/schemas/UploadedFile' discriminator: propertyName: kind mapping: audio-url: $ref: '#/components/schemas/AudioUrl' binary: $ref: '#/components/schemas/BinaryContent' document-url: $ref: '#/components/schemas/DocumentUrl' image-url: $ref: '#/components/schemas/ImageUrl' uploaded-file: $ref: '#/components/schemas/UploadedFile' video-url: $ref: '#/components/schemas/VideoUrl' - $ref: '#/components/schemas/CachePoint' type: array title: Content timestamp: type: string format: date-time title: Timestamp part_kind: type: string const: user-prompt title: Part Kind default: user-prompt type: object required: - content title: UserPromptPart ToolReturnPart: properties: tool_name: type: string title: Tool Name content: $ref: '#/components/schemas/ToolReturnContent' tool_call_id: type: string title: Tool Call Id metadata: title: Metadata timestamp: type: string format: date-time title: Timestamp outcome: type: string enum: - success - failed - denied title: Outcome default: success part_kind: type: string const: tool-return title: Part Kind default: tool-return type: object required: - tool_name - content title: ToolReturnPart RetryPromptPart: properties: content: anyOf: - items: $ref: '#/components/schemas/ErrorDetails' type: array - type: string title: Content tool_name: anyOf: - type: string - type: 'null' title: Tool Name tool_call_id: type: string title: Tool Call Id timestamp: type: string format: date-time title: Timestamp part_kind: type: string const: retry-prompt title: Part Kind default: retry-prompt type: object required: - content title: RetryPromptPart TextPart: properties: content: type: string title: Content id: anyOf: - type: string - type: 'null' title: Id provider_name: anyOf: - type: string - type: 'null' title: Provider Name provider_details: anyOf: - additionalProperties: true type: object - type: 'null' title: Provider Details part_kind: type: string const: text title: Part Kind default: text type: object required: - content title: TextPart ToolCallPart: properties: tool_name: type: string title: Tool Name args: anyOf: - type: string - additionalProperties: true type: object - type: 'null' title: Args tool_call_id: type: string title: Tool Call Id id: anyOf: - type: string - type: 'null' title: Id provider_name: anyOf: - type: string - type: 'null' title: Provider Name provider_details: anyOf: - additionalProperties: true type: object - type: 'null' title: Provider Details part_kind: type: string const: tool-call title: Part Kind default: tool-call type: object required: - tool_name title: ToolCallPart BuiltinToolCallPart: properties: tool_name: type: string title: Tool Name args: anyOf: - type: string - additionalProperties: true type: object - type: 'null' title: Args tool_call_id: type: string title: Tool Call Id id: anyOf: - type: string - type: 'null' title: Id provider_name: anyOf: - type: string - type: 'null' title: Provider Name provider_details: anyOf: - additionalProperties: true type: object - type: 'null' title: Provider Details part_kind: type: string const: builtin-tool-call title: Part Kind default: builtin-tool-call type: object required: - tool_name title: BuiltinToolCallPart BuiltinToolReturnPart: properties: tool_name: type: string title: Tool Name content: $ref: '#/components/schemas/ToolReturnContent' tool_call_id: type: string title: Tool Call Id metadata: title: Metadata timestamp: type: string format: date-time title: Timestamp outcome: type: string enum: - success - failed - denied title: Outcome default: success provider_name: anyOf: - type: string - type: 'null' title: Provider Name provider_details: anyOf: - additionalProperties: true type: object - type: 'null' title: Provider Details part_kind: type: string const: builtin-tool-return title: Part Kind default: builtin-tool-return type: object required: - tool_name - content title: BuiltinToolReturnPart ThinkingPart: properties: content: type: string title: Content id: anyOf: - type: string - type: 'null' title: Id signature: anyOf: - type: string - type: 'null' title: Signature provider_name: anyOf: - type: string - type: 'null' title: Provider Name provider_details: anyOf: - additionalProperties: true type: object - type: 'null' title: Provider Details part_kind: type: string const: thinking title: Part Kind default: thinking type: object required: - content title: ThinkingPart FilePart: properties: content: $ref: '#/components/schemas/BinaryContent' id: anyOf: - type: string - type: 'null' title: Id provider_name: anyOf: - type: string - type: 'null' title: Provider Name provider_details: anyOf: - additionalProperties: true type: object - type: 'null' title: Provider Details part_kind: type: string const: file title: Part Kind default: file type: object required: - content title: FilePart RequestUsage: properties: input_tokens: type: integer title: Input Tokens default: 0 cache_write_tokens: type: integer title: Cache Write Tokens default: 0 cache_read_tokens: type: integer title: Cache Read Tokens default: 0 output_tokens: type: integer title: Output Tokens default: 0 input_audio_tokens: type: integer title: Input Audio Tokens default: 0 cache_audio_read_tokens: type: integer title: Cache Audio Read Tokens default: 0 output_audio_tokens: type: integer title: Output Audio Tokens default: 0 details: additionalProperties: type: integer type: object title: Details type: object title: RequestUsage ToolApprovalRequested: properties: id: type: string title: Id additionalProperties: false type: object required: - id title: ToolApprovalRequested description: Tool approval in requested state (awaiting user response). ToolApprovalResponded: properties: id: type: string title: Id approved: type: boolean title: Approved reason: anyOf: - type: string - type: 'null' title: Reason additionalProperties: false type: object required: - id - approved title: ToolApprovalResponded description: Tool approval in responded state (user has approved or denied). 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 ImageUrl: properties: url: type: string title: Url force_download: anyOf: - type: boolean - type: string const: allow-local title: Force Download default: false vendor_metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Vendor Metadata kind: type: string const: image-url title: Kind default: image-url media_type: type: string title: Media Type description: >- Return the media type of the file, based on the URL or the provided `media_type`. readOnly: true identifier: type: string title: Identifier description: >- The identifier of the file, such as a unique ID. This identifier can be provided to the model in a message to allow it to refer to this file in a tool call argument, and the tool can look up the file in question by iterating over the message history and finding the matching `FileUrl`. This identifier is only automatically passed to the model when the `FileUrl` is returned by a tool. If you're passing the `FileUrl` as a user message, it's up to you to include a separate text part with the identifier, e.g. "This is file :" preceding the `FileUrl`. It's also included in inline-text delimiters for providers that require inlining text documents, so the model can distinguish multiple files. readOnly: true type: object required: - url - media_type - identifier title: ImageUrl description: A URL to an image. AudioUrl: properties: url: type: string title: Url force_download: anyOf: - type: boolean - type: string const: allow-local title: Force Download default: false vendor_metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Vendor Metadata kind: type: string const: audio-url title: Kind default: audio-url media_type: type: string title: Media Type description: >- Return the media type of the file, based on the URL or the provided `media_type`. readOnly: true identifier: type: string title: Identifier description: >- The identifier of the file, such as a unique ID. This identifier can be provided to the model in a message to allow it to refer to this file in a tool call argument, and the tool can look up the file in question by iterating over the message history and finding the matching `FileUrl`. This identifier is only automatically passed to the model when the `FileUrl` is returned by a tool. If you're passing the `FileUrl` as a user message, it's up to you to include a separate text part with the identifier, e.g. "This is file :" preceding the `FileUrl`. It's also included in inline-text delimiters for providers that require inlining text documents, so the model can distinguish multiple files. readOnly: true type: object required: - url - media_type - identifier title: AudioUrl description: A URL to an audio file. DocumentUrl: properties: url: type: string title: Url force_download: anyOf: - type: boolean - type: string const: allow-local title: Force Download default: false vendor_metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Vendor Metadata kind: type: string const: document-url title: Kind default: document-url media_type: type: string title: Media Type description: >- Return the media type of the file, based on the URL or the provided `media_type`. readOnly: true identifier: type: string title: Identifier description: >- The identifier of the file, such as a unique ID. This identifier can be provided to the model in a message to allow it to refer to this file in a tool call argument, and the tool can look up the file in question by iterating over the message history and finding the matching `FileUrl`. This identifier is only automatically passed to the model when the `FileUrl` is returned by a tool. If you're passing the `FileUrl` as a user message, it's up to you to include a separate text part with the identifier, e.g. "This is file :" preceding the `FileUrl`. It's also included in inline-text delimiters for providers that require inlining text documents, so the model can distinguish multiple files. readOnly: true type: object required: - url - media_type - identifier title: DocumentUrl description: The URL of the document. VideoUrl: properties: url: type: string title: Url force_download: anyOf: - type: boolean - type: string const: allow-local title: Force Download default: false vendor_metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Vendor Metadata kind: type: string const: video-url title: Kind default: video-url media_type: type: string title: Media Type description: >- Return the media type of the file, based on the URL or the provided `media_type`. readOnly: true identifier: type: string title: Identifier description: >- The identifier of the file, such as a unique ID. This identifier can be provided to the model in a message to allow it to refer to this file in a tool call argument, and the tool can look up the file in question by iterating over the message history and finding the matching `FileUrl`. This identifier is only automatically passed to the model when the `FileUrl` is returned by a tool. If you're passing the `FileUrl` as a user message, it's up to you to include a separate text part with the identifier, e.g. "This is file :" preceding the `FileUrl`. It's also included in inline-text delimiters for providers that require inlining text documents, so the model can distinguish multiple files. readOnly: true type: object required: - url - media_type - identifier title: VideoUrl description: A URL to a video. BinaryContent: properties: data: type: string format: base64url title: Data media_type: anyOf: - type: string enum: - audio/wav - audio/mpeg - audio/ogg - audio/flac - audio/aiff - audio/aac - type: string enum: - image/jpeg - image/png - image/gif - image/webp - type: string enum: - application/pdf - text/plain - text/csv - >- application/vnd.openxmlformats-officedocument.wordprocessingml.document - >- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - text/html - text/markdown - application/msword - application/vnd.ms-excel - type: string title: Media Type vendor_metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Vendor Metadata kind: type: string const: binary title: Kind default: binary identifier: type: string title: Identifier description: >- Identifier for the binary content, such as a unique ID. This identifier can be provided to the model in a message to allow it to refer to this file in a tool call argument, and the tool can look up the file in question by iterating over the message history and finding the matching `BinaryContent`. This identifier is only automatically passed to the model when the `BinaryContent` is returned by a tool. If you're passing the `BinaryContent` as a user message, it's up to you to include a separate text part with the identifier, e.g. "This is file :" preceding the `BinaryContent`. It's also included in inline-text delimiters for providers that require inlining text documents, so the model can distinguish multiple files. readOnly: true type: object required: - data - media_type - identifier title: BinaryContent description: Binary content, e.g. an audio or image file. UploadedFile: properties: file_id: type: string title: File Id provider_name: type: string enum: - anthropic - openai - google-gla - google-vertex - bedrock - xai title: Provider Name vendor_metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Vendor Metadata kind: type: string const: uploaded-file title: Kind default: uploaded-file media_type: type: string title: Media Type description: >- Return the media type of the file, inferred from `file_id` if not explicitly provided. Note: Inference relies on the file extension in `file_id`. For opaque file IDs (e.g., `'file-abc123'`), the media type will default to `'application/octet-stream'`. Inference relies on Python's `mimetypes` module, whose results may vary across platforms. Required by some providers (e.g., Bedrock) for certain file types. readOnly: true identifier: type: string title: Identifier description: >- The identifier of the file, such as a unique ID. This identifier can be provided to the model in a message to allow it to refer to this file in a tool call argument, and the tool can look up the file in question by iterating over the message history and finding the matching `UploadedFile`. This identifier is only automatically passed to the model when the `UploadedFile` is returned by a tool. If you're passing the `UploadedFile` as a user message, it's up to you to include a separate text part with the identifier, e.g. "This is file :" preceding the `UploadedFile`. readOnly: true type: object required: - file_id - provider_name - media_type - identifier title: UploadedFile description: >- A reference to a file uploaded to a provider's file storage by ID. This allows referencing files that have been uploaded via provider-specific file APIs rather than providing the file content directly. Supported by: - [`AnthropicModel`][pydantic_ai.models.anthropic.AnthropicModel] - [`OpenAIChatModel`][pydantic_ai.models.openai.OpenAIChatModel] - [`OpenAIResponsesModel`][pydantic_ai.models.openai.OpenAIResponsesModel] - [`BedrockConverseModel`][pydantic_ai.models.bedrock.BedrockConverseModel] - [`GoogleModel`][pydantic_ai.models.google.GoogleModel] - [`XaiModel`][pydantic_ai.models.xai.XaiModel] CachePoint: properties: kind: type: string const: cache-point title: Kind default: cache-point ttl: type: string enum: - 5m - 1h title: Ttl default: 5m type: object title: CachePoint ToolReturnContent: anyOf: - oneOf: - $ref: '#/components/schemas/ImageUrl' - $ref: '#/components/schemas/AudioUrl' - $ref: '#/components/schemas/DocumentUrl' - $ref: '#/components/schemas/VideoUrl' - $ref: '#/components/schemas/BinaryContent' - $ref: '#/components/schemas/UploadedFile' discriminator: propertyName: kind mapping: audio-url: $ref: '#/components/schemas/AudioUrl' binary: $ref: '#/components/schemas/BinaryContent' document-url: $ref: '#/components/schemas/DocumentUrl' image-url: $ref: '#/components/schemas/ImageUrl' uploaded-file: $ref: '#/components/schemas/UploadedFile' video-url: $ref: '#/components/schemas/VideoUrl' - items: $ref: '#/components/schemas/ToolReturnContent' type: array - additionalProperties: $ref: '#/components/schemas/ToolReturnContent' type: object - {} ErrorDetails: properties: type: type: string title: Type loc: items: anyOf: - type: integer - type: string type: array title: Loc msg: type: string title: Msg input: title: Input ctx: additionalProperties: true type: object title: Ctx url: type: string title: Url type: object required: - type - loc - msg - input title: ErrorDetails 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 ````