{"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"},"paths":{"/v1/workflows":{"get":{"tags":["V1 - Workflows"],"summary":"Get Workflows Public","operationId":"get_workflows_public","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","default":"last_updated_at","title":"Order By"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","default":"desc","title":"Sort"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_WorkflowWithTriggers_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["V1 - Workflows"],"summary":"Create Workflow Public","operationId":"create_workflow_public","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkflowRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workflow"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/workflows/{workflow_id}":{"patch":{"tags":["V1 - Workflows"],"summary":"Update Workflow Public","operationId":"update_workflow_public","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"string","title":"Workflow Id"}},{"name":"force","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Force"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWorkflowRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workflow"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["V1 - Workflows"],"summary":"Get Workflow Public","operationId":"get_workflow_public","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"string","title":"Workflow Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workflow"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["V1 - Workflows"],"summary":"Delete Workflow Public","operationId":"delete_workflow_public","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"string","title":"Workflow Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Status"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/workflows/{workflow_id}/logs/columns":{"get":{"tags":["V1 - Workflows"],"summary":"Get Workflow Logs Columns","operationId":"get_workflow_logs_columns","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"string","title":"Workflow Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"title":"Response Get Workflow Logs Columns"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/workflows/{workflow_id}/logs":{"get":{"tags":["V1 - Workflows"],"summary":"Get Workflow Logs Public","operationId":"get_workflow_logs_public","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"string","title":"Workflow Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowLogs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/workflows/{workflow_id}/versions":{"get":{"tags":["V1 - Workflows"],"summary":"Public Get Workflow Versions","operationId":"public_get_workflow_versions","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workflow Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WorkflowVersion"},"title":"Response Public Get Workflow Versions"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["V1 - Workflows"],"summary":"Public Create Workflow Version","operationId":"public_create_workflow_version","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"string","title":"Workflow Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkflowVersionRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowVersion"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/workflows/{workflow_id}/versions/{version_id}":{"patch":{"tags":["V1 - Workflows"],"summary":"Public Update Workflow Version","operationId":"public_update_workflow_version","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workflow Id"}},{"name":"version_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Version Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkflowVersionRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowVersion"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/workflows/{workflow_id}/export/preview":{"get":{"tags":["V1 - Workflows"],"summary":"Public Export Workflow Preview","description":"Preview what will be exported for a workflow.\n\nReturns a list of entities that would be exported along with any warnings\n(e.g., KBs that are too large).","operationId":"public_export_workflow_preview","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"string","title":"Workflow Id"}},{"name":"version_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportPreviewResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/workflows/{workflow_id}/export":{"post":{"tags":["V1 - Workflows"],"summary":"Public Export Workflow","description":"Export a workflow and all its dependencies.\n\nReturns an export file (v4 plaintext YAML by default, v3 base64 on request)\nthat can be imported later.","operationId":"public_export_workflow","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"string","title":"Workflow Id"}},{"name":"version_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version Id"}},{"name":"version","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ExportFormat","description":"Export wire format. `auto` (default) emits the legacy base64-encoded bundle for back-compat; pass `v4` for plaintext multi-doc YAML (`.nx`), or `v3` for base64 explicitly.","default":"auto"},"description":"Export wire format. `auto` (default) emits the legacy base64-encoded bundle for back-compat; pass `v4` for plaintext multi-doc YAML (`.nx`), or `v3` for base64 explicitly."},{"name":"set_active_on_import","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Set Active On Import"}},{"name":"include_dependencies","in":"query","required":false,"schema":{"type":"boolean","description":"Bundle referenced sub-flows / KBs / files into the .nx.","default":true,"title":"Include Dependencies"},"description":"Bundle referenced sub-flows / KBs / files into the .nx."}],"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/workflows/import":{"post":{"tags":["V1 - Workflows"],"summary":"Public Import Workflow","description":"Import a workflow from an export file.\n\nThe definition should be the base64-encoded content from a previous export.\nReturns a list of all created entities with their new IDs.","operationId":"public_import_workflow","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"mode","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ImportMode","default":"clone"}},{"name":"activate","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Activate"}},{"name":"on_missing_dependency","in":"query","required":false,"schema":{"$ref":"#/components/schemas/MissingDependencyPolicy","default":"fail"}},{"name":"dry_run","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Dry Run"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportWorkflowRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExportableReference"},"title":"Response Public Import Workflow"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/workflows/{workflow_id}/runs":{"post":{"tags":["V1 - Runs"],"summary":"Create Run With Api Key","operationId":"create_run_with_api_key","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"string","title":"Workflow Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRunRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicSimplifiedRun"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["V1 - Runs"],"summary":"Get Runs Public","operationId":"get_runs_public","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"string","title":"Workflow Id"}},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","default":"created_at","title":"Order By"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","default":"desc","title":"Sort"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_PublicSimplifiedRun_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/workflows/{workflow_id}/runs/{run_id}":{"get":{"tags":["V1 - Runs"],"summary":"Public Get Run By Id And Workflow","operationId":"public_get_run_by_id_and_workflow","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"string","title":"Workflow Id"}},{"name":"run_id","in":"path","required":true,"schema":{"type":"string","title":"Run Id"}},{"name":"output_only","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Output Only"}},{"name":"use_output_ids","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Use Output Ids"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/PublicSimplifiedRun"},{"$ref":"#/components/schemas/RunOutputWithStatus"}],"title":"Response Public Get Run By Id And Workflow"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/workflows/{workflow_id}/runs/sync":{"post":{"tags":["V1 - Runs"],"summary":"Create Sync Run","operationId":"create_sync_run","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"string","title":"Workflow Id"}},{"name":"output_only","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Output Only"}},{"name":"use_output_ids","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Use Output Ids"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRunRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/RunOutput"},{"$ref":"#/components/schemas/PublicSimplifiedRun"}],"title":"Response Create Sync Run"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/runs":{"get":{"tags":["V1 - Runs"],"summary":"Public Get Paginated Runs","operationId":"public_get_paginated_runs","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"created_at","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/RunStatus"},{"type":"null"}],"title":"Status"}},{"name":"source","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"}},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","default":"created_at","title":"Order By"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","default":"desc","title":"Sort"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_RunNoIO_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/runs/{run_id}/events":{"get":{"tags":["V1 - Runs"],"summary":"Public Run Events","operationId":"public_run_events","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"run_id","in":"path","required":true,"schema":{"type":"string","title":"Run Id"}},{"name":"etag","in":"query","required":false,"schema":{"type":"string","title":"Etag"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/runs/{run_id}":{"get":{"tags":["V1 - Runs"],"summary":"Public Get Run By Id","operationId":"public_get_run_by_id","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"run_id","in":"path","required":true,"schema":{"type":"string","title":"Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunNoIO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["V1 - Runs"],"summary":"Public Delete Run","description":"Delete one finished run with its data. A run still in flight is reported\nunder ``errors`` and left alone.","operationId":"public_delete_run","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"run_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRunsResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/runs/{run_id}/stop":{"post":{"tags":["V1 - Runs"],"summary":"Public Stop Run","operationId":"public_stop_run","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"run_id","in":"path","required":true,"schema":{"type":"string","title":"Run Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicSimplifiedRun"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/runs/{run_id}/data":{"get":{"tags":["V1 - Runs"],"summary":"Public Get Run Data By Id","operationId":"public_get_run_data_by_id","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"run_id","in":"path","required":true,"schema":{"type":"string","title":"Run Id"}},{"name":"fetch_structured_data","in":"query","required":false,"schema":{"type":"boolean","description":"When False, skip fetching structured_data from node IO storage","default":true,"title":"Fetch Structured Data"},"description":"When False, skip fetching structured_data from node IO storage"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunData"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/runs/{run_id}/io/{node_id}":{"get":{"tags":["V1 - Runs"],"summary":"Public Get Run Node Io","description":"Inputs/outputs of a single node within a run (with secret redaction).\n\n``it`` is the node's iteration (1-based) for nodes that fan out in a loop;\n0 is tolerated and treated as the first iteration.","operationId":"public_get_run_node_io","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"run_id","in":"path","required":true,"schema":{"type":"string","title":"Run Id"}},{"name":"node_id","in":"path","required":true,"schema":{"type":"string","title":"Node Id"}},{"name":"it","in":"query","required":false,"schema":{"type":"integer","default":1,"title":"It"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunIO"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/runs/search":{"post":{"tags":["V1 - Runs"],"summary":"Search Runs Public","operationId":"search_runs_public","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRunRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_PublicRunWithSearchData_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/runs/bulk/delete":{"post":{"tags":["V1 - Runs"],"summary":"Public Delete Runs","description":"Delete finished runs with everything they own (inputs and outputs, logs,\nprogress, traces, files no other run references). Select by ``run_ids`` or\nby ``filters`` — ``filters.to_date`` deletes runs created before it. Runs\nstill queued, running or awaiting a human are listed under ``errors`` and\nleft alone. Usage analytics survive: billing is unaffected. Needs a key\ncarrying ``resource:delete_history``.","operationId":"public_delete_runs","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRunsRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteRunsResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/knowledge-bases/mime-types":{"get":{"tags":["V1 - Knowledge Bases"],"summary":"Get Compatible Mime Types","description":"Get supported MIME types for a specific entity type","operationId":"get_compatible_mime_types","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/MimeTypeInfo"},"type":"array","title":"Response Get Compatible Mime Types"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/knowledge-bases":{"post":{"tags":["V1 - Knowledge Bases"],"summary":"Add Knowledge Base V2","operationId":"add_knowledge_base_v2","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateKnowledgeBase"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseV2"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["V1 - Knowledge Bases"],"summary":"Get Knowledge Bases V2","operationId":"get_knowledge_bases_v2","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query"}},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","default":"last_updated_at","title":"Order By"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","default":"desc","title":"Sort"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_KnowledgeBaseV2_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/knowledge-bases/{knowledge_base_id}":{"get":{"tags":["V1 - Knowledge Bases"],"summary":"Get Knowledge Base V2","operationId":"get_knowledge_base_v2","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","title":"Knowledge Base Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseWithDocuments"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["V1 - Knowledge Bases"],"summary":"Update Knowledge Base V2","operationId":"update_knowledge_base_v2","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","title":"Knowledge Base Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateKnowledgeBaseRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseV2"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["V1 - Knowledge Bases"],"summary":"Delete Knowledge Base V2","operationId":"delete_knowledge_base_v2","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","title":"Knowledge Base Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Status"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/knowledge-bases/{knowledge_base_id}/runs":{"get":{"tags":["V1 - Knowledge Bases"],"summary":"Get Knowledge Base Running Jobs","operationId":"get_knowledge_base_running_jobs","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","title":"Knowledge Base Id"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/RunStatus"},{"type":"null"}],"title":"Status"}},{"name":"run_ids","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Run Ids"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Run"},"title":"Response Get Knowledge Base Running Jobs"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/knowledge-bases/{knowledge_base_id}/search":{"post":{"tags":["V1 - Knowledge Bases"],"summary":"Search Knowledge Base","operationId":"search_knowledge_base","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","title":"Knowledge Base Id"}},{"name":"query","in":"query","required":true,"schema":{"type":"string","title":"Query"}},{"name":"prefix","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prefix"}},{"name":"date_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date From"}},{"name":"date_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Date To"}},{"name":"date_field","in":"query","required":false,"schema":{"type":"string","default":"file_modified_date","title":"Date Field"}},{"name":"recency_boost","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Recency Boost"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SearchResult"},"title":"Response Search Knowledge Base"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/knowledge-bases/{knowledge_base_id}/document":{"post":{"tags":["V1 - Knowledge Bases"],"summary":"Add Knowledge Base Document","operationId":"add_knowledge_base_document","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","title":"Knowledge Base Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDocument"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseDocument"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/knowledge-bases/{knowledge_base_id}/document/{document_id}":{"get":{"tags":["V1 - Knowledge Bases"],"summary":"Get Knowledge Base Document","operationId":"get_knowledge_base_document","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","title":"Knowledge Base Id"}},{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseDocument"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["V1 - Knowledge Bases"],"summary":"Delete Knowledge Base Document","operationId":"delete_knowledge_base_document","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","title":"Knowledge Base Id"}},{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseDocument"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["V1 - Knowledge Bases"],"summary":"Update Knowledge Base Document","operationId":"update_knowledge_base_document","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","title":"Knowledge Base Id"}},{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDocument"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseDocument"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/knowledge-bases/{knowledge_base_id}/tree":{"get":{"tags":["V1 - Knowledge Bases"],"summary":"Get Knowledge Base Tree","description":"Get a hierarchical tree view of files and folders in a knowledge base.","operationId":"get_knowledge_base_tree","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","title":"Knowledge Base Id"}},{"name":"folder","in":"query","required":false,"schema":{"type":"string","description":"Root folder path","default":"/","title":"Folder"},"description":"Root folder path"},{"name":"max_depth","in":"query","required":false,"schema":{"type":"integer","maximum":10,"minimum":1,"description":"Maximum tree depth","default":3,"title":"Max Depth"},"description":"Maximum tree depth"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response Get Knowledge Base Tree"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/knowledge-bases/{knowledge_base_id}/ls":{"get":{"tags":["V1 - Knowledge Bases"],"summary":"List Knowledge Base Folder","description":"List files and folders in a specific folder of a knowledge base (non-recursive).","operationId":"list_knowledge_base_folder","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","title":"Knowledge Base Id"}},{"name":"folder","in":"query","required":false,"schema":{"type":"string","description":"Folder path to list","default":"/","title":"Folder"},"description":"Folder path to list"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","title":"Response List Knowledge Base Folder"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/knowledge-bases/{knowledge_base_id}/documents/search":{"get":{"tags":["V1 - Knowledge Bases"],"summary":"Search Knowledge Base Documents","description":"Search documents by file name using fuzzy matching.","operationId":"search_knowledge_base_documents","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","title":"Knowledge Base Id"}},{"name":"query","in":"query","required":true,"schema":{"type":"string","description":"File name search query","title":"Query"},"description":"File name search query"},{"name":"prefix","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Folder prefix filter","title":"Prefix"},"description":"Folder prefix filter"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Max results","default":25,"title":"Limit"},"description":"Max results"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeBaseDocument"},"title":"Response Search Knowledge Base Documents"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/knowledge-bases/{knowledge_base_id}/documents/ingestion":{"get":{"tags":["V1 - Knowledge Bases"],"summary":"Get Knowledge Base Ingestion Documents","description":"Get documents that are currently being ingested (uploaded, training, or error status)","operationId":"get_knowledge_base_ingestion_documents","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","title":"Knowledge Base Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeBaseDocument"},"title":"Response Get Knowledge Base Ingestion Documents"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/knowledge-bases/{knowledge_base_id}/documents/{status}":{"get":{"tags":["V1 - Knowledge Bases"],"summary":"Get Knowledge Base Documents","operationId":"get_knowledge_base_documents","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","title":"Knowledge Base Id"}},{"name":"status","in":"path","required":true,"schema":{"$ref":"#/components/schemas/DocumentStatus"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_KnowledgeBaseDocument_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/knowledge-bases/{knowledge_base_id}/document/{document_id}/dismiss":{"patch":{"tags":["V1 - Knowledge Bases"],"summary":"Dismiss Knowledge Base Document","description":"Mark a document as dismissed (typically used for error documents)","operationId":"dismiss_knowledge_base_document","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","title":"Knowledge Base Id"}},{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseDocument"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/knowledge-bases/{knowledge_base_id}/retry_all":{"post":{"tags":["V1 - Knowledge Bases"],"summary":"Retry Train Knowledge Base","operationId":"retry_train_knowledge_base","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","title":"Knowledge Base Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"},"title":"Response Retry Train Knowledge Base"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/knowledge-bases/{knowledge_base_id}/document/{document_id}/retry":{"post":{"tags":["V1 - Knowledge Bases"],"summary":"Retry Document Ingestion","operationId":"retry_document_ingestion","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","title":"Knowledge Base Id"}},{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","format":"uuid","title":"Response Retry Document Ingestion"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/knowledge-bases/{knowledge_base_id}/upload_train":{"post":{"tags":["V1 - Knowledge Bases"],"summary":"Upload Train Knowledge Base","operationId":"upload_train_knowledge_base","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Knowledge Base Id"}},{"name":"prefix","in":"query","required":false,"schema":{"type":"string","description":"The path prefix where to upload","default":"/","title":"Prefix"},"description":"The path prefix where to upload"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_train_knowledge_base"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"},"title":"Response Upload Train Knowledge Base"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/knowledge-bases/types":{"get":{"tags":["V1 - Knowledge Bases"],"summary":"Fetch Knowledge Base Custom Types","operationId":"fetch_knowledge_base_custom_types","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/KnowledgeBaseType"},"type":"array","title":"Response Fetch Knowledge Base Custom Types"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/knowledge-bases/{knowledge_base_id}/generic_train":{"post":{"tags":["V1 - Knowledge Bases"],"summary":"Generic Train Knowledge Base","operationId":"generic_train_knowledge_base","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Knowledge Base Id"}},{"name":"prefix","in":"query","required":false,"schema":{"type":"string","description":"The path prefix where to upload","default":"/","title":"Prefix"},"description":"The path prefix where to upload"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Source"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string","format":"uuid"},"title":"Response Generic Train Knowledge Base"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/knowledge-bases/{knowledge_base_id}/export":{"post":{"tags":["V1 - Knowledge Bases"],"summary":"Public Export Kb","description":"Export a knowledge base.\n\nReturns an export file (v4 plaintext YAML by default, v3 base64 on request)\nthat can be imported later.\nNote: KBs larger than 15MB are exported without their documents (metadata\nand settings only); the response is ``206 Partial Content`` and carries an\n``X-Export-Warning`` header.","operationId":"public_export_kb","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","title":"Knowledge Base Id"}},{"name":"version","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ExportFormat","description":"Export wire format. `auto` (default) emits the legacy base64-encoded bundle for back-compat; pass `v4` for plaintext multi-doc YAML (`.nx`), or `v3` for base64 explicitly.","default":"auto"},"description":"Export wire format. `auto` (default) emits the legacy base64-encoded bundle for back-compat; pass `v4` for plaintext multi-doc YAML (`.nx`), or `v3` for base64 explicitly."},{"name":"set_active_on_import","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Set Active On Import"}}],"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/knowledge-bases/import":{"post":{"tags":["V1 - Knowledge Bases"],"summary":"Public Import Kb","description":"Import a knowledge base from an export file.\n\nThe definition should be the base64-encoded content from a previous export.\nReturns the created knowledge base with its new ID.","operationId":"public_import_kb","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"mode","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ImportMode","default":"clone"}},{"name":"activate","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Activate"}},{"name":"on_missing_dependency","in":"query","required":false,"schema":{"$ref":"#/components/schemas/MissingDependencyPolicy","default":"fail"}},{"name":"dry_run","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Dry Run"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportKBRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExportableReference"},"title":"Response Public Import Kb"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/conversations":{"get":{"tags":["V1 - Conversations"],"summary":"List Conversations","operationId":"list_conversations","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"order_by","in":"query","required":false,"schema":{"type":"string","default":"last_updated_at","title":"Order By"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","default":"desc","title":"Sort"}},{"name":"assistant_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Assistant Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_SdkConversation_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["V1 - Conversations"],"summary":"Create Conversation","operationId":"create_conversation","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"assistant_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Assistant Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConversation"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdkConversationWithMessages"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/conversations/{conversation_id}":{"get":{"tags":["V1 - Conversations"],"summary":"Get Conversation","operationId":"get_conversation","security":[{"APIKeyHeader":[]}],"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/SdkConversationWithMessages"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["V1 - Conversations"],"summary":"Update Conversation","operationId":"update_conversation","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"conversation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Conversation Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConversation"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdkConversationWithMessages"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["V1 - Conversations"],"summary":"Add Message","operationId":"add_message","security":[{"APIKeyHeader":[]}],"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"}},{"name":"message_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddMessageRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdkConversationWithMessages"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["V1 - Conversations"],"summary":"Delete Conversation","operationId":"delete_conversation","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"conversation_id","in":"path","required":true,"schema":{"type":"string","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/Status"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/conversations/{conversation_id}/stream":{"post":{"tags":["V1 - Conversations"],"summary":"Stream Message","description":"Send a message and stream agent SSE events back over the same request.\n\nUnlike `POST /v1/conversations/{id}` (which blocks until the run finishes),\nthis endpoint dispatches the run and immediately returns a streaming SSE\nresponse carrying every event the worker emits to Redis.\n\n`format` controls the SSE wire format:\n  * `vercel` (default) — pydantic-ai Vercel AI SDK frames passed through verbatim.\n  * `json` — each frame normalised to `event: message\\ndata: {\"event\": ..., \"data\": ...}\\n\\n`,\n    terminated by `event: done`.","operationId":"stream_message","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"conversation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Conversation Id"}},{"name":"format","in":"query","required":false,"schema":{"enum":["vercel","json"],"type":"string","default":"vercel","title":"Format"}},{"name":"assistant_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Assistant Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddMessageRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/conversations/{conversation_id}/chat":{"post":{"tags":["V1 - Conversations"],"summary":"Chat","operationId":"chat","security":[{"APIKeyHeader":[]}],"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"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddMessageRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatMessage"}}}},"502":{"description":"Conversation job failed or returned no assistant content."},"504":{"description":"Conversation job did not finish before the synchronous wait timed out."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/conversations/{conversation_id}/messages/{message_id}/refresh":{"post":{"tags":["V1 - Conversations"],"summary":"Refresh Message","operationId":"refresh_message","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"conversation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Conversation Id"}},{"name":"message_id","in":"path","required":true,"schema":{"type":"string","title":"Message 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/SdkConversationWithMessages"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/conversations/{conversation_id}/events":{"get":{"tags":["V1 - Conversations"],"summary":"Conversation Events","description":"Tail the SSE event stream of an in-progress conversation run.\n\nReads the same `vercel::{conversation_id}` Redis stream that the worker\npublishes to (and that `/stream` consumes). Use `?etag=` to resume from a\nspecific Redis stream id; use `?format=json` for normalised envelope\nframes (`event: message\\ndata: {\"event\": ..., \"data\": ...}`).","operationId":"conversation_events","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"conversation_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Conversation Id"}},{"name":"format","in":"query","required":false,"schema":{"enum":["vercel","json"],"type":"string","default":"vercel","title":"Format"}},{"name":"etag","in":"query","required":false,"schema":{"type":"string","title":"Etag"}},{"name":"token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Public access token","title":"Token"},"description":"Public access token"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents":{"post":{"tags":["V1 - Agents (Co-workers)"],"summary":"Add Agent","operationId":"add_agent","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssistant"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdkAssistant"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["V1 - Agents (Co-workers)"],"summary":"Get Agents","operationId":"get_agents","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Query"}},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"order_by","in":"query","required":false,"schema":{"type":"string","default":"last_updated_at","title":"Order By"}},{"name":"sort","in":"query","required":false,"schema":{"type":"string","default":"desc","title":"Sort"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_SdkAssistant_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{agent_id}":{"patch":{"tags":["V1 - Agents (Co-workers)"],"summary":"Update Agent","operationId":"update_agent","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}},{"name":"preview","in":"query","required":false,"schema":{"type":"boolean","description":"Preview changes without saving","default":false,"title":"Preview"},"description":"Preview changes without saving"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAssistant"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdkAssistant"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["V1 - Agents (Co-workers)"],"summary":"Get Agent","operationId":"get_agent","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdkAssistant"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["V1 - Agents (Co-workers)"],"summary":"Delete Agent","operationId":"delete_agent","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Status"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{agent_id}/duplicate":{"post":{"tags":["V1 - Agents (Co-workers)"],"summary":"Duplicate Agent","operationId":"duplicate_agent","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SdkAssistant"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{agent_id}/publish":{"post":{"tags":["V1 - Agents (Co-workers)"],"summary":"Publish Assistant","operationId":"publish_assistant","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Status"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/tool-schemas":{"get":{"tags":["V1 - Agents (Co-workers)"],"summary":"Get Tool Schemas","description":"Return NCL config schemas for all tool types, grouped by category.","operationId":"get_tool_schemas","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"items":{"$ref":"#/components/schemas/ToolSchemaEntry"},"type":"array"},"type":"object","title":"Response Get Tool Schemas"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/agents/{agent_id}/versions":{"get":{"tags":["V1 - Agents (Co-workers)"],"summary":"Get Agent Versions","operationId":"get_agent_versions","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_AssistantVersion_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{agent_id}/restore":{"post":{"tags":["V1 - Agents (Co-workers)"],"summary":"Restore Agent","operationId":"restore_agent","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Status"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{agent_id}/export/preview":{"get":{"tags":["V1 - Agents (Co-workers)"],"summary":"Public Export Agent Preview","operationId":"public_export_agent_preview","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}},{"name":"version_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportPreviewResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{agent_id}/export":{"post":{"tags":["V1 - Agents (Co-workers)"],"summary":"Public Export Agent","operationId":"public_export_agent","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id"}},{"name":"version_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version Id"}},{"name":"version","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ExportFormat","description":"Export wire format. `auto` (default) emits the legacy base64-encoded bundle for back-compat; pass `v4` for plaintext multi-doc YAML (`.nx`), or `v3` for base64 explicitly.","default":"auto"},"description":"Export wire format. `auto` (default) emits the legacy base64-encoded bundle for back-compat; pass `v4` for plaintext multi-doc YAML (`.nx`), or `v3` for base64 explicitly."},{"name":"set_active_on_import","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Set Active On Import"}},{"name":"include_dependencies","in":"query","required":false,"schema":{"type":"boolean","description":"Bundle referenced sub-flows / KBs / files into the .nx.","default":true,"title":"Include Dependencies"},"description":"Bundle referenced sub-flows / KBs / files into the .nx."}],"responses":{"200":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/import":{"post":{"tags":["V1 - Agents (Co-workers)"],"summary":"Public Import Agent","operationId":"public_import_agent","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"mode","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ImportMode","default":"clone"}},{"name":"activate","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Activate"}},{"name":"on_missing_dependency","in":"query","required":false,"schema":{"$ref":"#/components/schemas/MissingDependencyPolicy","default":"fail"}},{"name":"dry_run","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Dry Run"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportAgentRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExportableReference"},"title":"Response Public Import Agent"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{assistant_id}/triggers":{"get":{"tags":["V1 - Triggers"],"summary":"Get Assistant Triggers","operationId":"get_assistant_triggers","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"assistant_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Assistant Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssistantTrigger"},"title":"Response Get Assistant Triggers"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/triggers/{trigger_id}":{"delete":{"tags":["V1 - Triggers"],"summary":"Delete Trigger","operationId":"delete_trigger","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"trigger_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Trigger Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Status"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/workflows/{workflow_id}/triggers":{"post":{"tags":["V1 - Triggers"],"summary":"Create Workflow Trigger","description":"Create a trigger on a workflow. The trigger is attributed to this API key.","operationId":"create_workflow_trigger","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"string","title":"Workflow Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTriggerRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trigger"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["V1 - Triggers"],"summary":"Get Workflow Triggers","description":"List a workflow's triggers.","operationId":"get_workflow_triggers","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"string","title":"Workflow Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_Trigger_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/workflows/{workflow_id}/triggers/{trigger_id}":{"patch":{"tags":["V1 - Triggers"],"summary":"Update Workflow Trigger","description":"Update a trigger's definition.","operationId":"update_workflow_trigger","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"string","title":"Workflow Id"}},{"name":"trigger_id","in":"path","required":true,"schema":{"type":"string","title":"Trigger Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTriggerRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Trigger"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/workflows/{workflow_id}/triggers/{trigger_id}/events":{"get":{"tags":["V1 - Triggers"],"summary":"Get Workflow Trigger Events","description":"Browse the events a specific trigger has received.\n\n``errored=true`` narrows this to the deliveries that went wrong.","operationId":"get_workflow_trigger_events","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"string","title":"Workflow Id"}},{"name":"trigger_id","in":"path","required":true,"schema":{"type":"string","title":"Trigger Id"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"errored","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Errored"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_TriggerEvent_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/triggers/events":{"get":{"tags":["V1 - Triggers"],"summary":"Get All Trigger Events","description":"Browse every trigger event in the workspace, across all triggers.\n\nPass ``errored=true`` to poll for triggers that stopped working — a failed\npoll or schedule produces no run at all, so it shows up here and nowhere else.","operationId":"get_all_trigger_events","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"event_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Event Type"}},{"name":"workflow_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflow Id"}},{"name":"started_run","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Started Run"}},{"name":"errored","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Errored"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_GroupTriggerEvent_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/channels":{"get":{"tags":["V1 - Deployments"],"summary":"List Channels","description":"Metadata for every registered deployment channel (respects kill switch).","operationId":"list_channels","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ChannelMetadata"},"type":"array","title":"Response List Channels"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/agents/{assistant_id}/deployments":{"get":{"tags":["V1 - Deployments"],"summary":"List Deployments","operationId":"list_deployments","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"assistant_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Assistant Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeploymentResponse"},"title":"Response List Deployments"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["V1 - Deployments"],"summary":"Create Deployment","operationId":"create_deployment","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"assistant_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Assistant Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{assistant_id}/deployments/{deployment_id}":{"get":{"tags":["V1 - Deployments"],"summary":"Get Deployment","operationId":"get_deployment","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"assistant_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Assistant Id"}},{"name":"deployment_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Deployment Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["V1 - Deployments"],"summary":"Update Deployment","operationId":"update_deployment","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"assistant_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Assistant Id"}},{"name":"deployment_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Deployment Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["V1 - Deployments"],"summary":"Delete Deployment","operationId":"delete_deployment","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"assistant_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Assistant Id"}},{"name":"deployment_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Deployment Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"boolean"},"title":"Response Delete Deployment"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{assistant_id}/deployments/{deployment_id}/activate":{"post":{"tags":["V1 - Deployments"],"summary":"Activate Deployment","operationId":"activate_deployment","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"assistant_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Assistant Id"}},{"name":"deployment_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Deployment Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{assistant_id}/deployments/{deployment_id}/deactivate":{"post":{"tags":["V1 - Deployments"],"summary":"Deactivate Deployment","operationId":"deactivate_deployment","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"assistant_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Assistant Id"}},{"name":"deployment_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Deployment Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{assistant_id}/deployments/{deployment_id}/events":{"get":{"tags":["V1 - Deployments"],"summary":"Get Deployment Events","operationId":"get_deployment_events","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"assistant_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Assistant Id"}},{"name":"deployment_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Deployment Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_DeploymentEvent_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/models/llms":{"get":{"tags":["V1 - Platform"],"summary":"Get Llms","operationId":"get_llms","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"multimodal","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Multimodal"}},{"name":"structured_outputs","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Structured Outputs"}},{"name":"chat","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Chat"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ModelDefinition"},"title":"Response Get Llms"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/models/llms/presets":{"get":{"tags":["V1 - Platform"],"summary":"Get Llms Presets","operationId":"get_llms_presets","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SpotflowModelPreset"},"type":"array","title":"Response Get Llms Presets"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/nodes":{"get":{"tags":["V1 - Platform"],"summary":"Get Nodes","operationId":"get_nodes","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/NodeDefinition"},"type":"array","title":"Response Get Nodes"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/evaluator-definitions":{"get":{"tags":["V1 - Evaluations"],"summary":"List Evaluator Definitions","operationId":"list_evaluator_definitions","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/EvaluatorDefinition"},"type":"array","title":"Response List Evaluator Definitions"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/evaluator-definitions/workflow":{"get":{"tags":["V1 - Evaluations"],"summary":"List Workflow Evaluator Definitions","operationId":"list_workflow_evaluator_definitions","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/EvaluatorDefinition"},"type":"array","title":"Response List Workflow Evaluator Definitions"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/evaluator-definitions/agent":{"get":{"tags":["V1 - Evaluations"],"summary":"List Agent Evaluator Definitions","operationId":"list_agent_evaluator_definitions","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/EvaluatorDefinition"},"type":"array","title":"Response List Agent Evaluator Definitions"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/groups/{group_id}/agents/{agent_id}/test-suites":{"post":{"tags":["V1 - Evaluations"],"summary":"Create Agent Test Suite","operationId":"create_agent_test_suite","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Agent Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSuiteCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSuiteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["V1 - Evaluations"],"summary":"List Agent Test Suites","operationId":"list_agent_test_suites","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Agent Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TestSuiteWithStats"},"title":"Response List Agent Test Suites"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/groups/{group_id}/workflows/{workflow_id}/test-suites":{"get":{"tags":["V1 - Evaluations"],"summary":"List Workflow Test Suites","operationId":"list_workflow_test_suites","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workflow_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workflow Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TestSuiteWithStats"},"title":"Response List Workflow Test Suites"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/groups/{group_id}/test-suites/{test_suite_id}":{"get":{"tags":["V1 - Evaluations"],"summary":"Get Test Suite","operationId":"get_test_suite","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"test_suite_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Test Suite Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSuiteWithStats"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/groups/{group_id}/test-suites/{test_suite_id}/evaluators":{"get":{"tags":["V1 - Evaluations"],"summary":"List Evaluators","operationId":"list_evaluators","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"test_suite_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Test Suite Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EvaluatorResponse"},"title":"Response List Evaluators"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["V1 - Evaluations"],"summary":"Create Evaluator","operationId":"create_evaluator","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"test_suite_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Test Suite Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEvaluatorRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluatorResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/groups/{group_id}/test-suites/{test_suite_id}/test-cases":{"get":{"tags":["V1 - Evaluations"],"summary":"List Test Cases","operationId":"list_test_cases","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"test_suite_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Test Suite Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_TestCaseResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["V1 - Evaluations"],"summary":"Create Test Case","operationId":"create_test_case","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"test_suite_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Test Suite Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTestCaseRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestCaseResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/groups/{group_id}/test-cases/{test_case_id}":{"get":{"tags":["V1 - Evaluations"],"summary":"Get Test Case","operationId":"get_test_case","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"test_case_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Test Case Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestCaseResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/groups/{group_id}/test-suites/{test_suite_id}/run-evaluation":{"post":{"tags":["V1 - Evaluations"],"summary":"Start Evaluation Run","operationId":"start_evaluation_run","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"test_suite_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Test Suite Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartEvaluationRunRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/groups/{group_id}/evaluation-runs/{evaluation_run_id}/wait":{"post":{"tags":["V1 - Evaluations"],"summary":"Wait Evaluation Run","operationId":"wait_evaluation_run","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"evaluation_run_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Evaluation Run Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}},{"name":"max_wait_seconds","in":"query","required":false,"schema":{"type":"integer","default":60,"title":"Max Wait Seconds"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluationRunWaitStatus"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/groups/{group_id}/test-suites/{test_suite_id}/evaluation-results":{"get":{"tags":["V1 - Evaluations"],"summary":"List Evaluation Results","operationId":"list_evaluation_results","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"test_suite_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Test Suite Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Page number","default":1,"title":"Page"},"description":"Page number"},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Page size","default":50,"title":"Size"},"description":"Page size"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_EvaluatorResultResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/groups/{group_id}/evaluation-results/{evaluation_result_id}":{"get":{"tags":["V1 - Evaluations"],"summary":"Get Evaluation Result","operationId":"get_evaluation_result","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"evaluation_result_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Evaluation Result Id"}},{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluatorResultResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/sandboxes":{"get":{"tags":["V1 - Sandboxes"],"summary":"List Sandboxes","description":"List this workspace's live sandboxes.","operationId":"list_sandboxes","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SandboxOut"},"type":"array","title":"Response List Sandboxes"}}}}},"security":[{"APIKeyHeader":[]}]},"post":{"tags":["V1 - Sandboxes"],"summary":"Create Sandbox","description":"Create a sandbox owned by this workspace.","operationId":"create_sandbox","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSandboxIn"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/sandboxes/{sandbox_id}":{"get":{"tags":["V1 - Sandboxes"],"summary":"Get Sandbox","operationId":"get_sandbox","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"sandbox_id","in":"path","required":true,"schema":{"type":"string","title":"Sandbox Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SandboxOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["V1 - Sandboxes"],"summary":"Delete Sandbox","description":"Destroy a sandbox and its filesystem.","operationId":"delete_sandbox","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"sandbox_id","in":"path","required":true,"schema":{"type":"string","title":"Sandbox Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/sandboxes/{sandbox_id}/commands":{"post":{"tags":["V1 - Sandboxes"],"summary":"Run Command","description":"Run a command and return its stdout, stderr and exit code.","operationId":"run_command","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"sandbox_id","in":"path","required":true,"schema":{"type":"string","title":"Sandbox Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunCommandIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecutionOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/sandboxes/{sandbox_id}/files":{"post":{"tags":["V1 - Sandboxes"],"summary":"Write File","description":"Write a file into the sandbox.","operationId":"write_file","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"sandbox_id","in":"path","required":true,"schema":{"type":"string","title":"Sandbox Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WriteFileIn"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WriteFileOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["V1 - Sandboxes"],"summary":"Read File","description":"Read a file out of the sandbox.\n\nBinary files should be fetched with ``encoding=base64``; utf-8 reads of\nnon-text content are rejected rather than silently mangled.","operationId":"read_file","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"sandbox_id","in":"path","required":true,"schema":{"type":"string","title":"Sandbox Id"}},{"name":"path","in":"query","required":true,"schema":{"type":"string","title":"Path"}},{"name":"encoding","in":"query","required":false,"schema":{"type":"string","default":"utf-8","title":"Encoding"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadFileOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tables/query":{"post":{"tags":["V1 - Tables"],"summary":"Query Tables","description":"Run a read-only SQL query across this workspace's tables.","operationId":"query_tables","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/tables":{"get":{"tags":["V1 - Tables"],"summary":"List Tables","operationId":"list_tables","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TableWithCount"},"type":"array","title":"Response List Tables"}}}}},"security":[{"APIKeyHeader":[]}]},"post":{"tags":["V1 - Tables"],"summary":"Create Table","operationId":"create_table","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTableRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/tables/import":{"post":{"tags":["V1 - Tables"],"summary":"Import Csv","description":"Create a table from a CSV upload. ``spec`` is a JSON ImportCsvSpec\n(name, id_type, has_header, columns).","operationId":"import_csv","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_import_csv"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/tables/{table_id}":{"get":{"tags":["V1 - Tables"],"summary":"Get Table","operationId":"get_table","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"table_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Table Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableWithCount"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["V1 - Tables"],"summary":"Update Table","operationId":"update_table","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"table_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Table Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTableRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["V1 - Tables"],"summary":"Delete Table","operationId":"delete_table","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"table_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Table Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"boolean"},"title":"Response Delete Table"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tables/{table_id}/stats":{"get":{"tags":["V1 - Tables"],"summary":"Get Table Stats","operationId":"get_table_stats","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"table_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Table Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableStats"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tables/{table_id}/columns/reorder":{"patch":{"tags":["V1 - Tables"],"summary":"Reorder Columns","operationId":"reorder_columns","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"table_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Table Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReorderColumnsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tables/{table_id}/columns":{"post":{"tags":["V1 - Tables"],"summary":"Add Column","operationId":"add_column","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"table_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Table Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddColumnRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tables/{table_id}/columns/{name}/rename":{"patch":{"tags":["V1 - Tables"],"summary":"Rename Column","operationId":"rename_column","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"table_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Table Id"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenameColumnRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tables/{table_id}/columns/{name}/type":{"patch":{"tags":["V1 - Tables"],"summary":"Change Column Type","operationId":"change_column_type","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"table_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Table Id"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeColumnTypeRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tables/{table_id}/columns/{name}/label":{"patch":{"tags":["V1 - Tables"],"summary":"Update Column Label","operationId":"update_column_label","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"table_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Table Id"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateColumnLabelRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tables/{table_id}/columns/{name}":{"delete":{"tags":["V1 - Tables"],"summary":"Drop Column","operationId":"drop_column","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"table_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Table Id"}},{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tables/{table_id}/rows":{"get":{"tags":["V1 - Tables"],"summary":"List Rows","operationId":"list_rows","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"table_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Table Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":500,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"order_by","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order By"}},{"name":"descending","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Descending"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"filters","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"JSON-encoded array of row filters","title":"Filters"},"description":"JSON-encoded array of row filters"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["V1 - Tables"],"summary":"Insert Row","operationId":"insert_row","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"table_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Table Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["V1 - Tables"],"summary":"Clear Rows","operationId":"clear_rows","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"table_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Table Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"integer"},"title":"Response Clear Rows"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tables/{table_id}/export":{"get":{"tags":["V1 - Tables"],"summary":"Export Table Csv","description":"Stream a table's rows as CSV.","operationId":"export_table_csv","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"table_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Table Id"}},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"filters","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"JSON-encoded array of row filters","title":"Filters"},"description":"JSON-encoded array of row filters"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tables/{table_id}/rows/bulk":{"post":{"tags":["V1 - Tables"],"summary":"Insert Rows","description":"Insert many rows in one fast load. For thousands of rows use CSV import.","operationId":"insert_rows","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"table_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Table Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkInsertRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkInsertResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/tables/{table_id}/rows/{row_id}":{"patch":{"tags":["V1 - Tables"],"summary":"Update Row","operationId":"update_row","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"table_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Table Id"}},{"name":"row_id","in":"path","required":true,"schema":{"type":"string","title":"Row Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RowResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["V1 - Tables"],"summary":"Delete Row","operationId":"delete_row","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"table_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Table Id"}},{"name":"row_id","in":"path","required":true,"schema":{"type":"string","title":"Row Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"boolean"},"title":"Response Delete Row"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/variables":{"get":{"tags":["V1 - Variables"],"summary":"List Variables","description":"List this workspace's variables (secret values are never returned).","operationId":"list_variables","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response List Variables"}}}}},"security":[{"APIKeyHeader":[]}]},"post":{"tags":["V1 - Variables"],"summary":"Create Variable","description":"Create a variable or secret.","operationId":"create_variable","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariableUpsertRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Create Variable"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/variables/{variable_id}":{"patch":{"tags":["V1 - Variables"],"summary":"Update Variable","description":"Update a variable or secret.","operationId":"update_variable","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"variable_id","in":"path","required":true,"schema":{"type":"string","title":"Variable Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VariablePatchRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Update Variable"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["V1 - Variables"],"summary":"Delete Variable","description":"Delete a variable or secret.","operationId":"delete_variable","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"variable_id","in":"path","required":true,"schema":{"type":"string","title":"Variable Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Delete Variable"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{assistant_id}/insights/sentiment-over-time":{"get":{"tags":["V1 - Insights"],"summary":"Sentiment Over Time","operationId":"sentiment_over_time","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"assistant_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Assistant Id"}},{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":90,"minimum":1,"default":7,"title":"Days"}},{"name":"deployment_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id"}},{"name":"message_length","in":"query","required":false,"schema":{"anyOf":[{"enum":["short","medium","long"],"type":"string"},{"type":"null"}],"title":"Message Length"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SentimentOverTime"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{assistant_id}/insights/rating-drivers":{"get":{"tags":["V1 - Insights"],"summary":"Rating Drivers","operationId":"rating_drivers","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"assistant_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Assistant Id"}},{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":90,"minimum":1,"default":7,"title":"Days"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":20,"minimum":1,"default":8,"title":"Limit"}},{"name":"deployment_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id"}},{"name":"message_length","in":"query","required":false,"schema":{"anyOf":[{"enum":["short","medium","long"],"type":"string"},{"type":"null"}],"title":"Message Length"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RatingDrivers"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{assistant_id}/insights/custom-insights":{"get":{"tags":["V1 - Insights"],"summary":"Custom Insights","operationId":"custom_insights","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"assistant_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Assistant Id"}},{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":90,"minimum":1,"default":7,"title":"Days"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"default":20,"title":"Limit"}},{"name":"deployment_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id"}},{"name":"message_length","in":"query","required":false,"schema":{"anyOf":[{"enum":["short","medium","long"],"type":"string"},{"type":"null"}],"title":"Message Length"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomInsightCounts"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{assistant_id}/insights/conversations":{"get":{"tags":["V1 - Insights"],"summary":"Insight Conversations","operationId":"insight_conversations","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"assistant_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Assistant Id"}},{"name":"kind","in":"query","required":true,"schema":{"enum":["topic","subtopic","driver","custom","cx"],"type":"string","title":"Kind"}},{"name":"key","in":"query","required":true,"schema":{"type":"string","title":"Key"}},{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":90,"minimum":1,"default":7,"title":"Days"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"default":20,"title":"Limit"}},{"name":"deployment_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id"}},{"name":"message_length","in":"query","required":false,"schema":{"anyOf":[{"enum":["short","medium","long"],"type":"string"},{"type":"null"}],"title":"Message Length"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InsightConversations"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{assistant_id}/insights/sub-topics":{"get":{"tags":["V1 - Insights"],"summary":"Sub Topics","operationId":"sub_topics","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"assistant_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Assistant Id"}},{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":90,"minimum":1,"default":7,"title":"Days"}},{"name":"parent","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parent"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"default":20,"title":"Limit"}},{"name":"deployment_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id"}},{"name":"message_length","in":"query","required":false,"schema":{"anyOf":[{"enum":["short","medium","long"],"type":"string"},{"type":"null"}],"title":"Message Length"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubTopics"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{assistant_id}/insights/noticed":{"get":{"tags":["V1 - Insights"],"summary":"Noticed","operationId":"noticed","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"assistant_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Assistant Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"default":12,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoticedFeed"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{assistant_id}/insights/top-topics":{"get":{"tags":["V1 - Insights"],"summary":"Top Topics","operationId":"top_topics","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"assistant_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Assistant Id"}},{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":90,"minimum":1,"default":7,"title":"Days"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"default":10,"title":"Limit"}},{"name":"deployment_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id"}},{"name":"message_length","in":"query","required":false,"schema":{"anyOf":[{"enum":["short","medium","long"],"type":"string"},{"type":"null"}],"title":"Message Length"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopTopics"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{assistant_id}/insights/conversation-funnel":{"get":{"tags":["V1 - Insights"],"summary":"Conversation Funnel","operationId":"conversation_funnel","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"assistant_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Assistant Id"}},{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":90,"minimum":1,"default":7,"title":"Days"}},{"name":"deployment_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id"}},{"name":"message_length","in":"query","required":false,"schema":{"anyOf":[{"enum":["short","medium","long"],"type":"string"},{"type":"null"}],"title":"Message Length"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConversationFunnel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{assistant_id}/insights/csat-score":{"get":{"tags":["V1 - Insights"],"summary":"Csat Score","operationId":"csat_score","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"assistant_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Assistant Id"}},{"name":"days","in":"query","required":false,"schema":{"type":"integer","maximum":90,"minimum":1,"default":7,"title":"Days"}},{"name":"deployment_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id"}},{"name":"message_length","in":"query","required":false,"schema":{"anyOf":[{"enum":["short","medium","long"],"type":"string"},{"type":"null"}],"title":"Message Length"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CSATScore"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/agents/{assistant_id}/insights/bootstrap":{"get":{"tags":["V1 - Insights"],"summary":"Bootstrap Status","operationId":"bootstrap_status","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"assistant_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Assistant Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BootstrapStatus"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/admin/system-keys":{"get":{"tags":["V1 - System keys"],"summary":"List System Keys","description":"List the tenant's system keys.","operationId":"list_system_keys","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ApiKey"},"type":"array","title":"Response List System Keys"}}}}},"security":[{"APIKeyHeader":[]}]},"post":{"tags":["V1 - System keys"],"summary":"Create System Key","description":"Mint a tenant-scoped system key in the tenant's admin workspace.","operationId":"create_system_key","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSystemKeyRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/admin/system-keys/{key_id}":{"delete":{"tags":["V1 - System keys"],"summary":"Delete System Key","description":"Revoke a system key.","operationId":"delete_system_key","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"key_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Key Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"boolean"},"title":"Response Delete System Key"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/admin/roles":{"get":{"tags":["V1 - Roles"],"summary":"List Roles","description":"List the tenant's roles. Requires a system key with ``org:admin``.","operationId":"list_roles","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Response List Roles"}}}}},"security":[{"APIKeyHeader":[]}]},"post":{"tags":["V1 - Roles"],"summary":"Create Role","description":"Create a tenant role.","operationId":"create_role","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantRoleCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/admin/roles/{role_id}":{"delete":{"tags":["V1 - Roles"],"summary":"Delete Role","description":"Delete a tenant role (system roles cannot be deleted).","operationId":"delete_role","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"role_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Role Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/admin/users":{"get":{"tags":["V1 - Users"],"summary":"List Users","description":"The tenant's users, sorted by email. Requires a system key with ``users:read``.","operationId":"list_users","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Email or name contains","title":"Search"},"description":"Email or name contains"},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"enum":["active","pending","suspended"],"type":"string"},{"type":"null"}],"title":"Status"}},{"name":"workspace_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workspace Id"}},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":1000,"minimum":1},{"type":"null"}],"description":"Page size; every user when omitted","title":"Limit"},"description":"Page size; every user when omitted"},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TenantUser"},"title":"Response List Users"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["V1 - Users"],"summary":"Create User","description":"Create a user who signs in later (matched by email), with their tenant\nrole and workspaces. ``send_invite`` emails them the welcome message.\n\nA key without ``org:admin`` can only create users with the Base tenant role\nand the Runner workspace role, as inviting from the app does.","operationId":"create_user","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantUserDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/admin/users/{user_id}":{"get":{"tags":["V1 - Users"],"summary":"Get User","operationId":"get_user","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantUserDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["V1 - Users"],"summary":"Update User","operationId":"update_user","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantUserDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["V1 - Users"],"summary":"Delete User","operationId":"delete_user","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Id"}},{"name":"transfer_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"description":"User who takes over the deleted user's triggers, credentials, inboxes, plugins and tags","title":"Transfer To"},"description":"User who takes over the deleted user's triggers, credentials, inboxes, plugins and tags"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"boolean"},"title":"Response Delete User"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/admin/users/{user_id}/access":{"get":{"tags":["V1 - Users"],"summary":"Get User Access","description":"What the user can do: their tenant role and permissions, and each\nworkspace with its role and the permissions it gives them there.","operationId":"get_user_access","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAccess"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/admin/users/{user_id}/tenant-role":{"put":{"tags":["V1 - Users"],"summary":"Set Tenant Role","operationId":"set_tenant_role","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantRoleRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantUserDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/admin/users/{user_id}/suspend":{"post":{"tags":["V1 - Users"],"summary":"Suspend User","description":"Block sign-in and every session at once, keeping the user's data and\naccess for a later reactivation.","operationId":"suspend_user","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantUserDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/admin/users/{user_id}/reactivate":{"post":{"tags":["V1 - Users"],"summary":"Reactivate User","operationId":"reactivate_user","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantUserDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/admin/groups/{workspace_id}/members":{"get":{"tags":["V1 - Users"],"summary":"List Members","operationId":"list_members","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TenantUser"},"title":"Response List Members"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/admin/groups/{workspace_id}/members/{user_id}":{"put":{"tags":["V1 - Users"],"summary":"Put Member","description":"Add the user to the workspace with ``role``, or change their role there.","operationId":"put_member","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MembershipRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantUserDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["V1 - Users"],"summary":"Delete Member","operationId":"delete_member","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"workspace_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Workspace Id"}},{"name":"user_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"User Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TenantUserDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/admin/me":{"get":{"tags":["V1 - Admin"],"summary":"Public Get Me","operationId":"public_get_me","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}}},"security":[{"APIKeyHeader":[]}]}},"/v1/admin/groups":{"get":{"tags":["V1 - Admin"],"summary":"Public List Groups","operationId":"public_list_groups","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"sort","in":"query","required":false,"schema":{"type":"string","default":"desc","title":"Sort"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Group"},"title":"Response Public List Groups"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["V1 - Admin"],"summary":"Public Create Group","operationId":"public_create_group","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Group"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/admin/groups/{group_id}":{"delete":{"tags":["V1 - Admin"],"summary":"Public Delete Group","operationId":"public_delete_group","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Public Delete Group"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/admin/groups/{group_id}/api-keys":{"post":{"tags":["V1 - Admin"],"summary":"Public Create Api Key","operationId":"public_create_api_key","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"group_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Group Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApiKeyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/file":{"post":{"tags":["V1 - Upload"],"summary":"Public Upload File","operationId":"public_upload_file","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"is_public","in":"query","required":false,"schema":{"type":"boolean","description":"Whether the file should be public","default":false,"title":"Is Public"},"description":"Whether the file should be public"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_public_upload_file"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OwnedFile"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/file/{name}":{"get":{"tags":["V1 - Upload"],"summary":"Get Image","operationId":"get_image","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}},{"name":"preview","in":"query","required":false,"schema":{"type":"boolean","description":"Whether the file should be downloaded, or opened on another tab.","default":false,"title":"Preview"},"description":"Whether the file should be downloaded, or opened on another tab."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"string","contentMediaType":"application/octet-stream","title":"Response Get Image"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/file/{name}/metadata":{"get":{"tags":["V1 - Upload"],"summary":"Get Image Metadata","operationId":"get_image_metadata","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","title":"Name"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OwnedFile"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/inbox/webhook":{"post":{"tags":["V1 - Inboxes"],"summary":"Receive Email","operationId":"receive_email","parameters":[{"name":"token","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Token"}},{"name":"host","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"auto_error":false,"title":"Host"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_receive_email"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/analytics/{metric}":{"get":{"tags":["V1 - Analytics"],"summary":"Get workspace analytics","description":"Query analytics metrics for the workspace associated with the API key. Results are scoped to the workspace and time range provided.","operationId":"get_workspace_analytics","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"metric","in":"path","required":true,"schema":{"$ref":"#/components/schemas/PublicAnalyticsKey"}},{"name":"time_start","in":"query","required":true,"schema":{"type":"string","format":"date-time","description":"Start of the time range (ISO 8601 with timezone)","title":"Time Start"},"description":"Start of the time range (ISO 8601 with timezone)"},{"name":"time_end","in":"query","required":true,"schema":{"type":"string","format":"date-time","description":"End of the time range (ISO 8601 with timezone)","title":"Time End"},"description":"End of the time range (ISO 8601 with timezone)"},{"name":"page","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Page number for paginated metrics","title":"Page"},"description":"Page number for paginated metrics"},{"name":"page_size","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":200,"minimum":1},{"type":"null"}],"description":"Page size for paginated metrics (default 50, max 200)","title":"Page Size"},"description":"Page size for paginated metrics (default 50, max 200)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"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.\n\nFor each config parameter or input connector, you either:\n1. Hardcode it (store value in overrides, don't expose to LLM)\n2. Expose it to LLM (add to exposed list, LLM provides value)"},"ActionToolSettings-Input":{"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","Agents"],"title":"Category","default":"Actions"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Zap"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Running action..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Action complete"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"type":{"type":"string","const":"action","title":"Type","default":"action"},"icon":{"type":"string","title":"Icon","default":"Zap"},"bg_color":{"type":"string","title":"Bg Color","default":"#FEF3C7"},"icon_color":{"type":"string","title":"Icon Color","default":"#F59E0B"},"node_name":{"type":"string","title":"Node Name","description":"The name of the node/action to execute"},"tool_config":{"anyOf":[{"$ref":"#/components/schemas/ActionToolConfig"},{"type":"null"}]}},"type":"object","required":["node_name"],"title":"ActionToolSettings"},"ActionToolSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Actions"},"description":{"type":"string","title":"Description","default":"Execute workflow actions"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","default":"Actions"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Zap"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Running action..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Action complete"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"type":{"type":"string","const":"action","title":"Type","default":"action"},"icon":{"type":"string","title":"Icon","default":"Zap"},"bg_color":{"type":"string","title":"Bg Color","default":"#FEF3C7"},"icon_color":{"type":"string","title":"Icon Color","default":"#F59E0B"},"node_name":{"type":"string","title":"Node Name","description":"The name of the node/action to execute"},"tool_config":{"anyOf":[{"$ref":"#/components/schemas/ActionToolConfig"},{"type":"null"}]}},"type":"object","required":["node_name"],"title":"ActionToolSettings"},"AddColumnRequest":{"properties":{"column":{"$ref":"#/components/schemas/DataTableColumn"}},"type":"object","required":["column"],"title":"AddColumnRequest"},"AddMessageRequest":{"properties":{"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"},"tool":{"anyOf":[{"type":"string","enum":["web_research","kb_qa"]},{"type":"string"},{"type":"null"}],"title":"Tool"},"kb_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kb Id"},"files":{"anyOf":[{"items":{"$ref":"#/components/schemas/ConversationFile"},"type":"array"},{"type":"null"}],"title":"Files"},"model_selection":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Model Selection"}},"type":"object","required":["content"],"title":"AddMessageRequest"},"AgentDatabaseConfig-Input":{"properties":{"credential_id":{"type":"string","format":"uuid","title":"Credential Id"},"context":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}]},"enabled":{"type":"boolean","title":"Enabled","default":true},"selected_tables":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Selected Tables"},"max_rows":{"type":"integer","maximum":10000.0,"minimum":1.0,"title":"Max Rows","default":100},"query_timeout_seconds":{"type":"integer","maximum":300.0,"minimum":1.0,"title":"Query Timeout Seconds","default":30}},"type":"object","required":["credential_id"],"title":"AgentDatabaseConfig","description":"A SQL database, referenced by stored credential id, the agent can query\nread-only. ``selected_tables=None`` means every table is visible."},"AgentDatabaseConfig-Output":{"properties":{"credential_id":{"type":"string","format":"uuid","title":"Credential Id"},"context":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}]},"enabled":{"type":"boolean","title":"Enabled","default":true},"selected_tables":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Selected Tables"},"max_rows":{"type":"integer","maximum":10000.0,"minimum":1.0,"title":"Max Rows","default":100},"query_timeout_seconds":{"type":"integer","maximum":300.0,"minimum":1.0,"title":"Query Timeout Seconds","default":30}},"type":"object","required":["credential_id"],"title":"AgentDatabaseConfig","description":"A SQL database, referenced by stored credential id, the agent can query\nread-only. ``selected_tables=None`` means every table is visible."},"AgentFileConfig-Input":{"properties":{"file":{"$ref":"#/components/schemas/File"},"context":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}]},"enabled":{"type":"boolean","title":"Enabled","default":true},"delimiter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Delimiter"}},"type":"object","required":["file"],"title":"AgentFileConfig","description":"A file pre-loaded into every chat of an agent, with context.\n\nStored directly in the agent's ``definition`` JSONB column. The file is\nuploaded in the agent settings (``file.uri`` is a ``spot://`` reference);\n``context`` is shown to the agent so it knows what the file is and when to\nread it via the always-on session-file tools."},"AgentFileConfig-Output":{"properties":{"file":{"$ref":"#/components/schemas/File"},"context":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}]},"enabled":{"type":"boolean","title":"Enabled","default":true},"delimiter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Delimiter"}},"type":"object","required":["file"],"title":"AgentFileConfig","description":"A file pre-loaded into every chat of an agent, with context.\n\nStored directly in the agent's ``definition`` JSONB column. The file is\nuploaded in the agent settings (``file.uri`` is a ``spot://`` reference);\n``context`` is shown to the agent so it knows what the file is and when to\nread it via the always-on session-file tools."},"AgentLanguage-Input":{"properties":{"code":{"type":"string","title":"Code"},"introductory_message":{"anyOf":[{"items":{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},"type":"array"},{"type":"null"}],"title":"Introductory Message"}},"type":"object","required":["code"],"title":"AgentLanguage","description":"One language the agent greets in, keyed by ISO 639-1 code."},"AgentLanguage-Output":{"properties":{"code":{"type":"string","title":"Code"},"introductory_message":{"anyOf":[{"items":{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},"type":"array"},{"type":"null"}],"title":"Introductory Message"}},"type":"object","required":["code"],"title":"AgentLanguage","description":"One language the agent greets in, keyed by ISO 639-1 code."},"AgentMemoryEntry":{"properties":{"id":{"type":"string","title":"Id"},"content":{"type":"string","title":"Content"},"category":{"type":"string","title":"Category","default":"general"},"created_at":{"type":"string","title":"Created At","default":""},"updated_at":{"type":"string","title":"Updated At","default":""}},"type":"object","required":["id","content"],"title":"AgentMemoryEntry","description":"A single persistent memory entry stored in agent settings."},"AgentMemorySettings-Input":{"properties":{"title":{"type":"string","title":"Title","default":"Agent Memory"},"description":{"type":"string","title":"Description","default":"Persistent memory across all conversations"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"BookOpen"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Accessing agent memory..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Memory operation complete"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","default":false},"icon":{"type":"string","title":"Icon","default":"BookOpen"},"bg_color":{"type":"string","title":"Bg Color","default":"#fef3c7"},"icon_color":{"type":"string","title":"Icon Color","default":"#d97706"},"deprecated":{"type":"boolean","title":"Deprecated","description":"Whether this tool type is deprecated and should be hidden from the UI","default":false},"type":{"type":"string","const":"agent_memory","title":"Type","default":"agent_memory"}},"type":"object","title":"AgentMemorySettings","description":"Settings for the persistent agent memory toolset.\n\nMemories are stored in assistant.definition[\"memories\"] JSONB\nand persist across all conversations with this agent."},"AgentMemorySettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Agent Memory"},"description":{"type":"string","title":"Description","default":"Persistent memory across all conversations"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"BookOpen"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Accessing agent memory..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Memory operation complete"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","default":false},"icon":{"type":"string","title":"Icon","default":"BookOpen"},"bg_color":{"type":"string","title":"Bg Color","default":"#fef3c7"},"icon_color":{"type":"string","title":"Icon Color","default":"#d97706"},"deprecated":{"type":"boolean","title":"Deprecated","description":"Whether this tool type is deprecated and should be hidden from the UI","default":false},"type":{"type":"string","const":"agent_memory","title":"Type","default":"agent_memory"}},"type":"object","title":"AgentMemorySettings","description":"Settings for the persistent agent memory toolset.\n\nMemories are stored in assistant.definition[\"memories\"] JSONB\nand persist across all conversations with this agent."},"AgentTableConfig-Input":{"properties":{"table_id":{"type":"string","format":"uuid","title":"Table Id"},"context":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}]},"enabled":{"type":"boolean","title":"Enabled","default":true},"read_only":{"type":"boolean","title":"Read Only","default":true},"max_rows":{"type":"integer","maximum":10000.0,"minimum":1.0,"title":"Max Rows","default":100},"query_timeout_seconds":{"type":"integer","maximum":300.0,"minimum":1.0,"title":"Query Timeout Seconds","default":30}},"type":"object","required":["table_id"],"title":"AgentTableConfig","description":"A single workspace custom table the agent can query read-only, with its\nown context and limits. Queries run as the workspace's read-only tenant role\nand are restricted to this table."},"AgentTableConfig-Output":{"properties":{"table_id":{"type":"string","format":"uuid","title":"Table Id"},"context":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}]},"enabled":{"type":"boolean","title":"Enabled","default":true},"read_only":{"type":"boolean","title":"Read Only","default":true},"max_rows":{"type":"integer","maximum":10000.0,"minimum":1.0,"title":"Max Rows","default":100},"query_timeout_seconds":{"type":"integer","maximum":300.0,"minimum":1.0,"title":"Query Timeout Seconds","default":30}},"type":"object","required":["table_id"],"title":"AgentTableConfig","description":"A single workspace custom table the agent can query read-only, with its\nown context and limits. Queries run as the workspace's read-only tenant role\nand are restricted to this table."},"AgentToolSettings-Input":{"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","Agents"],"title":"Category","default":"Agents","tab":"Configuration","tool_mode":"hidden","visible":false},"enabled":{"type":"boolean","title":"Enabled","description":"Whether the tool is enabled","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enabled","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Bot","tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Calling co-worker","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Start message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when calling the co-worker.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Co-worker responded","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"End message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed after the co-worker responds.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"type":{"type":"string","const":"agent_tool","title":"Type","default":"agent_tool","tab":"Configuration","tool_mode":"hidden","visible":false},"agent_id":{"type":"string","format":"uuid","title":"Agent Id","description":"The ID of the agent to call. Comes unselected, and should be selected by the user.","tab":"Configuration","tool_mode":"hidden","visible":false},"version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Version Id","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_input":false,"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"},"AgentToolSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Agent Tool","tab":"Configuration","tool_mode":"hidden","visible":false},"description":{"type":"string","title":"Description","default":"Call another co-worker","tab":"Configuration","tool_mode":"hidden","visible":false},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","default":"Agents","tab":"Configuration","tool_mode":"hidden","visible":false},"enabled":{"type":"boolean","title":"Enabled","description":"Whether the tool is enabled","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enabled","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Bot","tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Calling co-worker","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Start message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when calling the co-worker.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Co-worker responded","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"End message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed after the co-worker responds.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"type":{"type":"string","const":"agent_tool","title":"Type","default":"agent_tool","tab":"Configuration","tool_mode":"hidden","visible":false},"agent_id":{"type":"string","format":"uuid","title":"Agent Id","description":"The ID of the agent to call. Comes unselected, and should be selected by the user.","tab":"Configuration","tool_mode":"hidden","visible":false},"version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Version Id","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_input":false,"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"},"AnalyticsBarChartValue":{"properties":{"name":{"type":"string","title":"Name"},"values":{"additionalProperties":{"anyOf":[{"type":"integer"},{"type":"number"}]},"type":"object","title":"Values"},"value_mapping":{"anyOf":[{"additionalProperties":{"anyOf":[{"$ref":"#/components/schemas/AnalyticsWorkflow"},{"$ref":"#/components/schemas/AnalyticsUser"},{"$ref":"#/components/schemas/AnalyticsKB"}]},"type":"object"},{"type":"null"}],"title":"Value Mapping"}},"type":"object","required":["name","values"],"title":"AnalyticsBarChartValue"},"AnalyticsBarChartsValue":{"properties":{"values":{"items":{"$ref":"#/components/schemas/AnalyticsBarChartValue"},"type":"array","title":"Values"}},"type":"object","required":["values"],"title":"AnalyticsBarChartsValue"},"AnalyticsChip":{"properties":{"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"}],"title":"Value"},"type":{"type":"string","enum":["success","outline","destructive","warning","default","secondary"],"title":"Type"}},"type":"object","required":["value","type"],"title":"AnalyticsChip"},"AnalyticsCostValue":{"properties":{"value":{"type":"number","title":"Value"},"estimated_additional_cost":{"type":"number","title":"Estimated Additional Cost"},"estimated_in_progress_cost":{"type":"number","title":"Estimated In Progress Cost"},"estimated_interrupted_cost":{"type":"number","title":"Estimated Interrupted Cost"},"estimated_other_cost":{"type":"number","title":"Estimated Other Cost"},"message":{"type":"string","title":"Message"},"currency":{"type":"string","enum":["USD","EUR","GBP"],"title":"Currency","description":"Currency of every amount in this value, already converted"},"currency_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency Note"}},"type":"object","required":["value","estimated_additional_cost","estimated_in_progress_cost","estimated_interrupted_cost","estimated_other_cost","message","currency"],"title":"AnalyticsCostValue"},"AnalyticsKB":{"properties":{"id":{"type":"string","title":"Id"},"group_id":{"type":"string","title":"Group Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","group_id","name"],"title":"AnalyticsKB"},"AnalyticsNode":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"node_type":{"type":"string","title":"Node Type"}},"type":"object","required":["id","name","node_type"],"title":"AnalyticsNode"},"AnalyticsPaginatedTableValue":{"properties":{"headings":{"items":{"type":"string"},"type":"array","title":"Headings"},"items":{"items":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"$ref":"#/components/schemas/AnalyticsWorkflow"},{"$ref":"#/components/schemas/AnalyticsUser"},{"$ref":"#/components/schemas/AnalyticsChip"},{"$ref":"#/components/schemas/AnalyticsNode"}]},"type":"object"},"type":"array","title":"Items"},"prefixes":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Prefixes"},"suffixes":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Suffixes"},"total":{"type":"integer","title":"Total"},"pages":{"type":"integer","title":"Pages"},"size":{"type":"integer","title":"Size"},"page":{"type":"integer","title":"Page"}},"type":"object","required":["headings","items","total","pages","size","page"],"title":"AnalyticsPaginatedTableValue"},"AnalyticsResponse":{"properties":{"type":{"$ref":"#/components/schemas/AnalyticsType"},"value":{"anyOf":[{"$ref":"#/components/schemas/AnalyticsSimpleValue"},{"$ref":"#/components/schemas/AnalyticsBarChartsValue"},{"$ref":"#/components/schemas/AnalyticsTableValue"},{"$ref":"#/components/schemas/AnalyticsPaginatedTableValue"}],"title":"Value"}},"type":"object","required":["type","value"],"title":"AnalyticsResponse"},"AnalyticsSimpleValue":{"properties":{"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"}],"title":"Value"},"suffix":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Suffix"},"prefix":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prefix"},"currency":{"anyOf":[{"type":"string","enum":["USD","EUR","GBP"]},{"type":"null"}],"title":"Currency","description":"Set when value is an amount of money in this currency"},"cost_details":{"anyOf":[{"$ref":"#/components/schemas/AnalyticsCostValue"},{"type":"null"}]}},"type":"object","required":["value"],"title":"AnalyticsSimpleValue"},"AnalyticsTableValue":{"properties":{"headings":{"items":{"type":"string"},"type":"array","title":"Headings"},"rows":{"items":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"$ref":"#/components/schemas/AnalyticsWorkflow"},{"$ref":"#/components/schemas/AnalyticsUser"},{"$ref":"#/components/schemas/AnalyticsKB"},{"$ref":"#/components/schemas/AnalyticsChip"},{"$ref":"#/components/schemas/AnalyticsNode"},{"$ref":"#/components/schemas/AnalyticsCostValue"}]},"type":"object"},"type":"array","title":"Rows"},"prefixes":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Prefixes"},"suffixes":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Suffixes"}},"type":"object","required":["headings","rows"],"title":"AnalyticsTableValue"},"AnalyticsType":{"type":"string","enum":["simple","barchart","table","horizontal-barchart","empty"],"title":"AnalyticsType"},"AnalyticsUser":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"img":{"type":"string","title":"Img"}},"type":"object","required":["id","name","img"],"title":"AnalyticsUser"},"AnalyticsWorkflow":{"properties":{"id":{"type":"string","title":"Id"},"group_id":{"type":"string","title":"Group Id"},"name":{"type":"string","title":"Name"},"icon":{"type":"string","title":"Icon"},"type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Type"}},"type":"object","required":["id","group_id","name","icon"],"title":"AnalyticsWorkflow"},"ApiKey":{"properties":{"name":{"type":"string","title":"Name"},"id":{"type":"string","format":"uuid","title":"Id"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"value":{"type":"string","title":"Value"},"tenant_admin":{"type":"boolean","title":"Tenant Admin","default":false},"permissions":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Permissions"},"last_used":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Used"}},"type":"object","required":["name","id","group_id","value"],"title":"ApiKey"},"AppInterfaceType":{"type":"string","enum":["slack","teams","chat","form","whatsapp","embed_widget","telegram"],"title":"AppInterfaceType"},"AppSettingsV2":{"properties":{"is_active":{"type":"boolean","title":"Is Active","default":false},"version_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version Id"},"interface_type":{"anyOf":[{"$ref":"#/components/schemas/AppInterfaceType"},{"type":"null"}]},"extra_settings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Extra Settings"},"published_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Published At"}},"type":"object","title":"AppSettingsV2"},"AssistantMeta":{"properties":{"template_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template Id"},"is_genie":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Genie"},"source":{"anyOf":[{"$ref":"#/components/schemas/EntitySource"},{"type":"null"}]}},"type":"object","title":"AssistantMeta"},"AssistantTrigger":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"definition":{"additionalProperties":true,"type":"object","title":"Definition"},"routing_key":{"type":"string","title":"Routing Key"},"assistant_id":{"type":"string","format":"uuid","title":"Assistant Id"},"type":{"type":"string","title":"Type"}},"type":"object","required":["id","group_id","definition","routing_key","assistant_id","type"],"title":"AssistantTrigger"},"AssistantVersion":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"created_by":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Created By"},"definition":{"additionalProperties":true,"type":"object","title":"Definition"},"meta":{"anyOf":[{"$ref":"#/components/schemas/VersionMeta"},{"type":"null"}]}},"type":"object","required":["id","name","created_at","definition"],"title":"AssistantVersion"},"AttachFileSettings":{"properties":{"title":{"type":"string","title":"Title","default":"Add Files"},"description":{"type":"string","title":"Description","default":"Allows the user to add files to the conversation for the agent to access."},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":true},"tool_display_icon":{"type":"string","title":"Tool Display Icon","description":"The lucide icon to display for this tool","default":"Cog","tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","description":"The message to display to the user when the tool is called.","default":"Running tool...","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Start message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the tool starts.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","description":"The message to display to the user when the tool completes.","default":"Tool complete","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"End message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the tool completes.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"extra_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Extra Instructions"},"requires_approval":{"type":"boolean","title":"Requires Approval","default":false},"visible":{"type":"boolean","title":"Visible","default":false},"icon":{"type":"string","title":"Icon","default":"Paperclip"},"bg_color":{"type":"string","title":"Bg Color","default":"#EFF6FF"},"icon_color":{"type":"string","title":"Icon Color","default":"#2B7FFF"},"deprecated":{"type":"boolean","title":"Deprecated","default":true},"type":{"type":"string","const":"attach_file","title":"Type","default":"attach_file"}},"type":"object","title":"AttachFileSettings"},"AudioContainer":{"properties":{"total_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Size"},"taken":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Taken"},"truncated":{"type":"boolean","title":"Truncated","default":false},"preview_file":{"anyOf":[{"$ref":"#/components/schemas/FileType"},{"type":"null"}]},"list_offset":{"type":"integer","title":"List Offset","default":0},"type":{"type":"string","const":"Audio","title":"Type","default":"Audio"},"value":{"title":"Value"}},"type":"object","required":["value"],"title":"AudioContainer"},"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"},"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.\n\nThis identifier can be provided to the model in a message to allow it to refer to this file in a tool call argument,\nand the tool can look up the file in question by iterating over the message history and finding the matching `FileUrl`.\n\nThis identifier is only automatically passed to the model when the `FileUrl` is returned by a tool.\nIf you're passing the `FileUrl` as a user message, it's up to you to include a separate text part with the identifier,\ne.g. \"This is file <identifier>:\" preceding the `FileUrl`.\n\nIt's also included in inline-text delimiters for providers that require inlining text documents, so the model can\ndistinguish multiple files.","readOnly":true}},"type":"object","required":["url","media_type","identifier"],"title":"AudioUrl","description":"A URL to an audio file."},"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"},"BaseModelContainer":{"properties":{"total_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Size"},"taken":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Taken"},"truncated":{"type":"boolean","title":"Truncated","default":false},"preview_file":{"anyOf":[{"$ref":"#/components/schemas/FileType"},{"type":"null"}]},"list_offset":{"type":"integer","title":"List Offset","default":0},"type":{"type":"string","const":"basemodel","title":"Type","default":"basemodel"},"value":{"title":"Value"}},"type":"object","required":["value"],"title":"BaseModelContainer"},"BinaryContent":{"properties":{"data":{"type":"string","contentEncoding":"base64","contentMediaType":"application/octet-stream","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.\n\nThis identifier can be provided to the model in a message to allow it to refer to this file in a tool call argument,\nand the tool can look up the file in question by iterating over the message history and finding the matching `BinaryContent`.\n\nThis identifier is only automatically passed to the model when the `BinaryContent` is returned by a tool.\nIf you're passing the `BinaryContent` as a user message, it's up to you to include a separate text part with the identifier,\ne.g. \"This is file <identifier>:\" preceding the `BinaryContent`.\n\nIt's also included in inline-text delimiters for providers that require inlining text documents, so the model can\ndistinguish multiple files.","readOnly":true}},"type":"object","required":["data","media_type","identifier"],"title":"BinaryContent","description":"Binary content, e.g. an audio or image file."},"Body_import_csv":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"},"spec":{"type":"string","title":"Spec"}},"type":"object","required":["file","spec"],"title":"Body_import_csv"},"Body_public_upload_file":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File"}},"type":"object","required":["file"],"title":"Body_public_upload_file"},"Body_receive_email":{"properties":{"to":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"To"},"cc":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cc"},"from":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"From"},"subject":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subject"},"text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Text"},"html":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Html"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"SPF":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Spf"},"attachments":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Attachments"},"headers":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Headers"}},"type":"object","title":"Body_receive_email"},"Body_upload_train_knowledge_base":{"properties":{"files":{"items":{"type":"string","contentMediaType":"application/octet-stream"},"type":"array","title":"Files"},"file_metadata":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Metadata","description":"JSON list of SourceMetadata objects, one per file (positionally matched)"}},"type":"object","required":["files"],"title":"Body_upload_train_knowledge_base"},"BoolContainer":{"properties":{"total_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Size"},"taken":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Taken"},"truncated":{"type":"boolean","title":"Truncated","default":false},"preview_file":{"anyOf":[{"$ref":"#/components/schemas/FileType"},{"type":"null"}]},"list_offset":{"type":"integer","title":"List Offset","default":0},"type":{"type":"string","const":"bool","title":"Type","default":"bool"},"value":{"title":"Value"}},"type":"object","required":["value"],"title":"BoolContainer"},"BootstrapStatus":{"properties":{"ready":{"type":"boolean","title":"Ready"},"conversation_count":{"type":"integer","title":"Conversation Count"},"min_conversations":{"type":"integer","title":"Min Conversations","default":50},"days_collecting":{"type":"integer","title":"Days Collecting","default":0},"min_days":{"type":"integer","title":"Min Days","default":7},"bootstrapped":{"type":"boolean","title":"Bootstrapped","default":false}},"type":"object","required":["ready","conversation_count"],"title":"BootstrapStatus"},"BulkInsertRequest":{"properties":{"rows":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Rows"}},"type":"object","required":["rows"],"title":"BulkInsertRequest"},"BulkInsertResponse":{"properties":{"inserted":{"type":"integer","title":"Inserted"}},"type":"object","required":["inserted"],"title":"BulkInsertResponse"},"CSATRatingCount":{"properties":{"rating":{"type":"integer","title":"Rating"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["rating","count"],"title":"CSATRatingCount"},"CSATScore":{"properties":{"total":{"type":"integer","title":"Total"},"positive":{"type":"integer","title":"Positive"},"score_pct":{"type":"number","title":"Score Pct"},"delta_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Delta Pct"},"ratings":{"items":{"$ref":"#/components/schemas/CSATRatingCount"},"type":"array","title":"Ratings"},"days":{"type":"integer","title":"Days"}},"type":"object","required":["total","positive","score_pct","delta_pct","ratings","days"],"title":"CSATScore","description":"CX score: the share of conversations rated 4 or 5 (the bar plot)."},"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","description":"A cache point marker for prompt caching.\n\nCan be inserted into UserPromptPart.content to mark cache boundaries.\nModels that don't support caching will filter these out.\n\nSupported by:\n\n- Anthropic\n- Amazon Bedrock (Converse API)\n- OpenAI (GPT-5.6 models)\n- OpenRouter (Anthropic and Gemini models via `OpenRouterModel`, plus OpenAI GPT-5.6 models when\n  using `OpenAIChatModel` or `OpenAIResponsesModel` with `OpenRouterProvider`)"},"CapabilityPins":{"additionalProperties":{"type":"integer","maximum":999.0,"minimum":0.0},"type":"object","title":"CapabilityPins","description":"A version per capability. Absent means \"whatever that capability says\nproduction runs\", which for an opt-in one is off."},"ChangeColumnTypeRequest":{"properties":{"new_type":{"type":"string","title":"New Type"}},"type":"object","required":["new_type"],"title":"ChangeColumnTypeRequest"},"ChannelMetadata":{"properties":{"channel_type":{"type":"string","title":"Channel Type"},"label":{"type":"string","title":"Label"},"description":{"type":"string","title":"Description"},"icon_url":{"type":"string","title":"Icon Url"},"preview_image_url":{"type":"string","title":"Preview Image Url"},"color":{"type":"string","title":"Color"},"required_integration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Required Integration"},"order":{"type":"integer","title":"Order"},"supports_app_url":{"type":"boolean","title":"Supports App Url"},"supports_embed":{"type":"boolean","title":"Supports Embed"},"supports_transport_display":{"type":"boolean","title":"Supports Transport Display"},"supports_customization":{"type":"boolean","title":"Supports Customization"},"is_external":{"type":"boolean","title":"Is External"}},"type":"object","required":["channel_type","label","description","icon_url","preview_image_url","color","required_integration","order","supports_app_url","supports_embed","supports_transport_display","supports_customization","is_external"],"title":"ChannelMetadata","description":"Public metadata for a registered deployment channel.\n\nMirrors ``ChannelDefinition.to_metadata()`` — typed so the OpenAPI\nspec is precise and the frontend generated types are useful."},"ChatMessage":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"parts":{"items":{"oneOf":[{"$ref":"#/components/schemas/ModelRequest"},{"$ref":"#/components/schemas/ModelResponse"}],"discriminator":{"propertyName":"kind","mapping":{"request":"#/components/schemas/ModelRequest","response":"#/components/schemas/ModelResponse"}}},"type":"array","title":"Parts"}},"type":"object","required":["id","parts"],"title":"ChatMessage"},"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"},"CoWorkerSettings-Input":{"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,"select_all":false,"show_optional_label":false,"type":"multi_select","values":[{"label":"Person","value":"PERSON"},{"label":"Email Address","value":"EMAIL_ADDRESS"},{"label":"Phone Number","value":"PHONE_NUMBER"},{"label":"Credit Card","value":"CREDIT_CARD"},{"label":"Cryptocurrency","value":"CRYPTO"},{"label":"IP Address","value":"IP_ADDRESS"},{"label":"Date Time","value":"DATE_TIME"},{"label":"NRP","value":"NRP"},{"label":"Location","value":"LOCATION"},{"label":"Medical License","value":"MEDICAL_LICENSE"},{"label":"URL","value":"URL"},{"label":"IBAN Code","value":"IBAN_CODE"}]},"rules":[{"config_source":"pii_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden","visible":false},"divider1":{"type":"string","title":"Divider1","default":"","accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_line":true,"show_optional_label":false,"spacing":0,"type":"divider"},"tab":"Model","tool_mode":"hidden","visible":false},"guardrail_info":{"type":"string","title":"Guardrail Info","description":"Information about the guardrails","default":"","accordion":"Safety","display":{"col_span":10,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"small_text":"Set the strictness level of guardrails to ensure the AI model's behavior and responses remain safe and appropriate, from 'Off' (no protection) to 'High' (maximum protection).","title":"Guardrails","type":"ui_text_display"},"tab":"Model","tool_mode":"hidden"},"guardrail_lock":{"type":"boolean","title":"Guardrail Lock","description":"Locks the guardrails settings.","default":false,"accordion":"Safety","display":{"col_align":"start","col_justify":"end","col_span":2,"icon":"Unlock","is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"toggledIcon":"Lock","tooltip":"Lock guardrails settings so they cannot be changed","type":"toggle_button"},"tab":"Model","tool_mode":"hidden","visible":false},"guardrail_latency_banner":{"type":"string","title":"Guardrail Latency Banner","description":"","default":"","accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Each enabled guardrail makes its own LLM call before the model can reply. Expect noticeably slower responses while any of these are on.","needs_confirmation":false,"show_optional_label":false,"style":"warning","title":"Guardrails add response latency","type":"banner"},"rules":[{"conds":[{"config_source":"violence_and_hate","type":"visible_if_not","value":"Off"},{"config_source":"sexual_content","type":"visible_if_not","value":"Off"},{"config_source":"guns_and_weapons","type":"visible_if_not","value":"Off"},{"config_source":"suicide","type":"visible_if_not","value":"Off"},{"config_source":"crime","type":"visible_if_not","value":"Off"},{"config_source":"toxicity","type":"visible_if_not","value":"Off"},{"config_source":"bias","type":"visible_if_not","value":"Off"},{"config_source":"profanity","type":"visible_if_not","value":"Off"},{"config_source":"jailbreak","type":"visible_if","value":true},{"config_source":"prompt_injection","type":"visible_if","value":true}],"mode":"or","type":"visible_if_group"}],"tab":"Model","tool_mode":"hidden"},"violence_and_hate":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a news agency. Reporting on conflict zones is expected and should not be flagged.","is_disabled":false,"is_subconfig":false,"label":"Violence and Hate","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"sexual_content":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is an airline booking system. Mentions of children traveling are normal and should not be flagged.","is_disabled":false,"is_subconfig":false,"label":"Sexual Content","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"guns_and_weapons":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a sporting goods store. Discussion of hunting equipment is expected.","is_disabled":false,"is_subconfig":false,"label":"Guns and Illegal Weapons","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"suicide":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a mental health support platform. Discussing symptoms is expected and should not be blocked.","is_disabled":false,"is_subconfig":false,"label":"Suicide and Self-Harm","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"crime":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a legal firm assistant. Discussing criminal cases and charges is part of normal operation.","is_disabled":false,"is_subconfig":false,"label":"Crime and Criminal Planning","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"toxicity":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a gaming community moderator. Competitive banter and trash talk is normal.","is_disabled":false,"is_subconfig":false,"label":"Toxicity","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"bias":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This assistant serves a diversity and inclusion team. Discussing demographic differences is expected.","is_disabled":false,"is_subconfig":false,"label":"Bias","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"profanity":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a content moderation tool. Quoting flagged content for review is expected.","is_disabled":false,"is_subconfig":false,"label":"Profanity","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"guardrails_scan_output":{"type":"boolean","title":"Guardrails Scan Output","description":"Scan the model's response with the same semantic guardrails applied to input. Catches sensitive content sourced from Knowledge Base documents or tools that the input scan cannot see.","default":false,"accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Scan responses (output guardrails)","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"guardrails_output_mode":{"type":"string","enum":["post_stream","pre_stream"],"title":"Guardrails Output Mode","description":"How output guardrails are enforced. 'post_stream' streams the response in real-time and warns/clears after the fact. 'pre_stream' buffers the full response, validates it against guardrails, and only emits it if it passes.","default":"post_stream","accordion":"Safety","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"Output guardrail mode","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"label":"Post-stream (warn after response)","value":"post_stream"},{"label":"Pre-stream (validate before showing)","value":"pre_stream"}]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true},{"config_source":"guardrails_scan_output","type":"visible_if","value":true}],"tab":"Model","tool_mode":"hidden"},"divider2":{"type":"string","title":"Divider2","default":"","accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_line":true,"show_optional_label":false,"spacing":0,"type":"divider"},"tab":"Model","tool_mode":"hidden"},"guardrail_action":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"string"}],"title":"Guardrail Action","description":"Choose the action to take when a guardrail is triggered.","default":{"value":"fail","label":"Fail/block run"},"accordion":"Safety","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"Guardrail action","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"label":"Fail/block run","value":"fail"},{"label":"Flag with warning but proceed","value":"flag"}]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden","visible":false},"guardrail_action_replace":{"type":"string","title":"Guardrail Action Replace","default":"","accordion":"Safety","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Replace with","needs_confirmation":false,"number_of_lines":1,"placeholder":"E.g. <REDACTED>","show_optional_label":false,"show_refresh":false,"type":"text"},"rules":[{"config_source":"guardrail_action","type":"visible_if","value":"replace"},{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden","visible":false},"guardrail_action_human":{"type":"string","title":"Guardrail Action Human","default":"","accordion":"Safety","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":true,"label":"Human task template","needs_confirmation":false,"number_of_lines":1,"placeholder":"E.g. <REDACTED>","show_optional_label":false,"show_refresh":false,"type":"text"},"rules":[{"config_source":"guardrail_action","type":"visible_if","value":"human"},{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden","visible":false},"block_after_violations":{"type":"integer","title":"Block After Violations","description":"Block the chat after this many turns with guardrail violations. Set to 0 to never block (per-turn warnings still surface).","default":0,"accordion":"Safety","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Block chat after N violations","max":20,"min":0,"needs_confirmation":false,"show_optional_label":false,"step":1,"tooltip":"Once a conversation accumulates this many turns with any guardrail violation (flag or fail mode), the chat input locks. Set to 0 to disable.","type":"number_slider"},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"block_message":{"type":"string","title":"Block Message","description":"Message shown to the user when the chat is locked.","default":"This conversation has been locked due to repeated safety violations. Please start a new conversation.","accordion":"Safety","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":true,"label":"Block message","needs_confirmation":false,"number_of_lines":1,"placeholder":"This conversation has been locked due to repeated safety violations.","show_optional_label":false,"show_refresh":false,"type":"text"},"rules":[{"config_source":"block_after_violations","type":"visible_if_not","value":0},{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"divider3":{"type":"string","title":"Divider3","default":"","accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_line":true,"show_optional_label":false,"spacing":0,"type":"divider"},"tab":"Model","tool_mode":"hidden","visible":false},"prompt_defense":{"type":"string","title":"Prompt Defense","default":"","accordion":"Safety","display":{"col_span":10,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"small_text":"Configurations to ensure the model behaves as expected and is protected against attacks, like jailbreak or prompt injection.","title":"Prompt Defense","type":"ui_text_display"},"tab":"Model","tool_mode":"hidden"},"prompt_lock":{"type":"boolean","title":"Prompt Lock","description":"Locks the prompt defense settings","default":false,"accordion":"Safety","display":{"col_align":"start","col_justify":"end","col_span":2,"icon":"Unlock","is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"toggledIcon":"Lock","tooltip":"Lock prompt settings so they cannot be changed","type":"toggle_button"},"tab":"Model","tool_mode":"hidden","visible":false},"jailbreak":{"type":"boolean","title":"Jailbreak","description":"Prevents attempts to manipulate or \"jailbreak\" the model into ignoring safety rules or system instructions (e.g., prompts like \"ignore previous instructions\").","default":false,"accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Jailbreak","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"prompt_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"prompt_injection":{"type":"boolean","title":"Prompt Injection","description":"Detects and blocks strategies where users attempt to get around restrictions indirectly (e.g., asking the model to 'pretend' or speak as a fictional character to evade policies).","default":false,"accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Prompt Injection","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"prompt_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"context_leak":{"type":"boolean","title":"Context Leak","description":"Prevents the model from unintentionally revealing internal context, instructions, or system messages that are not meant to be shared with the user.","default":false,"accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Context Leak","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"prompt_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden","visible":false},"auto_model_pick":{"type":"boolean","title":"Auto Model Pick","description":"AI selects the optimal model for performance, cost savings or length","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Smart model selection","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Model","tool_mode":"hidden","visible":false},"auto_model_preference":{"type":"string","title":"Auto Model Preference","default":"cost","display":{"can_wrap":true,"col_span":12,"endpoint":"/models/llms","is_disabled":false,"is_multi":false,"is_subconfig":true,"needs_confirmation":false,"show_optional_label":false,"type":"select_chips","values":[{"custom_fields":{"icon":"gauge"},"label":"Performance","value":"performance"},{"custom_fields":{"icon":"dollar"},"label":"Cost","value":"cost"},{"custom_fields":{"icon":"text"},"label":"Length","value":"length"}]},"optional":true,"tab":"Model","tool_mode":"hidden","visible":false},"model":{"items":{"type":"string"},"type":"array","title":"Model","description":"Model configuration","default":["preset:cost"],"display":{"col_span":12,"default_preset":"cost","endpoint":"/models/llms","hide_disabled_models":true,"is_disabled":false,"is_subconfig":true,"label":"Choose from our recommended models","layout":"side_by_side","model_type":"text","needs_confirmation":false,"show_inline_presets":true,"show_optional_label":false,"show_presets":false,"type":"model_select"},"optional":true,"tab":"Model","tool_mode":"hidden"},"parameter_preset":{"type":"string","enum":["default","creative","precise","custom"],"title":"Parameter Preset","description":"Controls randomness, diversity, and repetition of the model's output.","default":"default","accordion":"Model Parameters","display":{"button_size":"sm","button_variant":"outline","col_span":12,"is_disabled":false,"is_horizontal":true,"is_subconfig":false,"label":"Model parameters preset","needs_confirmation":false,"show_optional_label":false,"type":"menu_select","values":[{"description":"Provider-recommended settings for general use","icon":"settings2","label":"Default","value":"default"},{"description":"Higher randomness for diverse, imaginative outputs","icon":"sparkles","label":"Creative","value":"creative"},{"description":"Deterministic and focused for factual tasks","icon":"target","label":"Precise","value":"precise"},{"description":"Fine-tune each parameter manually","icon":"sliders-horizontal","label":"Custom","value":"custom"}]},"rules":[{"target_fields":["temperature","top_p","top_k","presence_penalty","frequency_penalty"],"type":"sets_field_values","value_map":{"creative":{"frequency_penalty":0.3,"presence_penalty":0.3,"temperature":0.7,"top_k":40,"top_p":0.95},"custom":{},"default":{},"precise":{"frequency_penalty":0.0,"presence_penalty":0.0,"temperature":0.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_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Max tokens","max":384000,"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_input":false,"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.0,"accordion":"Model Parameters","display":{"col_span":12,"hide_input":false,"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_input":false,"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.0,"accordion":"Model Parameters","display":{"col_span":12,"hide_input":false,"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_input":false,"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_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Frequency penalty","max":2,"min":-2,"needs_confirmation":false,"show_optional_label":false,"step":0.1,"type":"number_slider"},"rules":[{"config_source":"parameter_preset","type":"visible_if","value":"custom"}],"tab":"Model","tool_mode":"hidden"},"stop_sequences":{"items":{"type":"string"},"type":"array","title":"Stop Sequences","description":"The model will stop generating text when it encounters any of these stop sequences","default":[],"accordion":"Model Parameters","display":{"chips_are_closable":false,"col_span":12,"hide_toolbar":false,"is_disabled":false,"is_subconfig":false,"label":"Stop sequences","needs_confirmation":false,"show_optional_label":false,"type":"chips_list_text"},"rules":[{"config_source":"parameter_preset","type":"visible_if","value":"custom"}],"tab":"Model","tool_mode":"hidden"},"divider_8":{"type":"string","title":"Divider 8","default":"","accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_line":true,"show_optional_label":false,"spacing":0,"type":"divider"},"rules":[{"config_source":"parameter_preset","type":"visible_if","value":"custom"}],"tab":"Model","tool_mode":"hidden"},"reasoning_section":{"type":"string","title":"Reasoning Section","default":"","accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"text":"Configure the model's reasoning capabilities and computational effort level.","title":"Model reasoning","type":"ui_text_display"},"rules":[{"config_source":"parameter_preset","type":"visible_if","value":"custom"}],"tab":"Model","tool_mode":"hidden"},"enable_reasoning":{"type":"boolean","title":"Enable Reasoning","description":"Whether to enable reasoning","default":true,"accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enable reasoning","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"parameter_preset","type":"visible_if","value":"custom"}],"tab":"Model","tool_mode":"hidden"},"reasoning_effort":{"type":"string","title":"Reasoning Effort","description":"The reasoning effort of the model","default":"Low","accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_horizontal":false,"is_subconfig":false,"label":"Reasoning effort","needs_confirmation":false,"show_optional_label":false,"type":"enum_slider","values":["low","medium","high"]},"rules":[{"conds":[{"config_source":"parameter_preset","type":"visible_if","value":"custom"},{"config_source":"enable_reasoning","type":"visible_if","value":true}],"mode":"and","type":"visible_if_group"}],"tab":"Model","tool_mode":"hidden"},"divider":{"type":"string","title":"Divider","default":"","accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_line":true,"show_optional_label":false,"spacing":0,"type":"divider"},"rules":[{"config_source":"parameter_preset","type":"visible_if","value":"custom"}],"tab":"Model","tool_mode":"hidden"},"reliability_section":{"type":"string","title":"Reliability Section","default":"","accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"text":"Configure retry behavior and fallback options for improved reliability.","title":"Reliability","type":"ui_text_display"},"tab":"Model","tool_mode":"hidden"},"max_retries_per_model":{"type":"integer","title":"Max Retries Per Model","description":"The maximum number of retries per model","default":3,"accordion":"Model Parameters","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Max retries","max":5,"min":0,"needs_confirmation":false,"show_optional_label":false,"step":1,"type":"number_slider"},"tab":"Model","tool_mode":"hidden"},"retry_on_status_codes":{"items":{"type":"integer"},"type":"array","title":"Retry On Status Codes","description":"The status codes to retry on","default":[429,500,502,503,504],"accordion":"Model Parameters","display":{"chips_are_closable":false,"col_span":12,"hide_toolbar":false,"is_disabled":false,"is_subconfig":false,"label":"Retry on status codes","needs_confirmation":false,"show_optional_label":false,"type":"chips_list_text"},"tab":"Model","tool_mode":"hidden"},"datacenter_fallback":{"type":"boolean","title":"Datacenter Fallback","description":"Whether to fallback to a different datacenter of the same model if the current one is down","default":true,"accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Datacenter fallback","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Model","tool_mode":"hidden"},"exclude_user_identity_from_prompt":{"type":"boolean","title":"Exclude User Identity From Prompt","description":"Omit the user's name from the system prompt. Keeps the cached instruction prefix identical across users so it can be reused, and avoids sending user identity to the model.","default":false,"accordion":"Advanced","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Exclude user identity from prompt","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Prompt","tool_mode":"hidden"},"enable_prompt_caching":{"type":"boolean","title":"Enable Prompt Caching","description":"Cache the stable instruction prefix at the model provider to cut input cost and latency on repeated turns. Disable to send every request uncached.","default":true,"accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Prompt caching","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Model","tool_mode":"hidden"},"protect_instructions_in_preview":{"type":"boolean","title":"Protect Instructions In Preview","description":"Deployed conversations always keep the agent's system instructions, persona, tools, and configuration confidential. Turn this on to also protect them in the preview/dev page; otherwise the safeguard is dropped there so builders can inspect the agent they are configuring.","default":false,"accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Protect instructions in preview","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"prompt_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"usage_limits_section":{"type":"string","title":"Usage Limits Section","default":"","accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"text":"Set limits on resource usage to control costs and prevent overuse.","title":"Agent usage limits","tooltip":"Applies to each conversation.","type":"ui_text_display"},"tab":"Model","tool_mode":"hidden"},"usage_limits_maximum_request":{"type":"integer","title":"Usage Limits Maximum Request","description":"The maximum number of requests","default":1000,"accordion":"Model Parameters","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Total Max Requests","max":10000,"min":1,"needs_confirmation":false,"show_optional_label":false,"step":50,"tooltip":"Applies to each conversation.","type":"number_slider"},"tab":"Model","tool_mode":"hidden"},"usage_limits_maximum_tokens":{"type":"integer","title":"Usage Limits Maximum Tokens","description":"The maximum number of tokens","default":2000000,"accordion":"Model Parameters","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Total max tokens","max":2000000,"min":100,"needs_confirmation":false,"show_optional_label":false,"step":500,"tooltip":"Applies to each conversation.","type":"number_slider"},"tab":"Model","tool_mode":"hidden"},"usage_limits_max_messages":{"type":"integer","title":"Usage Limits Max Messages","description":"The maximum number of messages","default":100,"accordion":"Model Parameters","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Total max messages","max":1000,"min":0,"needs_confirmation":false,"show_optional_label":false,"step":10,"tooltip":"Applies to each conversation.","type":"number_slider"},"tab":"Model","tool_mode":"hidden"},"usage_limits_agent_timeout":{"type":"integer","title":"Usage Limits Agent Timeout","description":"The maximum number of seconds the agent can run for","default":120,"accordion":"Model Parameters","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Agent timeout","max":600,"min":0,"needs_confirmation":false,"show_optional_label":false,"step":1,"tooltip":"Applies to each message.","type":"number_slider"},"tab":"Model","tool_mode":"hidden"},"divider_11":{"type":"string","title":"Divider 11","default":"","accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_line":true,"show_optional_label":false,"spacing":0,"type":"divider"},"tab":"Model","tool_mode":"hidden"},"compaction_enabled":{"type":"boolean","title":"Compaction Enabled","description":"Automatically summarize old messages when context limit is approached.","default":true,"accordion":"Compaction Settings","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Chat compaction","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Model","tool_mode":"hidden"},"compaction_strategy":{"type":"string","title":"Compaction Strategy","description":"How to compact chat history when it grows too long.","default":"auto","accordion":"Compaction Settings","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":false,"is_subconfig":false,"label":"Compaction strategy","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"label":"Auto (prefer provider-native)","value":"auto"},{"label":"Provider-native only","value":"provider"},{"label":"LLM summarization","value":"summarization"}]},"rules":[{"config_source":"compaction_enabled","type":"visible_if","value":true}],"tab":"Model","tool_mode":"hidden"},"compaction_threshold":{"type":"number","title":"Compaction Threshold","description":"How full the context window may get before compaction runs (0.01 to 0.95). Lower compacts sooner and more often.","default":0.75,"accordion":"Compaction Settings","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Compact when the context is this full","max":0.95,"min":0.01,"needs_confirmation":false,"show_optional_label":false,"step":0.01,"tooltip":"When token usage reaches this fraction of the context window, the older part of the conversation is compacted away. Lower this to compact earlier on long chats.","type":"number_slider"},"rules":[{"config_source":"compaction_enabled","type":"visible_if","value":true}],"tab":"Model","tool_mode":"hidden"},"compaction_tool_enabled":{"type":"boolean","title":"Compaction Tool Enabled","description":"Expose a tool that lets the agent request compaction manually.","default":false,"accordion":"Compaction Settings","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Compaction tool","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","tooltip":"When on, the agent can call `compact_conversation` to compact at will.","type":"toggle"},"rules":[{"conds":[{"config_source":"compaction_enabled","type":"visible_if","value":true},{"conds":[{"config_source":"compaction_strategy","type":"visible_if","value":"auto"},{"config_source":"compaction_strategy","type":"visible_if","value":"summarization"}],"mode":"or","type":"visible_if_group"}],"mode":"and","type":"visible_if_group"}],"tab":"Model","tool_mode":"hidden"},"tool_calling_section":{"type":"string","title":"Tool Calling Section","default":"","accordion":"Model Parameters","display":{"col_span":10,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"small_text":"Configure how the agent handles tool execution and function calls.","title":"Tool calling","type":"ui_text_display"},"tab":"Model","tool_mode":"hidden"},"parallel_tool_calls":{"type":"boolean","title":"Parallel Tool Calls","description":"Whether to allow the agent to call multiple tools at the same time.","default":true,"accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Parallel tool calls","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Model","tool_mode":"hidden"},"tool_timeout":{"type":"number","title":"Tool Timeout","description":"Maximum seconds a single tool call can run before timing out.","default":15.0,"accordion":"Model Parameters","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Tool timeout","max":300,"min":1,"needs_confirmation":false,"show_optional_label":false,"step":1,"tooltip":"Per-tool-call timeout. The model retries on timeout.","type":"number_slider"},"tab":"Model","tool_mode":"hidden"},"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,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"enable_reasoning","type":"visible_if","value":true}],"tab":"Display","tool_mode":"hidden"},"group_into_chain_of_thought":{"type":"boolean","title":"Group Into Chain Of Thought","description":"Group reasoning and tool calls into a collapsible chain of thought","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Group into chain of thought","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Display","tool_mode":"hidden"},"chain_of_thought_final_answer_only":{"type":"boolean","title":"Chain Of Thought Final Answer Only","description":"The agent only responds at the end, keeping all intermediate messages in its chain of thought.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Only show the final answer","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"group_into_chain_of_thought","type":"visible_if","value":true}],"tab":"Display","tool_mode":"hidden","visible":false},"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,"toggle_position":"right","type":"toggle"},"tab":"Display","tool_mode":"hidden"},"hide_error_banners":{"type":"boolean","title":"Hide Error Banners","description":"When a turn fails on the web widget or an embed, hide the error banner from end users; the agent's own reply still explains what it could not do, and a turn that fails before it replies still offers a retry. The platform's own chat always shows the error while you build. Slack, Teams and the other channels never rendered these banners.","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Hide error banners on the widget and embed","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","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 the agent is working.","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enable loading message","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Display","tool_mode":"hidden"},"message_footer_enabled":{"type":"boolean","title":"Message Footer Enabled","description":"Show a fixed footer under the agent's final reply in every channel.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Message footer","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Display","tool_mode":"hidden"},"message_footer":{"anyOf":[{"items":{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},"type":"array"},{"type":"null"}],"title":"Message Footer","description":"Shown under the agent's final reply in every channel. Never sent to the model, so it cannot be reworded or dropped.","display":{"col_span":12,"connector_name":"","hide_chip_options":false,"hide_toolbar":false,"is_disabled":false,"is_simple_text":false,"is_subconfig":false,"label":"Footer text","needs_confirmation":false,"no_space_on_insert":false,"number_of_lines":5,"placeholder":"e.g. a disclaimer shown under every answer","show_optional_label":false,"type":"rich_text_variables"},"rules":[{"config_source":"message_footer_enabled","type":"visible_if","value":true}],"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":[{"config_source":"minimal_caret_only","type":"visible_if","value":true}],"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,"icons":false,"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"},"deduplicate_sources_by_url":{"type":"boolean","title":"Deduplicate Sources By Url","description":"Group sources by unique URL in the sources panel","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Deduplicate sources by URL","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"conds":[{"config_source":"citation_style","type":"visible_if","value":"text"},{"config_source":"citation_style","type":"visible_if","value":"numbered"}],"mode":"or","type":"visible_if_group"}],"tab":"Display","tool_mode":"hidden"},"omit_citation_quotes":{"type":"boolean","title":"Omit Citation Quotes","description":"Hide quoted text in citation bubbles, show only the URL","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Omit citation quotes","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"conds":[{"config_source":"citation_style","type":"visible_if","value":"text"},{"config_source":"citation_style","type":"visible_if","value":"numbered"}],"mode":"or","type":"visible_if_group"}],"tab":"Display","tool_mode":"hidden"},"show_source_images":{"type":"boolean","title":"Show Source Images","description":"Show document page images presented by the agent expanded by default instead of collapsed behind the source images toggle","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Show source images by default","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"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"},"transport_show_tool_calls":{"type":"boolean","title":"Transport Show Tool Calls","default":false,"tab":"Configuration","tool_mode":"hidden","visible":false},"transport_show_sources":{"type":"boolean","title":"Transport Show Sources","default":true,"tab":"Configuration","tool_mode":"hidden","visible":false},"transport_show_thinking":{"type":"boolean","title":"Transport Show Thinking","default":false,"tab":"Configuration","tool_mode":"hidden","visible":false},"transport_allow_noop":{"type":"boolean","title":"Transport Allow Noop","default":false,"tab":"Configuration","tool_mode":"hidden","visible":false},"transport_thinking_text":{"type":"string","title":"Transport Thinking Text","default":"","tab":"Configuration","tool_mode":"hidden","visible":false},"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 chat title is displayed.","title":"Chat title display","type":"ui_text_display"},"tab":"Display","tool_mode":"hidden"},"agent_title_mode":{"type":"string","enum":["generate","first_message","last_message","custom"],"title":"Agent Title Mode","description":"Configure how the agent chat title is displayed in the chat history","default":"generate","display":{"col_span":12,"icons":false,"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"},{"label":"Custom prompt","value":"custom"}]},"tab":"Display","tool_mode":"hidden"},"agent_title_prompt":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"string"}],"title":"Agent Title Prompt","description":"Custom instructions for the generated conversation title.","default":"","display":{"col_span":12,"hide_toolbar":false,"is_disabled":false,"is_subconfig":false,"label":"Title prompt","needs_confirmation":false,"number_of_lines":5,"placeholder":"Describe what the title should contain and the format it should follow.","show_optional_label":false,"type":"big_text"},"rules":[{"config_source":"agent_title_mode","type":"visible_if","value":"custom"}],"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"},"feedback_section":{"type":"string","title":"Feedback Section","default":"","display":{"col_span":10,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"small_text":"Customise the inline prompt shown when a user rates a response.","title":"Message feedback","type":"ui_text_display"},"tab":"Display","tool_mode":"hidden"},"feedback_placeholder":{"type":"string","title":"Feedback Placeholder","description":"Placeholder shown in the inline feedback box.","default":"Add details (optional)","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Feedback placeholder","max_length":140,"needs_confirmation":false,"number_of_lines":1,"placeholder":"Add details (optional)","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Display","tool_mode":"hidden"},"feedback_submit_label":{"type":"string","title":"Feedback Submit Label","default":"Submit","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Submit button label","max_length":30,"needs_confirmation":false,"number_of_lines":1,"placeholder":"Submit","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Display","tool_mode":"hidden"},"feedback_cancel_label":{"type":"string","title":"Feedback Cancel Label","default":"Cancel","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Cancel button label","max_length":30,"needs_confirmation":false,"number_of_lines":1,"placeholder":"Cancel","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Display","tool_mode":"hidden"},"capability_versions":{"$ref":"#/components/schemas/CapabilityPins","description":"Pinned behaviour version per agent capability","tab":"Configuration","tool_mode":"hidden","visible":false},"is_coworker":{"type":"boolean","title":"Is Coworker","description":"Whether the agent is a co-worker","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Is co-worker","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"preset_selector":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Preset Selector","description":"Choose a preset to get started quickly.","display":{"button_label":"Choose preset","button_size":"default","button_variant":"outline","col_span":12,"confirmation_message":"Loading a preset will overwrite your persona, tone, instructions, and some model settings. Continue?","is_disabled":false,"is_horizontal":true,"is_subconfig":false,"label":"Quick start","mixpanel_event":"AGENT_PRESET_SELECTOR_CLICK","needs_confirmation":true,"show_optional_label":false,"type":"menu_select","values":[{"description":"Customer service agent for issue resolution","label":"Customer Operations","value":"customer_operations"},{"description":"Technical support specialist for troubleshooting","label":"IT Helpdesk","value":"it_helpdesk"},{"description":"Case management specialist for claims and workflows","label":"Case Management","value":"case_management"}]},"rules":[{"target_fields":["persona","tone","extra_instructions","temperature","top_p","top_k","presence_penalty","frequency_penalty","parameter_preset","preset_selector"],"type":"sets_field_values","value_map":{"case_management":{"extra_instructions":{"definition":{"content":[{"content":[{"text":"- Review all case details thoroughly before proceeding","type":"text"}],"type":"paragraph"},{"content":[{"text":"- Follow established procedures and compliance requirements","type":"text"}],"type":"paragraph"},{"content":[{"text":"- Document all actions and decisions clearly","type":"text"}],"type":"paragraph"},{"content":[{"text":"- Maintain accuracy and attention to detail throughout the process","type":"text"}],"type":"paragraph"}],"type":"doc"},"isRaw":false,"text":"- Review all case details thoroughly before proceeding\n- Follow established procedures and compliance requirements\n- Document all actions and decisions clearly\n- 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\n- Provide concise step-by-step guidance\n- Escalate complex cases politely when needed\n- Maintain empathy and professionalism in all interactions"},"frequency_penalty":0.6,"parameter_preset":"custom","persona":{"definition":{"content":[{"content":[{"text":"You are a knowledgeable and empathetic customer operations agent who helps users resolve issues quickly and clearly. You have deep expertise in customer service best practices, issue resolution, and maintaining positive customer relationships.","type":"text"}],"type":"paragraph"}],"type":"doc"},"isRaw":false,"text":"You are a knowledgeable and empathetic customer operations agent who helps users resolve issues quickly and clearly. You have deep expertise in customer service best practices, issue resolution, and maintaining positive customer relationships."},"presence_penalty":0.4,"temperature":0.2,"tone":{"definition":{"content":[{"content":[{"text":"Be professional yet personable. Provide clear and engaging communication. Exercise good judgment in matching tone to context.","type":"text"}],"type":"paragraph"}],"type":"doc"},"isRaw":false,"text":"Be professional yet personable. Provide clear and engaging communication. Exercise good judgment in matching tone to context."},"top_k":20,"top_p":0.85},"it_helpdesk":{"extra_instructions":{"definition":{"content":[{"content":[{"text":"- Gather system information and error details first","type":"text"}],"type":"paragraph"},{"content":[{"text":"- Provide step-by-step troubleshooting instructions","type":"text"}],"type":"paragraph"},{"content":[{"text":"- Explain technical concepts in simple terms","type":"text"}],"type":"paragraph"},{"content":[{"text":"- Document solutions for future reference","type":"text"}],"type":"paragraph"}],"type":"doc"},"isRaw":false,"text":"- Gather system information and error details first\n- Provide step-by-step troubleshooting instructions\n- Explain technical concepts in simple terms\n- Document solutions for future reference"},"frequency_penalty":0.7,"parameter_preset":"custom","persona":{"definition":{"content":[{"content":[{"text":"You are an experienced IT helpdesk support specialist with comprehensive knowledge of technical troubleshooting, common software and hardware issues, and system administration. You excel at translating complex technical concepts into simple, actionable guidance.","type":"text"}],"type":"paragraph"}],"type":"doc"},"isRaw":false,"text":"You are an experienced IT helpdesk support specialist with comprehensive knowledge of technical troubleshooting, common software and hardware issues, and system administration. You excel at translating complex technical concepts into simple, actionable guidance."},"presence_penalty":0.3,"temperature":0.2,"tone":{"definition":{"content":[{"content":[{"text":"Be professional yet personable. Provide clear and engaging communication. Exercise good judgment in matching tone to context.","type":"text"}],"type":"paragraph"}],"type":"doc"},"isRaw":false,"text":"Be professional yet personable. Provide clear and engaging communication. Exercise good judgment in matching tone to context."},"top_k":25,"top_p":0.85}}}],"tab":"Prompt","tool_mode":"hidden","visible":false},"languages":{"items":{"$ref":"#/components/schemas/AgentLanguage-Input"},"type":"array","title":"Languages","description":"Welcome message per language. The deployed widget's language picks one, otherwise the visitor's browser locale; the default language is used when none matches.","default":[],"display":{"addable_codes":["en","es","pt"],"col_span":12,"intro_placeholder":"Hello, how can I help you today?","is_disabled":false,"is_subconfig":false,"label":"Languages","needs_confirmation":false,"options":[{"label":"Abkhazian","tag":"ab","value":"ab"},{"label":"Afar","tag":"aa","value":"aa"},{"label":"Afrikaans","tag":"af","value":"af"},{"label":"Akan","tag":"ak","value":"ak"},{"label":"Albanian","tag":"sq","value":"sq"},{"label":"Amharic","tag":"am","value":"am"},{"label":"Arabic","tag":"ar","value":"ar"},{"label":"Aragonese","tag":"an","value":"an"},{"label":"Armenian","tag":"hy","value":"hy"},{"label":"Assamese","tag":"as","value":"as"},{"label":"Avaric","tag":"av","value":"av"},{"label":"Avestan","tag":"ae","value":"ae"},{"label":"Aymara","tag":"ay","value":"ay"},{"label":"Azerbaijani","tag":"az","value":"az"},{"label":"Bambara","tag":"bm","value":"bm"},{"label":"Bashkir","tag":"ba","value":"ba"},{"label":"Basque","tag":"eu","value":"eu"},{"label":"Belarusian","tag":"be","value":"be"},{"label":"Bengali","tag":"bn","value":"bn"},{"label":"Bislama","tag":"bi","value":"bi"},{"label":"Bosnian","tag":"bs","value":"bs"},{"label":"Breton","tag":"br","value":"br"},{"label":"Bulgarian","tag":"bg","value":"bg"},{"label":"Burmese","tag":"my","value":"my"},{"label":"Catalan","tag":"ca","value":"ca"},{"label":"Chamorro","tag":"ch","value":"ch"},{"label":"Chechen","tag":"ce","value":"ce"},{"label":"Chinese","tag":"zh","value":"zh"},{"label":"Church Slavic","tag":"cu","value":"cu"},{"label":"Chuvash","tag":"cv","value":"cv"},{"label":"Cornish","tag":"kw","value":"kw"},{"label":"Corsican","tag":"co","value":"co"},{"label":"Cree","tag":"cr","value":"cr"},{"label":"Croatian","tag":"hr","value":"hr"},{"label":"Czech","tag":"cs","value":"cs"},{"label":"Danish","tag":"da","value":"da"},{"label":"Dhivehi","tag":"dv","value":"dv"},{"label":"Dutch","tag":"nl","value":"nl"},{"label":"Dzongkha","tag":"dz","value":"dz"},{"label":"English (UK)","tag":"en","value":"en"},{"label":"Esperanto","tag":"eo","value":"eo"},{"label":"Estonian","tag":"et","value":"et"},{"label":"Ewe","tag":"ee","value":"ee"},{"label":"Faroese","tag":"fo","value":"fo"},{"label":"Fijian","tag":"fj","value":"fj"},{"label":"Finnish","tag":"fi","value":"fi"},{"label":"French","tag":"fr","value":"fr"},{"label":"Fulah","tag":"ff","value":"ff"},{"label":"Galician","tag":"gl","value":"gl"},{"label":"Ganda","tag":"lg","value":"lg"},{"label":"Georgian","tag":"ka","value":"ka"},{"label":"German","tag":"de","value":"de"},{"label":"Guarani","tag":"gn","value":"gn"},{"label":"Gujarati","tag":"gu","value":"gu"},{"label":"Haitian","tag":"ht","value":"ht"},{"label":"Hausa","tag":"ha","value":"ha"},{"label":"Hebrew","tag":"he","value":"he"},{"label":"Herero","tag":"hz","value":"hz"},{"label":"Hindi","tag":"hi","value":"hi"},{"label":"Hiri Motu","tag":"ho","value":"ho"},{"label":"Hungarian","tag":"hu","value":"hu"},{"label":"Icelandic","tag":"is","value":"is"},{"label":"Ido","tag":"io","value":"io"},{"label":"Igbo","tag":"ig","value":"ig"},{"label":"Indonesian","tag":"id","value":"id"},{"label":"Interlingua (International Auxiliary Language Association)","tag":"ia","value":"ia"},{"label":"Interlingue","tag":"ie","value":"ie"},{"label":"Inuktitut","tag":"iu","value":"iu"},{"label":"Inupiaq","tag":"ik","value":"ik"},{"label":"Irish","tag":"ga","value":"ga"},{"label":"Italian","tag":"it","value":"it"},{"label":"Japanese","tag":"ja","value":"ja"},{"label":"Javanese","tag":"jv","value":"jv"},{"label":"Kalaallisut","tag":"kl","value":"kl"},{"label":"Kannada","tag":"kn","value":"kn"},{"label":"Kanuri","tag":"kr","value":"kr"},{"label":"Kashmiri","tag":"ks","value":"ks"},{"label":"Kazakh","tag":"kk","value":"kk"},{"label":"Khmer","tag":"km","value":"km"},{"label":"Kikuyu","tag":"ki","value":"ki"},{"label":"Kinyarwanda","tag":"rw","value":"rw"},{"label":"Kirghiz","tag":"ky","value":"ky"},{"label":"Komi","tag":"kv","value":"kv"},{"label":"Kongo","tag":"kg","value":"kg"},{"label":"Korean","tag":"ko","value":"ko"},{"label":"Kuanyama","tag":"kj","value":"kj"},{"label":"Kurdish","tag":"ku","value":"ku"},{"label":"Lao","tag":"lo","value":"lo"},{"label":"Latin","tag":"la","value":"la"},{"label":"Latvian","tag":"lv","value":"lv"},{"label":"Limburgan","tag":"li","value":"li"},{"label":"Lingala","tag":"ln","value":"ln"},{"label":"Lithuanian","tag":"lt","value":"lt"},{"label":"Luba-Katanga","tag":"lu","value":"lu"},{"label":"Luxembourgish","tag":"lb","value":"lb"},{"label":"Macedonian","tag":"mk","value":"mk"},{"label":"Malagasy","tag":"mg","value":"mg"},{"label":"Malay (macrolanguage)","tag":"ms","value":"ms"},{"label":"Malayalam","tag":"ml","value":"ml"},{"label":"Maltese","tag":"mt","value":"mt"},{"label":"Manx","tag":"gv","value":"gv"},{"label":"Maori","tag":"mi","value":"mi"},{"label":"Marathi","tag":"mr","value":"mr"},{"label":"Marshallese","tag":"mh","value":"mh"},{"label":"Modern Greek (1453-)","tag":"el","value":"el"},{"label":"Mongolian","tag":"mn","value":"mn"},{"label":"Nauru","tag":"na","value":"na"},{"label":"Navajo","tag":"nv","value":"nv"},{"label":"Ndonga","tag":"ng","value":"ng"},{"label":"Nepali (macrolanguage)","tag":"ne","value":"ne"},{"label":"North Ndebele","tag":"nd","value":"nd"},{"label":"Northern Sami","tag":"se","value":"se"},{"label":"Norwegian","tag":"no","value":"no"},{"label":"Norwegian Bokmål","tag":"nb","value":"nb"},{"label":"Norwegian Nynorsk","tag":"nn","value":"nn"},{"label":"Nyanja","tag":"ny","value":"ny"},{"label":"Occitan (post 1500)","tag":"oc","value":"oc"},{"label":"Ojibwa","tag":"oj","value":"oj"},{"label":"Oriya (macrolanguage)","tag":"or","value":"or"},{"label":"Oromo","tag":"om","value":"om"},{"label":"Ossetian","tag":"os","value":"os"},{"label":"Pali","tag":"pi","value":"pi"},{"label":"Panjabi","tag":"pa","value":"pa"},{"label":"Persian","tag":"fa","value":"fa"},{"label":"Polish","tag":"pl","value":"pl"},{"label":"Portuguese (Portugal)","tag":"pt","value":"pt"},{"label":"Pushto","tag":"ps","value":"ps"},{"label":"Quechua","tag":"qu","value":"qu"},{"label":"Romanian","tag":"ro","value":"ro"},{"label":"Romansh","tag":"rm","value":"rm"},{"label":"Rundi","tag":"rn","value":"rn"},{"label":"Russian","tag":"ru","value":"ru"},{"label":"Samoan","tag":"sm","value":"sm"},{"label":"Sango","tag":"sg","value":"sg"},{"label":"Sanskrit","tag":"sa","value":"sa"},{"label":"Sardinian","tag":"sc","value":"sc"},{"label":"Scottish Gaelic","tag":"gd","value":"gd"},{"label":"Serbian","tag":"sr","value":"sr"},{"label":"Serbo-Croatian","tag":"sh","value":"sh"},{"label":"Shona","tag":"sn","value":"sn"},{"label":"Sichuan Yi","tag":"ii","value":"ii"},{"label":"Sindhi","tag":"sd","value":"sd"},{"label":"Sinhala","tag":"si","value":"si"},{"label":"Slovak","tag":"sk","value":"sk"},{"label":"Slovenian","tag":"sl","value":"sl"},{"label":"Somali","tag":"so","value":"so"},{"label":"South Ndebele","tag":"nr","value":"nr"},{"label":"Southern Sotho","tag":"st","value":"st"},{"label":"Spanish (Spain)","tag":"es","value":"es"},{"label":"Sundanese","tag":"su","value":"su"},{"label":"Swahili (macrolanguage)","tag":"sw","value":"sw"},{"label":"Swati","tag":"ss","value":"ss"},{"label":"Swedish","tag":"sv","value":"sv"},{"label":"Tagalog","tag":"tl","value":"tl"},{"label":"Tahitian","tag":"ty","value":"ty"},{"label":"Tajik","tag":"tg","value":"tg"},{"label":"Tamil","tag":"ta","value":"ta"},{"label":"Tatar","tag":"tt","value":"tt"},{"label":"Telugu","tag":"te","value":"te"},{"label":"Thai","tag":"th","value":"th"},{"label":"Tibetan","tag":"bo","value":"bo"},{"label":"Tigrinya","tag":"ti","value":"ti"},{"label":"Tonga (Tonga Islands)","tag":"to","value":"to"},{"label":"Tsonga","tag":"ts","value":"ts"},{"label":"Tswana","tag":"tn","value":"tn"},{"label":"Turkish","tag":"tr","value":"tr"},{"label":"Turkmen","tag":"tk","value":"tk"},{"label":"Twi","tag":"tw","value":"tw"},{"label":"Uighur","tag":"ug","value":"ug"},{"label":"Ukrainian","tag":"uk","value":"uk"},{"label":"Urdu","tag":"ur","value":"ur"},{"label":"Uzbek","tag":"uz","value":"uz"},{"label":"Venda","tag":"ve","value":"ve"},{"label":"Vietnamese","tag":"vi","value":"vi"},{"label":"Volapük","tag":"vo","value":"vo"},{"label":"Walloon","tag":"wa","value":"wa"},{"label":"Welsh","tag":"cy","value":"cy"},{"label":"Western Frisian","tag":"fy","value":"fy"},{"label":"Wolof","tag":"wo","value":"wo"},{"label":"Xhosa","tag":"xh","value":"xh"},{"label":"Yiddish","tag":"yi","value":"yi"},{"label":"Yoruba","tag":"yo","value":"yo"},{"label":"Zhuang","tag":"za","value":"za"},{"label":"Zulu","tag":"zu","value":"zu"}],"show_optional_label":false,"type":"languages_list"},"rules":[{"config_source":"is_coworker","type":"visible_if","value":true}],"tab":"Prompt","tool_mode":"hidden"},"default_language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Default Language","description":"ISO 639-1 code of the language used when the visitor's locale matches none.","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"default_language","needs_confirmation":false,"show_optional_label":false,"type":"config_dynamic_text"},"tab":"Configuration","tool_mode":"hidden","visible":false},"persona":{"anyOf":[{"items":{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},"type":"array"},{"type":"null"}],"title":"Persona","description":"Describe who the co-worker is: their background, role, or point of view.","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Agent persona defining the AI's character, background, role, and point of view","heuristic_types":["clarity","specificity","roleplaying"],"improver_context":"This is an AGENT PERSONA definition — a description of who the AI agent is. The output must read as a natural character description, NOT a structured task prompt. Do NOT include output format specs, JSON schemas, edge case sections, or task-type templates. Focus on: identity, background, personality traits, expertise, and point of view. Keep it concise (2-4 short paragraphs max). Write in second person ('You are...'). Be specific about the character but avoid copying any real or copyrighted personas.","improver_prompt":"PromptImproverPromptV2","is_disabled":false,"is_subconfig":false,"label":"Persona","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Prompt","tool_mode":"hidden"},"tone":{"anyOf":[{"items":{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},"type":"array"},{"type":"null"}],"title":"Tone","description":"Define how the co-worker should communicate: its voice, attitude, and style.","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Agent tone and communication style defining voice, attitude, and writing style","heuristic_types":["clarity","specificity","roleplaying"],"improver_context":"This is an AGENT TONE & STYLE definition — how the AI agent should communicate. The output must be a concise set of voice and style guidelines, NOT a structured task prompt. Do NOT include output format specs, JSON schemas, edge case sections, or task-type templates. Focus on: communication style, vocabulary level, formality, pacing, and attitude. Keep it concise (a short list of guidelines or 1-2 paragraphs max). Use direct instructions ('Use short sentences', 'Be encouraging', etc.).","improver_prompt":"PromptImproverPromptV2","is_disabled":false,"is_subconfig":false,"label":"Tone & style","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Prompt","tool_mode":"hidden"},"extra_instructions":{"anyOf":[{"items":{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},"type":"array"},{"type":"null"}],"title":"Extra Instructions","description":"Provide specific rules, goals, or context to guide the co-worker's behavior.","display":{"allow_reference_mentions":false,"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_context":"This is an AGENT BEHAVIOR INSTRUCTIONS field — specific rules and guidelines for the agent. The output must be a concise set of behavioral rules, NOT a generic task prompt template. Do NOT include output format specs, JSON schemas, edge case sections, or task-type templates. Focus on: do/don't rules, goals, boundaries, and operational guidelines. Keep it concise and actionable. Use bullet points or numbered rules.","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-Input"},{"$ref":"#/components/schemas/NoxusQaSettings-Input"},{"$ref":"#/components/schemas/KnowledgeBaseSelectorSettings-Input"},{"$ref":"#/components/schemas/KnowledgeBaseQaSettings-Input"},{"$ref":"#/components/schemas/WorkflowSettings-Input"},{"$ref":"#/components/schemas/AttachFileSettings"},{"$ref":"#/components/schemas/HumanInTheLoopSettings-Input"},{"$ref":"#/components/schemas/AgentToolSettings-Input"},{"$ref":"#/components/schemas/MemorySettings-Input"},{"$ref":"#/components/schemas/ActionToolSettings-Input"},{"$ref":"#/components/schemas/ExcelSettings-Input"},{"$ref":"#/components/schemas/DocxSettings-Input"},{"$ref":"#/components/schemas/FileSystemSettings-Input"},{"$ref":"#/components/schemas/FileSettings-Input"},{"$ref":"#/components/schemas/TodoSettings-Input"},{"$ref":"#/components/schemas/SandboxSettings-Input"},{"$ref":"#/components/schemas/ScheduleToolSettings-Input"},{"$ref":"#/components/schemas/SubAgentSettings-Input"},{"$ref":"#/components/schemas/CodeExecutionSettings-Input"},{"$ref":"#/components/schemas/AgentMemorySettings-Input"},{"$ref":"#/components/schemas/CreateFilesSettings-Input"},{"$ref":"#/components/schemas/DocumentationSettings-Input"},{"$ref":"#/components/schemas/ImageGenerationSettings-Input"},{"$ref":"#/components/schemas/FailureProbeSettings-Input"},{"$ref":"#/components/schemas/CodeModeSettings-Input"},{"$ref":"#/components/schemas/OverflowSettings-Input"},{"$ref":"#/components/schemas/GuardrailsSettings-Input"}],"discriminator":{"propertyName":"type","mapping":{"action":"#/components/schemas/ActionToolSettings-Input","agent_memory":"#/components/schemas/AgentMemorySettings-Input","agent_tool":"#/components/schemas/AgentToolSettings-Input","attach_file":"#/components/schemas/AttachFileSettings","code_execution":"#/components/schemas/CodeExecutionSettings-Input","code_mode":"#/components/schemas/CodeModeSettings-Input","create_files":"#/components/schemas/CreateFilesSettings-Input","documentation":"#/components/schemas/DocumentationSettings-Input","docx":"#/components/schemas/DocxSettings-Input","excel":"#/components/schemas/ExcelSettings-Input","failure_probe":"#/components/schemas/FailureProbeSettings-Input","files":"#/components/schemas/FileSettings-Input","filesystem":"#/components/schemas/FileSystemSettings-Input","guardrails":"#/components/schemas/GuardrailsSettings-Input","human_in_the_loop":"#/components/schemas/HumanInTheLoopSettings-Input","image_generation":"#/components/schemas/ImageGenerationSettings-Input","kb_qa":"#/components/schemas/KnowledgeBaseQaSettings-Input","kb_selector":"#/components/schemas/KnowledgeBaseSelectorSettings-Input","memory":"#/components/schemas/MemorySettings-Input","noxus_qa":"#/components/schemas/NoxusQaSettings-Input","overflow":"#/components/schemas/OverflowSettings-Input","sandbox":"#/components/schemas/SandboxSettings-Input","schedule_tool":"#/components/schemas/ScheduleToolSettings-Input","subagent":"#/components/schemas/SubAgentSettings-Input","todos":"#/components/schemas/TodoSettings-Input","web_research":"#/components/schemas/WebResearchSettings-Input","workflow":"#/components/schemas/WorkflowSettings-Input"}}},"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},"workflows_parallel_enabled":{"type":"boolean","title":"Workflows Parallel Enabled","description":"Let the agent start flows without blocking on them, then poll for the result. Off keeps every flow call blocking.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Parallel flow execution","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"order":15,"tab":"Actions","tool_mode":"hidden"},"mcp_servers":{"items":{"$ref":"#/components/schemas/MCPServerBinding"},"type":"array","title":"Mcp Servers","description":"Workspace MCP credentials this agent can call tools on.","default":[],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"MCP","needs_confirmation":false,"show_optional_label":false,"type":"mcp_credential_select"},"order":50,"tab":"Actions","tool_mode":"hidden"},"convert_unsupported_files_to_text":{"type":"boolean","title":"Convert Unsupported Files To Text","description":"When an attached file's type can't be sent to the model as a native attachment (e.g. JSON, CSV, XML, Markdown), inline its text content into the prompt instead of failing the run. PDFs and images are always sent as attachments.","default":true,"accordion":"Advanced","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Convert unsupported files to text","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Prompt","tool_mode":"hidden"},"skills":{"items":{"$ref":"#/components/schemas/SkillConfig"},"type":"array","title":"Skills","default":[],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Skills","needs_confirmation":false,"show_optional_label":false,"type":"skills_list"},"tab":"Knowledge","tool_mode":"hidden"},"subagents_enabled":{"type":"boolean","title":"Subagents Enabled","description":"Let the agent hand self-contained tasks to a built-in general-purpose subagent, which runs in its own fresh context on the Cost-Effective Models preset. Off keeps every task in the agent's own context.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Subagents","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"feature_flag":"AGENT_SUBAGENTS_ENABLED","order":60,"tab":"Actions","tool_mode":"hidden"},"subagents":{"items":{"$ref":"#/components/schemas/SubAgentDefinition"},"type":"array","title":"Subagents","default":[],"tab":"Configuration","tool_mode":"hidden","visible":false},"guidelines_enabled":{"type":"boolean","title":"Guidelines Enabled","description":"Enable behavioral guidelines that shape how the agent responds.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enable Guidelines","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"feature_flag":"AGENT_GUIDELINES_ENABLED","tab":"Prompt","tool_mode":"hidden","visible":false},"guidelines":{"items":{"$ref":"#/components/schemas/GuidelineConfig"},"type":"array","title":"Guidelines","default":[],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Guidelines","needs_confirmation":false,"show_optional_label":false,"type":"guidelines_list"},"feature_flag":"AGENT_GUIDELINES_ENABLED","tab":"Prompt","tool_mode":"hidden"},"glossary":{"items":{"$ref":"#/components/schemas/GlossaryTermConfig"},"type":"array","title":"Glossary","default":[],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Glossary","needs_confirmation":false,"show_optional_label":false,"type":"glossary_list"},"feature_flag":"AGENT_GUIDELINES_ENABLED","tab":"Prompt","tool_mode":"hidden"},"memories":{"items":{"$ref":"#/components/schemas/AgentMemoryEntry"},"type":"array","title":"Memories","description":"Persistent memory across all conversations","default":[],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Agent Memory","needs_confirmation":false,"show_optional_label":false,"type":"agent_memory_field"},"feature_flag":"AGENT_MEMORY_ENABLED","tab":"Knowledge","tool_mode":"hidden"},"hidden_tools":{"items":{"type":"string"},"type":"array","title":"Hidden Tools","description":"Tool calls that never appear in the chat activity feed.","default":["todos_read_todos","todos_add_todo","todos_write_todos","todos_update_todo_status","todos_remove_todo"],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Hidden tools","needs_confirmation":false,"show_optional_label":false,"tooltip":"Toggled-on tools never appear in the chat activity feed.","type":"tool_select"},"tab":"Display","tool_mode":"hidden","visible":false},"deployment_custom_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deployment Custom Instructions","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"deployment_custom_instructions","needs_confirmation":false,"show_optional_label":false,"type":"config_dynamic_text"},"tab":"Configuration","tool_mode":"hidden","visible":false},"variables_enabled":{"type":"boolean","title":"Variables Enabled","description":"Create external values that can be mapped to flow inputs. The agent receives these external values through its widget deployment.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"External values","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"feature_flag":"AGENT_VARIABLES_ENABLED","order":16,"tab":"Actions","tool_mode":"hidden"},"variables":{"items":{"$ref":"#/components/schemas/VariableDefinition"},"type":"array","title":"Variables","default":[],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"External values list","needs_confirmation":false,"show_optional_label":false,"type":"variables_field"},"feature_flag":"AGENT_VARIABLES_ENABLED","order":17,"rules":[{"config_source":"variables_enabled","type":"visible_if","value":true}],"tab":"Actions","tool_mode":"hidden"},"workflows":{"items":{"$ref":"#/components/schemas/WorkflowSettings-Input"},"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"},"order":10,"tab":"Actions","tool_mode":"hidden"},"knowledge_bases":{"items":{"$ref":"#/components/schemas/KnowledgeBaseQaSettings-Input"},"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":"Knowledge","tool_mode":"hidden"},"multi_kb_search":{"type":"boolean","title":"Multi Kb Search","description":"Let one search cover several knowledge bases at once, merging their results. Off means every search targets a single one.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Search knowledge bases together","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Knowledge","tool_mode":"hidden"},"citation_instructions_enabled":{"type":"boolean","title":"Citation Instructions Enabled","description":"Write your own rules for what the co-worker cites from its knowledge bases. Off keeps the built-in citation behaviour.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Custom knowledge base citation instructions","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Knowledge","tool_mode":"hidden"},"citation_instructions":{"anyOf":[{"items":{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},"type":"array"},{"type":"null"}],"title":"Citation Instructions","description":"Tell the co-worker what to cite from its knowledge bases, when a claim needs a source, and how much to quote. The reference tag format itself is fixed and always applies.","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Agent citation policy defining what to cite from knowledge bases, when a claim needs a source, and how much to quote","heuristic_types":["clarity","specificity","actionability"],"improver_context":"This is an AGENT CITATION POLICY field — when and what the agent should cite from its knowledge bases. The output must be a concise set of citation rules, NOT a generic task prompt template. Do NOT include output format specs, JSON schemas, edge case sections, or task-type templates. Do NOT invent or alter any citation tag syntax — the reference tag format is fixed by the platform and is not part of this field. Focus on: what is worth citing, when a claim needs a source, quoting versus paraphrasing, how much to quote, citation density, and when not to cite. Keep it concise and actionable. Use bullet points.","improver_prompt":"PromptImproverPromptV2","is_disabled":false,"is_subconfig":false,"label":"Knowledge base citation instructions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"rules":[{"config_source":"citation_instructions_enabled","type":"visible_if","value":true}],"tab":"Knowledge","tool_mode":"hidden"},"agent_files":{"items":{"$ref":"#/components/schemas/AgentFileConfig-Input"},"type":"array","title":"Agent Files","description":"Files pre-loaded into every chat. Each is added to the session (readable via the file tools) with its context shown to the agent.","default":[],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Files","needs_confirmation":false,"show_optional_label":false,"type":"files_field"},"order":10,"tab":"Knowledge","tool_mode":"hidden"},"databases":{"items":{"$ref":"#/components/schemas/AgentDatabaseConfig-Input"},"type":"array","title":"Databases","description":"SQL databases the agent can query read-only. Each references a database credential; access is deferred, so the agent connects only when a query is needed.","default":[],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Databases","needs_confirmation":false,"show_optional_label":false,"type":"databases_field"},"order":20,"tab":"Knowledge","tool_mode":"hidden"},"tables":{"items":{"$ref":"#/components/schemas/AgentTableConfig-Input"},"type":"array","title":"Tables","description":"The workspace tables this agent can use. Add context for each so the agent knows what it holds and when to use it.","default":[],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Tables","needs_confirmation":false,"show_optional_label":false,"type":"tables_field"},"order":21,"tab":"Knowledge","tool_mode":"hidden"},"coworkers":{"items":{"$ref":"#/components/schemas/AgentToolSettings-Input"},"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"},"order":20,"tab":"Actions","tool_mode":"hidden"},"base_tools":{"items":{"oneOf":[{"$ref":"#/components/schemas/WebResearchSettings-Input"},{"$ref":"#/components/schemas/HumanInTheLoopSettings-Input"},{"$ref":"#/components/schemas/MemorySettings-Input"},{"$ref":"#/components/schemas/AttachFileSettings"},{"$ref":"#/components/schemas/FileSystemSettings-Input"},{"$ref":"#/components/schemas/FileSettings-Input"},{"$ref":"#/components/schemas/CodeExecutionSettings-Input"},{"$ref":"#/components/schemas/ExcelSettings-Input"},{"$ref":"#/components/schemas/DocxSettings-Input"},{"$ref":"#/components/schemas/NoxusQaSettings-Input"},{"$ref":"#/components/schemas/KnowledgeBaseSelectorSettings-Input"},{"$ref":"#/components/schemas/TodoSettings-Input"},{"$ref":"#/components/schemas/SandboxSettings-Input"},{"$ref":"#/components/schemas/ScheduleToolSettings-Input"},{"$ref":"#/components/schemas/SubAgentSettings-Input"},{"$ref":"#/components/schemas/AgentMemorySettings-Input"},{"$ref":"#/components/schemas/CreateFilesSettings-Input"},{"$ref":"#/components/schemas/DocumentationSettings-Input"},{"$ref":"#/components/schemas/ImageGenerationSettings-Input"},{"$ref":"#/components/schemas/FailureProbeSettings-Input"},{"$ref":"#/components/schemas/CodeModeSettings-Input"},{"$ref":"#/components/schemas/OverflowSettings-Input"},{"$ref":"#/components/schemas/GuardrailsSettings-Input"}],"discriminator":{"propertyName":"type","mapping":{"agent_memory":"#/components/schemas/AgentMemorySettings-Input","attach_file":"#/components/schemas/AttachFileSettings","code_execution":"#/components/schemas/CodeExecutionSettings-Input","code_mode":"#/components/schemas/CodeModeSettings-Input","create_files":"#/components/schemas/CreateFilesSettings-Input","documentation":"#/components/schemas/DocumentationSettings-Input","docx":"#/components/schemas/DocxSettings-Input","excel":"#/components/schemas/ExcelSettings-Input","failure_probe":"#/components/schemas/FailureProbeSettings-Input","files":"#/components/schemas/FileSettings-Input","filesystem":"#/components/schemas/FileSystemSettings-Input","guardrails":"#/components/schemas/GuardrailsSettings-Input","human_in_the_loop":"#/components/schemas/HumanInTheLoopSettings-Input","image_generation":"#/components/schemas/ImageGenerationSettings-Input","kb_selector":"#/components/schemas/KnowledgeBaseSelectorSettings-Input","memory":"#/components/schemas/MemorySettings-Input","noxus_qa":"#/components/schemas/NoxusQaSettings-Input","overflow":"#/components/schemas/OverflowSettings-Input","sandbox":"#/components/schemas/SandboxSettings-Input","schedule_tool":"#/components/schemas/ScheduleToolSettings-Input","subagent":"#/components/schemas/SubAgentSettings-Input","todos":"#/components/schemas/TodoSettings-Input","web_research":"#/components/schemas/WebResearchSettings-Input"}}},"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","requires_approval":false,"visible":true,"icon":"PersonStanding","bg_color":"blue.50","icon_color":"blue.500","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","requires_approval":false,"visible":true,"icon":"Globe","bg_color":"#D1FADF","icon_color":"#027A48","deprecated":false,"type":"web_research"},{"title":"Files","description":"Attach, generate, and work with files.","category":"QuickAction","enabled":false,"tool_display_icon":"Files","tool_display_message_start":"Working with files...","tool_display_message_end":"Done","requires_approval":false,"visible":true,"icon":"Files","bg_color":"#EFF6FF","icon_color":"#2B7FFF","deprecated":false,"type":"files","allow_html_graphs":true,"show_inline":true,"custom_author_name":false,"author_name":"","enable_python_sandbox":false,"enable_formula_eval":false,"experimental":false},{"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","requires_approval":false,"visible":true,"icon":"Brain","bg_color":"#f5f3ff","icon_color":"#8e51ff","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","requires_approval":false,"visible":false,"icon":"FolderOpen","bg_color":"#fef3c7","icon_color":"#f59e0b","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","requires_approval":false,"visible":true,"icon":"Terminal","bg_color":"#fef9c3","icon_color":"#ca8a04","deprecated":false,"type":"code_execution","timeout":60},{"title":"Agent Memory","description":"Persistent memory across all conversations","category":"QuickAction","enabled":false,"tool_display_icon":"BookOpen","tool_display_message_start":"Accessing agent memory...","tool_display_message_end":"Memory operation complete","requires_approval":false,"visible":false,"icon":"BookOpen","bg_color":"#fef3c7","icon_color":"#d97706","deprecated":false,"type":"agent_memory"},{"title":"Documentation","description":"Search and read Noxus platform documentation","category":"QuickAction","enabled":false,"tool_display_icon":"BookOpen","tool_display_message_start":"Searching documentation...","tool_display_message_end":"Documentation found","requires_approval":false,"visible":true,"icon":"BookOpen","bg_color":"#EFF6FF","icon_color":"#2B7FFF","deprecated":false,"type":"documentation"},{"title":"Task Tracking","description":"Track and manage tasks during the conversation","category":"QuickAction","enabled":false,"tool_display_icon":"ListTodo","tool_display_message_start":"Managing tasks...","tool_display_message_end":"Tasks updated","requires_approval":false,"visible":true,"icon":"ListTodo","bg_color":"#f0fdf4","icon_color":"#16a34a","deprecated":false,"type":"todos","enable_subtasks":false},{"title":"Image Generation","description":"Generate images from text prompts, shown inline in the chat.","category":"QuickAction","enabled":false,"tool_display_icon":"ImagePlus","tool_display_message_start":"Generating image...","tool_display_message_end":"Image generated","requires_approval":false,"visible":true,"icon":"ImagePlus","bg_color":"#FDF4FF","icon_color":"#C026D3","deprecated":false,"type":"image_generation"}],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Tools","needs_confirmation":false,"show_optional_label":false,"type":"base_tools_field"},"order":80,"tab":"Actions","tool_mode":"hidden"},"actions":{"items":{"$ref":"#/components/schemas/ActionToolSettings-Input"},"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"},"feature_flag":"COWORKER_ACTION_TOOLS_ENABLED","order":40,"tab":"Actions","tool_mode":"hidden"},"insights_enabled":{"type":"boolean","title":"Insights Enabled","description":"Enable conversation analysis and insights dashboard.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enable Insights","needs_confirmation":false,"show_optional_label":false,"toggle_position":"left","type":"toggle"},"feature_flag":"AGENT_INSIGHTS_ENABLED","tab":"Insights","tool_mode":"hidden"},"insights_csat_enabled":{"type":"boolean","title":"Insights Csat Enabled","description":"Collect customer satisfaction (CSAT) ratings at end of conversations.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enable CSAT","needs_confirmation":false,"show_optional_label":false,"toggle_position":"left","type":"toggle"},"feature_flag":"AGENT_INSIGHTS_ENABLED","rules":[{"config_source":"insights_enabled","type":"visible_if","value":true}],"tab":"Insights","tool_mode":"hidden"},"insights_csat_sampling_rate":{"type":"number","title":"Insights Csat Sampling Rate","description":"Fraction of conversations that get a CSAT prompt (1.0 = every conversation).","default":1.0,"display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"CSAT Sampling Rate","max":1.0,"min":0.0,"needs_confirmation":false,"show_optional_label":false,"step":0.05,"type":"number_slider"},"feature_flag":"AGENT_INSIGHTS_ENABLED","rules":[{"conds":[{"config_source":"insights_enabled","type":"visible_if","value":true},{"config_source":"insights_csat_enabled","type":"visible_if","value":true}],"mode":"and","type":"visible_if_group"}],"tab":"Insights","tool_mode":"hidden"},"insights_csat_agent_tool_enabled":{"type":"boolean","title":"Insights Csat Agent Tool Enabled","description":"Let the agent decide when to show the CSAT form via a tool call.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Agent Feedback Tool","needs_confirmation":false,"show_optional_label":false,"toggle_position":"left","type":"toggle"},"feature_flag":"AGENT_INSIGHTS_ENABLED","rules":[{"conds":[{"config_source":"insights_enabled","type":"visible_if","value":true},{"config_source":"insights_csat_enabled","type":"visible_if","value":true}],"mode":"and","type":"visible_if_group"}],"tab":"Insights","tool_mode":"hidden"},"insights_csat_agent_tool_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"string"}],"title":"Insights Csat Agent Tool Instructions","description":"Custom instructions for when the agent should request customer feedback.","default":"","display":{"col_span":12,"hide_toolbar":false,"is_disabled":false,"is_subconfig":false,"label":"Feedback Tool Instructions","needs_confirmation":false,"number_of_lines":5,"placeholder":"e.g. Ask for feedback once the customer confirms their issue is solved. Never ask during troubleshooting.","show_optional_label":false,"type":"big_text"},"feature_flag":"AGENT_INSIGHTS_ENABLED","rules":[{"conds":[{"config_source":"insights_enabled","type":"visible_if","value":true},{"config_source":"insights_csat_enabled","type":"visible_if","value":true},{"config_source":"insights_csat_agent_tool_enabled","type":"visible_if","value":true}],"mode":"and","type":"visible_if_group"}],"tab":"Insights","tool_mode":"hidden"},"insights_csat_auto_enabled":{"type":"boolean","title":"Insights Csat Auto Enabled","description":"Automatically show the CSAT form at the end of an agent turn (rule-based, no tool call). Independent of the agent feedback tool.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Automatic Feedback Request","needs_confirmation":false,"show_optional_label":false,"toggle_position":"left","type":"toggle"},"feature_flag":"AGENT_INSIGHTS_ENABLED","rules":[{"conds":[{"config_source":"insights_enabled","type":"visible_if","value":true},{"config_source":"insights_csat_enabled","type":"visible_if","value":true}],"mode":"and","type":"visible_if_group"}],"tab":"Insights","tool_mode":"hidden"},"insights_csat_auto_min_messages":{"type":"integer","title":"Insights Csat Auto Min Messages","description":"Only auto-request feedback once the user has sent at least this many messages.","default":2,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Minimum user messages before auto request","needs_confirmation":false,"show_optional_label":false,"type":"number"},"feature_flag":"AGENT_INSIGHTS_ENABLED","rules":[{"conds":[{"config_source":"insights_enabled","type":"visible_if","value":true},{"config_source":"insights_csat_enabled","type":"visible_if","value":true},{"config_source":"insights_csat_auto_enabled","type":"visible_if","value":true}],"mode":"and","type":"visible_if_group"}],"tab":"Insights","tool_mode":"hidden"},"insights_custom_definitions":{"items":{"$ref":"#/components/schemas/CustomInsightDefinition"},"type":"array","title":"Insights Custom Definitions","description":"User-defined situations to detect in each conversation.","default":[],"feature_flag":"AGENT_INSIGHTS_ENABLED","tab":"Insights","tool_mode":"hidden","visible":false},"tool_grant_scope":{"type":"string","enum":["workspace","user"],"title":"Tool Grant Scope","description":"Whether 'Always Allow' tool grants apply to all workspace users or only the granting user","default":"workspace","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"Tool Grant Scope","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"label":"Workspace","value":"workspace"},{"label":"Per User","value":"user"}]},"feature_flag":"AGENT_TOOL_APPROVALS_ENABLED","order":70,"tab":"Actions","tool_mode":"hidden"}},"type":"object","title":"CoWorkerSettings"},"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,"select_all":false,"show_optional_label":false,"type":"multi_select","values":[{"label":"Person","value":"PERSON"},{"label":"Email Address","value":"EMAIL_ADDRESS"},{"label":"Phone Number","value":"PHONE_NUMBER"},{"label":"Credit Card","value":"CREDIT_CARD"},{"label":"Cryptocurrency","value":"CRYPTO"},{"label":"IP Address","value":"IP_ADDRESS"},{"label":"Date Time","value":"DATE_TIME"},{"label":"NRP","value":"NRP"},{"label":"Location","value":"LOCATION"},{"label":"Medical License","value":"MEDICAL_LICENSE"},{"label":"URL","value":"URL"},{"label":"IBAN Code","value":"IBAN_CODE"}]},"rules":[{"config_source":"pii_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden","visible":false},"divider1":{"type":"string","title":"Divider1","default":"","accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_line":true,"show_optional_label":false,"spacing":0,"type":"divider"},"tab":"Model","tool_mode":"hidden","visible":false},"guardrail_info":{"type":"string","title":"Guardrail Info","description":"Information about the guardrails","default":"","accordion":"Safety","display":{"col_span":10,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"small_text":"Set the strictness level of guardrails to ensure the AI model's behavior and responses remain safe and appropriate, from 'Off' (no protection) to 'High' (maximum protection).","title":"Guardrails","type":"ui_text_display"},"tab":"Model","tool_mode":"hidden"},"guardrail_lock":{"type":"boolean","title":"Guardrail Lock","description":"Locks the guardrails settings.","default":false,"accordion":"Safety","display":{"col_align":"start","col_justify":"end","col_span":2,"icon":"Unlock","is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"toggledIcon":"Lock","tooltip":"Lock guardrails settings so they cannot be changed","type":"toggle_button"},"tab":"Model","tool_mode":"hidden","visible":false},"guardrail_latency_banner":{"type":"string","title":"Guardrail Latency Banner","description":"","default":"","accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Each enabled guardrail makes its own LLM call before the model can reply. Expect noticeably slower responses while any of these are on.","needs_confirmation":false,"show_optional_label":false,"style":"warning","title":"Guardrails add response latency","type":"banner"},"rules":[{"conds":[{"config_source":"violence_and_hate","type":"visible_if_not","value":"Off"},{"config_source":"sexual_content","type":"visible_if_not","value":"Off"},{"config_source":"guns_and_weapons","type":"visible_if_not","value":"Off"},{"config_source":"suicide","type":"visible_if_not","value":"Off"},{"config_source":"crime","type":"visible_if_not","value":"Off"},{"config_source":"toxicity","type":"visible_if_not","value":"Off"},{"config_source":"bias","type":"visible_if_not","value":"Off"},{"config_source":"profanity","type":"visible_if_not","value":"Off"},{"config_source":"jailbreak","type":"visible_if","value":true},{"config_source":"prompt_injection","type":"visible_if","value":true}],"mode":"or","type":"visible_if_group"}],"tab":"Model","tool_mode":"hidden"},"violence_and_hate":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a news agency. Reporting on conflict zones is expected and should not be flagged.","is_disabled":false,"is_subconfig":false,"label":"Violence and Hate","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"sexual_content":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is an airline booking system. Mentions of children traveling are normal and should not be flagged.","is_disabled":false,"is_subconfig":false,"label":"Sexual Content","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"guns_and_weapons":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a sporting goods store. Discussion of hunting equipment is expected.","is_disabled":false,"is_subconfig":false,"label":"Guns and Illegal Weapons","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"suicide":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a mental health support platform. Discussing symptoms is expected and should not be blocked.","is_disabled":false,"is_subconfig":false,"label":"Suicide and Self-Harm","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"crime":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a legal firm assistant. Discussing criminal cases and charges is part of normal operation.","is_disabled":false,"is_subconfig":false,"label":"Crime and Criminal Planning","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"toxicity":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a gaming community moderator. Competitive banter and trash talk is normal.","is_disabled":false,"is_subconfig":false,"label":"Toxicity","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"bias":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This assistant serves a diversity and inclusion team. Discussing demographic differences is expected.","is_disabled":false,"is_subconfig":false,"label":"Bias","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"profanity":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a content moderation tool. Quoting flagged content for review is expected.","is_disabled":false,"is_subconfig":false,"label":"Profanity","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"guardrails_scan_output":{"type":"boolean","title":"Guardrails Scan Output","description":"Scan the model's response with the same semantic guardrails applied to input. Catches sensitive content sourced from Knowledge Base documents or tools that the input scan cannot see.","default":false,"accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Scan responses (output guardrails)","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"guardrails_output_mode":{"type":"string","enum":["post_stream","pre_stream"],"title":"Guardrails Output Mode","description":"How output guardrails are enforced. 'post_stream' streams the response in real-time and warns/clears after the fact. 'pre_stream' buffers the full response, validates it against guardrails, and only emits it if it passes.","default":"post_stream","accordion":"Safety","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"Output guardrail mode","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"label":"Post-stream (warn after response)","value":"post_stream"},{"label":"Pre-stream (validate before showing)","value":"pre_stream"}]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true},{"config_source":"guardrails_scan_output","type":"visible_if","value":true}],"tab":"Model","tool_mode":"hidden"},"divider2":{"type":"string","title":"Divider2","default":"","accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_line":true,"show_optional_label":false,"spacing":0,"type":"divider"},"tab":"Model","tool_mode":"hidden"},"guardrail_action":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"string"}],"title":"Guardrail Action","description":"Choose the action to take when a guardrail is triggered.","default":{"value":"fail","label":"Fail/block run"},"accordion":"Safety","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"Guardrail action","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"label":"Fail/block run","value":"fail"},{"label":"Flag with warning but proceed","value":"flag"}]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden","visible":false},"guardrail_action_replace":{"type":"string","title":"Guardrail Action Replace","default":"","accordion":"Safety","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Replace with","needs_confirmation":false,"number_of_lines":1,"placeholder":"E.g. <REDACTED>","show_optional_label":false,"show_refresh":false,"type":"text"},"rules":[{"config_source":"guardrail_action","type":"visible_if","value":"replace"},{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden","visible":false},"guardrail_action_human":{"type":"string","title":"Guardrail Action Human","default":"","accordion":"Safety","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":true,"label":"Human task template","needs_confirmation":false,"number_of_lines":1,"placeholder":"E.g. <REDACTED>","show_optional_label":false,"show_refresh":false,"type":"text"},"rules":[{"config_source":"guardrail_action","type":"visible_if","value":"human"},{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden","visible":false},"block_after_violations":{"type":"integer","title":"Block After Violations","description":"Block the chat after this many turns with guardrail violations. Set to 0 to never block (per-turn warnings still surface).","default":0,"accordion":"Safety","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Block chat after N violations","max":20,"min":0,"needs_confirmation":false,"show_optional_label":false,"step":1,"tooltip":"Once a conversation accumulates this many turns with any guardrail violation (flag or fail mode), the chat input locks. Set to 0 to disable.","type":"number_slider"},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"block_message":{"type":"string","title":"Block Message","description":"Message shown to the user when the chat is locked.","default":"This conversation has been locked due to repeated safety violations. Please start a new conversation.","accordion":"Safety","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":true,"label":"Block message","needs_confirmation":false,"number_of_lines":1,"placeholder":"This conversation has been locked due to repeated safety violations.","show_optional_label":false,"show_refresh":false,"type":"text"},"rules":[{"config_source":"block_after_violations","type":"visible_if_not","value":0},{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"divider3":{"type":"string","title":"Divider3","default":"","accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_line":true,"show_optional_label":false,"spacing":0,"type":"divider"},"tab":"Model","tool_mode":"hidden","visible":false},"prompt_defense":{"type":"string","title":"Prompt Defense","default":"","accordion":"Safety","display":{"col_span":10,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"small_text":"Configurations to ensure the model behaves as expected and is protected against attacks, like jailbreak or prompt injection.","title":"Prompt Defense","type":"ui_text_display"},"tab":"Model","tool_mode":"hidden"},"prompt_lock":{"type":"boolean","title":"Prompt Lock","description":"Locks the prompt defense settings","default":false,"accordion":"Safety","display":{"col_align":"start","col_justify":"end","col_span":2,"icon":"Unlock","is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"toggledIcon":"Lock","tooltip":"Lock prompt settings so they cannot be changed","type":"toggle_button"},"tab":"Model","tool_mode":"hidden","visible":false},"jailbreak":{"type":"boolean","title":"Jailbreak","description":"Prevents attempts to manipulate or \"jailbreak\" the model into ignoring safety rules or system instructions (e.g., prompts like \"ignore previous instructions\").","default":false,"accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Jailbreak","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"prompt_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"prompt_injection":{"type":"boolean","title":"Prompt Injection","description":"Detects and blocks strategies where users attempt to get around restrictions indirectly (e.g., asking the model to 'pretend' or speak as a fictional character to evade policies).","default":false,"accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Prompt Injection","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"prompt_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"context_leak":{"type":"boolean","title":"Context Leak","description":"Prevents the model from unintentionally revealing internal context, instructions, or system messages that are not meant to be shared with the user.","default":false,"accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Context Leak","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"prompt_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden","visible":false},"auto_model_pick":{"type":"boolean","title":"Auto Model Pick","description":"AI selects the optimal model for performance, cost savings or length","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Smart model selection","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Model","tool_mode":"hidden","visible":false},"auto_model_preference":{"type":"string","title":"Auto Model Preference","default":"cost","display":{"can_wrap":true,"col_span":12,"endpoint":"/models/llms","is_disabled":false,"is_multi":false,"is_subconfig":true,"needs_confirmation":false,"show_optional_label":false,"type":"select_chips","values":[{"custom_fields":{"icon":"gauge"},"label":"Performance","value":"performance"},{"custom_fields":{"icon":"dollar"},"label":"Cost","value":"cost"},{"custom_fields":{"icon":"text"},"label":"Length","value":"length"}]},"optional":true,"tab":"Model","tool_mode":"hidden","visible":false},"model":{"items":{"type":"string"},"type":"array","title":"Model","description":"Model configuration","default":["preset:cost"],"display":{"col_span":12,"default_preset":"cost","endpoint":"/models/llms","hide_disabled_models":true,"is_disabled":false,"is_subconfig":true,"label":"Choose from our recommended models","layout":"side_by_side","model_type":"text","needs_confirmation":false,"show_inline_presets":true,"show_optional_label":false,"show_presets":false,"type":"model_select"},"optional":true,"tab":"Model","tool_mode":"hidden"},"parameter_preset":{"type":"string","enum":["default","creative","precise","custom"],"title":"Parameter Preset","description":"Controls randomness, diversity, and repetition of the model's output.","default":"default","accordion":"Model Parameters","display":{"button_size":"sm","button_variant":"outline","col_span":12,"is_disabled":false,"is_horizontal":true,"is_subconfig":false,"label":"Model parameters preset","needs_confirmation":false,"show_optional_label":false,"type":"menu_select","values":[{"description":"Provider-recommended settings for general use","icon":"settings2","label":"Default","value":"default"},{"description":"Higher randomness for diverse, imaginative outputs","icon":"sparkles","label":"Creative","value":"creative"},{"description":"Deterministic and focused for factual tasks","icon":"target","label":"Precise","value":"precise"},{"description":"Fine-tune each parameter manually","icon":"sliders-horizontal","label":"Custom","value":"custom"}]},"rules":[{"target_fields":["temperature","top_p","top_k","presence_penalty","frequency_penalty"],"type":"sets_field_values","value_map":{"creative":{"frequency_penalty":0.3,"presence_penalty":0.3,"temperature":0.7,"top_k":40,"top_p":0.95},"custom":{},"default":{},"precise":{"frequency_penalty":0.0,"presence_penalty":0.0,"temperature":0.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_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Max tokens","max":384000,"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_input":false,"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.0,"accordion":"Model Parameters","display":{"col_span":12,"hide_input":false,"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_input":false,"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.0,"accordion":"Model Parameters","display":{"col_span":12,"hide_input":false,"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_input":false,"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_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Frequency penalty","max":2,"min":-2,"needs_confirmation":false,"show_optional_label":false,"step":0.1,"type":"number_slider"},"rules":[{"config_source":"parameter_preset","type":"visible_if","value":"custom"}],"tab":"Model","tool_mode":"hidden"},"stop_sequences":{"items":{"type":"string"},"type":"array","title":"Stop Sequences","description":"The model will stop generating text when it encounters any of these stop sequences","default":[],"accordion":"Model Parameters","display":{"chips_are_closable":false,"col_span":12,"hide_toolbar":false,"is_disabled":false,"is_subconfig":false,"label":"Stop sequences","needs_confirmation":false,"show_optional_label":false,"type":"chips_list_text"},"rules":[{"config_source":"parameter_preset","type":"visible_if","value":"custom"}],"tab":"Model","tool_mode":"hidden"},"divider_8":{"type":"string","title":"Divider 8","default":"","accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_line":true,"show_optional_label":false,"spacing":0,"type":"divider"},"rules":[{"config_source":"parameter_preset","type":"visible_if","value":"custom"}],"tab":"Model","tool_mode":"hidden"},"reasoning_section":{"type":"string","title":"Reasoning Section","default":"","accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"text":"Configure the model's reasoning capabilities and computational effort level.","title":"Model reasoning","type":"ui_text_display"},"rules":[{"config_source":"parameter_preset","type":"visible_if","value":"custom"}],"tab":"Model","tool_mode":"hidden"},"enable_reasoning":{"type":"boolean","title":"Enable Reasoning","description":"Whether to enable reasoning","default":true,"accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enable reasoning","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"parameter_preset","type":"visible_if","value":"custom"}],"tab":"Model","tool_mode":"hidden"},"reasoning_effort":{"type":"string","title":"Reasoning Effort","description":"The reasoning effort of the model","default":"Low","accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_horizontal":false,"is_subconfig":false,"label":"Reasoning effort","needs_confirmation":false,"show_optional_label":false,"type":"enum_slider","values":["low","medium","high"]},"rules":[{"conds":[{"config_source":"parameter_preset","type":"visible_if","value":"custom"},{"config_source":"enable_reasoning","type":"visible_if","value":true}],"mode":"and","type":"visible_if_group"}],"tab":"Model","tool_mode":"hidden"},"divider":{"type":"string","title":"Divider","default":"","accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_line":true,"show_optional_label":false,"spacing":0,"type":"divider"},"rules":[{"config_source":"parameter_preset","type":"visible_if","value":"custom"}],"tab":"Model","tool_mode":"hidden"},"reliability_section":{"type":"string","title":"Reliability Section","default":"","accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"text":"Configure retry behavior and fallback options for improved reliability.","title":"Reliability","type":"ui_text_display"},"tab":"Model","tool_mode":"hidden"},"max_retries_per_model":{"type":"integer","title":"Max Retries Per Model","description":"The maximum number of retries per model","default":3,"accordion":"Model Parameters","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Max retries","max":5,"min":0,"needs_confirmation":false,"show_optional_label":false,"step":1,"type":"number_slider"},"tab":"Model","tool_mode":"hidden"},"retry_on_status_codes":{"items":{"type":"integer"},"type":"array","title":"Retry On Status Codes","description":"The status codes to retry on","default":[429,500,502,503,504],"accordion":"Model Parameters","display":{"chips_are_closable":false,"col_span":12,"hide_toolbar":false,"is_disabled":false,"is_subconfig":false,"label":"Retry on status codes","needs_confirmation":false,"show_optional_label":false,"type":"chips_list_text"},"tab":"Model","tool_mode":"hidden"},"datacenter_fallback":{"type":"boolean","title":"Datacenter Fallback","description":"Whether to fallback to a different datacenter of the same model if the current one is down","default":true,"accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Datacenter fallback","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Model","tool_mode":"hidden"},"exclude_user_identity_from_prompt":{"type":"boolean","title":"Exclude User Identity From Prompt","description":"Omit the user's name from the system prompt. Keeps the cached instruction prefix identical across users so it can be reused, and avoids sending user identity to the model.","default":false,"accordion":"Advanced","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Exclude user identity from prompt","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Prompt","tool_mode":"hidden"},"enable_prompt_caching":{"type":"boolean","title":"Enable Prompt Caching","description":"Cache the stable instruction prefix at the model provider to cut input cost and latency on repeated turns. Disable to send every request uncached.","default":true,"accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Prompt caching","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Model","tool_mode":"hidden"},"protect_instructions_in_preview":{"type":"boolean","title":"Protect Instructions In Preview","description":"Deployed conversations always keep the agent's system instructions, persona, tools, and configuration confidential. Turn this on to also protect them in the preview/dev page; otherwise the safeguard is dropped there so builders can inspect the agent they are configuring.","default":false,"accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Protect instructions in preview","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"prompt_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"usage_limits_section":{"type":"string","title":"Usage Limits Section","default":"","accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"text":"Set limits on resource usage to control costs and prevent overuse.","title":"Agent usage limits","tooltip":"Applies to each conversation.","type":"ui_text_display"},"tab":"Model","tool_mode":"hidden"},"usage_limits_maximum_request":{"type":"integer","title":"Usage Limits Maximum Request","description":"The maximum number of requests","default":1000,"accordion":"Model Parameters","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Total Max Requests","max":10000,"min":1,"needs_confirmation":false,"show_optional_label":false,"step":50,"tooltip":"Applies to each conversation.","type":"number_slider"},"tab":"Model","tool_mode":"hidden"},"usage_limits_maximum_tokens":{"type":"integer","title":"Usage Limits Maximum Tokens","description":"The maximum number of tokens","default":2000000,"accordion":"Model Parameters","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Total max tokens","max":2000000,"min":100,"needs_confirmation":false,"show_optional_label":false,"step":500,"tooltip":"Applies to each conversation.","type":"number_slider"},"tab":"Model","tool_mode":"hidden"},"usage_limits_max_messages":{"type":"integer","title":"Usage Limits Max Messages","description":"The maximum number of messages","default":100,"accordion":"Model Parameters","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Total max messages","max":1000,"min":0,"needs_confirmation":false,"show_optional_label":false,"step":10,"tooltip":"Applies to each conversation.","type":"number_slider"},"tab":"Model","tool_mode":"hidden"},"usage_limits_agent_timeout":{"type":"integer","title":"Usage Limits Agent Timeout","description":"The maximum number of seconds the agent can run for","default":120,"accordion":"Model Parameters","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Agent timeout","max":600,"min":0,"needs_confirmation":false,"show_optional_label":false,"step":1,"tooltip":"Applies to each message.","type":"number_slider"},"tab":"Model","tool_mode":"hidden"},"divider_11":{"type":"string","title":"Divider 11","default":"","accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_line":true,"show_optional_label":false,"spacing":0,"type":"divider"},"tab":"Model","tool_mode":"hidden"},"compaction_enabled":{"type":"boolean","title":"Compaction Enabled","description":"Automatically summarize old messages when context limit is approached.","default":true,"accordion":"Compaction Settings","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Chat compaction","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Model","tool_mode":"hidden"},"compaction_strategy":{"type":"string","title":"Compaction Strategy","description":"How to compact chat history when it grows too long.","default":"auto","accordion":"Compaction Settings","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":false,"is_subconfig":false,"label":"Compaction strategy","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"label":"Auto (prefer provider-native)","value":"auto"},{"label":"Provider-native only","value":"provider"},{"label":"LLM summarization","value":"summarization"}]},"rules":[{"config_source":"compaction_enabled","type":"visible_if","value":true}],"tab":"Model","tool_mode":"hidden"},"compaction_threshold":{"type":"number","title":"Compaction Threshold","description":"How full the context window may get before compaction runs (0.01 to 0.95). Lower compacts sooner and more often.","default":0.75,"accordion":"Compaction Settings","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Compact when the context is this full","max":0.95,"min":0.01,"needs_confirmation":false,"show_optional_label":false,"step":0.01,"tooltip":"When token usage reaches this fraction of the context window, the older part of the conversation is compacted away. Lower this to compact earlier on long chats.","type":"number_slider"},"rules":[{"config_source":"compaction_enabled","type":"visible_if","value":true}],"tab":"Model","tool_mode":"hidden"},"compaction_tool_enabled":{"type":"boolean","title":"Compaction Tool Enabled","description":"Expose a tool that lets the agent request compaction manually.","default":false,"accordion":"Compaction Settings","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Compaction tool","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","tooltip":"When on, the agent can call `compact_conversation` to compact at will.","type":"toggle"},"rules":[{"conds":[{"config_source":"compaction_enabled","type":"visible_if","value":true},{"conds":[{"config_source":"compaction_strategy","type":"visible_if","value":"auto"},{"config_source":"compaction_strategy","type":"visible_if","value":"summarization"}],"mode":"or","type":"visible_if_group"}],"mode":"and","type":"visible_if_group"}],"tab":"Model","tool_mode":"hidden"},"tool_calling_section":{"type":"string","title":"Tool Calling Section","default":"","accordion":"Model Parameters","display":{"col_span":10,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"small_text":"Configure how the agent handles tool execution and function calls.","title":"Tool calling","type":"ui_text_display"},"tab":"Model","tool_mode":"hidden"},"parallel_tool_calls":{"type":"boolean","title":"Parallel Tool Calls","description":"Whether to allow the agent to call multiple tools at the same time.","default":true,"accordion":"Model Parameters","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Parallel tool calls","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Model","tool_mode":"hidden"},"tool_timeout":{"type":"number","title":"Tool Timeout","description":"Maximum seconds a single tool call can run before timing out.","default":15.0,"accordion":"Model Parameters","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Tool timeout","max":300,"min":1,"needs_confirmation":false,"show_optional_label":false,"step":1,"tooltip":"Per-tool-call timeout. The model retries on timeout.","type":"number_slider"},"tab":"Model","tool_mode":"hidden"},"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,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"enable_reasoning","type":"visible_if","value":true}],"tab":"Display","tool_mode":"hidden"},"group_into_chain_of_thought":{"type":"boolean","title":"Group Into Chain Of Thought","description":"Group reasoning and tool calls into a collapsible chain of thought","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Group into chain of thought","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Display","tool_mode":"hidden"},"chain_of_thought_final_answer_only":{"type":"boolean","title":"Chain Of Thought Final Answer Only","description":"The agent only responds at the end, keeping all intermediate messages in its chain of thought.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Only show the final answer","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"group_into_chain_of_thought","type":"visible_if","value":true}],"tab":"Display","tool_mode":"hidden","visible":false},"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,"toggle_position":"right","type":"toggle"},"tab":"Display","tool_mode":"hidden"},"hide_error_banners":{"type":"boolean","title":"Hide Error Banners","description":"When a turn fails on the web widget or an embed, hide the error banner from end users; the agent's own reply still explains what it could not do, and a turn that fails before it replies still offers a retry. The platform's own chat always shows the error while you build. Slack, Teams and the other channels never rendered these banners.","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Hide error banners on the widget and embed","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","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 the agent is working.","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enable loading message","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Display","tool_mode":"hidden"},"message_footer_enabled":{"type":"boolean","title":"Message Footer Enabled","description":"Show a fixed footer under the agent's final reply in every channel.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Message footer","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Display","tool_mode":"hidden"},"message_footer":{"anyOf":[{"items":{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},"type":"array"},{"type":"null"}],"title":"Message Footer","description":"Shown under the agent's final reply in every channel. Never sent to the model, so it cannot be reworded or dropped.","display":{"col_span":12,"connector_name":"","hide_chip_options":false,"hide_toolbar":false,"is_disabled":false,"is_simple_text":false,"is_subconfig":false,"label":"Footer text","needs_confirmation":false,"no_space_on_insert":false,"number_of_lines":5,"placeholder":"e.g. a disclaimer shown under every answer","show_optional_label":false,"type":"rich_text_variables"},"rules":[{"config_source":"message_footer_enabled","type":"visible_if","value":true}],"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":[{"config_source":"minimal_caret_only","type":"visible_if","value":true}],"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,"icons":false,"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"},"deduplicate_sources_by_url":{"type":"boolean","title":"Deduplicate Sources By Url","description":"Group sources by unique URL in the sources panel","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Deduplicate sources by URL","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"conds":[{"config_source":"citation_style","type":"visible_if","value":"text"},{"config_source":"citation_style","type":"visible_if","value":"numbered"}],"mode":"or","type":"visible_if_group"}],"tab":"Display","tool_mode":"hidden"},"omit_citation_quotes":{"type":"boolean","title":"Omit Citation Quotes","description":"Hide quoted text in citation bubbles, show only the URL","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Omit citation quotes","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"conds":[{"config_source":"citation_style","type":"visible_if","value":"text"},{"config_source":"citation_style","type":"visible_if","value":"numbered"}],"mode":"or","type":"visible_if_group"}],"tab":"Display","tool_mode":"hidden"},"show_source_images":{"type":"boolean","title":"Show Source Images","description":"Show document page images presented by the agent expanded by default instead of collapsed behind the source images toggle","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Show source images by default","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"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"},"transport_show_tool_calls":{"type":"boolean","title":"Transport Show Tool Calls","default":false,"tab":"Configuration","tool_mode":"hidden","visible":false},"transport_show_sources":{"type":"boolean","title":"Transport Show Sources","default":true,"tab":"Configuration","tool_mode":"hidden","visible":false},"transport_show_thinking":{"type":"boolean","title":"Transport Show Thinking","default":false,"tab":"Configuration","tool_mode":"hidden","visible":false},"transport_allow_noop":{"type":"boolean","title":"Transport Allow Noop","default":false,"tab":"Configuration","tool_mode":"hidden","visible":false},"transport_thinking_text":{"type":"string","title":"Transport Thinking Text","default":"","tab":"Configuration","tool_mode":"hidden","visible":false},"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 chat title is displayed.","title":"Chat title display","type":"ui_text_display"},"tab":"Display","tool_mode":"hidden"},"agent_title_mode":{"type":"string","enum":["generate","first_message","last_message","custom"],"title":"Agent Title Mode","description":"Configure how the agent chat title is displayed in the chat history","default":"generate","display":{"col_span":12,"icons":false,"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"},{"label":"Custom prompt","value":"custom"}]},"tab":"Display","tool_mode":"hidden"},"agent_title_prompt":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"string"}],"title":"Agent Title Prompt","description":"Custom instructions for the generated conversation title.","default":"","display":{"col_span":12,"hide_toolbar":false,"is_disabled":false,"is_subconfig":false,"label":"Title prompt","needs_confirmation":false,"number_of_lines":5,"placeholder":"Describe what the title should contain and the format it should follow.","show_optional_label":false,"type":"big_text"},"rules":[{"config_source":"agent_title_mode","type":"visible_if","value":"custom"}],"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"},"feedback_section":{"type":"string","title":"Feedback Section","default":"","display":{"col_span":10,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"small_text":"Customise the inline prompt shown when a user rates a response.","title":"Message feedback","type":"ui_text_display"},"tab":"Display","tool_mode":"hidden"},"feedback_placeholder":{"type":"string","title":"Feedback Placeholder","description":"Placeholder shown in the inline feedback box.","default":"Add details (optional)","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Feedback placeholder","max_length":140,"needs_confirmation":false,"number_of_lines":1,"placeholder":"Add details (optional)","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Display","tool_mode":"hidden"},"feedback_submit_label":{"type":"string","title":"Feedback Submit Label","default":"Submit","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Submit button label","max_length":30,"needs_confirmation":false,"number_of_lines":1,"placeholder":"Submit","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Display","tool_mode":"hidden"},"feedback_cancel_label":{"type":"string","title":"Feedback Cancel Label","default":"Cancel","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Cancel button label","max_length":30,"needs_confirmation":false,"number_of_lines":1,"placeholder":"Cancel","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Display","tool_mode":"hidden"},"capability_versions":{"$ref":"#/components/schemas/CapabilityPins","description":"Pinned behaviour version per agent capability","tab":"Configuration","tool_mode":"hidden","visible":false},"is_coworker":{"type":"boolean","title":"Is Coworker","description":"Whether the agent is a co-worker","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Is co-worker","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"preset_selector":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Preset Selector","description":"Choose a preset to get started quickly.","display":{"button_label":"Choose preset","button_size":"default","button_variant":"outline","col_span":12,"confirmation_message":"Loading a preset will overwrite your persona, tone, instructions, and some model settings. Continue?","is_disabled":false,"is_horizontal":true,"is_subconfig":false,"label":"Quick start","mixpanel_event":"AGENT_PRESET_SELECTOR_CLICK","needs_confirmation":true,"show_optional_label":false,"type":"menu_select","values":[{"description":"Customer service agent for issue resolution","label":"Customer Operations","value":"customer_operations"},{"description":"Technical support specialist for troubleshooting","label":"IT Helpdesk","value":"it_helpdesk"},{"description":"Case management specialist for claims and workflows","label":"Case Management","value":"case_management"}]},"rules":[{"target_fields":["persona","tone","extra_instructions","temperature","top_p","top_k","presence_penalty","frequency_penalty","parameter_preset","preset_selector"],"type":"sets_field_values","value_map":{"case_management":{"extra_instructions":{"definition":{"content":[{"content":[{"text":"- Review all case details thoroughly before proceeding","type":"text"}],"type":"paragraph"},{"content":[{"text":"- Follow established procedures and compliance requirements","type":"text"}],"type":"paragraph"},{"content":[{"text":"- Document all actions and decisions clearly","type":"text"}],"type":"paragraph"},{"content":[{"text":"- Maintain accuracy and attention to detail throughout the process","type":"text"}],"type":"paragraph"}],"type":"doc"},"isRaw":false,"text":"- Review all case details thoroughly before proceeding\n- Follow established procedures and compliance requirements\n- Document all actions and decisions clearly\n- 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\n- Provide concise step-by-step guidance\n- Escalate complex cases politely when needed\n- Maintain empathy and professionalism in all interactions"},"frequency_penalty":0.6,"parameter_preset":"custom","persona":{"definition":{"content":[{"content":[{"text":"You are a knowledgeable and empathetic customer operations agent who helps users resolve issues quickly and clearly. You have deep expertise in customer service best practices, issue resolution, and maintaining positive customer relationships.","type":"text"}],"type":"paragraph"}],"type":"doc"},"isRaw":false,"text":"You are a knowledgeable and empathetic customer operations agent who helps users resolve issues quickly and clearly. You have deep expertise in customer service best practices, issue resolution, and maintaining positive customer relationships."},"presence_penalty":0.4,"temperature":0.2,"tone":{"definition":{"content":[{"content":[{"text":"Be professional yet personable. Provide clear and engaging communication. Exercise good judgment in matching tone to context.","type":"text"}],"type":"paragraph"}],"type":"doc"},"isRaw":false,"text":"Be professional yet personable. Provide clear and engaging communication. Exercise good judgment in matching tone to context."},"top_k":20,"top_p":0.85},"it_helpdesk":{"extra_instructions":{"definition":{"content":[{"content":[{"text":"- Gather system information and error details first","type":"text"}],"type":"paragraph"},{"content":[{"text":"- Provide step-by-step troubleshooting instructions","type":"text"}],"type":"paragraph"},{"content":[{"text":"- Explain technical concepts in simple terms","type":"text"}],"type":"paragraph"},{"content":[{"text":"- Document solutions for future reference","type":"text"}],"type":"paragraph"}],"type":"doc"},"isRaw":false,"text":"- Gather system information and error details first\n- Provide step-by-step troubleshooting instructions\n- Explain technical concepts in simple terms\n- Document solutions for future reference"},"frequency_penalty":0.7,"parameter_preset":"custom","persona":{"definition":{"content":[{"content":[{"text":"You are an experienced IT helpdesk support specialist with comprehensive knowledge of technical troubleshooting, common software and hardware issues, and system administration. You excel at translating complex technical concepts into simple, actionable guidance.","type":"text"}],"type":"paragraph"}],"type":"doc"},"isRaw":false,"text":"You are an experienced IT helpdesk support specialist with comprehensive knowledge of technical troubleshooting, common software and hardware issues, and system administration. You excel at translating complex technical concepts into simple, actionable guidance."},"presence_penalty":0.3,"temperature":0.2,"tone":{"definition":{"content":[{"content":[{"text":"Be professional yet personable. Provide clear and engaging communication. Exercise good judgment in matching tone to context.","type":"text"}],"type":"paragraph"}],"type":"doc"},"isRaw":false,"text":"Be professional yet personable. Provide clear and engaging communication. Exercise good judgment in matching tone to context."},"top_k":25,"top_p":0.85}}}],"tab":"Prompt","tool_mode":"hidden","visible":false},"languages":{"items":{"$ref":"#/components/schemas/AgentLanguage-Output"},"type":"array","title":"Languages","description":"Welcome message per language. The deployed widget's language picks one, otherwise the visitor's browser locale; the default language is used when none matches.","default":[],"display":{"addable_codes":["en","es","pt"],"col_span":12,"intro_placeholder":"Hello, how can I help you today?","is_disabled":false,"is_subconfig":false,"label":"Languages","needs_confirmation":false,"options":[{"label":"Abkhazian","tag":"ab","value":"ab"},{"label":"Afar","tag":"aa","value":"aa"},{"label":"Afrikaans","tag":"af","value":"af"},{"label":"Akan","tag":"ak","value":"ak"},{"label":"Albanian","tag":"sq","value":"sq"},{"label":"Amharic","tag":"am","value":"am"},{"label":"Arabic","tag":"ar","value":"ar"},{"label":"Aragonese","tag":"an","value":"an"},{"label":"Armenian","tag":"hy","value":"hy"},{"label":"Assamese","tag":"as","value":"as"},{"label":"Avaric","tag":"av","value":"av"},{"label":"Avestan","tag":"ae","value":"ae"},{"label":"Aymara","tag":"ay","value":"ay"},{"label":"Azerbaijani","tag":"az","value":"az"},{"label":"Bambara","tag":"bm","value":"bm"},{"label":"Bashkir","tag":"ba","value":"ba"},{"label":"Basque","tag":"eu","value":"eu"},{"label":"Belarusian","tag":"be","value":"be"},{"label":"Bengali","tag":"bn","value":"bn"},{"label":"Bislama","tag":"bi","value":"bi"},{"label":"Bosnian","tag":"bs","value":"bs"},{"label":"Breton","tag":"br","value":"br"},{"label":"Bulgarian","tag":"bg","value":"bg"},{"label":"Burmese","tag":"my","value":"my"},{"label":"Catalan","tag":"ca","value":"ca"},{"label":"Chamorro","tag":"ch","value":"ch"},{"label":"Chechen","tag":"ce","value":"ce"},{"label":"Chinese","tag":"zh","value":"zh"},{"label":"Church Slavic","tag":"cu","value":"cu"},{"label":"Chuvash","tag":"cv","value":"cv"},{"label":"Cornish","tag":"kw","value":"kw"},{"label":"Corsican","tag":"co","value":"co"},{"label":"Cree","tag":"cr","value":"cr"},{"label":"Croatian","tag":"hr","value":"hr"},{"label":"Czech","tag":"cs","value":"cs"},{"label":"Danish","tag":"da","value":"da"},{"label":"Dhivehi","tag":"dv","value":"dv"},{"label":"Dutch","tag":"nl","value":"nl"},{"label":"Dzongkha","tag":"dz","value":"dz"},{"label":"English (UK)","tag":"en","value":"en"},{"label":"Esperanto","tag":"eo","value":"eo"},{"label":"Estonian","tag":"et","value":"et"},{"label":"Ewe","tag":"ee","value":"ee"},{"label":"Faroese","tag":"fo","value":"fo"},{"label":"Fijian","tag":"fj","value":"fj"},{"label":"Finnish","tag":"fi","value":"fi"},{"label":"French","tag":"fr","value":"fr"},{"label":"Fulah","tag":"ff","value":"ff"},{"label":"Galician","tag":"gl","value":"gl"},{"label":"Ganda","tag":"lg","value":"lg"},{"label":"Georgian","tag":"ka","value":"ka"},{"label":"German","tag":"de","value":"de"},{"label":"Guarani","tag":"gn","value":"gn"},{"label":"Gujarati","tag":"gu","value":"gu"},{"label":"Haitian","tag":"ht","value":"ht"},{"label":"Hausa","tag":"ha","value":"ha"},{"label":"Hebrew","tag":"he","value":"he"},{"label":"Herero","tag":"hz","value":"hz"},{"label":"Hindi","tag":"hi","value":"hi"},{"label":"Hiri Motu","tag":"ho","value":"ho"},{"label":"Hungarian","tag":"hu","value":"hu"},{"label":"Icelandic","tag":"is","value":"is"},{"label":"Ido","tag":"io","value":"io"},{"label":"Igbo","tag":"ig","value":"ig"},{"label":"Indonesian","tag":"id","value":"id"},{"label":"Interlingua (International Auxiliary Language Association)","tag":"ia","value":"ia"},{"label":"Interlingue","tag":"ie","value":"ie"},{"label":"Inuktitut","tag":"iu","value":"iu"},{"label":"Inupiaq","tag":"ik","value":"ik"},{"label":"Irish","tag":"ga","value":"ga"},{"label":"Italian","tag":"it","value":"it"},{"label":"Japanese","tag":"ja","value":"ja"},{"label":"Javanese","tag":"jv","value":"jv"},{"label":"Kalaallisut","tag":"kl","value":"kl"},{"label":"Kannada","tag":"kn","value":"kn"},{"label":"Kanuri","tag":"kr","value":"kr"},{"label":"Kashmiri","tag":"ks","value":"ks"},{"label":"Kazakh","tag":"kk","value":"kk"},{"label":"Khmer","tag":"km","value":"km"},{"label":"Kikuyu","tag":"ki","value":"ki"},{"label":"Kinyarwanda","tag":"rw","value":"rw"},{"label":"Kirghiz","tag":"ky","value":"ky"},{"label":"Komi","tag":"kv","value":"kv"},{"label":"Kongo","tag":"kg","value":"kg"},{"label":"Korean","tag":"ko","value":"ko"},{"label":"Kuanyama","tag":"kj","value":"kj"},{"label":"Kurdish","tag":"ku","value":"ku"},{"label":"Lao","tag":"lo","value":"lo"},{"label":"Latin","tag":"la","value":"la"},{"label":"Latvian","tag":"lv","value":"lv"},{"label":"Limburgan","tag":"li","value":"li"},{"label":"Lingala","tag":"ln","value":"ln"},{"label":"Lithuanian","tag":"lt","value":"lt"},{"label":"Luba-Katanga","tag":"lu","value":"lu"},{"label":"Luxembourgish","tag":"lb","value":"lb"},{"label":"Macedonian","tag":"mk","value":"mk"},{"label":"Malagasy","tag":"mg","value":"mg"},{"label":"Malay (macrolanguage)","tag":"ms","value":"ms"},{"label":"Malayalam","tag":"ml","value":"ml"},{"label":"Maltese","tag":"mt","value":"mt"},{"label":"Manx","tag":"gv","value":"gv"},{"label":"Maori","tag":"mi","value":"mi"},{"label":"Marathi","tag":"mr","value":"mr"},{"label":"Marshallese","tag":"mh","value":"mh"},{"label":"Modern Greek (1453-)","tag":"el","value":"el"},{"label":"Mongolian","tag":"mn","value":"mn"},{"label":"Nauru","tag":"na","value":"na"},{"label":"Navajo","tag":"nv","value":"nv"},{"label":"Ndonga","tag":"ng","value":"ng"},{"label":"Nepali (macrolanguage)","tag":"ne","value":"ne"},{"label":"North Ndebele","tag":"nd","value":"nd"},{"label":"Northern Sami","tag":"se","value":"se"},{"label":"Norwegian","tag":"no","value":"no"},{"label":"Norwegian Bokmål","tag":"nb","value":"nb"},{"label":"Norwegian Nynorsk","tag":"nn","value":"nn"},{"label":"Nyanja","tag":"ny","value":"ny"},{"label":"Occitan (post 1500)","tag":"oc","value":"oc"},{"label":"Ojibwa","tag":"oj","value":"oj"},{"label":"Oriya (macrolanguage)","tag":"or","value":"or"},{"label":"Oromo","tag":"om","value":"om"},{"label":"Ossetian","tag":"os","value":"os"},{"label":"Pali","tag":"pi","value":"pi"},{"label":"Panjabi","tag":"pa","value":"pa"},{"label":"Persian","tag":"fa","value":"fa"},{"label":"Polish","tag":"pl","value":"pl"},{"label":"Portuguese (Portugal)","tag":"pt","value":"pt"},{"label":"Pushto","tag":"ps","value":"ps"},{"label":"Quechua","tag":"qu","value":"qu"},{"label":"Romanian","tag":"ro","value":"ro"},{"label":"Romansh","tag":"rm","value":"rm"},{"label":"Rundi","tag":"rn","value":"rn"},{"label":"Russian","tag":"ru","value":"ru"},{"label":"Samoan","tag":"sm","value":"sm"},{"label":"Sango","tag":"sg","value":"sg"},{"label":"Sanskrit","tag":"sa","value":"sa"},{"label":"Sardinian","tag":"sc","value":"sc"},{"label":"Scottish Gaelic","tag":"gd","value":"gd"},{"label":"Serbian","tag":"sr","value":"sr"},{"label":"Serbo-Croatian","tag":"sh","value":"sh"},{"label":"Shona","tag":"sn","value":"sn"},{"label":"Sichuan Yi","tag":"ii","value":"ii"},{"label":"Sindhi","tag":"sd","value":"sd"},{"label":"Sinhala","tag":"si","value":"si"},{"label":"Slovak","tag":"sk","value":"sk"},{"label":"Slovenian","tag":"sl","value":"sl"},{"label":"Somali","tag":"so","value":"so"},{"label":"South Ndebele","tag":"nr","value":"nr"},{"label":"Southern Sotho","tag":"st","value":"st"},{"label":"Spanish (Spain)","tag":"es","value":"es"},{"label":"Sundanese","tag":"su","value":"su"},{"label":"Swahili (macrolanguage)","tag":"sw","value":"sw"},{"label":"Swati","tag":"ss","value":"ss"},{"label":"Swedish","tag":"sv","value":"sv"},{"label":"Tagalog","tag":"tl","value":"tl"},{"label":"Tahitian","tag":"ty","value":"ty"},{"label":"Tajik","tag":"tg","value":"tg"},{"label":"Tamil","tag":"ta","value":"ta"},{"label":"Tatar","tag":"tt","value":"tt"},{"label":"Telugu","tag":"te","value":"te"},{"label":"Thai","tag":"th","value":"th"},{"label":"Tibetan","tag":"bo","value":"bo"},{"label":"Tigrinya","tag":"ti","value":"ti"},{"label":"Tonga (Tonga Islands)","tag":"to","value":"to"},{"label":"Tsonga","tag":"ts","value":"ts"},{"label":"Tswana","tag":"tn","value":"tn"},{"label":"Turkish","tag":"tr","value":"tr"},{"label":"Turkmen","tag":"tk","value":"tk"},{"label":"Twi","tag":"tw","value":"tw"},{"label":"Uighur","tag":"ug","value":"ug"},{"label":"Ukrainian","tag":"uk","value":"uk"},{"label":"Urdu","tag":"ur","value":"ur"},{"label":"Uzbek","tag":"uz","value":"uz"},{"label":"Venda","tag":"ve","value":"ve"},{"label":"Vietnamese","tag":"vi","value":"vi"},{"label":"Volapük","tag":"vo","value":"vo"},{"label":"Walloon","tag":"wa","value":"wa"},{"label":"Welsh","tag":"cy","value":"cy"},{"label":"Western Frisian","tag":"fy","value":"fy"},{"label":"Wolof","tag":"wo","value":"wo"},{"label":"Xhosa","tag":"xh","value":"xh"},{"label":"Yiddish","tag":"yi","value":"yi"},{"label":"Yoruba","tag":"yo","value":"yo"},{"label":"Zhuang","tag":"za","value":"za"},{"label":"Zulu","tag":"zu","value":"zu"}],"show_optional_label":false,"type":"languages_list"},"rules":[{"config_source":"is_coworker","type":"visible_if","value":true}],"tab":"Prompt","tool_mode":"hidden"},"default_language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Default Language","description":"ISO 639-1 code of the language used when the visitor's locale matches none.","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"default_language","needs_confirmation":false,"show_optional_label":false,"type":"config_dynamic_text"},"tab":"Configuration","tool_mode":"hidden","visible":false},"persona":{"anyOf":[{"items":{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},"type":"array"},{"type":"null"}],"title":"Persona","description":"Describe who the co-worker is: their background, role, or point of view.","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Agent persona defining the AI's character, background, role, and point of view","heuristic_types":["clarity","specificity","roleplaying"],"improver_context":"This is an AGENT PERSONA definition — a description of who the AI agent is. The output must read as a natural character description, NOT a structured task prompt. Do NOT include output format specs, JSON schemas, edge case sections, or task-type templates. Focus on: identity, background, personality traits, expertise, and point of view. Keep it concise (2-4 short paragraphs max). Write in second person ('You are...'). Be specific about the character but avoid copying any real or copyrighted personas.","improver_prompt":"PromptImproverPromptV2","is_disabled":false,"is_subconfig":false,"label":"Persona","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Prompt","tool_mode":"hidden"},"tone":{"anyOf":[{"items":{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},"type":"array"},{"type":"null"}],"title":"Tone","description":"Define how the co-worker should communicate: its voice, attitude, and style.","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Agent tone and communication style defining voice, attitude, and writing style","heuristic_types":["clarity","specificity","roleplaying"],"improver_context":"This is an AGENT TONE & STYLE definition — how the AI agent should communicate. The output must be a concise set of voice and style guidelines, NOT a structured task prompt. Do NOT include output format specs, JSON schemas, edge case sections, or task-type templates. Focus on: communication style, vocabulary level, formality, pacing, and attitude. Keep it concise (a short list of guidelines or 1-2 paragraphs max). Use direct instructions ('Use short sentences', 'Be encouraging', etc.).","improver_prompt":"PromptImproverPromptV2","is_disabled":false,"is_subconfig":false,"label":"Tone & style","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Prompt","tool_mode":"hidden"},"extra_instructions":{"anyOf":[{"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":{"allow_reference_mentions":false,"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_context":"This is an AGENT BEHAVIOR INSTRUCTIONS field — specific rules and guidelines for the agent. The output must be a concise set of behavioral rules, NOT a generic task prompt template. Do NOT include output format specs, JSON schemas, edge case sections, or task-type templates. Focus on: do/don't rules, goals, boundaries, and operational guidelines. Keep it concise and actionable. Use bullet points or numbered rules.","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-Output"},{"$ref":"#/components/schemas/NoxusQaSettings-Output"},{"$ref":"#/components/schemas/KnowledgeBaseSelectorSettings-Output"},{"$ref":"#/components/schemas/KnowledgeBaseQaSettings-Output"},{"$ref":"#/components/schemas/WorkflowSettings-Output"},{"$ref":"#/components/schemas/AttachFileSettings"},{"$ref":"#/components/schemas/HumanInTheLoopSettings-Output"},{"$ref":"#/components/schemas/AgentToolSettings-Output"},{"$ref":"#/components/schemas/MemorySettings-Output"},{"$ref":"#/components/schemas/ActionToolSettings-Output"},{"$ref":"#/components/schemas/ExcelSettings-Output"},{"$ref":"#/components/schemas/DocxSettings-Output"},{"$ref":"#/components/schemas/FileSystemSettings-Output"},{"$ref":"#/components/schemas/FileSettings-Output"},{"$ref":"#/components/schemas/TodoSettings-Output"},{"$ref":"#/components/schemas/SandboxSettings-Output"},{"$ref":"#/components/schemas/ScheduleToolSettings-Output"},{"$ref":"#/components/schemas/SubAgentSettings-Output"},{"$ref":"#/components/schemas/CodeExecutionSettings-Output"},{"$ref":"#/components/schemas/AgentMemorySettings-Output"},{"$ref":"#/components/schemas/CreateFilesSettings-Output"},{"$ref":"#/components/schemas/DocumentationSettings-Output"},{"$ref":"#/components/schemas/ImageGenerationSettings-Output"},{"$ref":"#/components/schemas/FailureProbeSettings-Output"},{"$ref":"#/components/schemas/CodeModeSettings-Output"},{"$ref":"#/components/schemas/OverflowSettings-Output"},{"$ref":"#/components/schemas/GuardrailsSettings-Output"}],"discriminator":{"propertyName":"type","mapping":{"action":"#/components/schemas/ActionToolSettings-Output","agent_memory":"#/components/schemas/AgentMemorySettings-Output","agent_tool":"#/components/schemas/AgentToolSettings-Output","attach_file":"#/components/schemas/AttachFileSettings","code_execution":"#/components/schemas/CodeExecutionSettings-Output","code_mode":"#/components/schemas/CodeModeSettings-Output","create_files":"#/components/schemas/CreateFilesSettings-Output","documentation":"#/components/schemas/DocumentationSettings-Output","docx":"#/components/schemas/DocxSettings-Output","excel":"#/components/schemas/ExcelSettings-Output","failure_probe":"#/components/schemas/FailureProbeSettings-Output","files":"#/components/schemas/FileSettings-Output","filesystem":"#/components/schemas/FileSystemSettings-Output","guardrails":"#/components/schemas/GuardrailsSettings-Output","human_in_the_loop":"#/components/schemas/HumanInTheLoopSettings-Output","image_generation":"#/components/schemas/ImageGenerationSettings-Output","kb_qa":"#/components/schemas/KnowledgeBaseQaSettings-Output","kb_selector":"#/components/schemas/KnowledgeBaseSelectorSettings-Output","memory":"#/components/schemas/MemorySettings-Output","noxus_qa":"#/components/schemas/NoxusQaSettings-Output","overflow":"#/components/schemas/OverflowSettings-Output","sandbox":"#/components/schemas/SandboxSettings-Output","schedule_tool":"#/components/schemas/ScheduleToolSettings-Output","subagent":"#/components/schemas/SubAgentSettings-Output","todos":"#/components/schemas/TodoSettings-Output","web_research":"#/components/schemas/WebResearchSettings-Output","workflow":"#/components/schemas/WorkflowSettings-Output"}}},"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},"workflows_parallel_enabled":{"type":"boolean","title":"Workflows Parallel Enabled","description":"Let the agent start flows without blocking on them, then poll for the result. Off keeps every flow call blocking.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Parallel flow execution","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"order":15,"tab":"Actions","tool_mode":"hidden"},"mcp_servers":{"items":{"$ref":"#/components/schemas/MCPServerBinding"},"type":"array","title":"Mcp Servers","description":"Workspace MCP credentials this agent can call tools on.","default":[],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"MCP","needs_confirmation":false,"show_optional_label":false,"type":"mcp_credential_select"},"order":50,"tab":"Actions","tool_mode":"hidden"},"convert_unsupported_files_to_text":{"type":"boolean","title":"Convert Unsupported Files To Text","description":"When an attached file's type can't be sent to the model as a native attachment (e.g. JSON, CSV, XML, Markdown), inline its text content into the prompt instead of failing the run. PDFs and images are always sent as attachments.","default":true,"accordion":"Advanced","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Convert unsupported files to text","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Prompt","tool_mode":"hidden"},"skills":{"items":{"$ref":"#/components/schemas/SkillConfig"},"type":"array","title":"Skills","default":[],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Skills","needs_confirmation":false,"show_optional_label":false,"type":"skills_list"},"tab":"Knowledge","tool_mode":"hidden"},"subagents_enabled":{"type":"boolean","title":"Subagents Enabled","description":"Let the agent hand self-contained tasks to a built-in general-purpose subagent, which runs in its own fresh context on the Cost-Effective Models preset. Off keeps every task in the agent's own context.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Subagents","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"feature_flag":"AGENT_SUBAGENTS_ENABLED","order":60,"tab":"Actions","tool_mode":"hidden"},"subagents":{"items":{"$ref":"#/components/schemas/SubAgentDefinition"},"type":"array","title":"Subagents","default":[],"tab":"Configuration","tool_mode":"hidden","visible":false},"guidelines_enabled":{"type":"boolean","title":"Guidelines Enabled","description":"Enable behavioral guidelines that shape how the agent responds.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enable Guidelines","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"feature_flag":"AGENT_GUIDELINES_ENABLED","tab":"Prompt","tool_mode":"hidden","visible":false},"guidelines":{"items":{"$ref":"#/components/schemas/GuidelineConfig"},"type":"array","title":"Guidelines","default":[],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Guidelines","needs_confirmation":false,"show_optional_label":false,"type":"guidelines_list"},"feature_flag":"AGENT_GUIDELINES_ENABLED","tab":"Prompt","tool_mode":"hidden"},"glossary":{"items":{"$ref":"#/components/schemas/GlossaryTermConfig"},"type":"array","title":"Glossary","default":[],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Glossary","needs_confirmation":false,"show_optional_label":false,"type":"glossary_list"},"feature_flag":"AGENT_GUIDELINES_ENABLED","tab":"Prompt","tool_mode":"hidden"},"memories":{"items":{"$ref":"#/components/schemas/AgentMemoryEntry"},"type":"array","title":"Memories","description":"Persistent memory across all conversations","default":[],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Agent Memory","needs_confirmation":false,"show_optional_label":false,"type":"agent_memory_field"},"feature_flag":"AGENT_MEMORY_ENABLED","tab":"Knowledge","tool_mode":"hidden"},"hidden_tools":{"items":{"type":"string"},"type":"array","title":"Hidden Tools","description":"Tool calls that never appear in the chat activity feed.","default":["todos_read_todos","todos_add_todo","todos_write_todos","todos_update_todo_status","todos_remove_todo"],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Hidden tools","needs_confirmation":false,"show_optional_label":false,"tooltip":"Toggled-on tools never appear in the chat activity feed.","type":"tool_select"},"tab":"Display","tool_mode":"hidden","visible":false},"deployment_custom_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deployment Custom Instructions","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"deployment_custom_instructions","needs_confirmation":false,"show_optional_label":false,"type":"config_dynamic_text"},"tab":"Configuration","tool_mode":"hidden","visible":false},"variables_enabled":{"type":"boolean","title":"Variables Enabled","description":"Create external values that can be mapped to flow inputs. The agent receives these external values through its widget deployment.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"External values","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"feature_flag":"AGENT_VARIABLES_ENABLED","order":16,"tab":"Actions","tool_mode":"hidden"},"variables":{"items":{"$ref":"#/components/schemas/VariableDefinition"},"type":"array","title":"Variables","default":[],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"External values list","needs_confirmation":false,"show_optional_label":false,"type":"variables_field"},"feature_flag":"AGENT_VARIABLES_ENABLED","order":17,"rules":[{"config_source":"variables_enabled","type":"visible_if","value":true}],"tab":"Actions","tool_mode":"hidden"},"workflows":{"items":{"$ref":"#/components/schemas/WorkflowSettings-Output"},"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"},"order":10,"tab":"Actions","tool_mode":"hidden"},"knowledge_bases":{"items":{"$ref":"#/components/schemas/KnowledgeBaseQaSettings-Output"},"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":"Knowledge","tool_mode":"hidden"},"multi_kb_search":{"type":"boolean","title":"Multi Kb Search","description":"Let one search cover several knowledge bases at once, merging their results. Off means every search targets a single one.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Search knowledge bases together","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Knowledge","tool_mode":"hidden"},"citation_instructions_enabled":{"type":"boolean","title":"Citation Instructions Enabled","description":"Write your own rules for what the co-worker cites from its knowledge bases. Off keeps the built-in citation behaviour.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Custom knowledge base citation instructions","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Knowledge","tool_mode":"hidden"},"citation_instructions":{"anyOf":[{"items":{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},"type":"array"},{"type":"null"}],"title":"Citation Instructions","description":"Tell the co-worker what to cite from its knowledge bases, when a claim needs a source, and how much to quote. The reference tag format itself is fixed and always applies.","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Agent citation policy defining what to cite from knowledge bases, when a claim needs a source, and how much to quote","heuristic_types":["clarity","specificity","actionability"],"improver_context":"This is an AGENT CITATION POLICY field — when and what the agent should cite from its knowledge bases. The output must be a concise set of citation rules, NOT a generic task prompt template. Do NOT include output format specs, JSON schemas, edge case sections, or task-type templates. Do NOT invent or alter any citation tag syntax — the reference tag format is fixed by the platform and is not part of this field. Focus on: what is worth citing, when a claim needs a source, quoting versus paraphrasing, how much to quote, citation density, and when not to cite. Keep it concise and actionable. Use bullet points.","improver_prompt":"PromptImproverPromptV2","is_disabled":false,"is_subconfig":false,"label":"Knowledge base citation instructions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"rules":[{"config_source":"citation_instructions_enabled","type":"visible_if","value":true}],"tab":"Knowledge","tool_mode":"hidden"},"agent_files":{"items":{"$ref":"#/components/schemas/AgentFileConfig-Output"},"type":"array","title":"Agent Files","description":"Files pre-loaded into every chat. Each is added to the session (readable via the file tools) with its context shown to the agent.","default":[],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Files","needs_confirmation":false,"show_optional_label":false,"type":"files_field"},"order":10,"tab":"Knowledge","tool_mode":"hidden"},"databases":{"items":{"$ref":"#/components/schemas/AgentDatabaseConfig-Output"},"type":"array","title":"Databases","description":"SQL databases the agent can query read-only. Each references a database credential; access is deferred, so the agent connects only when a query is needed.","default":[],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Databases","needs_confirmation":false,"show_optional_label":false,"type":"databases_field"},"order":20,"tab":"Knowledge","tool_mode":"hidden"},"tables":{"items":{"$ref":"#/components/schemas/AgentTableConfig-Output"},"type":"array","title":"Tables","description":"The workspace tables this agent can use. Add context for each so the agent knows what it holds and when to use it.","default":[],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Tables","needs_confirmation":false,"show_optional_label":false,"type":"tables_field"},"order":21,"tab":"Knowledge","tool_mode":"hidden"},"coworkers":{"items":{"$ref":"#/components/schemas/AgentToolSettings-Output"},"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"},"order":20,"tab":"Actions","tool_mode":"hidden"},"base_tools":{"items":{"oneOf":[{"$ref":"#/components/schemas/WebResearchSettings-Output"},{"$ref":"#/components/schemas/HumanInTheLoopSettings-Output"},{"$ref":"#/components/schemas/MemorySettings-Output"},{"$ref":"#/components/schemas/AttachFileSettings"},{"$ref":"#/components/schemas/FileSystemSettings-Output"},{"$ref":"#/components/schemas/FileSettings-Output"},{"$ref":"#/components/schemas/CodeExecutionSettings-Output"},{"$ref":"#/components/schemas/ExcelSettings-Output"},{"$ref":"#/components/schemas/DocxSettings-Output"},{"$ref":"#/components/schemas/NoxusQaSettings-Output"},{"$ref":"#/components/schemas/KnowledgeBaseSelectorSettings-Output"},{"$ref":"#/components/schemas/TodoSettings-Output"},{"$ref":"#/components/schemas/SandboxSettings-Output"},{"$ref":"#/components/schemas/ScheduleToolSettings-Output"},{"$ref":"#/components/schemas/SubAgentSettings-Output"},{"$ref":"#/components/schemas/AgentMemorySettings-Output"},{"$ref":"#/components/schemas/CreateFilesSettings-Output"},{"$ref":"#/components/schemas/DocumentationSettings-Output"},{"$ref":"#/components/schemas/ImageGenerationSettings-Output"},{"$ref":"#/components/schemas/FailureProbeSettings-Output"},{"$ref":"#/components/schemas/CodeModeSettings-Output"},{"$ref":"#/components/schemas/OverflowSettings-Output"},{"$ref":"#/components/schemas/GuardrailsSettings-Output"}],"discriminator":{"propertyName":"type","mapping":{"agent_memory":"#/components/schemas/AgentMemorySettings-Output","attach_file":"#/components/schemas/AttachFileSettings","code_execution":"#/components/schemas/CodeExecutionSettings-Output","code_mode":"#/components/schemas/CodeModeSettings-Output","create_files":"#/components/schemas/CreateFilesSettings-Output","documentation":"#/components/schemas/DocumentationSettings-Output","docx":"#/components/schemas/DocxSettings-Output","excel":"#/components/schemas/ExcelSettings-Output","failure_probe":"#/components/schemas/FailureProbeSettings-Output","files":"#/components/schemas/FileSettings-Output","filesystem":"#/components/schemas/FileSystemSettings-Output","guardrails":"#/components/schemas/GuardrailsSettings-Output","human_in_the_loop":"#/components/schemas/HumanInTheLoopSettings-Output","image_generation":"#/components/schemas/ImageGenerationSettings-Output","kb_selector":"#/components/schemas/KnowledgeBaseSelectorSettings-Output","memory":"#/components/schemas/MemorySettings-Output","noxus_qa":"#/components/schemas/NoxusQaSettings-Output","overflow":"#/components/schemas/OverflowSettings-Output","sandbox":"#/components/schemas/SandboxSettings-Output","schedule_tool":"#/components/schemas/ScheduleToolSettings-Output","subagent":"#/components/schemas/SubAgentSettings-Output","todos":"#/components/schemas/TodoSettings-Output","web_research":"#/components/schemas/WebResearchSettings-Output"}}},"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","requires_approval":false,"visible":true,"icon":"PersonStanding","bg_color":"blue.50","icon_color":"blue.500","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","requires_approval":false,"visible":true,"icon":"Globe","bg_color":"#D1FADF","icon_color":"#027A48","deprecated":false,"type":"web_research"},{"title":"Files","description":"Attach, generate, and work with files.","category":"QuickAction","enabled":false,"tool_display_icon":"Files","tool_display_message_start":"Working with files...","tool_display_message_end":"Done","requires_approval":false,"visible":true,"icon":"Files","bg_color":"#EFF6FF","icon_color":"#2B7FFF","deprecated":false,"type":"files","allow_html_graphs":true,"show_inline":true,"custom_author_name":false,"author_name":"","enable_python_sandbox":false,"enable_formula_eval":false,"experimental":false},{"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","requires_approval":false,"visible":true,"icon":"Brain","bg_color":"#f5f3ff","icon_color":"#8e51ff","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","requires_approval":false,"visible":false,"icon":"FolderOpen","bg_color":"#fef3c7","icon_color":"#f59e0b","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","requires_approval":false,"visible":true,"icon":"Terminal","bg_color":"#fef9c3","icon_color":"#ca8a04","deprecated":false,"type":"code_execution","timeout":60},{"title":"Agent Memory","description":"Persistent memory across all conversations","category":"QuickAction","enabled":false,"tool_display_icon":"BookOpen","tool_display_message_start":"Accessing agent memory...","tool_display_message_end":"Memory operation complete","requires_approval":false,"visible":false,"icon":"BookOpen","bg_color":"#fef3c7","icon_color":"#d97706","deprecated":false,"type":"agent_memory"},{"title":"Documentation","description":"Search and read Noxus platform documentation","category":"QuickAction","enabled":false,"tool_display_icon":"BookOpen","tool_display_message_start":"Searching documentation...","tool_display_message_end":"Documentation found","requires_approval":false,"visible":true,"icon":"BookOpen","bg_color":"#EFF6FF","icon_color":"#2B7FFF","deprecated":false,"type":"documentation"},{"title":"Task Tracking","description":"Track and manage tasks during the conversation","category":"QuickAction","enabled":false,"tool_display_icon":"ListTodo","tool_display_message_start":"Managing tasks...","tool_display_message_end":"Tasks updated","requires_approval":false,"visible":true,"icon":"ListTodo","bg_color":"#f0fdf4","icon_color":"#16a34a","deprecated":false,"type":"todos","enable_subtasks":false},{"title":"Image Generation","description":"Generate images from text prompts, shown inline in the chat.","category":"QuickAction","enabled":false,"tool_display_icon":"ImagePlus","tool_display_message_start":"Generating image...","tool_display_message_end":"Image generated","requires_approval":false,"visible":true,"icon":"ImagePlus","bg_color":"#FDF4FF","icon_color":"#C026D3","deprecated":false,"type":"image_generation"}],"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Tools","needs_confirmation":false,"show_optional_label":false,"type":"base_tools_field"},"order":80,"tab":"Actions","tool_mode":"hidden"},"actions":{"items":{"$ref":"#/components/schemas/ActionToolSettings-Output"},"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"},"feature_flag":"COWORKER_ACTION_TOOLS_ENABLED","order":40,"tab":"Actions","tool_mode":"hidden"},"insights_enabled":{"type":"boolean","title":"Insights Enabled","description":"Enable conversation analysis and insights dashboard.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enable Insights","needs_confirmation":false,"show_optional_label":false,"toggle_position":"left","type":"toggle"},"feature_flag":"AGENT_INSIGHTS_ENABLED","tab":"Insights","tool_mode":"hidden"},"insights_csat_enabled":{"type":"boolean","title":"Insights Csat Enabled","description":"Collect customer satisfaction (CSAT) ratings at end of conversations.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enable CSAT","needs_confirmation":false,"show_optional_label":false,"toggle_position":"left","type":"toggle"},"feature_flag":"AGENT_INSIGHTS_ENABLED","rules":[{"config_source":"insights_enabled","type":"visible_if","value":true}],"tab":"Insights","tool_mode":"hidden"},"insights_csat_sampling_rate":{"type":"number","title":"Insights Csat Sampling Rate","description":"Fraction of conversations that get a CSAT prompt (1.0 = every conversation).","default":1.0,"display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"CSAT Sampling Rate","max":1.0,"min":0.0,"needs_confirmation":false,"show_optional_label":false,"step":0.05,"type":"number_slider"},"feature_flag":"AGENT_INSIGHTS_ENABLED","rules":[{"conds":[{"config_source":"insights_enabled","type":"visible_if","value":true},{"config_source":"insights_csat_enabled","type":"visible_if","value":true}],"mode":"and","type":"visible_if_group"}],"tab":"Insights","tool_mode":"hidden"},"insights_csat_agent_tool_enabled":{"type":"boolean","title":"Insights Csat Agent Tool Enabled","description":"Let the agent decide when to show the CSAT form via a tool call.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Agent Feedback Tool","needs_confirmation":false,"show_optional_label":false,"toggle_position":"left","type":"toggle"},"feature_flag":"AGENT_INSIGHTS_ENABLED","rules":[{"conds":[{"config_source":"insights_enabled","type":"visible_if","value":true},{"config_source":"insights_csat_enabled","type":"visible_if","value":true}],"mode":"and","type":"visible_if_group"}],"tab":"Insights","tool_mode":"hidden"},"insights_csat_agent_tool_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"string"}],"title":"Insights Csat Agent Tool Instructions","description":"Custom instructions for when the agent should request customer feedback.","default":"","display":{"col_span":12,"hide_toolbar":false,"is_disabled":false,"is_subconfig":false,"label":"Feedback Tool Instructions","needs_confirmation":false,"number_of_lines":5,"placeholder":"e.g. Ask for feedback once the customer confirms their issue is solved. Never ask during troubleshooting.","show_optional_label":false,"type":"big_text"},"feature_flag":"AGENT_INSIGHTS_ENABLED","rules":[{"conds":[{"config_source":"insights_enabled","type":"visible_if","value":true},{"config_source":"insights_csat_enabled","type":"visible_if","value":true},{"config_source":"insights_csat_agent_tool_enabled","type":"visible_if","value":true}],"mode":"and","type":"visible_if_group"}],"tab":"Insights","tool_mode":"hidden"},"insights_csat_auto_enabled":{"type":"boolean","title":"Insights Csat Auto Enabled","description":"Automatically show the CSAT form at the end of an agent turn (rule-based, no tool call). Independent of the agent feedback tool.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Automatic Feedback Request","needs_confirmation":false,"show_optional_label":false,"toggle_position":"left","type":"toggle"},"feature_flag":"AGENT_INSIGHTS_ENABLED","rules":[{"conds":[{"config_source":"insights_enabled","type":"visible_if","value":true},{"config_source":"insights_csat_enabled","type":"visible_if","value":true}],"mode":"and","type":"visible_if_group"}],"tab":"Insights","tool_mode":"hidden"},"insights_csat_auto_min_messages":{"type":"integer","title":"Insights Csat Auto Min Messages","description":"Only auto-request feedback once the user has sent at least this many messages.","default":2,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Minimum user messages before auto request","needs_confirmation":false,"show_optional_label":false,"type":"number"},"feature_flag":"AGENT_INSIGHTS_ENABLED","rules":[{"conds":[{"config_source":"insights_enabled","type":"visible_if","value":true},{"config_source":"insights_csat_enabled","type":"visible_if","value":true},{"config_source":"insights_csat_auto_enabled","type":"visible_if","value":true}],"mode":"and","type":"visible_if_group"}],"tab":"Insights","tool_mode":"hidden"},"insights_custom_definitions":{"items":{"$ref":"#/components/schemas/CustomInsightDefinition"},"type":"array","title":"Insights Custom Definitions","description":"User-defined situations to detect in each conversation.","default":[],"feature_flag":"AGENT_INSIGHTS_ENABLED","tab":"Insights","tool_mode":"hidden","visible":false},"tool_grant_scope":{"type":"string","enum":["workspace","user"],"title":"Tool Grant Scope","description":"Whether 'Always Allow' tool grants apply to all workspace users or only the granting user","default":"workspace","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"Tool Grant Scope","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"label":"Workspace","value":"workspace"},{"label":"Per User","value":"user"}]},"feature_flag":"AGENT_TOOL_APPROVALS_ENABLED","order":70,"tab":"Actions","tool_mode":"hidden"}},"type":"object","title":"CoWorkerSettings"},"CodeExecutionSettings-Input":{"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","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Terminal"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Running code..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Code executed"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Terminal"},"bg_color":{"type":"string","title":"Bg Color","default":"#fef9c3"},"icon_color":{"type":"string","title":"Icon Color","default":"#ca8a04"},"deprecated":{"type":"boolean","title":"Deprecated","description":"Whether this tool type is deprecated and should be hidden from the UI","default":false},"type":{"type":"string","const":"code_execution","title":"Type","default":"code_execution"},"timeout":{"type":"integer","title":"Timeout","description":"Maximum execution time in seconds","default":60,"display":{"col_span":12,"hide_input":false,"hide_number":false,"is_disabled":false,"is_subconfig":false,"label":"Timeout (seconds)","max":300,"min":10,"needs_confirmation":false,"show_optional_label":false,"step":10,"type":"number_slider"},"tab":"Configuration","tool_mode":"hidden"}},"type":"object","title":"CodeExecutionSettings"},"CodeExecutionSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Code Execution"},"description":{"type":"string","title":"Description","default":"Run Python code in a sandboxed environment"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Terminal"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Running code..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Code executed"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Terminal"},"bg_color":{"type":"string","title":"Bg Color","default":"#fef9c3"},"icon_color":{"type":"string","title":"Icon Color","default":"#ca8a04"},"deprecated":{"type":"boolean","title":"Deprecated","description":"Whether this tool type is deprecated and should be hidden from the UI","default":false},"type":{"type":"string","const":"code_execution","title":"Type","default":"code_execution"},"timeout":{"type":"integer","title":"Timeout","description":"Maximum execution time in seconds","default":60,"display":{"col_span":12,"hide_input":false,"hide_number":false,"is_disabled":false,"is_subconfig":false,"label":"Timeout (seconds)","max":300,"min":10,"needs_confirmation":false,"show_optional_label":false,"step":10,"type":"number_slider"},"tab":"Configuration","tool_mode":"hidden"}},"type":"object","title":"CodeExecutionSettings"},"CodeModeSettings-Input":{"properties":{"title":{"type":"string","title":"Title","default":"Code Mode"},"description":{"type":"string","title":"Description","default":"Call platform tools from one Python script instead of one call per turn"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Terminal"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Running orchestration code..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Code executed"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Terminal"},"bg_color":{"type":"string","title":"Bg Color","default":"#ede9fe"},"icon_color":{"type":"string","title":"Icon Color","default":"#7c3aed"},"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_mode","title":"Type","default":"code_mode"}},"type":"object","title":"CodeModeSettings","description":"Route selected tools through a Monty ``run_code`` sandbox.\n\nThe tools each capability declared read-only leave the model's native\ntool list and become async functions inside one ``run_code`` tool:\nthe model writes the orchestration (loops, filters, chained calls) instead\nof round-tripping every intermediate result through its context. Tool\nbodies still execute host-side."},"CodeModeSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Code Mode"},"description":{"type":"string","title":"Description","default":"Call platform tools from one Python script instead of one call per turn"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Terminal"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Running orchestration code..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Code executed"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Terminal"},"bg_color":{"type":"string","title":"Bg Color","default":"#ede9fe"},"icon_color":{"type":"string","title":"Icon Color","default":"#7c3aed"},"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_mode","title":"Type","default":"code_mode"}},"type":"object","title":"CodeModeSettings","description":"Route selected tools through a Monty ``run_code`` sandbox.\n\nThe tools each capability declared read-only leave the model's native\ntool list and become async functions inside one ``run_code`` tool:\nthe model writes the orchestration (loops, filters, chained calls) instead\nof round-tripping every intermediate result through its context. Tool\nbodies still execute host-side."},"CompactionPart":{"properties":{"content":{"anyOf":[{"type":"string"},{"type":"null"}],"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":"compaction","title":"Part Kind","default":"compaction"}},"type":"object","title":"CompactionPart","description":"A compaction part that summarizes previous conversation history.\n\nCompaction parts contain an opaque or readable summary of prior messages,\nproduced by provider-specific compaction mechanisms. They must be round-tripped\nback to the same provider in subsequent requests.\n\nFor Anthropic, `content` contains a readable text summary.\nFor OpenAI, `content` is `None` and the encrypted data is stored in `provider_details`."},"ConnectorAddress":{"properties":{"connector_name":{"type":"string","title":"Connector Name"},"node_id":{"type":"string","title":"Node Id"},"key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Key"},"optional":{"type":"boolean","title":"Optional","default":false}},"type":"object","required":["connector_name","node_id"],"title":"ConnectorAddress"},"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"},"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"},"ConversationFunnel":{"properties":{"started":{"type":"integer","title":"Started"},"engaged":{"type":"integer","title":"Engaged"},"reached_outcome":{"type":"integer","title":"Reached Outcome"},"total":{"type":"integer","title":"Total"},"outcomes":{"items":{"$ref":"#/components/schemas/FunnelOutcome"},"type":"array","title":"Outcomes"},"resolution_rate":{"type":"number","title":"Resolution Rate"}},"type":"object","required":["started","engaged","reached_outcome","total","outcomes","resolution_rate"],"title":"ConversationFunnel","description":"The conversation funnel: stage drop-off + terminal outcomes."},"ConversationHistoryPage":{"properties":{"has_more":{"type":"boolean","title":"Has More"},"before":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Before"}},"type":"object","required":["has_more"],"title":"ConversationHistoryPage","description":"Where a paged conversation read stopped."},"CreateApiKeyRequest":{"properties":{"name":{"type":"string","title":"Name"},"tenant_admin":{"type":"boolean","title":"Tenant Admin","default":false},"permissions":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Permissions"}},"type":"object","required":["name"],"title":"CreateApiKeyRequest"},"CreateAssistant":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Url"},"visible":{"type":"boolean","title":"Visible","default":true},"author_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Author Name"},"definition":{"anyOf":[{"$ref":"#/components/schemas/CoWorkerSettings-Input"},{"type":"null"}]}},"additionalProperties":true,"type":"object","required":["name"],"title":"CreateAssistant"},"CreateConversation":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"settings":{"anyOf":[{"$ref":"#/components/schemas/CoWorkerSettings-Input"},{"type":"null"}]},"preview":{"type":"boolean","title":"Preview","default":false},"assistant_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Assistant Version Id"},"variables":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Variables"}},"type":"object","title":"CreateConversation"},"CreateDocument":{"properties":{"status":{"$ref":"#/components/schemas/DocumentStatus"},"prefix":{"type":"string","title":"Prefix","default":"/"},"name":{"type":"string","title":"Name"},"doc_metadata":{"additionalProperties":true,"type":"object","title":"Doc Metadata","default":{}},"run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Run Id"}},"type":"object","required":["status","name"],"title":"CreateDocument"},"CreateEvaluatorRequest":{"properties":{"type":{"type":"string","title":"Type"},"name":{"type":"string","title":"Name"},"config":{"additionalProperties":true,"type":"object","title":"Config","default":{}}},"type":"object","required":["type","name"],"title":"CreateEvaluatorRequest","description":"Request to create an evaluator.\n\nOnly behavioral config is passed - display_name/description are derived from the type."},"CreateFilesSettings-Input":{"properties":{"title":{"type":"string","title":"Title","default":"Create Files"},"description":{"type":"string","title":"Description","default":"Generate files and surface them in the chat."},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"FileInput"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Working with files..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Done"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","default":false},"icon":{"type":"string","title":"Icon","default":"FileInput"},"bg_color":{"type":"string","title":"Bg Color","default":"#EFF6FF"},"icon_color":{"type":"string","title":"Icon Color","default":"#2B7FFF"},"deprecated":{"type":"boolean","title":"Deprecated","default":true},"type":{"type":"string","const":"create_files","title":"Type","default":"create_files"},"allow_html_graphs":{"type":"boolean","title":"Allow Html Graphs","description":"Instruct the agent to use self-contained HTML (Plotly, Chart.js, ...) when generating charts and visualizations.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Use HTML for charts","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"show_inline":{"type":"boolean","title":"Show Inline","description":"Render HTML and images directly in the chat instead of as a card.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Render artifacts inline","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"}},"type":"object","title":"CreateFilesSettings","description":"Unified setting for the file creation + presentation tools.\n\nEnables ``create_file`` (generate text/markdown/html/json/csv/code into the\nsession) and ``present_file`` (surface a session file as a preview/download\ncard in the chat). They share one toggle because they're useless apart —\ncreating a file the user can't see is dead weight, and presenting nothing\nis a no-op."},"CreateFilesSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Create Files"},"description":{"type":"string","title":"Description","default":"Generate files and surface them in the chat."},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"FileInput"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Working with files..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Done"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","default":false},"icon":{"type":"string","title":"Icon","default":"FileInput"},"bg_color":{"type":"string","title":"Bg Color","default":"#EFF6FF"},"icon_color":{"type":"string","title":"Icon Color","default":"#2B7FFF"},"deprecated":{"type":"boolean","title":"Deprecated","default":true},"type":{"type":"string","const":"create_files","title":"Type","default":"create_files"},"allow_html_graphs":{"type":"boolean","title":"Allow Html Graphs","description":"Instruct the agent to use self-contained HTML (Plotly, Chart.js, ...) when generating charts and visualizations.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Use HTML for charts","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"show_inline":{"type":"boolean","title":"Show Inline","description":"Render HTML and images directly in the chat instead of as a card.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Render artifacts inline","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"}},"type":"object","title":"CreateFilesSettings","description":"Unified setting for the file creation + presentation tools.\n\nEnables ``create_file`` (generate text/markdown/html/json/csv/code into the\nsession) and ``present_file`` (surface a session file as a preview/download\ncard in the chat). They share one toggle because they're useless apart —\ncreating a file the user can't see is dead weight, and presenting nothing\nis a no-op."},"CreateGroupRequest":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"settings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Settings"}},"type":"object","required":["name","description"],"title":"CreateGroupRequest"},"CreateKnowledgeBase":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"document_types":{"items":{"type":"string"},"type":"array","title":"Document Types","default":[]},"status":{"$ref":"#/components/schemas/TrainStatus","default":"created"},"kb_type":{"$ref":"#/components/schemas/KBType","default":"entity"},"workflow_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workflow Id"},"node_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Node Id"},"settings_":{"anyOf":[{"$ref":"#/components/schemas/KBConfig"},{"type":"null"}]},"version":{"type":"string","enum":["v2","v3"],"title":"Version","default":"v3"}},"type":"object","required":["name","description"],"title":"CreateKnowledgeBase"},"CreateRunRequest":{"properties":{"input":{"additionalProperties":true,"type":"object","title":"Input"},"node_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Node Ids"},"single_node_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Single Node Id"},"group_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group Id"},"workflow_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workflow Version Id"},"tracing":{"type":"boolean","title":"Tracing","default":false},"debugger":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Debugger"},"callback_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Callback Url"}},"type":"object","required":["input"],"title":"CreateRunRequest"},"CreateSandboxIn":{"properties":{"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"Human-readable name for this sandbox."},"persistent":{"type":"boolean","title":"Persistent","description":"Keep the sandbox alive across idle periods instead of letting the reaper collect it.","default":false}},"type":"object","title":"CreateSandboxIn"},"CreateSystemKeyRequest":{"properties":{"name":{"type":"string","title":"Name"},"permissions":{"items":{"type":"string"},"type":"array","title":"Permissions","description":"Tenant-wide permissions to grant (subset of TENANT_PERMISSIONS)."},"tenant_admin":{"type":"boolean","title":"Tenant Admin","description":"Grant full tenant-admin access instead of specific permissions.","default":false}},"type":"object","required":["name"],"title":"CreateSystemKeyRequest"},"CreateTableRequest":{"properties":{"name":{"type":"string","maxLength":56,"title":"Name"},"id_type":{"type":"string","enum":["uuid","autoincrement"],"title":"Id Type","default":"uuid"},"description":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Description"},"columns":{"items":{"$ref":"#/components/schemas/DataTableColumn"},"type":"array","title":"Columns","default":[]}},"type":"object","required":["name"],"title":"CreateTableRequest"},"CreateTestCaseRequest":{"properties":{"name":{"type":"string","title":"Name"},"inputs":{"additionalProperties":true,"type":"object","title":"Inputs"},"expected_outputs":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Expected Outputs"}},"type":"object","required":["name","inputs"],"title":"CreateTestCaseRequest","description":"Request to create a test case.\n\nAccepts any format — normalization is handled by the service layer."},"CreateTriggerRequest":{"properties":{"definition":{"additionalProperties":true,"type":"object","title":"Definition"},"name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Name"},"workflow_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workflow Version Id"}},"type":"object","required":["definition"],"title":"CreateTriggerRequest"},"CreateUserRequest":{"properties":{"email":{"type":"string","title":"Email"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"tenant_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tenant Role","description":"Tenant role id or name; defaults to Base. Any other needs org:admin"},"workspaces":{"items":{"$ref":"#/components/schemas/WorkspaceAssignment"},"type":"array","title":"Workspaces","description":"Workspace roles other than Runner need org:admin. Without any, the user joins the fallback workspace"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata"},"send_invite":{"type":"boolean","title":"Send Invite","default":false}},"type":"object","required":["email"],"title":"CreateUserRequest"},"CreateWorkflowRequest":{"properties":{"name":{"type":"string","title":"Name"},"type":{"$ref":"#/components/schemas/WorkflowType"},"definition":{"additionalProperties":true,"type":"object","title":"Definition"},"error_handler":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Error Handler"},"meta":{"anyOf":[{"$ref":"#/components/schemas/WorkflowMeta"},{"type":"null"}]}},"type":"object","required":["name","type","definition"],"title":"CreateWorkflowRequest"},"CreateWorkflowVersionRequest":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"definition":{"additionalProperties":true,"type":"object","title":"Definition"}},"type":"object","required":["name","definition"],"title":"CreateWorkflowVersionRequest"},"CustomContainer":{"properties":{"total_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Size"},"taken":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Taken"},"truncated":{"type":"boolean","title":"Truncated","default":false},"preview_file":{"anyOf":[{"$ref":"#/components/schemas/FileType"},{"type":"null"}]},"list_offset":{"type":"integer","title":"List Offset","default":0},"type":{"type":"string","const":"Custom","title":"Type","default":"Custom"},"value":{"title":"Value"}},"type":"object","required":["value"],"title":"CustomContainer"},"CustomInsightCount":{"properties":{"name":{"type":"string","title":"Name"},"count":{"type":"integer","title":"Count"},"days":{"items":{"$ref":"#/components/schemas/CustomInsightDay"},"type":"array","title":"Days","default":[]}},"type":"object","required":["name","count"],"title":"CustomInsightCount"},"CustomInsightCounts":{"properties":{"insights":{"items":{"$ref":"#/components/schemas/CustomInsightCount"},"type":"array","title":"Insights"}},"type":"object","required":["insights"],"title":"CustomInsightCounts"},"CustomInsightDay":{"properties":{"date":{"type":"string","title":"Date"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["date","count"],"title":"CustomInsightDay"},"CustomInsightDefinition":{"properties":{"name":{"type":"string","maxLength":200,"title":"Name"},"prompt":{"type":"string","maxLength":2000,"title":"Prompt"},"scope":{"type":"string","enum":["all","resolved","unresolved","escalated","abandoned","rated-high","rated-low"],"title":"Scope","default":"all"}},"type":"object","required":["name","prompt"],"title":"CustomInsightDefinition","description":"A user-defined situation to detect in a conversation (binary)."},"CustomSource":{"properties":{"source_type":{"type":"string","const":"Custom","title":"Source Type","default":"Custom"},"subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subtype"},"config_cls":{"title":"Config Cls"},"config":{"$ref":"#/components/schemas/CustomSourceConfig"},"integration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration"},"image":{"type":"string","title":"Image","default":"icon:Globe"},"name":{"type":"string","title":"Name","default":"Custom"},"exposed":{"type":"boolean","title":"Exposed","default":true}},"type":"object","required":["config"],"title":"CustomSource"},"CustomSourceConfig":{"properties":{},"additionalProperties":true,"type":"object","title":"CustomSourceConfig"},"DataTableColumn":{"properties":{"name":{"type":"string","title":"Name"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"type":{"type":"string","enum":["string","number","boolean","datetime","file","reference"],"title":"Type"},"default":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"boolean"},{"type":"null"}],"title":"Default"},"references":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"References"},"on_delete":{"type":"string","enum":["restrict","cascade","set_null"],"title":"On Delete","default":"restrict"}},"type":"object","required":["name","type"],"title":"DataTableColumn"},"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."},"DateTimeContainer":{"properties":{"total_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Size"},"taken":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Taken"},"truncated":{"type":"boolean","title":"Truncated","default":false},"preview_file":{"anyOf":[{"$ref":"#/components/schemas/FileType"},{"type":"null"}]},"list_offset":{"type":"integer","title":"List Offset","default":0},"type":{"type":"string","const":"datetime","title":"Type","default":"datetime"},"value":{"title":"Value"}},"type":"object","required":["value"],"title":"DateTimeContainer"},"DeleteOut":{"properties":{"success":{"type":"boolean","title":"Success"}},"type":"object","required":["success"],"title":"DeleteOut"},"DeleteRunsRequest":{"properties":{"run_ids":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Run Ids"},"filters":{"anyOf":[{"$ref":"#/components/schemas/RunFilters"},{"type":"null"}]},"expected_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expected Count"},"dry_run":{"type":"boolean","title":"Dry Run","default":false}},"type":"object","title":"DeleteRunsRequest","description":"Public run deletion. ``filters.to_date`` is the \"older than\" knob; only\nfinished runs (completed, failed, stopped) are deleted, the rest are\nreported under ``errors``. ``dry_run`` only counts."},"DeleteRunsResult":{"properties":{"succeeded":{"type":"integer","title":"Succeeded"},"failed":{"type":"integer","title":"Failed"},"errors":{"additionalProperties":{"type":"string"},"type":"object","title":"Errors"},"matched":{"type":"integer","title":"Matched"}},"type":"object","required":["succeeded","failed","errors","matched"],"title":"DeleteRunsResult"},"DeploymentCreate":{"properties":{"channel_type":{"type":"string","title":"Channel Type"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"alias":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Alias"},"config":{"additionalProperties":true,"type":"object","title":"Config","default":{}},"assistant_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Assistant Version Id"}},"type":"object","required":["channel_type"],"title":"DeploymentCreate"},"DeploymentEvent":{"properties":{"id":{"type":"string","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"state":{"type":"string","title":"State"},"event_type":{"type":"string","title":"Event Type"},"started_conversation":{"type":"boolean","title":"Started Conversation","default":false},"conversation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Conversation Id"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"},"ignore_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ignore Reason"},"event_data":{"additionalProperties":true,"type":"object","title":"Event Data","default":{}}},"type":"object","required":["id","created_at","state","event_type"],"title":"DeploymentEvent","description":"Event entry for the deployment events view."},"DeploymentResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"alias":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Alias"},"assistant_id":{"type":"string","format":"uuid","title":"Assistant Id"},"channel_type":{"type":"string","title":"Channel Type"},"config":{"additionalProperties":true,"type":"object","title":"Config","default":{}},"is_active":{"type":"boolean","title":"Is Active"},"published_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Published At"},"trigger_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Trigger Id"},"assistant_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Assistant Version Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"effective_active":{"type":"boolean","title":"Effective Active"},"toggle_on_action":{"type":"string","enum":["activate","resume"],"title":"Toggle On Action"},"toggle_off_action":{"type":"string","enum":["deactivate","pause"],"title":"Toggle Off Action"},"config_read_only":{"type":"boolean","title":"Config Read Only"},"native_teams_app":{"anyOf":[{"$ref":"#/components/schemas/NativeTeamsAppState"},{"type":"null"}]}},"type":"object","required":["id","name","assistant_id","channel_type","is_active","published_at","trigger_id","assistant_version_id","created_at","updated_at","effective_active","toggle_on_action","toggle_off_action","config_read_only"],"title":"DeploymentResponse"},"DeploymentUpdate":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"alias":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Alias"},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Config"},"assistant_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Assistant Version Id"}},"type":"object","title":"DeploymentUpdate"},"DictContainer":{"properties":{"total_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Size"},"taken":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Taken"},"truncated":{"type":"boolean","title":"Truncated","default":false},"preview_file":{"anyOf":[{"$ref":"#/components/schemas/FileType"},{"type":"null"}]},"list_offset":{"type":"integer","title":"List Offset","default":0},"type":{"type":"string","const":"dict","title":"Type","default":"dict"},"value":{"title":"Value"}},"type":"object","required":["value"],"title":"DictContainer"},"DocumentMetadata":{"properties":{"kind":{"type":"string","const":"document","title":"Kind","default":"document"},"word_count":{"type":"integer","title":"Word Count"},"paragraph_count":{"type":"integer","title":"Paragraph Count"},"page_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Page Count"}},"type":"object","required":["word_count","paragraph_count"],"title":"DocumentMetadata","description":"Structural metadata for a word-processing document (Word).\n\n``page_count`` is the authoring app's cached count from\n``docProps/app.xml`` — present only for Word-authored files, ``None`` when\nthe document came from another tool (Google Docs, LibreOffice, python-docx)\nthat does not write the cache. ``word_count`` / ``paragraph_count`` are\nderived from the body text and always populated."},"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"},"DocumentResult":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"kb_id":{"type":"string","format":"uuid","title":"Kb Id"},"file_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"File Id"},"name":{"type":"string","title":"Name"},"status":{"$ref":"#/components/schemas/DocumentStatus"},"short_summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Short Summary"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary"},"doc_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Type"},"doc_metadata":{"additionalProperties":true,"type":"object","title":"Doc Metadata"},"prefix":{"type":"string","title":"Prefix"},"m_content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"M Content Type"},"m_source_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"M Source Type"},"m_source_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"M Source Metadata"}},"type":"object","required":["id","created_at","updated_at","group_id","kb_id","file_id","name","status","short_summary","summary","doc_type","doc_metadata","prefix","m_content_type","m_source_type","m_source_metadata"],"title":"DocumentResult"},"DocumentSource":{"properties":{"source_type":{"type":"string","const":"Document","title":"Source Type","default":"Document"},"subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subtype"},"config_cls":{"title":"Config Cls"},"config":{"$ref":"#/components/schemas/DocumentSourceConfig"},"integration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration"},"image":{"type":"string","title":"Image","default":""},"name":{"type":"string","title":"Name","default":"File"},"exposed":{"type":"boolean","title":"Exposed","default":false}},"type":"object","required":["config"],"title":"DocumentSource"},"DocumentSourceConfig":{"properties":{"files":{"items":{"$ref":"#/components/schemas/File"},"type":"array","title":"Files","display":{"can_select_multiple_files":false,"col_span":12,"isPublic":false,"is_disabled":false,"is_subconfig":false,"label":"Files","needs_confirmation":false,"show_optional_label":false,"type":"file_array","variant":"regular"},"tab":"Configuration","tool_mode":"hidden"}},"type":"object","title":"DocumentSourceConfig"},"DocumentStatus":{"type":"string","enum":["trained","training","error","uploaded","folder","outdated"],"title":"DocumentStatus"},"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.\n\nThis identifier can be provided to the model in a message to allow it to refer to this file in a tool call argument,\nand the tool can look up the file in question by iterating over the message history and finding the matching `FileUrl`.\n\nThis identifier is only automatically passed to the model when the `FileUrl` is returned by a tool.\nIf you're passing the `FileUrl` as a user message, it's up to you to include a separate text part with the identifier,\ne.g. \"This is file <identifier>:\" preceding the `FileUrl`.\n\nIt's also included in inline-text delimiters for providers that require inlining text documents, so the model can\ndistinguish multiple files.","readOnly":true}},"type":"object","required":["url","media_type","identifier"],"title":"DocumentUrl","description":"The URL of the document."},"DocumentationSettings-Input":{"properties":{"title":{"type":"string","title":"Title","default":"Documentation"},"description":{"type":"string","title":"Description","default":"Search and read Noxus platform documentation"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"BookOpen","tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Searching documentation...","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Start message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when searching docs.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Documentation found","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"End message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when search completes.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"BookOpen"},"bg_color":{"type":"string","title":"Bg Color","default":"#EFF6FF"},"icon_color":{"type":"string","title":"Icon Color","default":"#2B7FFF"},"deprecated":{"type":"boolean","title":"Deprecated","description":"Whether this tool type is deprecated and should be hidden from the UI","default":false},"type":{"type":"string","const":"documentation","title":"Type","default":"documentation"}},"type":"object","title":"DocumentationSettings"},"DocumentationSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Documentation"},"description":{"type":"string","title":"Description","default":"Search and read Noxus platform documentation"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"BookOpen","tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Searching documentation...","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Start message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when searching docs.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Documentation found","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"End message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when search completes.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"BookOpen"},"bg_color":{"type":"string","title":"Bg Color","default":"#EFF6FF"},"icon_color":{"type":"string","title":"Icon Color","default":"#2B7FFF"},"deprecated":{"type":"boolean","title":"Deprecated","description":"Whether this tool type is deprecated and should be hidden from the UI","default":false},"type":{"type":"string","const":"documentation","title":"Type","default":"documentation"}},"type":"object","title":"DocumentationSettings"},"DocxSettings-Input":{"properties":{"title":{"type":"string","title":"Title","default":"Word Document"},"description":{"type":"string","title":"Description","default":"Read, edit, and comment on Word (.docx) files using track changes."},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":true},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"FileText"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Editing Word document..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Word document edit complete"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","default":false},"icon":{"type":"string","title":"Icon","default":"FileText"},"bg_color":{"type":"string","title":"Bg Color","default":"#dbeafe"},"icon_color":{"type":"string","title":"Icon Color","default":"#2563eb"},"deprecated":{"type":"boolean","title":"Deprecated","default":true},"type":{"type":"string","const":"docx","title":"Type","default":"docx"},"author_name":{"type":"string","title":"Author Name","description":"Author shown on track-change revisions and comments.","default":"Docx Agent","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Track-change author","needs_confirmation":false,"number_of_lines":1,"placeholder":"Docx Agent","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"}},"type":"object","title":"DocxSettings"},"DocxSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Word Document"},"description":{"type":"string","title":"Description","default":"Read, edit, and comment on Word (.docx) files using track changes."},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":true},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"FileText"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Editing Word document..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Word document edit complete"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","default":false},"icon":{"type":"string","title":"Icon","default":"FileText"},"bg_color":{"type":"string","title":"Bg Color","default":"#dbeafe"},"icon_color":{"type":"string","title":"Icon Color","default":"#2563eb"},"deprecated":{"type":"boolean","title":"Deprecated","default":true},"type":{"type":"string","const":"docx","title":"Type","default":"docx"},"author_name":{"type":"string","title":"Author Name","description":"Author shown on track-change revisions and comments.","default":"Docx Agent","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Track-change author","needs_confirmation":false,"number_of_lines":1,"placeholder":"Docx Agent","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"}},"type":"object","title":"DocxSettings"},"DynamicToolApprovalRequestedPart":{"properties":{"type":{"type":"string","const":"dynamic-tool","title":"Type","default":"dynamic-tool"},"toolName":{"type":"string","title":"Toolname"},"toolCallId":{"type":"string","title":"Toolcallid"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"state":{"type":"string","const":"approval-requested","title":"State","default":"approval-requested"},"input":{"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":["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"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"state":{"type":"string","const":"approval-responded","title":"State","default":"approval-responded"},"input":{"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":["toolName","toolCallId","input"],"title":"DynamicToolApprovalRespondedPart","description":"Dynamic tool part in approval-responded state (user approved/denied, execution pending)."},"DynamicToolInputAvailablePart":{"properties":{"type":{"type":"string","const":"dynamic-tool","title":"Type","default":"dynamic-tool"},"toolName":{"type":"string","title":"Toolname"},"toolCallId":{"type":"string","title":"Toolcallid"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"state":{"type":"string","const":"input-available","title":"State","default":"input-available"},"input":{"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":["toolName","toolCallId","input"],"title":"DynamicToolInputAvailablePart","description":"Dynamic tool part in input-available state."},"DynamicToolInputStreamingPart":{"properties":{"type":{"type":"string","const":"dynamic-tool","title":"Type","default":"dynamic-tool"},"toolName":{"type":"string","title":"Toolname"},"toolCallId":{"type":"string","title":"Toolcallid"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"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":["toolName","toolCallId"],"title":"DynamicToolInputStreamingPart","description":"Dynamic tool part in input-streaming state."},"DynamicToolOutputAvailablePart":{"properties":{"type":{"type":"string","const":"dynamic-tool","title":"Type","default":"dynamic-tool"},"toolName":{"type":"string","title":"Toolname"},"toolCallId":{"type":"string","title":"Toolcallid"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"state":{"type":"string","const":"output-available","title":"State","default":"output-available"},"input":{"title":"Input"},"output":{"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":["toolName","toolCallId","input","output"],"title":"DynamicToolOutputAvailablePart","description":"Dynamic tool part in output-available state."},"DynamicToolOutputDeniedPart":{"properties":{"type":{"type":"string","const":"dynamic-tool","title":"Type","default":"dynamic-tool"},"toolName":{"type":"string","title":"Toolname"},"toolCallId":{"type":"string","title":"Toolcallid"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"state":{"type":"string","const":"output-denied","title":"State","default":"output-denied"},"input":{"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":["toolName","toolCallId","input"],"title":"DynamicToolOutputDeniedPart","description":"Dynamic tool part in output-denied state (tool was denied, terminal state)."},"DynamicToolOutputErrorPart":{"properties":{"type":{"type":"string","const":"dynamic-tool","title":"Type","default":"dynamic-tool"},"toolName":{"type":"string","title":"Toolname"},"toolCallId":{"type":"string","title":"Toolcallid"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"state":{"type":"string","const":"output-error","title":"State","default":"output-error"},"input":{"title":"Input"},"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":["toolName","toolCallId","input","errorText"],"title":"DynamicToolOutputErrorPart","description":"Dynamic tool part in output-error state."},"EdgePreview":{"properties":{"from_id":{"$ref":"#/components/schemas/ConnectorAddress"},"to_id":{"$ref":"#/components/schemas/ConnectorAddress"},"id":{"type":"string","title":"Id"}},"type":"object","required":["from_id","to_id","id"],"title":"EdgePreview"},"EdgeProgress":{"properties":{"status":{"$ref":"#/components/schemas/EdgeStatus","default":"pending"}},"type":"object","title":"EdgeProgress"},"EdgeStatus":{"type":"string","enum":["pending","active","skipped","completed"],"title":"EdgeStatus"},"EmbeddingHealth":{"properties":{"healthy":{"type":"boolean","title":"Healthy"},"message":{"type":"string","title":"Message","default":""},"embedding_model":{"type":"string","title":"Embedding Model","default":""}},"type":"object","required":["healthy"],"title":"EmbeddingHealth"},"EntitySource":{"type":"string","enum":["genie","user"],"title":"EntitySource","description":"Who authored an entity (or version). Absent/``user`` means a person made\nit; ``genie`` marks something the platform assistant created on their behalf,\nso the frontend can badge it."},"ErrorContainer":{"properties":{"total_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Size"},"taken":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Taken"},"truncated":{"type":"boolean","title":"Truncated","default":false},"preview_file":{"anyOf":[{"$ref":"#/components/schemas/FileType"},{"type":"null"}]},"list_offset":{"type":"integer","title":"List Offset","default":0},"type":{"type":"string","const":"_error","title":"Type","default":"_error"},"value":{"$ref":"#/components/schemas/SpotError"}},"type":"object","required":["value"],"title":"ErrorContainer"},"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"},"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"},"EvaluationRunWaitStatus":{"properties":{"evaluation_run_id":{"type":"string","format":"uuid","title":"Evaluation Run Id"},"status":{"type":"string","title":"Status"},"settled":{"type":"boolean","title":"Settled"},"counts":{"additionalProperties":{"type":"integer"},"type":"object","title":"Counts"}},"type":"object","required":["evaluation_run_id","status","settled","counts"],"title":"EvaluationRunWaitStatus"},"EvaluatorDefinition":{"properties":{"type":{"type":"string","title":"Type"},"display_name":{"type":"string","title":"Display Name"},"description":{"type":"string","title":"Description"},"icon":{"type":"string","title":"Icon","default":"Brackets"},"config_schema":{"additionalProperties":true,"type":"object","title":"Config Schema"},"expected_schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Expected Schema"},"category":{"type":"string","enum":["workflow","agent","knowledge_base"],"title":"Category","default":"workflow"},"group":{"type":"string","title":"Group","default":""},"docs_url":{"type":"string","title":"Docs Url","default":""}},"type":"object","required":["type","display_name","description","config_schema"],"title":"EvaluatorDefinition"},"EvaluatorResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"test_suite_id":{"type":"string","format":"uuid","title":"Test Suite Id"},"type":{"type":"string","title":"Type"},"name":{"type":"string","title":"Name"},"display_name":{"type":"string","title":"Display Name"},"description":{"type":"string","title":"Description"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"config":{"additionalProperties":true,"type":"object","title":"Config"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","test_suite_id","type","name","display_name","description","group_id","config","created_at"],"title":"EvaluatorResponse","description":"Response model for evaluator.\n\nNote:\n- `name` is the user-provided name for this evaluator instance (stored in DB)\n- `display_name` is the evaluator type's display name (derived from registry)\n- `description` is the evaluator type's description (derived from registry)"},"EvaluatorResultResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"evaluator_id":{"type":"string","format":"uuid","title":"Evaluator Id"},"test_case_id":{"type":"string","format":"uuid","title":"Test Case Id"},"workflow_run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workflow Run Id"},"workflow_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workflow Version Id"},"agent_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Version Id"},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Score"},"passed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Passed"},"feedback":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Feedback"},"definition_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Definition Hash"},"evaluator_config_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Evaluator Config Hash"},"test_case_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Test Case Hash"},"evaluator_set_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Evaluator Set Hash"},"is_outdated":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Outdated"},"outdated_reasons":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Outdated Reasons"},"status":{"type":"string","title":"Status"},"created_at":{"type":"string","format":"date-time","title":"Created At"}},"type":"object","required":["id","evaluator_id","test_case_id","workflow_run_id","workflow_version_id","agent_version_id","score","feedback","status","created_at"],"title":"EvaluatorResultResponse","description":"Response model for evaluation result."},"ExcelSettings-Input":{"properties":{"title":{"type":"string","title":"Title","default":"Excel"},"description":{"type":"string","title":"Description","default":"Read, analyze, and modify Excel spreadsheets"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":true},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"FileSpreadsheet"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Analyzing spreadsheet..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Spreadsheet analysis complete"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","default":false},"icon":{"type":"string","title":"Icon","default":"FileSpreadsheet"},"bg_color":{"type":"string","title":"Bg Color","default":"#dcfce7"},"icon_color":{"type":"string","title":"Icon Color","default":"#16a34a"},"deprecated":{"type":"boolean","title":"Deprecated","default":true},"type":{"type":"string","const":"excel","title":"Type","default":"excel"},"enable_python_sandbox":{"type":"boolean","title":"Enable Python Sandbox","default":false},"enable_formula_eval":{"type":"boolean","title":"Enable Formula Eval","default":false},"experimental":{"type":"boolean","title":"Experimental","default":false}},"type":"object","title":"ExcelSettings"},"ExcelSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Excel"},"description":{"type":"string","title":"Description","default":"Read, analyze, and modify Excel spreadsheets"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":true},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"FileSpreadsheet"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Analyzing spreadsheet..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Spreadsheet analysis complete"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","default":false},"icon":{"type":"string","title":"Icon","default":"FileSpreadsheet"},"bg_color":{"type":"string","title":"Bg Color","default":"#dcfce7"},"icon_color":{"type":"string","title":"Icon Color","default":"#16a34a"},"deprecated":{"type":"boolean","title":"Deprecated","default":true},"type":{"type":"string","const":"excel","title":"Type","default":"excel"},"enable_python_sandbox":{"type":"boolean","title":"Enable Python Sandbox","default":false},"enable_formula_eval":{"type":"boolean","title":"Enable Formula Eval","default":false},"experimental":{"type":"boolean","title":"Experimental","default":false}},"type":"object","title":"ExcelSettings"},"ExecutionOut":{"properties":{"stdout":{"type":"string","title":"Stdout"},"stderr":{"type":"string","title":"Stderr"},"exit_code":{"type":"integer","title":"Exit Code"},"timed_out":{"type":"boolean","title":"Timed Out"}},"type":"object","required":["stdout","stderr","exit_code","timed_out"],"title":"ExecutionOut"},"ExportFormat":{"type":"string","enum":["auto","v3","v4"],"title":"ExportFormat","description":"Wire format for an export/import payload.\n\n- ``auto`` (default both directions): export emits the default format\n  (currently ``v3`` base64, for back-compat with existing pipelines); import\n  detects the format from the payload content.\n- ``v4``: plaintext multi-doc YAML (`.nx`) — opt-in, requested on purpose.\n- ``v3``: legacy base64-encoded bundle."},"ExportPreviewResponse":{"properties":{"entities":{"items":{"$ref":"#/components/schemas/ExportableReference"},"type":"array","title":"Entities"},"warnings":{"items":{"$ref":"#/components/schemas/ExportWarning"},"type":"array","title":"Warnings"}},"type":"object","required":["entities","warnings"],"title":"ExportPreviewResponse"},"ExportWarning":{"properties":{"identifier":{"type":"string","title":"Identifier"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"type":{"$ref":"#/components/schemas/ExportWarningType"},"message":{"type":"string","title":"Message"}},"type":"object","required":["identifier","type","message"],"title":"ExportWarning"},"ExportWarningType":{"type":"string","enum":["kb_too_large","table_too_large","file_too_large","entity_not_found","entity_access_error","export_error","triggers_not_exported","app_deployment_not_exported","secret_found"],"title":"ExportWarningType"},"ExportableReference":{"properties":{"reference":{"type":"string","title":"Reference"},"type":{"type":"string","enum":["kb","workflow","assistant","file","inbox","connection","secret","deployment","table","trigger"],"title":"Type"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"}},"type":"object","required":["reference","type"],"title":"ExportableReference"},"FailureProbeSettings-Input":{"properties":{"title":{"type":"string","title":"Title","default":"Failure probe"},"description":{"type":"string","title":"Description","default":"Internal: makes the agent's tool call fail on purpose, to exercise tool-failure handling"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","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":"Bug"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Failing on purpose..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Failure probe complete"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Bug"},"bg_color":{"type":"string","title":"Bg Color","default":"#fef2f2"},"icon_color":{"type":"string","title":"Icon Color","default":"#e7000b"},"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":"failure_probe","title":"Type","default":"failure_probe"}},"type":"object","title":"FailureProbeSettings","description":"Makes an agent fail on demand, so tool-failure handling can be driven\nin a real conversation instead of only in a unit test.\n\nNoxus-internal, behind two independent gates. ``internal_only`` +\n``settings.shows_internal_test_tools()`` decides whether the tool exists on\nthis deployment at all — never on-prem, never production, and not\nconfigurable. ``AGENT_FAILURE_PROBE_ENABLED`` then decides which of our\ntenants see it, off by default like every other beta tool.\n\nThe flag is the weaker of the two on purpose: it is a convenience, and an\nadmin flipping it can never reach a customer deployment, because the\ndeployment gate is checked independently at build time."},"FailureProbeSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Failure probe"},"description":{"type":"string","title":"Description","default":"Internal: makes the agent's tool call fail on purpose, to exercise tool-failure handling"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","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":"Bug"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Failing on purpose..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Failure probe complete"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Bug"},"bg_color":{"type":"string","title":"Bg Color","default":"#fef2f2"},"icon_color":{"type":"string","title":"Icon Color","default":"#e7000b"},"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":"failure_probe","title":"Type","default":"failure_probe"}},"type":"object","title":"FailureProbeSettings","description":"Makes an agent fail on demand, so tool-failure handling can be driven\nin a real conversation instead of only in a unit test.\n\nNoxus-internal, behind two independent gates. ``internal_only`` +\n``settings.shows_internal_test_tools()`` decides whether the tool exists on\nthis deployment at all — never on-prem, never production, and not\nconfigurable. ``AGENT_FAILURE_PROBE_ENABLED`` then decides which of our\ntenants see it, off by default like every other beta tool.\n\nThe flag is the weaker of the two on purpose: it is a convenience, and an\nadmin flipping it can never reach a customer deployment, because the\ndeployment gate is checked independently at build time."},"FeedbackMeta":{"properties":{"feedback_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Feedback Reason"},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comment"}},"type":"object","title":"FeedbackMeta"},"File":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"uri":{"type":"string","title":"Uri"},"name":{"type":"string","title":"Name"},"content_type":{"type":"string","title":"Content Type","default":"text/plain"},"size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Size"},"content_metadata":{"anyOf":[{"oneOf":[{"$ref":"#/components/schemas/PdfMetadata"},{"$ref":"#/components/schemas/SpreadsheetMetadata"},{"$ref":"#/components/schemas/TabularMetadata"},{"$ref":"#/components/schemas/ImageMetadata"},{"$ref":"#/components/schemas/PresentationMetadata"},{"$ref":"#/components/schemas/DocumentMetadata"}],"discriminator":{"propertyName":"kind","mapping":{"document":"#/components/schemas/DocumentMetadata","image":"#/components/schemas/ImageMetadata","pdf":"#/components/schemas/PdfMetadata","presentation":"#/components/schemas/PresentationMetadata","spreadsheet":"#/components/schemas/SpreadsheetMetadata","tabular":"#/components/schemas/TabularMetadata"}}},{"type":"null"}],"title":"Content Metadata"},"source_type":{"$ref":"#/components/schemas/SourceType","default":"Document"},"source_metadata":{"anyOf":[{"$ref":"#/components/schemas/SourceMetadata"},{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Source Metadata"}},"additionalProperties":true,"type":"object","required":["uri","name"],"title":"File"},"FileDataContainer":{"properties":{"total_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Size"},"taken":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Taken"},"truncated":{"type":"boolean","title":"Truncated","default":false},"preview_file":{"anyOf":[{"$ref":"#/components/schemas/FileType"},{"type":"null"}]},"list_offset":{"type":"integer","title":"List Offset","default":0},"type":{"type":"string","const":"File","title":"Type","default":"File"},"value":{"anyOf":[{"$ref":"#/components/schemas/FileType"},{"items":{"$ref":"#/components/schemas/FileType"},"type":"array"},{},{"type":"null"}],"title":"Value"}},"type":"object","required":["value"],"title":"FileDataContainer"},"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","description":"A file response from a model."},"FileSettings-Input":{"properties":{"title":{"type":"string","title":"Title","default":"Files"},"description":{"type":"string","title":"Description","default":"Attach, generate, and work with files."},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Files"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Working with files..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Done"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Files"},"bg_color":{"type":"string","title":"Bg Color","default":"#EFF6FF"},"icon_color":{"type":"string","title":"Icon Color","default":"#2B7FFF"},"deprecated":{"type":"boolean","title":"Deprecated","description":"Whether this tool type is deprecated and should be hidden from the UI","default":false},"type":{"type":"string","const":"files","title":"Type","default":"files"},"allow_html_graphs":{"type":"boolean","title":"Allow Html Graphs","description":"Instruct the agent to use self-contained HTML (Plotly, Chart.js, ...) when generating charts and visualizations.","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Use HTML for charts","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"show_inline":{"type":"boolean","title":"Show Inline","description":"Render HTML and images directly in the chat instead of as a card.","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Render artifacts inline","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"custom_author_name":{"type":"boolean","title":"Custom Author Name","description":"Use a custom author for track-change revisions and comments. When off, the agent's name is used.","default":false,"accordion":"Word documents","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Custom track-change author","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"author_name":{"type":"string","title":"Author Name","description":"Author shown on track-change revisions and comments. Defaults to the agent's name when left unset.","default":"","accordion":"Word documents","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Track-change author","needs_confirmation":false,"number_of_lines":1,"placeholder":"The agent's name","show_optional_label":false,"show_refresh":false,"type":"text"},"rules":[{"config_source":"custom_author_name","type":"visible_if","value":true}],"tab":"Configuration","tool_mode":"hidden"},"enable_python_sandbox":{"type":"boolean","title":"Enable Python Sandbox","description":"Run pandas/Python over the workbook in the sandbox.","default":false,"accordion":"Spreadsheets","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Python sandbox","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"enable_formula_eval":{"type":"boolean","title":"Enable Formula Eval","description":"Evaluate spreadsheet formulas via the formulas library.","default":false,"accordion":"Spreadsheets","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Formula evaluation","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"experimental":{"type":"boolean","title":"Experimental","description":"Enable every experimental spreadsheet tool above.","default":false,"accordion":"Spreadsheets","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"All experimental spreadsheet tools","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false}},"type":"object","title":"FileSettings","description":"Unified file capability for the agent.\n\nOne master toggle that, when on, lets the user attach files and lets the\nagent generate + present them (``create_file``, ``present_file``,\n``sandbox_publish_file``). Word (.docx) and Excel editing are offered\non-demand whenever a matching file is in the session — no separate toggles.\n\nThe always-on session-file reader (``list_files``/``read_file``) is a\nseparate, hidden capability (``FileSystemSettings``) and is unaffected."},"FileSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Files"},"description":{"type":"string","title":"Description","default":"Attach, generate, and work with files."},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Files"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Working with files..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Done"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Files"},"bg_color":{"type":"string","title":"Bg Color","default":"#EFF6FF"},"icon_color":{"type":"string","title":"Icon Color","default":"#2B7FFF"},"deprecated":{"type":"boolean","title":"Deprecated","description":"Whether this tool type is deprecated and should be hidden from the UI","default":false},"type":{"type":"string","const":"files","title":"Type","default":"files"},"allow_html_graphs":{"type":"boolean","title":"Allow Html Graphs","description":"Instruct the agent to use self-contained HTML (Plotly, Chart.js, ...) when generating charts and visualizations.","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Use HTML for charts","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"show_inline":{"type":"boolean","title":"Show Inline","description":"Render HTML and images directly in the chat instead of as a card.","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Render artifacts inline","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"custom_author_name":{"type":"boolean","title":"Custom Author Name","description":"Use a custom author for track-change revisions and comments. When off, the agent's name is used.","default":false,"accordion":"Word documents","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Custom track-change author","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"author_name":{"type":"string","title":"Author Name","description":"Author shown on track-change revisions and comments. Defaults to the agent's name when left unset.","default":"","accordion":"Word documents","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Track-change author","needs_confirmation":false,"number_of_lines":1,"placeholder":"The agent's name","show_optional_label":false,"show_refresh":false,"type":"text"},"rules":[{"config_source":"custom_author_name","type":"visible_if","value":true}],"tab":"Configuration","tool_mode":"hidden"},"enable_python_sandbox":{"type":"boolean","title":"Enable Python Sandbox","description":"Run pandas/Python over the workbook in the sandbox.","default":false,"accordion":"Spreadsheets","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Python sandbox","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"enable_formula_eval":{"type":"boolean","title":"Enable Formula Eval","description":"Evaluate spreadsheet formulas via the formulas library.","default":false,"accordion":"Spreadsheets","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Formula evaluation","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"experimental":{"type":"boolean","title":"Experimental","description":"Enable every experimental spreadsheet tool above.","default":false,"accordion":"Spreadsheets","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"All experimental spreadsheet tools","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false}},"type":"object","title":"FileSettings","description":"Unified file capability for the agent.\n\nOne master toggle that, when on, lets the user attach files and lets the\nagent generate + present them (``create_file``, ``present_file``,\n``sandbox_publish_file``). Word (.docx) and Excel editing are offered\non-demand whenever a matching file is in the session — no separate toggles.\n\nThe always-on session-file reader (``list_files``/``read_file``) is a\nseparate, hidden capability (``FileSystemSettings``) and is unaffected."},"FileSystemSettings-Input":{"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","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":true},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"FolderOpen"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Accessing file system..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"File system operation complete"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","default":false},"icon":{"type":"string","title":"Icon","default":"FolderOpen"},"bg_color":{"type":"string","title":"Bg Color","default":"#fef3c7"},"icon_color":{"type":"string","title":"Icon Color","default":"#f59e0b"},"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"},"FileSystemSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"File System"},"description":{"type":"string","title":"Description","default":"Access and read files in the current session"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":true},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"FolderOpen"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Accessing file system..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"File system operation complete"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","default":false},"icon":{"type":"string","title":"Icon","default":"FolderOpen"},"bg_color":{"type":"string","title":"Bg Color","default":"#fef3c7"},"icon_color":{"type":"string","title":"Icon Color","default":"#f59e0b"},"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"},"FileType":{"properties":{"uri":{"type":"string","title":"Uri"},"name":{"type":"string","title":"Name"},"content_type":{"type":"string","title":"Content Type"}},"type":"object","required":["uri","name","content_type"],"title":"FileType"},"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."},"FunnelOutcome":{"properties":{"name":{"type":"string","title":"Name"},"count":{"type":"integer","title":"Count"},"pct":{"type":"number","title":"Pct"}},"type":"object","required":["name","count","pct"],"title":"FunnelOutcome"},"GlossaryTermConfig":{"properties":{"term":{"type":"string","title":"Term"},"definition":{"type":"string","title":"Definition"},"synonyms":{"items":{"type":"string"},"type":"array","title":"Synonyms"}},"type":"object","required":["term","definition"],"title":"GlossaryTermConfig","description":"A glossary term definition stored in agent settings."},"GoogleDriveSource":{"properties":{"source_type":{"type":"string","const":"Google Drive","title":"Source Type","default":"Google Drive"},"subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subtype"},"config_cls":{"title":"Config Cls"},"config":{"$ref":"#/components/schemas/GoogleDriveSourceConfig"},"integration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration"},"image":{"type":"string","title":"Image","default":"https://storage.googleapis.com/image-storage-spot-manual/logos/google-drive.svg"},"name":{"type":"string","title":"Name","default":"Google Drive"},"exposed":{"type":"boolean","title":"Exposed","default":true}},"type":"object","required":["config"],"title":"GoogleDriveSource"},"GoogleDriveSourceConfig":{"properties":{"connection":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connection","display":{"col_span":12,"integration_type":"gdrive","is_disabled":false,"is_subconfig":false,"label":"Gdrive Connection","needs_confirmation":false,"show_optional_label":false,"type":"credential_picker"},"field_type":"config","tab":"Configuration","tool_mode":"hidden"},"files":{"items":{"$ref":"#/components/schemas/GoogleFile"},"type":"array","title":"Files","description":"File or folder to read","display":{"col_span":12,"file_type":"application/pdf,text/plain,application/vnd.google-apps.document,application/vnd.google-apps.presentation,application/json,application/vnd.google-apps.folder,application/vnd.openxmlformats-officedocument.wordprocessingml.document,application/vnd.openxmlformats-officedocument.presentationml.presentation,image/jpeg,image/png,image/gif,image/webp,image/svg+xml,application/vnd.google-apps.spreadsheet","is_disabled":false,"is_subconfig":false,"label":"Path(s)","multi_select":true,"needs_confirmation":false,"setIncludeFolders":false,"show_optional_label":false,"type":"gdrive_picker"},"placeholder":{"id":"123","name":"123"},"tab":"Configuration","tool_mode":"hidden"}},"type":"object","required":["files"],"title":"GoogleDriveSourceConfig","description":"text_display_1: str = Parameter(\n    default=\"\",\n    display=ConfigTextDisplay(\n        title=\"Select files to add to knowledge base\",\n        text=\"\",\n    ),\n)"},"GoogleFile":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"mime_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mime Type"},"image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image"}},"type":"object","required":["id","name"],"title":"GoogleFile"},"Group":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"settings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Settings"}},"type":"object","required":["id","name","description","created_at"],"title":"Group"},"GroupTriggerEvent":{"properties":{"id":{"type":"string","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"state":{"$ref":"#/components/schemas/TriggerQueueStatus"},"event_type":{"type":"string","title":"Event Type"},"event_data":{"additionalProperties":true,"type":"object","title":"Event Data"},"trigger_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trigger Id"},"trigger_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Trigger Type"},"workflow_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflow Id"},"workflow_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflow Name"},"run_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Run Id"},"started_run":{"type":"boolean","title":"Started Run","default":false},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"},"ignore_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ignore Reason"}},"type":"object","required":["id","created_at","state","event_type","event_data"],"title":"GroupTriggerEvent","description":"Event entry for the group-level events view (all triggers)."},"GuardrailValue":{"properties":{"value":{"type":"string","title":"Value","default":"Off"},"context":{"type":"string","title":"Context","default":""}},"type":"object","title":"GuardrailValue"},"GuardrailsSettings-Input":{"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,"select_all":false,"show_optional_label":false,"type":"multi_select","values":[{"label":"Person","value":"PERSON"},{"label":"Email Address","value":"EMAIL_ADDRESS"},{"label":"Phone Number","value":"PHONE_NUMBER"},{"label":"Credit Card","value":"CREDIT_CARD"},{"label":"Cryptocurrency","value":"CRYPTO"},{"label":"IP Address","value":"IP_ADDRESS"},{"label":"Date Time","value":"DATE_TIME"},{"label":"NRP","value":"NRP"},{"label":"Location","value":"LOCATION"},{"label":"Medical License","value":"MEDICAL_LICENSE"},{"label":"URL","value":"URL"},{"label":"IBAN Code","value":"IBAN_CODE"}]},"rules":[{"config_source":"pii_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden","visible":false},"divider1":{"type":"string","title":"Divider1","default":"","accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_line":true,"show_optional_label":false,"spacing":0,"type":"divider"},"tab":"Model","tool_mode":"hidden","visible":false},"guardrail_info":{"type":"string","title":"Guardrail Info","description":"Information about the guardrails","default":"","accordion":"Safety","display":{"col_span":10,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"small_text":"Set the strictness level of guardrails to ensure the AI model's behavior and responses remain safe and appropriate, from 'Off' (no protection) to 'High' (maximum protection).","title":"Guardrails","type":"ui_text_display"},"tab":"Model","tool_mode":"hidden"},"guardrail_lock":{"type":"boolean","title":"Guardrail Lock","description":"Locks the guardrails settings.","default":false,"accordion":"Safety","display":{"col_align":"start","col_justify":"end","col_span":2,"icon":"Unlock","is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"toggledIcon":"Lock","tooltip":"Lock guardrails settings so they cannot be changed","type":"toggle_button"},"tab":"Model","tool_mode":"hidden","visible":false},"guardrail_latency_banner":{"type":"string","title":"Guardrail Latency Banner","description":"","default":"","accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Each enabled guardrail makes its own LLM call before the model can reply. Expect noticeably slower responses while any of these are on.","needs_confirmation":false,"show_optional_label":false,"style":"warning","title":"Guardrails add response latency","type":"banner"},"rules":[{"conds":[{"config_source":"violence_and_hate","type":"visible_if_not","value":"Off"},{"config_source":"sexual_content","type":"visible_if_not","value":"Off"},{"config_source":"guns_and_weapons","type":"visible_if_not","value":"Off"},{"config_source":"suicide","type":"visible_if_not","value":"Off"},{"config_source":"crime","type":"visible_if_not","value":"Off"},{"config_source":"toxicity","type":"visible_if_not","value":"Off"},{"config_source":"bias","type":"visible_if_not","value":"Off"},{"config_source":"profanity","type":"visible_if_not","value":"Off"},{"config_source":"jailbreak","type":"visible_if","value":true},{"config_source":"prompt_injection","type":"visible_if","value":true}],"mode":"or","type":"visible_if_group"}],"tab":"Model","tool_mode":"hidden"},"violence_and_hate":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a news agency. Reporting on conflict zones is expected and should not be flagged.","is_disabled":false,"is_subconfig":false,"label":"Violence and Hate","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"sexual_content":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is an airline booking system. Mentions of children traveling are normal and should not be flagged.","is_disabled":false,"is_subconfig":false,"label":"Sexual Content","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"guns_and_weapons":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a sporting goods store. Discussion of hunting equipment is expected.","is_disabled":false,"is_subconfig":false,"label":"Guns and Illegal Weapons","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"suicide":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a mental health support platform. Discussing symptoms is expected and should not be blocked.","is_disabled":false,"is_subconfig":false,"label":"Suicide and Self-Harm","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"crime":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a legal firm assistant. Discussing criminal cases and charges is part of normal operation.","is_disabled":false,"is_subconfig":false,"label":"Crime and Criminal Planning","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"toxicity":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a gaming community moderator. Competitive banter and trash talk is normal.","is_disabled":false,"is_subconfig":false,"label":"Toxicity","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"bias":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This assistant serves a diversity and inclusion team. Discussing demographic differences is expected.","is_disabled":false,"is_subconfig":false,"label":"Bias","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"profanity":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a content moderation tool. Quoting flagged content for review is expected.","is_disabled":false,"is_subconfig":false,"label":"Profanity","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"guardrails_scan_output":{"type":"boolean","title":"Guardrails Scan Output","description":"Scan the model's response with the same semantic guardrails applied to input. Catches sensitive content sourced from Knowledge Base documents or tools that the input scan cannot see.","default":false,"accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Scan responses (output guardrails)","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"guardrails_output_mode":{"type":"string","enum":["post_stream","pre_stream"],"title":"Guardrails Output Mode","description":"How output guardrails are enforced. 'post_stream' streams the response in real-time and warns/clears after the fact. 'pre_stream' buffers the full response, validates it against guardrails, and only emits it if it passes.","default":"post_stream","accordion":"Safety","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"Output guardrail mode","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"label":"Post-stream (warn after response)","value":"post_stream"},{"label":"Pre-stream (validate before showing)","value":"pre_stream"}]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true},{"config_source":"guardrails_scan_output","type":"visible_if","value":true}],"tab":"Model","tool_mode":"hidden"},"divider2":{"type":"string","title":"Divider2","default":"","accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_line":true,"show_optional_label":false,"spacing":0,"type":"divider"},"tab":"Model","tool_mode":"hidden"},"guardrail_action":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"string"}],"title":"Guardrail Action","description":"Choose the action to take when a guardrail is triggered.","default":{"value":"fail","label":"Fail/block run"},"accordion":"Safety","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"Guardrail action","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"label":"Fail/block run","value":"fail"},{"label":"Flag with warning but proceed","value":"flag"}]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden","visible":false},"guardrail_action_replace":{"type":"string","title":"Guardrail Action Replace","default":"","accordion":"Safety","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Replace with","needs_confirmation":false,"number_of_lines":1,"placeholder":"E.g. <REDACTED>","show_optional_label":false,"show_refresh":false,"type":"text"},"rules":[{"config_source":"guardrail_action","type":"visible_if","value":"replace"},{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden","visible":false},"guardrail_action_human":{"type":"string","title":"Guardrail Action Human","default":"","accordion":"Safety","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":true,"label":"Human task template","needs_confirmation":false,"number_of_lines":1,"placeholder":"E.g. <REDACTED>","show_optional_label":false,"show_refresh":false,"type":"text"},"rules":[{"config_source":"guardrail_action","type":"visible_if","value":"human"},{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden","visible":false},"block_after_violations":{"type":"integer","title":"Block After Violations","description":"Block the chat after this many turns with guardrail violations. Set to 0 to never block (per-turn warnings still surface).","default":0,"accordion":"Safety","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Block chat after N violations","max":20,"min":0,"needs_confirmation":false,"show_optional_label":false,"step":1,"tooltip":"Once a conversation accumulates this many turns with any guardrail violation (flag or fail mode), the chat input locks. Set to 0 to disable.","type":"number_slider"},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"block_message":{"type":"string","title":"Block Message","description":"Message shown to the user when the chat is locked.","default":"This conversation has been locked due to repeated safety violations. Please start a new conversation.","accordion":"Safety","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":true,"label":"Block message","needs_confirmation":false,"number_of_lines":1,"placeholder":"This conversation has been locked due to repeated safety violations.","show_optional_label":false,"show_refresh":false,"type":"text"},"rules":[{"config_source":"block_after_violations","type":"visible_if_not","value":0},{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"divider3":{"type":"string","title":"Divider3","default":"","accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_line":true,"show_optional_label":false,"spacing":0,"type":"divider"},"tab":"Model","tool_mode":"hidden","visible":false},"prompt_defense":{"type":"string","title":"Prompt Defense","default":"","accordion":"Safety","display":{"col_span":10,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"small_text":"Configurations to ensure the model behaves as expected and is protected against attacks, like jailbreak or prompt injection.","title":"Prompt Defense","type":"ui_text_display"},"tab":"Model","tool_mode":"hidden"},"prompt_lock":{"type":"boolean","title":"Prompt Lock","description":"Locks the prompt defense settings","default":false,"accordion":"Safety","display":{"col_align":"start","col_justify":"end","col_span":2,"icon":"Unlock","is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"toggledIcon":"Lock","tooltip":"Lock prompt settings so they cannot be changed","type":"toggle_button"},"tab":"Model","tool_mode":"hidden","visible":false},"jailbreak":{"type":"boolean","title":"Jailbreak","description":"Prevents attempts to manipulate or \"jailbreak\" the model into ignoring safety rules or system instructions (e.g., prompts like \"ignore previous instructions\").","default":false,"accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Jailbreak","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"prompt_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"prompt_injection":{"type":"boolean","title":"Prompt Injection","description":"Detects and blocks strategies where users attempt to get around restrictions indirectly (e.g., asking the model to 'pretend' or speak as a fictional character to evade policies).","default":false,"accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Prompt Injection","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"prompt_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"context_leak":{"type":"boolean","title":"Context Leak","description":"Prevents the model from unintentionally revealing internal context, instructions, or system messages that are not meant to be shared with the user.","default":false,"accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Context Leak","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"prompt_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden","visible":false},"title":{"type":"string","title":"Title","default":"Safety & Guardrails"},"description":{"type":"string","title":"Description","default":"Content scanning, prompt defence and blocking"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","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":"Shield","tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","description":"The message to display to the user when the tool is called.","default":"Running tool...","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Start message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the tool starts.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","description":"The message to display to the user when the tool completes.","default":"Tool complete","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"End message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the tool completes.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Shield"},"bg_color":{"type":"string","title":"Bg Color","default":"#EFF6FF"},"icon_color":{"type":"string","title":"Icon Color","default":"#2B7FFF"},"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":"guardrails","title":"Type","default":"guardrails"},"settings_display":{"type":"string","const":"dialog","title":"Settings Display","default":"dialog","tab":"Configuration","tool_mode":"hidden","visible":false},"guardrail_engine":{"type":"string","enum":["llm","system_one"],"title":"Guardrail Engine","description":"How the semantic categories are scanned. The language model makes one call per enabled category. The System 1 classifier answers every category in a single call, faster and far cheaper, and needs a System 1 model enabled under Settings > Models; without one the language model is used.","default":"llm","accordion":"Safety","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"Guardrail engine","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"label":"Language model (one call per category)","value":"llm"},{"label":"System 1 classifier (one call for all categories)","value":"system_one"}]},"order":0,"tab":"Model","tool_mode":"hidden"}},"type":"object","title":"GuardrailsSettings","description":"Every safety option of an agent on guardrails v2, owned by its quick action.\n\nThe fields are ``PIIConfig``'s, so v1 agents, which keep them on the\nagent's own settings, and v2 agents read the same shape. The toggle is the\nmaster switch: off builds no shields at all."},"GuardrailsSettings-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,"select_all":false,"show_optional_label":false,"type":"multi_select","values":[{"label":"Person","value":"PERSON"},{"label":"Email Address","value":"EMAIL_ADDRESS"},{"label":"Phone Number","value":"PHONE_NUMBER"},{"label":"Credit Card","value":"CREDIT_CARD"},{"label":"Cryptocurrency","value":"CRYPTO"},{"label":"IP Address","value":"IP_ADDRESS"},{"label":"Date Time","value":"DATE_TIME"},{"label":"NRP","value":"NRP"},{"label":"Location","value":"LOCATION"},{"label":"Medical License","value":"MEDICAL_LICENSE"},{"label":"URL","value":"URL"},{"label":"IBAN Code","value":"IBAN_CODE"}]},"rules":[{"config_source":"pii_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden","visible":false},"divider1":{"type":"string","title":"Divider1","default":"","accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_line":true,"show_optional_label":false,"spacing":0,"type":"divider"},"tab":"Model","tool_mode":"hidden","visible":false},"guardrail_info":{"type":"string","title":"Guardrail Info","description":"Information about the guardrails","default":"","accordion":"Safety","display":{"col_span":10,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"small_text":"Set the strictness level of guardrails to ensure the AI model's behavior and responses remain safe and appropriate, from 'Off' (no protection) to 'High' (maximum protection).","title":"Guardrails","type":"ui_text_display"},"tab":"Model","tool_mode":"hidden"},"guardrail_lock":{"type":"boolean","title":"Guardrail Lock","description":"Locks the guardrails settings.","default":false,"accordion":"Safety","display":{"col_align":"start","col_justify":"end","col_span":2,"icon":"Unlock","is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"toggledIcon":"Lock","tooltip":"Lock guardrails settings so they cannot be changed","type":"toggle_button"},"tab":"Model","tool_mode":"hidden","visible":false},"guardrail_latency_banner":{"type":"string","title":"Guardrail Latency Banner","description":"","default":"","accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Each enabled guardrail makes its own LLM call before the model can reply. Expect noticeably slower responses while any of these are on.","needs_confirmation":false,"show_optional_label":false,"style":"warning","title":"Guardrails add response latency","type":"banner"},"rules":[{"conds":[{"config_source":"violence_and_hate","type":"visible_if_not","value":"Off"},{"config_source":"sexual_content","type":"visible_if_not","value":"Off"},{"config_source":"guns_and_weapons","type":"visible_if_not","value":"Off"},{"config_source":"suicide","type":"visible_if_not","value":"Off"},{"config_source":"crime","type":"visible_if_not","value":"Off"},{"config_source":"toxicity","type":"visible_if_not","value":"Off"},{"config_source":"bias","type":"visible_if_not","value":"Off"},{"config_source":"profanity","type":"visible_if_not","value":"Off"},{"config_source":"jailbreak","type":"visible_if","value":true},{"config_source":"prompt_injection","type":"visible_if","value":true}],"mode":"or","type":"visible_if_group"}],"tab":"Model","tool_mode":"hidden"},"violence_and_hate":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a news agency. Reporting on conflict zones is expected and should not be flagged.","is_disabled":false,"is_subconfig":false,"label":"Violence and Hate","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"sexual_content":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is an airline booking system. Mentions of children traveling are normal and should not be flagged.","is_disabled":false,"is_subconfig":false,"label":"Sexual Content","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"guns_and_weapons":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a sporting goods store. Discussion of hunting equipment is expected.","is_disabled":false,"is_subconfig":false,"label":"Guns and Illegal Weapons","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"suicide":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a mental health support platform. Discussing symptoms is expected and should not be blocked.","is_disabled":false,"is_subconfig":false,"label":"Suicide and Self-Harm","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"crime":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a legal firm assistant. Discussing criminal cases and charges is part of normal operation.","is_disabled":false,"is_subconfig":false,"label":"Crime and Criminal Planning","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"toxicity":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a gaming community moderator. Competitive banter and trash talk is normal.","is_disabled":false,"is_subconfig":false,"label":"Toxicity","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"bias":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This assistant serves a diversity and inclusion team. Discussing demographic differences is expected.","is_disabled":false,"is_subconfig":false,"label":"Bias","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"profanity":{"$ref":"#/components/schemas/GuardrailValue","default":{"value":"Off","context":""},"accordion":"Safety","display":{"accordion_label":"Additional context","col_span":12,"context_placeholder":"E.g. This is a content moderation tool. Quoting flagged content for review is expected.","is_disabled":false,"is_subconfig":false,"label":"Profanity","needs_confirmation":false,"off_value":"Off","show_optional_label":false,"type":"guardrail_card","values":["Off","Low","Medium","High"]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"guardrails_scan_output":{"type":"boolean","title":"Guardrails Scan Output","description":"Scan the model's response with the same semantic guardrails applied to input. Catches sensitive content sourced from Knowledge Base documents or tools that the input scan cannot see.","default":false,"accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Scan responses (output guardrails)","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"guardrails_output_mode":{"type":"string","enum":["post_stream","pre_stream"],"title":"Guardrails Output Mode","description":"How output guardrails are enforced. 'post_stream' streams the response in real-time and warns/clears after the fact. 'pre_stream' buffers the full response, validates it against guardrails, and only emits it if it passes.","default":"post_stream","accordion":"Safety","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"Output guardrail mode","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"label":"Post-stream (warn after response)","value":"post_stream"},{"label":"Pre-stream (validate before showing)","value":"pre_stream"}]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true},{"config_source":"guardrails_scan_output","type":"visible_if","value":true}],"tab":"Model","tool_mode":"hidden"},"divider2":{"type":"string","title":"Divider2","default":"","accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_line":true,"show_optional_label":false,"spacing":0,"type":"divider"},"tab":"Model","tool_mode":"hidden"},"guardrail_action":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"string"}],"title":"Guardrail Action","description":"Choose the action to take when a guardrail is triggered.","default":{"value":"fail","label":"Fail/block run"},"accordion":"Safety","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"Guardrail action","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"label":"Fail/block run","value":"fail"},{"label":"Flag with warning but proceed","value":"flag"}]},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden","visible":false},"guardrail_action_replace":{"type":"string","title":"Guardrail Action Replace","default":"","accordion":"Safety","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Replace with","needs_confirmation":false,"number_of_lines":1,"placeholder":"E.g. <REDACTED>","show_optional_label":false,"show_refresh":false,"type":"text"},"rules":[{"config_source":"guardrail_action","type":"visible_if","value":"replace"},{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden","visible":false},"guardrail_action_human":{"type":"string","title":"Guardrail Action Human","default":"","accordion":"Safety","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":true,"label":"Human task template","needs_confirmation":false,"number_of_lines":1,"placeholder":"E.g. <REDACTED>","show_optional_label":false,"show_refresh":false,"type":"text"},"rules":[{"config_source":"guardrail_action","type":"visible_if","value":"human"},{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden","visible":false},"block_after_violations":{"type":"integer","title":"Block After Violations","description":"Block the chat after this many turns with guardrail violations. Set to 0 to never block (per-turn warnings still surface).","default":0,"accordion":"Safety","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Block chat after N violations","max":20,"min":0,"needs_confirmation":false,"show_optional_label":false,"step":1,"tooltip":"Once a conversation accumulates this many turns with any guardrail violation (flag or fail mode), the chat input locks. Set to 0 to disable.","type":"number_slider"},"rules":[{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"block_message":{"type":"string","title":"Block Message","description":"Message shown to the user when the chat is locked.","default":"This conversation has been locked due to repeated safety violations. Please start a new conversation.","accordion":"Safety","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":true,"label":"Block message","needs_confirmation":false,"number_of_lines":1,"placeholder":"This conversation has been locked due to repeated safety violations.","show_optional_label":false,"show_refresh":false,"type":"text"},"rules":[{"config_source":"block_after_violations","type":"visible_if_not","value":0},{"config_source":"guardrail_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"divider3":{"type":"string","title":"Divider3","default":"","accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_line":true,"show_optional_label":false,"spacing":0,"type":"divider"},"tab":"Model","tool_mode":"hidden","visible":false},"prompt_defense":{"type":"string","title":"Prompt Defense","default":"","accordion":"Safety","display":{"col_span":10,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"small_text":"Configurations to ensure the model behaves as expected and is protected against attacks, like jailbreak or prompt injection.","title":"Prompt Defense","type":"ui_text_display"},"tab":"Model","tool_mode":"hidden"},"prompt_lock":{"type":"boolean","title":"Prompt Lock","description":"Locks the prompt defense settings","default":false,"accordion":"Safety","display":{"col_align":"start","col_justify":"end","col_span":2,"icon":"Unlock","is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"toggledIcon":"Lock","tooltip":"Lock prompt settings so they cannot be changed","type":"toggle_button"},"tab":"Model","tool_mode":"hidden","visible":false},"jailbreak":{"type":"boolean","title":"Jailbreak","description":"Prevents attempts to manipulate or \"jailbreak\" the model into ignoring safety rules or system instructions (e.g., prompts like \"ignore previous instructions\").","default":false,"accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Jailbreak","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"prompt_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"prompt_injection":{"type":"boolean","title":"Prompt Injection","description":"Detects and blocks strategies where users attempt to get around restrictions indirectly (e.g., asking the model to 'pretend' or speak as a fictional character to evade policies).","default":false,"accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Prompt Injection","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"prompt_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden"},"context_leak":{"type":"boolean","title":"Context Leak","description":"Prevents the model from unintentionally revealing internal context, instructions, or system messages that are not meant to be shared with the user.","default":false,"accordion":"Safety","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Context Leak","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"prompt_lock","type":"disabled_if","value":true}],"tab":"Model","tool_mode":"hidden","visible":false},"title":{"type":"string","title":"Title","default":"Safety & Guardrails"},"description":{"type":"string","title":"Description","default":"Content scanning, prompt defence and blocking"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","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":"Shield","tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","description":"The message to display to the user when the tool is called.","default":"Running tool...","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Start message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the tool starts.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","description":"The message to display to the user when the tool completes.","default":"Tool complete","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"End message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the tool completes.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Shield"},"bg_color":{"type":"string","title":"Bg Color","default":"#EFF6FF"},"icon_color":{"type":"string","title":"Icon Color","default":"#2B7FFF"},"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":"guardrails","title":"Type","default":"guardrails"},"settings_display":{"type":"string","const":"dialog","title":"Settings Display","default":"dialog","tab":"Configuration","tool_mode":"hidden","visible":false},"guardrail_engine":{"type":"string","enum":["llm","system_one"],"title":"Guardrail Engine","description":"How the semantic categories are scanned. The language model makes one call per enabled category. The System 1 classifier answers every category in a single call, faster and far cheaper, and needs a System 1 model enabled under Settings > Models; without one the language model is used.","default":"llm","accordion":"Safety","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"Guardrail engine","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"label":"Language model (one call per category)","value":"llm"},{"label":"System 1 classifier (one call for all categories)","value":"system_one"}]},"order":0,"tab":"Model","tool_mode":"hidden"}},"type":"object","title":"GuardrailsSettings","description":"Every safety option of an agent on guardrails v2, owned by its quick action.\n\nThe fields are ``PIIConfig``'s, so v1 agents, which keep them on the\nagent's own settings, and v2 agents read the same shape. The toggle is the\nmaster switch: off builds no shields at all."},"GuidelineConfig":{"properties":{"id":{"type":"string","title":"Id"},"condition":{"type":"string","title":"Condition"},"action":{"type":"string","title":"Action"},"priority":{"type":"string","title":"Priority","default":"NORMAL"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"enabled":{"type":"boolean","title":"Enabled","default":true},"tool_association":{"anyOf":[{"$ref":"#/components/schemas/ToolAssociationConfig"},{"type":"null"}]},"tool_associations":{"items":{"$ref":"#/components/schemas/ToolAssociationConfig"},"type":"array","title":"Tool Associations"}},"type":"object","required":["id","condition","action"],"title":"GuidelineConfig","description":"A single When/Then behavioral guideline stored in agent settings."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"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"},"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"},"HumanInTheLoopSettings-Input":{"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","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"PersonStanding"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Escalating to human operator..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Escalated to human operator"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"PersonStanding"},"bg_color":{"type":"string","title":"Bg Color","default":"blue.50"},"icon_color":{"type":"string","title":"Icon Color","default":"blue.500"},"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"},"HumanInTheLoopSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Human in the Loop"},"description":{"type":"string","title":"Description","default":"Human in the Loop"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"PersonStanding"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Escalating to human operator..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Escalated to human operator"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"PersonStanding"},"bg_color":{"type":"string","title":"Bg Color","default":"blue.50"},"icon_color":{"type":"string","title":"Icon Color","default":"blue.500"},"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"},"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"},"ImageDataContainer":{"properties":{"total_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Size"},"taken":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Taken"},"truncated":{"type":"boolean","title":"Truncated","default":false},"preview_file":{"anyOf":[{"$ref":"#/components/schemas/FileType"},{"type":"null"}]},"list_offset":{"type":"integer","title":"List Offset","default":0},"type":{"type":"string","const":"Image","title":"Type","default":"Image"},"value":{"anyOf":[{"$ref":"#/components/schemas/FileType"},{"items":{"$ref":"#/components/schemas/FileType"},"type":"array"},{},{"type":"null"}],"title":"Value"}},"type":"object","required":["value"],"title":"ImageDataContainer"},"ImageGenerationSettings-Input":{"properties":{"title":{"type":"string","title":"Title","default":"Image Generation"},"description":{"type":"string","title":"Description","default":"Generate images from text prompts, shown inline in the chat."},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"ImagePlus"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Generating image..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Image generated"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"ImagePlus"},"bg_color":{"type":"string","title":"Bg Color","default":"#FDF4FF"},"icon_color":{"type":"string","title":"Icon Color","default":"#C026D3"},"deprecated":{"type":"boolean","title":"Deprecated","description":"Whether this tool type is deprecated and should be hidden from the UI","default":false},"type":{"type":"string","const":"image_generation","title":"Type","default":"image_generation"}},"type":"object","title":"ImageGenerationSettings","description":"Image generation quick action.\n\nWhen on, the agent can generate images from text prompts with any\nimage-generation-capable model in the registry; results are surfaced\ninline in the chat."},"ImageGenerationSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Image Generation"},"description":{"type":"string","title":"Description","default":"Generate images from text prompts, shown inline in the chat."},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"ImagePlus"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Generating image..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Image generated"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"ImagePlus"},"bg_color":{"type":"string","title":"Bg Color","default":"#FDF4FF"},"icon_color":{"type":"string","title":"Icon Color","default":"#C026D3"},"deprecated":{"type":"boolean","title":"Deprecated","description":"Whether this tool type is deprecated and should be hidden from the UI","default":false},"type":{"type":"string","const":"image_generation","title":"Type","default":"image_generation"}},"type":"object","title":"ImageGenerationSettings","description":"Image generation quick action.\n\nWhen on, the agent can generate images from text prompts with any\nimage-generation-capable model in the registry; results are surfaced\ninline in the chat."},"ImageMetadata":{"properties":{"kind":{"type":"string","const":"image","title":"Kind","default":"image"},"width":{"type":"integer","title":"Width"},"height":{"type":"integer","title":"Height"},"format":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Format"}},"type":"object","required":["width","height"],"title":"ImageMetadata","description":"Structural metadata for an image file."},"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"},"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.\n\nThis identifier can be provided to the model in a message to allow it to refer to this file in a tool call argument,\nand the tool can look up the file in question by iterating over the message history and finding the matching `FileUrl`.\n\nThis identifier is only automatically passed to the model when the `FileUrl` is returned by a tool.\nIf you're passing the `FileUrl` as a user message, it's up to you to include a separate text part with the identifier,\ne.g. \"This is file <identifier>:\" preceding the `FileUrl`.\n\nIt's also included in inline-text delimiters for providers that require inlining text documents, so the model can\ndistinguish multiple files.","readOnly":true}},"type":"object","required":["url","media_type","identifier"],"title":"ImageUrl","description":"A URL to an image."},"ImportAgentRequest":{"properties":{"definition":{"type":"string","maxLength":104857600,"title":"Definition"},"version":{"$ref":"#/components/schemas/ExportFormat","description":"Payload format. `auto` (default) detects it from the content; `v3` / `v4` force the base64 / YAML parse path.","default":"auto"}},"type":"object","required":["definition"],"title":"ImportAgentRequest"},"ImportKBRequest":{"properties":{"definition":{"type":"string","maxLength":104857600,"title":"Definition"},"version":{"$ref":"#/components/schemas/ExportFormat","description":"Payload format. `auto` (default) detects it from the content; `v3` / `v4` force the base64 / YAML parse path.","default":"auto"}},"type":"object","required":["definition"],"title":"ImportKBRequest","description":"Request body for importing a knowledge base"},"ImportMode":{"type":"string","enum":["version","clone","replace"],"title":"ImportMode","description":"Operator control over how a bundle's artifacts land in the target.\n\n- ``version``: keep the bundle's IDs. If the artifact already exists in\n  the target workspace, append a new version row (Workflow/Assistant)\n  or refuse with NOT_VERSIONABLE (KB/Inbox — use ``replace``). If not,\n  create with the bundle's id. Lineage history is appended on every\n  successful artifact write.\n- ``clone``: today's default — fresh UUIDs everywhere, no history.\n- ``replace``: keep IDs, overwrite the active definition in place. No\n  version row. Lineage history is appended."},"ImportWorkflowRequest":{"properties":{"definition":{"type":"string","maxLength":104857600,"title":"Definition"},"version":{"$ref":"#/components/schemas/ExportFormat","description":"Payload format. `auto` (default) detects it from the content; `v3` / `v4` force the base64 / YAML parse path.","default":"auto"}},"type":"object","required":["definition"],"title":"ImportWorkflowRequest","description":"Request body for importing a workflow"},"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"},"InputOverride":{"properties":{"mode":{"type":"string","enum":["fixed","variable","conversation_property"],"title":"Mode","default":"fixed"},"value":{"type":"string","title":"Value","default":""}},"type":"object","title":"InputOverride","description":"Override for a single workflow input."},"InsightConversation":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"preview":{"type":"string","title":"Preview"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"score":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Score"}},"type":"object","required":["id","name","preview","created_at"],"title":"InsightConversation","description":"A conversation behind an insight fact (the drill-down list rows)."},"InsightConversations":{"properties":{"conversations":{"items":{"$ref":"#/components/schemas/InsightConversation"},"type":"array","title":"Conversations"}},"type":"object","required":["conversations"],"title":"InsightConversations"},"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"},"IterationError":{"properties":{"iteration":{"type":"integer","title":"Iteration"},"error":{"$ref":"#/components/schemas/SpotError"}},"type":"object","required":["iteration","error"],"title":"IterationError"},"IterationOutcomes":{"properties":{"failed":{"items":{"$ref":"#/components/schemas/IterationError"},"type":"array","title":"Failed"},"not_run":{"items":{"type":"integer"},"type":"array","title":"Not Run"},"skipped":{"items":{"type":"integer"},"type":"array","title":"Skipped"}},"type":"object","required":["failed","not_run","skipped"],"title":"IterationOutcomes","description":"Per-item record of a fan-out that failed under the `fail` policy.\nIterations are 1-based; items absent from every list finished."},"IterationOutcomesContainer":{"properties":{"total_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Size"},"taken":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Taken"},"truncated":{"type":"boolean","title":"Truncated","default":false},"preview_file":{"anyOf":[{"$ref":"#/components/schemas/FileType"},{"type":"null"}]},"list_offset":{"type":"integer","title":"List Offset","default":0},"type":{"type":"string","const":"_iterations","title":"Type","default":"_iterations"},"value":{"$ref":"#/components/schemas/IterationOutcomes"}},"type":"object","required":["value"],"title":"IterationOutcomesContainer"},"KBConfig":{"properties":{"retrieval_info":{"type":"string","title":"Retrieval Info","description":"Information about retrieval settings","default":"","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"small_text":"Configure how documents are retrieved from your Knowledge Base. These settings set the defaults when using a specific retrieval method.","title":"Retrieval settings","type":"ui_text_display"},"tab":"Retrieval","tool_mode":"hidden"},"retrieval_method":{"type":"string","title":"Retrieval Method","default":"hybrid_bm25","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"Retrieval method","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"description":"Uses vector embeddings for meaning-based search","label":"Semantic search","value":"semantic"},{"description":"Traditional keyword-based search with ranking","label":"Keyword search","value":"full_text_search"},{"description":"Keyword search ranked with BM25 (IDF + term saturation)","label":"BM25 keyword search","value":"bm25"},{"description":"Combines semantic and keyword search with score fusion","label":"Hybrid search","value":"hybrid_relative_score"},{"description":"Combines semantic and keyword search with RRF score fusion","label":"RRF hybrid search","value":"hybrid_rrf"},{"description":"Combines semantic and BM25 keyword search with score fusion","label":"Hybrid search (BM25)","value":"hybrid_bm25"},{"description":"Combines semantic and BM25 keyword search with RRF fusion","label":"RRF hybrid search (BM25)","value":"hybrid_bm25_rrf"}]},"tab":"Retrieval","tool_mode":"hidden"},"reranking_enabled":{"type":"boolean","title":"Reranking Enabled","description":"Retrieve a wider candidate pool, then reorder it with a reranker before returning results.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enable reranking","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Retrieval","tool_mode":"hidden"},"rerankers":{"items":{"type":"string"},"type":"array","title":"Rerankers","description":"Tried in order. If one is unavailable the next takes over. Leave empty to use the rerankers enabled for your workspace.","display":{"col_span":12,"endpoint":"/models/rerankers","hide_disabled_models":true,"is_disabled":false,"is_subconfig":false,"label":"Rerankers","layout":"side_by_side","model_limit":3,"model_type":"rerankers","needs_confirmation":false,"show_inline_presets":false,"show_optional_label":false,"show_presets":false,"type":"model_select"},"rules":[{"config_source":"reranking_enabled","type":"visible_if","value":true}],"tab":"Retrieval","tool_mode":"hidden"},"retrieval_top_k":{"type":"integer","title":"Retrieval Top K","description":"Maximum number of results to return","default":25,"display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Max results","max":100,"min":1,"needs_confirmation":false,"show_optional_label":false,"step":1,"type":"number_slider"},"tab":"Retrieval","tool_mode":"hidden"},"retrieval_top_k_window":{"items":{"type":"integer"},"type":"array","title":"Retrieval Top K Window","description":"Searches against this Knowledge Base always return between min and max results. Requested top_k values outside this window are clamped.","display":{"col_span":12,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Allowed results range","max":100,"min":1,"needs_confirmation":false,"show_optional_label":false,"step":1,"type":"number_range_slider"},"tab":"Retrieval","tool_mode":"hidden"},"fts_weight":{"type":"number","title":"Fts Weight","description":"Weight for keyword search in hybrid methods","default":0.7,"display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Keyword search weight","max":1.0,"min":0.0,"needs_confirmation":false,"show_optional_label":false,"step":0.1,"type":"number_slider"},"rules":[{"conds":[{"config_source":"retrieval_method","type":"visible_if","value":"hybrid_relative_score"},{"config_source":"retrieval_method","type":"visible_if","value":"hybrid_reranking"},{"config_source":"retrieval_method","type":"visible_if","value":"hybrid_bm25"}],"mode":"or","type":"visible_if_group"}],"tab":"Retrieval","tool_mode":"hidden"},"semantic_weight":{"type":"number","title":"Semantic Weight","description":"Weight for semantic search in hybrid methods","default":0.3,"display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Semantic search weight","max":1.0,"min":0.0,"needs_confirmation":false,"show_optional_label":false,"step":0.1,"type":"number_slider"},"rules":[{"conds":[{"config_source":"retrieval_method","type":"visible_if","value":"hybrid_relative_score"},{"config_source":"retrieval_method","type":"visible_if","value":"hybrid_reranking"},{"config_source":"retrieval_method","type":"visible_if","value":"hybrid_bm25"}],"mode":"or","type":"visible_if_group"}],"tab":"Retrieval","tool_mode":"hidden"},"rrf_k":{"type":"integer","title":"Rrf K","description":"RRF constant k - higher values reduce the impact of rank differences","default":60,"display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"RRF constant (k)","max":200,"min":1,"needs_confirmation":false,"show_optional_label":false,"step":1,"type":"number_slider"},"rules":[{"conds":[{"config_source":"retrieval_method","type":"visible_if","value":"hybrid_rrf"},{"config_source":"retrieval_method","type":"visible_if","value":"hybrid_bm25_rrf"}],"mode":"or","type":"visible_if_group"}],"tab":"Retrieval","tool_mode":"hidden"},"threshold_enabled":{"type":"boolean","title":"Threshold Enabled","description":"Semantic retrieval only: exclude results below the minimum similarity score. Ignored by every other retrieval method.","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enable minimum similarity","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"retrieval_method","type":"visible_if","value":"semantic"}],"tab":"Retrieval","tool_mode":"hidden"},"threshold":{"type":"number","title":"Threshold","description":"Minimum cosine similarity for semantic retrieval results. Ignored by every other retrieval method.","default":0.0,"display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Minimum semantic similarity","max":1.0,"min":0.0,"needs_confirmation":false,"show_optional_label":false,"step":0.01,"type":"number_slider"},"rules":[{"conds":[{"config_source":"retrieval_method","type":"visible_if","value":"semantic"},{"config_source":"threshold_enabled","type":"visible_if","value":true}],"mode":"and","type":"visible_if_group"}],"tab":"Retrieval","tool_mode":"hidden"},"reranker_type":{"type":"string","title":"Reranker Type","description":"The reranking method to use after initial retrieval","default":"vertex","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"Reranker type","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"description":"Google's semantic ranking service","label":"Vertex AI reranker","value":"vertex"}]},"rules":[{"config_source":"retrieval_method","type":"visible_if","value":"hybrid_reranking"}],"tab":"Retrieval","tool_mode":"hidden","visible":false},"reranker_top_k":{"type":"integer","title":"Reranker Top K","description":"Number of results to return from reranker","default":10,"display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Reranker top k","max":25,"min":1,"needs_confirmation":false,"show_optional_label":false,"step":1,"type":"number_slider"},"rules":[{"config_source":"retrieval_method","type":"visible_if","value":"hybrid_reranking"}],"tab":"Retrieval","tool_mode":"hidden","visible":false},"reranker_threshold_enabled":{"type":"boolean","title":"Reranker Threshold Enabled","description":"Enable minimum score threshold for reranker","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enable reranker score threshold","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"rules":[{"config_source":"retrieval_method","type":"visible_if","value":"hybrid_reranking"}],"tab":"Retrieval","tool_mode":"hidden","visible":false},"reranker_threshold":{"type":"number","title":"Reranker Threshold","description":"Minimum score threshold for reranker results","default":0.0,"display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Reranker score threshold","max":1.0,"min":0.0,"needs_confirmation":false,"show_optional_label":false,"step":0.01,"type":"number_slider"},"rules":[{"conds":[{"config_source":"retrieval_method","type":"visible_if","value":"hybrid_reranking"},{"config_source":"reranker_threshold_enabled","type":"visible_if","value":true}],"mode":"and","type":"visible_if_group"}],"tab":"Retrieval","tool_mode":"hidden","visible":false},"vertex_model":{"type":"string","title":"Vertex Model","description":"Vertex AI ranking model to use","default":"semantic-ranker-512@latest","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"Vertex model","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"label":"Semantic ranker 512","value":"semantic-ranker-512@latest"}]},"rules":[{"conds":[{"config_source":"reranker_type","type":"visible_if","value":"vertex"},{"config_source":"retrieval_method","type":"visible_if","value":"hybrid_reranking"}],"mode":"and","type":"visible_if_group"}],"tab":"Retrieval","tool_mode":"hidden","visible":false},"ingestion_info":{"type":"string","title":"Ingestion Info","description":"Information about ingestion settings","default":"","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"small_text":"Configure how documents are processed and stored in your Knowledge Base. These settings control chunking, enrichment, and file-specific processing options.","title":"Ingestion settings","type":"ui_text_display"},"optional":true,"tab":"Ingestion","tool_mode":"hidden"},"batch_size":{"type":"integer","title":"Batch Size","description":"Number of documents to process in each batch","default":8,"display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Batch size","max":32,"min":1,"needs_confirmation":false,"show_optional_label":false,"step":1,"type":"number_slider"},"tab":"Ingestion","tool_mode":"hidden","visible":false},"default_chunk_size":{"type":"integer","title":"Default Chunk Size","description":"Default size for text chunks in characters","default":2048,"display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Default chunk size","max":4096,"min":256,"needs_confirmation":false,"show_optional_label":false,"step":256,"type":"number_slider"},"tab":"Ingestion","tool_mode":"hidden"},"default_chunk_overlap":{"type":"integer","title":"Default Chunk Overlap","description":"Default overlap between chunks in characters","default":512,"display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Default chunk overlap","max":1024,"min":0,"needs_confirmation":false,"show_optional_label":false,"step":64,"type":"number_slider"},"tab":"Ingestion","tool_mode":"hidden"},"enrich_chunks_mode":{"type":"string","title":"Enrich Chunks Mode","description":"How to enrich chunks with additional context","default":"inject_summary","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"Chunk enrichment mode","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"description":"Add document summary to each chunk for better context","label":"Inject summary","value":"inject_summary"},{"description":"Generate contextual information for each chunk","label":"Contextual","value":"contextual"},{"description":"Skip per-document summary generation entirely. Cuts ingestion latency and LLM cost dramatically for small documents at the cost of slightly worse retrieval on large documents.","label":"None","value":"none"}]},"tab":"Ingestion","tool_mode":"hidden","visible":false},"enrich_pre_made_qa":{"type":"boolean","title":"Enrich Pre Made Qa","description":"Generate Q&A pairs from the document content","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Generate Q&A pairs","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Ingestion","tool_mode":"hidden","visible":false},"pdf_info":{"type":"string","title":"Pdf Info","description":"PDF-specific processing settings","default":"","accordion":"PDF Options","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"small_text":"Configure settings specific to PDF document processing including OCR, image extraction, and chunking parameters.","title":"PDF Processing","type":"ui_text_display"},"optional":true,"tab":"Ingestion","tool_mode":"hidden","visible":false},"pdf_extract_images":{"type":"boolean","title":"Pdf Extract Images","description":"Extract and process images from PDF files","default":true,"accordion":"PDF Options","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Extract images from PDFs","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Ingestion","tool_mode":"hidden","visible":false},"pdf_chunk_size":{"type":"integer","title":"Pdf Chunk Size","description":"Chunk size for PDF documents","default":1024,"accordion":"PDF Options","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"PDF chunk size","max":4096,"min":256,"needs_confirmation":false,"show_optional_label":false,"step":256,"type":"number_slider"},"tab":"Ingestion","tool_mode":"hidden","visible":false},"pdf_chunk_overlap":{"type":"integer","title":"Pdf Chunk Overlap","description":"Chunk overlap for PDF documents","default":256,"accordion":"PDF Options","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"PDF chunk overlap","max":1024,"min":0,"needs_confirmation":false,"show_optional_label":false,"step":64,"type":"number_slider"},"tab":"Ingestion","tool_mode":"hidden","visible":false},"pdf_ocr_enabled":{"type":"boolean","title":"Pdf Ocr Enabled","description":"Enable OCR processing for scanned PDFs","default":false,"accordion":"PDF Options","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enable OCR","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Ingestion","tool_mode":"hidden","visible":false},"pdf_ocr_confidence":{"type":"number","title":"Pdf Ocr Confidence","description":"Minimum confidence threshold for OCR text recognition","default":0.7,"accordion":"PDF Options","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"OCR confidence threshold","max":1.0,"min":0.1,"needs_confirmation":false,"show_optional_label":false,"step":0.1,"type":"number_slider"},"rules":[{"config_source":"pdf_ocr_enabled","type":"visible_if","value":true}],"tab":"Ingestion","tool_mode":"hidden","visible":false},"pdf_ocr_language":{"type":"string","title":"Pdf Ocr Language","description":"Language hint for OCR processing","default":"auto","accordion":"PDF Options","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"OCR language","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"label":"Auto-detect","value":"auto"},{"label":"English","value":"en"},{"label":"Spanish","value":"es"},{"label":"French","value":"fr"},{"label":"German","value":"de"},{"label":"Portuguese","value":"pt"},{"label":"Chinese","value":"zh"},{"label":"Japanese","value":"ja"}]},"rules":[{"config_source":"pdf_ocr_enabled","type":"visible_if","value":true}],"tab":"Ingestion","tool_mode":"hidden","visible":false},"text_info":{"type":"string","title":"Text Info","description":"Text-specific processing settings","default":"","accordion":"Plain Text Options","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"small_text":"Configure settings for plain text document processing including chunking and formatting options.","title":"Text Processing","type":"ui_text_display"},"optional":true,"tab":"Ingestion","tool_mode":"hidden","visible":false},"text_chunking_enabled":{"type":"boolean","title":"Text Chunking Enabled","description":"Enable automatic chunking for text files","default":true,"accordion":"Plain Text Options","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enable text chunking","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Ingestion","tool_mode":"hidden","visible":false},"text_chunk_size":{"type":"integer","title":"Text Chunk Size","description":"Chunk size for text documents","default":1024,"accordion":"Plain Text Options","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Text chunk size","max":4096,"min":256,"needs_confirmation":false,"show_optional_label":false,"step":256,"type":"number_slider"},"rules":[{"config_source":"text_chunking_enabled","type":"visible_if","value":true}],"tab":"Ingestion","tool_mode":"hidden","visible":false},"text_chunk_overlap":{"type":"integer","title":"Text Chunk Overlap","description":"Chunk overlap for text documents","default":256,"accordion":"Plain Text Options","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Text chunk overlap","max":1024,"min":0,"needs_confirmation":false,"show_optional_label":false,"step":64,"type":"number_slider"},"rules":[{"config_source":"text_chunking_enabled","type":"visible_if","value":true}],"tab":"Ingestion","tool_mode":"hidden","visible":false},"text_preserve_formatting":{"type":"boolean","title":"Text Preserve Formatting","description":"Preserve original text formatting and structure","default":true,"accordion":"Plain Text Options","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Preserve formatting","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Ingestion","tool_mode":"hidden","visible":false},"html_info":{"type":"string","title":"Html Info","description":"HTML-specific processing settings","default":"","accordion":"HTML ingestion options","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"small_text":"Configure settings for HTML document processing including content extraction and chunking parameters.","title":"HTML Processing","type":"ui_text_display"},"optional":true,"tab":"Ingestion","tool_mode":"hidden","visible":false},"html_extract_text_only":{"type":"boolean","title":"Html Extract Text Only","description":"Extract only text content from HTML","default":true,"accordion":"HTML ingestion options","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Extract text only","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Ingestion","tool_mode":"hidden","visible":false},"html_include_tables":{"type":"boolean","title":"Html Include Tables","description":"Include table content from HTML","default":true,"accordion":"HTML ingestion options","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Include tables","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Ingestion","tool_mode":"hidden","visible":false},"html_include_images":{"type":"boolean","title":"Html Include Images","description":"Include image references from HTML","default":false,"accordion":"HTML ingestion options","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Include images","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Ingestion","tool_mode":"hidden","visible":false},"html_ingest_as_markdown":{"type":"boolean","title":"Html Ingest As Markdown","description":"Convert HTML to Markdown before chunking. Preserves headings, lists, links, and tables while dropping tag noise, producing smaller, more semantic chunks. Recommended for crawled web pages; turn off only to reproduce legacy raw-HTML behaviour.","default":true,"accordion":"HTML ingestion options","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Ingest as Markdown","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Ingestion","tool_mode":"hidden"},"image_info":{"type":"string","title":"Image Info","description":"Image-specific processing settings","default":"","accordion":"Image Options","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"","needs_confirmation":false,"show_optional_label":false,"small_text":"Configure settings for image document processing including vision model settings and content extraction.","title":"Image processing","type":"ui_text_display"},"optional":true,"tab":"Ingestion","tool_mode":"hidden","visible":false},"image_ocr_enabled":{"type":"boolean","title":"Image Ocr Enabled","description":"Enable OCR processing for images","default":false,"accordion":"Image Options","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enable OCR for images","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Ingestion","tool_mode":"hidden","visible":false},"image_ocr_confidence":{"type":"number","title":"Image Ocr Confidence","description":"Minimum confidence threshold for image OCR","default":0.7,"accordion":"Image Options","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Image OCR confidence","max":1.0,"min":0.1,"needs_confirmation":false,"show_optional_label":false,"step":0.1,"type":"number_slider"},"rules":[{"config_source":"image_ocr_enabled","type":"visible_if","value":true}],"tab":"Ingestion","tool_mode":"hidden","visible":false},"csv_row_as_document":{"type":"boolean","title":"Csv Row As Document","description":"Treat each row as a separate chunk.","default":false,"accordion":"CSV ingestion options","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Row as chunk","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Ingestion","tool_mode":"hidden","visible":false},"csv_include_headers":{"type":"boolean","title":"Csv Include Headers","description":"Include headers in the text representation","default":true,"accordion":"CSV ingestion options","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Include headers","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Ingestion","tool_mode":"hidden","visible":false},"csv_auto_detect_delimiter":{"type":"boolean","title":"Csv Auto Detect Delimiter","description":"Automatically detect CSV delimiter","default":true,"accordion":"CSV ingestion options","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Auto-detect delimiter","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Ingestion","tool_mode":"hidden","visible":false},"csv_delimiter":{"type":"string","title":"Csv Delimiter","description":"Custom delimiter for CSV parsing","default":",","accordion":"CSV ingestion options","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"CSV delimiter","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"label":"Comma (,)","value":","},{"label":"Semicolon (;)","value":";"},{"label":"Tab","value":"\t"},{"label":"Pipe (|)","value":"|"}]},"rules":[{"config_source":"csv_auto_detect_delimiter","type":"visible_if","value":false}],"tab":"Ingestion","tool_mode":"hidden","visible":false},"csv_encoding":{"type":"string","title":"Csv Encoding","description":"File encoding for CSV files","default":"utf-8","accordion":"CSV ingestion options","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"CSV encoding","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"label":"UTF-8","value":"utf-8"},{"label":"ASCII","value":"ascii"},{"label":"ISO-8859-1","value":"iso-8859-1"},{"label":"Windows-1252","value":"cp1252"}]},"tab":"Ingestion","tool_mode":"hidden","visible":false},"xlsx_row_as_document":{"type":"boolean","title":"Xlsx Row As Document","description":"Excel: emit one chunk per row (with cell coordinates and detected headers). Off → render the whole sheet as a markdown table and chunk by token budget, closer to the legacy text-based behavior. Default on; toggle off if a workbook has unusual structure that confuses row mode.","default":false,"accordion":"Excel ingestion options","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Row as chunk","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Ingestion","tool_mode":"hidden","visible":false},"xlsx_include_headers":{"type":"boolean","title":"Xlsx Include Headers","description":"Excel: include detected column headers alongside cell coordinates in row chunks.","default":true,"accordion":"Excel ingestion options","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Include headers","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Ingestion","tool_mode":"hidden","visible":false},"tabular_ingest_all_rows":{"type":"boolean","title":"Tabular Ingest All Rows","description":"Ingest every row regardless of size. Turn on only for small-to-medium workbooks; very large files will slow retrieval and may exhaust worker memory.","default":false,"accordion":"Tabular ingestion options","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Ingest all rows","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Ingestion","tool_mode":"hidden","visible":false},"tabular_max_rows":{"type":"integer","title":"Tabular Max Rows","description":"Excel & CSV: max rows ingested per sheet when the 'Ingest all rows' toggle is off. Rows beyond this are dropped and the document is flagged as truncated.","default":50000,"accordion":"Tabular ingestion options","display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Max rows per sheet","max":500000,"min":100,"needs_confirmation":false,"show_optional_label":false,"step":100,"type":"number_slider"},"rules":[{"config_source":"tabular_ingest_all_rows","type":"visible_if","value":false}],"tab":"Ingestion","tool_mode":"hidden","visible":false},"embedding_model":{"items":{"type":"string"},"type":"array","title":"Embedding Model","description":"The model to use for embedding documents","default":[],"display":{"col_span":12,"endpoint":"/models/embeddings","hide_disabled_models":false,"is_disabled":false,"is_subconfig":false,"label":"Embedding model","layout":"side_by_side","model_limit":1,"model_type":"embeddings","needs_confirmation":false,"show_inline_presets":false,"show_optional_label":false,"show_presets":false,"type":"model_select"},"tab":"Ingestion","tool_mode":"hidden"},"embedding_dimension":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Embedding Dimension","description":"Leave unset to use the model's default dimension.","display":{"col_span":12,"endpoint":"/models/embeddings","fallback_values":[],"is_clearable":false,"is_disabled":false,"is_searchable":false,"is_subconfig":false,"label":"Embedding dimension","needs_confirmation":false,"placeholder":"Use model default","show_optional_label":false,"source_attribute":"supported_dimensions","source_field":"embedding_model","type":"config_dynamic_select"},"optional":true,"tab":"Ingestion","tool_mode":"hidden"},"mm_embedding_model":{"items":{"type":"string"},"type":"array","title":"Mm Embedding Model","description":"The model to use for embedding documents","default":[],"display":{"col_span":12,"endpoint":"/models/embeddings?multimodal=true","hide_disabled_models":true,"is_disabled":false,"is_subconfig":false,"label":"Embedding model","layout":"side_by_side","model_limit":3,"model_type":"embeddings","needs_confirmation":false,"show_inline_presets":false,"show_optional_label":false,"show_presets":false,"type":"model_select"},"tab":"Ingestion","tool_mode":"hidden","visible":false},"auto_summary":{"type":"boolean","title":"Auto Summary","description":"Keep an AI-generated summary of this Knowledge Base up to date","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Auto-generate KB summary","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Ingestion","tool_mode":"hidden","tooltip":"Keeps a short routing summary of this Knowledge Base regenerated whenever its documents change, so agents can tell which Knowledge Base to search."},"citation_mode":{"type":"string","enum":["source_url","noxus_url","metadata_key"],"title":"Citation Mode","description":"Where a citation of a document from this Knowledge Base points.","default":"source_url","accordion":"Citation options","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"Citation link","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"description":"Link to where the document came from, such as its Google Drive or SharePoint page","label":"Source URL","value":"source_url"},{"description":"Link to the copy of the document stored in Noxus","label":"Noxus internal URL","value":"noxus_url"},{"description":"Link to a URL held in a metadata field you name","label":"Metadata field","value":"metadata_key"}]},"tab":"Retrieval","tool_mode":"hidden"},"citation_url_key":{"type":"string","title":"Citation Url Key","description":"Metadata field holding the URL to cite. Use a dot for nested fields. Documents without it fall back to the Noxus copy.","default":"","accordion":"Citation options","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"URL field","needs_confirmation":false,"number_of_lines":1,"placeholder":"review_url","show_optional_label":false,"show_refresh":false,"type":"text"},"rules":[{"config_source":"citation_mode","type":"visible_if","value":"metadata_key"}],"tab":"Retrieval","tool_mode":"hidden"},"citation_title_mode":{"type":"string","enum":["document_name","source_title","metadata_key"],"title":"Citation Title Mode","description":"What a citation of a document from this Knowledge Base reads as.","default":"document_name","accordion":"Citation options","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":true,"is_subconfig":false,"label":"Citation title","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"description":"Show the document's name as stored in the Knowledge Base","label":"Document name","value":"document_name"},{"description":"Show the title the source gave the document, such as a web page title","label":"Source title","value":"source_title"},{"description":"Show the value of a metadata field you name","label":"Metadata field","value":"metadata_key"}]},"tab":"Retrieval","tool_mode":"hidden"},"citation_title_key":{"type":"string","title":"Citation Title Key","description":"Metadata field holding the title to show. Use a dot for nested fields. Documents without it are cited by their name.","default":"","accordion":"Citation options","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Title field","needs_confirmation":false,"number_of_lines":1,"placeholder":"heading","show_optional_label":false,"show_refresh":false,"type":"text"},"rules":[{"config_source":"citation_title_mode","type":"visible_if","value":"metadata_key"}],"tab":"Retrieval","tool_mode":"hidden"}},"type":"object","title":"KBConfig"},"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"},"KBHealth":{"properties":{"status":{"type":"string","enum":["ok","needs_repair","error"],"title":"Status"},"issue":{"anyOf":[{"type":"string","enum":["vector_table_missing","index_struct_missing","dim_drift","resolver_error","embedding_config_error"]},{"type":"null"}],"title":"Issue"},"detected_dim":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Detected Dim"},"declared_dim":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Declared Dim"},"message":{"type":"string","title":"Message","default":""},"action":{"type":"string","title":"Action","default":""}},"type":"object","required":["status"],"title":"KBHealth","description":"Structural health of a v3 knowledge base, computed at request time.\n\nReturned on every ``GET /kbs/{id}`` so the FE can surface an inline\nbanner + CTA when the KB needs repair. Four concrete issues can be\ndetected by ``KBManagementService.compute_health``:\n\n- ``vector_table_missing`` — pgvector table was never created or was\n  dropped out from under us. Repair rebuilds the table at the\n  declared dim and queues every document for re-ingestion.\n- ``index_struct_missing`` — the pgvector table is present but the\n  kirby ``index_struct`` row is absent. Repair rebuilds the struct\n  anchored to the existing column; no documents need reprocessing.\n- ``dim_drift`` — declared dim no longer matches the pgvector column\n  width. Retrieval still works against the actual dim, but new\n  INSERTs fail. Repair recreates the table at the declared dim and\n  queues every document for re-ingestion.\n- ``resolver_error`` — the resolver itself failed (DB outage,\n  unexpected column type). Not a repair-able state; the user is\n  asked to retry later. HTTP stays 200 so the FE can render the\n  apology inline instead of a blank error page."},"KBType":{"type":"string","enum":["temporary","entity"],"title":"KBType"},"KnowledgeBaseDocument":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary"},"short_summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Short Summary"},"doc_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Type"},"source_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Type"},"source_external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source External Id"},"source_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Source Metadata"},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Type"},"has_conversion":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Conversion"},"status":{"$ref":"#/components/schemas/DocumentStatus"},"doc_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Doc Metadata"},"error":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Error"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"prefix":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prefix"},"uri":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uri"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"size":{"type":"integer","title":"Size"},"file_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"File Id"},"run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Run Id"},"dismissed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Dismissed"},"warnings":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Warnings"},"needs_reingestion":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Needs Reingestion"}},"type":"object","required":["id","summary","status","error","updated_at","created_at","size"],"title":"KnowledgeBaseDocument"},"KnowledgeBaseDocumentWithCitation":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary"},"short_summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Short Summary"},"doc_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Type"},"source_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Type"},"source_external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source External Id"},"source_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Source Metadata"},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Type"},"has_conversion":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Conversion"},"status":{"$ref":"#/components/schemas/DocumentStatus"},"doc_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Doc Metadata"},"error":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Error"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"prefix":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prefix"},"uri":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Uri"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"size":{"type":"integer","title":"Size"},"file_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"File Id"},"run_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Run Id"},"dismissed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Dismissed"},"warnings":{"anyOf":[{"items":{},"type":"array"},{"type":"null"}],"title":"Warnings"},"needs_reingestion":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Needs Reingestion"},"citation_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Citation Url"}},"type":"object","required":["id","summary","status","error","updated_at","created_at","size"],"title":"KnowledgeBaseDocumentWithCitation"},"KnowledgeBaseQaSettings-Input":{"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","Agents"],"title":"Category","default":"Knowledge","tab":"Configuration","tool_mode":"hidden","visible":false},"enabled":{"type":"boolean","title":"Enabled","description":"Whether the tool is enabled","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enabled","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Search","tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Searching knowledge base...","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Start message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the knowledge base search starts.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Knowledge base search complete","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"End message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the knowledge base search completes.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"type":{"type":"string","const":"kb_qa","title":"Type","default":"kb_qa","tab":"Configuration","tool_mode":"hidden","visible":false},"kb_id":{"type":"string","format":"uuid","title":"Kb Id","tab":"Configuration","tool_mode":"hidden","visible":false},"advanced_search":{"type":"boolean","title":"Advanced Search","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Advanced search tools","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","tooltip":"The agent chooses the best search method (overrides the KB configured retrieval method).","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"clamp_top_k":{"type":"boolean","title":"Clamp Top K","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Limit results per search","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","tooltip":"Force every search against this knowledge base to return a number of results inside a fixed range.","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"top_k_window":{"items":{"type":"integer"},"type":"array","title":"Top K Window","display":{"col_span":12,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Allowed results range","max":100,"min":1,"needs_confirmation":false,"show_optional_label":false,"step":1,"type":"number_range_slider"},"rules":[{"config_source":"clamp_top_k","type":"visible_if","value":true}],"tab":"Configuration","tool_mode":"hidden"},"private":{"type":"boolean","title":"Private","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Private knowledge base","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","tooltip":"The agent won’t cite this knowledge base as a source.","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"enable_browse_tools":{"type":"boolean","title":"Enable Browse Tools","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enable File system tools","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","tooltip":"Enable kb_tree and kb_ls tools for navigating the knowledge base file system.","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"include_tree_in_instructions":{"type":"boolean","title":"Include Tree In Instructions","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Include File system structure in instructions","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","tooltip":"Inline this KB's folder tree into the system prompt every turn. Saves the agent a kb_tree round-trip but increases prompt size. Keep depth low for large KBs.","type":"toggle"},"rules":[{"config_source":"enable_browse_tools","type":"visible_if","value":true}],"tab":"Configuration","tool_mode":"hidden"},"tree_depth_in_instructions":{"type":"integer","title":"Tree Depth In Instructions","default":3,"display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Tree depth in instructions","max":10,"min":1,"needs_confirmation":false,"show_optional_label":false,"step":1,"tooltip":"How many folder levels to include (1-10).","type":"number_slider"},"rules":[{"config_source":"enable_browse_tools","type":"visible_if","value":true},{"config_source":"include_tree_in_instructions","type":"visible_if","value":true}],"tab":"Configuration","tool_mode":"hidden"},"link_references_to_noxus_file":{"type":"boolean","title":"Link References To Noxus File","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Always cite the Noxus internal URL","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","tooltip":"Overrides this Knowledge Base's citation options, forcing the Noxus internal URL: citations link to the document stored in Noxus instead of the URL from its metadata (e.g. the Google Drive or SharePoint link). Turn this on when the people using this agent may not have access to the original source location.","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"}},"type":"object","required":["kb_id"],"title":"KnowledgeBaseQaSettings","description":"Tool that allows the user to answer questions about a specific pre-selected knowledge base"},"KnowledgeBaseQaSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Knowledge Base Q&A","tab":"Configuration","tool_mode":"hidden","visible":false},"description":{"type":"string","title":"Description","default":"Answer questions about the knowledge base","tab":"Configuration","tool_mode":"hidden","visible":false},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","default":"Knowledge","tab":"Configuration","tool_mode":"hidden","visible":false},"enabled":{"type":"boolean","title":"Enabled","description":"Whether the tool is enabled","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enabled","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Search","tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Searching knowledge base...","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Start message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the knowledge base search starts.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Knowledge base search complete","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"End message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the knowledge base search completes.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"type":{"type":"string","const":"kb_qa","title":"Type","default":"kb_qa","tab":"Configuration","tool_mode":"hidden","visible":false},"kb_id":{"type":"string","format":"uuid","title":"Kb Id","tab":"Configuration","tool_mode":"hidden","visible":false},"advanced_search":{"type":"boolean","title":"Advanced Search","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Advanced search tools","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","tooltip":"The agent chooses the best search method (overrides the KB configured retrieval method).","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"clamp_top_k":{"type":"boolean","title":"Clamp Top K","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Limit results per search","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","tooltip":"Force every search against this knowledge base to return a number of results inside a fixed range.","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"top_k_window":{"items":{"type":"integer"},"type":"array","title":"Top K Window","display":{"col_span":12,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Allowed results range","max":100,"min":1,"needs_confirmation":false,"show_optional_label":false,"step":1,"type":"number_range_slider"},"rules":[{"config_source":"clamp_top_k","type":"visible_if","value":true}],"tab":"Configuration","tool_mode":"hidden"},"private":{"type":"boolean","title":"Private","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Private knowledge base","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","tooltip":"The agent won’t cite this knowledge base as a source.","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"enable_browse_tools":{"type":"boolean","title":"Enable Browse Tools","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enable File system tools","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","tooltip":"Enable kb_tree and kb_ls tools for navigating the knowledge base file system.","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"include_tree_in_instructions":{"type":"boolean","title":"Include Tree In Instructions","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Include File system structure in instructions","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","tooltip":"Inline this KB's folder tree into the system prompt every turn. Saves the agent a kb_tree round-trip but increases prompt size. Keep depth low for large KBs.","type":"toggle"},"rules":[{"config_source":"enable_browse_tools","type":"visible_if","value":true}],"tab":"Configuration","tool_mode":"hidden"},"tree_depth_in_instructions":{"type":"integer","title":"Tree Depth In Instructions","default":3,"display":{"col_span":12,"hide_input":false,"hide_number":true,"is_disabled":false,"is_subconfig":false,"label":"Tree depth in instructions","max":10,"min":1,"needs_confirmation":false,"show_optional_label":false,"step":1,"tooltip":"How many folder levels to include (1-10).","type":"number_slider"},"rules":[{"config_source":"enable_browse_tools","type":"visible_if","value":true},{"config_source":"include_tree_in_instructions","type":"visible_if","value":true}],"tab":"Configuration","tool_mode":"hidden"},"link_references_to_noxus_file":{"type":"boolean","title":"Link References To Noxus File","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Always cite the Noxus internal URL","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","tooltip":"Overrides this Knowledge Base's citation options, forcing the Noxus internal URL: citations link to the document stored in Noxus instead of the URL from its metadata (e.g. the Google Drive or SharePoint link). Turn this on when the people using this agent may not have access to the original source location.","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"}},"type":"object","required":["kb_id"],"title":"KnowledgeBaseQaSettings","description":"Tool that allows the user to answer questions about a specific pre-selected knowledge base"},"KnowledgeBaseSelectorSettings-Input":{"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","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","description":"Whether the tool is enabled","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enabled","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Search","tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Searching knowledge base...","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Start message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the knowledge base search starts.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Knowledge base search complete","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"End message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the knowledge base search completes.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Folder"},"bg_color":{"type":"string","title":"Bg Color","default":"#FEF9C2"},"icon_color":{"type":"string","title":"Icon Color","default":"#894B00"},"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"},"KnowledgeBaseSelectorSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"KB Selector"},"description":{"type":"string","title":"Description","default":"Allows the user to select a knowledge base for your co-worker"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","description":"Whether the tool is enabled","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enabled","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Search","tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Searching knowledge base...","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Start message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the knowledge base search starts.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Knowledge base search complete","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"End message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the knowledge base search completes.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Folder"},"bg_color":{"type":"string","title":"Bg Color","default":"#FEF9C2"},"icon_color":{"type":"string","title":"Icon Color","default":"#894B00"},"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"},"KnowledgeBaseType":{"properties":{"source_type":{"type":"string","title":"Source Type"},"name":{"type":"string","title":"Name"},"image":{"type":"string","title":"Image"},"integration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration"},"subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subtype"},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Config"},"exposed":{"type":"boolean","title":"Exposed","default":true}},"type":"object","required":["source_type","name","image"],"title":"KnowledgeBaseType"},"KnowledgeBaseV2":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"name":{"type":"string","title":"Name"},"status":{"$ref":"#/components/schemas/TrainStatus"},"description":{"type":"string","title":"Description"},"document_types":{"items":{"type":"string"},"type":"array","title":"Document Types"},"kb_type":{"$ref":"#/components/schemas/KBType"},"size":{"type":"number","title":"Size"},"num_docs":{"type":"integer","title":"Num Docs"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"error":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Error"},"version":{"type":"string","enum":["v2","v3"],"title":"Version"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary"},"needs_summary_update":{"type":"boolean","title":"Needs Summary Update","default":false},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta"},"embedding_health":{"anyOf":[{"$ref":"#/components/schemas/EmbeddingHealth"},{"type":"null"}]},"health":{"anyOf":[{"$ref":"#/components/schemas/KBHealth"},{"type":"null"}]},"total_documents":{"type":"integer","title":"Total Documents"},"training_documents":{"type":"integer","title":"Training Documents"},"trained_documents":{"type":"integer","title":"Trained Documents"},"error_documents":{"type":"integer","title":"Error Documents"},"uploaded_documents":{"type":"integer","title":"Uploaded Documents"},"source_types":{"additionalProperties":{"type":"integer"},"type":"object","title":"Source Types"},"training_source_types":{"items":{"type":"string"},"type":"array","title":"Training Source Types"},"settings_":{"anyOf":[{"$ref":"#/components/schemas/KBConfig"},{"type":"null"}]}},"type":"object","required":["id","group_id","name","status","description","document_types","kb_type","size","num_docs","created_at","updated_at","error","version","total_documents","training_documents","trained_documents","error_documents","uploaded_documents","source_types","training_source_types"],"title":"KnowledgeBaseV2"},"KnowledgeBaseWithDocuments":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"name":{"type":"string","title":"Name"},"status":{"$ref":"#/components/schemas/TrainStatus"},"description":{"type":"string","title":"Description"},"document_types":{"items":{"type":"string"},"type":"array","title":"Document Types"},"kb_type":{"$ref":"#/components/schemas/KBType"},"size":{"type":"number","title":"Size"},"num_docs":{"type":"integer","title":"Num Docs"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"error":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Error"},"version":{"type":"string","enum":["v2","v3"],"title":"Version"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary"},"needs_summary_update":{"type":"boolean","title":"Needs Summary Update","default":false},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta"},"embedding_health":{"anyOf":[{"$ref":"#/components/schemas/EmbeddingHealth"},{"type":"null"}]},"health":{"anyOf":[{"$ref":"#/components/schemas/KBHealth"},{"type":"null"}]},"total_documents":{"type":"integer","title":"Total Documents"},"training_documents":{"type":"integer","title":"Training Documents"},"trained_documents":{"type":"integer","title":"Trained Documents"},"error_documents":{"type":"integer","title":"Error Documents"},"uploaded_documents":{"type":"integer","title":"Uploaded Documents"},"source_types":{"additionalProperties":{"type":"integer"},"type":"object","title":"Source Types"},"training_source_types":{"items":{"type":"string"},"type":"array","title":"Training Source Types"},"settings_":{"anyOf":[{"$ref":"#/components/schemas/KBConfig"},{"type":"null"}]},"documents":{"items":{"$ref":"#/components/schemas/KnowledgeBaseDocumentWithCitation"},"type":"array","title":"Documents","default":[]}},"type":"object","required":["id","group_id","name","status","description","document_types","kb_type","size","num_docs","created_at","updated_at","error","version","total_documents","training_documents","trained_documents","error_documents","uploaded_documents","source_types","training_source_types"],"title":"KnowledgeBaseWithDocuments"},"LLMModelProperties":{"properties":{"speed":{"type":"number","title":"Speed"},"quality":{"type":"number","title":"Quality"},"max_input_tokens":{"type":"integer","title":"Max Input Tokens"},"max_output_tokens":{"type":"integer","title":"Max Output Tokens"},"is_multimodal":{"type":"boolean","title":"Is Multimodal","default":false}},"type":"object","required":["speed","quality","max_input_tokens","max_output_tokens"],"title":"LLMModelProperties"},"ListContainer":{"properties":{"total_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Size"},"taken":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Taken"},"truncated":{"type":"boolean","title":"Truncated","default":false},"preview_file":{"anyOf":[{"$ref":"#/components/schemas/FileType"},{"type":"null"}]},"list_offset":{"type":"integer","title":"List Offset","default":0},"type":{"type":"string","const":"list","title":"Type","default":"list"},"value":{"title":"Value"}},"type":"object","required":["value"],"title":"ListContainer"},"LoadCapabilityArgs":{"properties":{"id":{"type":"string","title":"Id","description":"The id of the capability to load."}},"type":"object","required":["id"],"title":"LoadCapabilityArgs","description":"Typed arguments for a `load_capability` tool call."},"LoadCapabilityCallPart":{"properties":{"tool_call_id":{"type":"string","title":"Tool Call Id"},"tool_name":{"type":"string","const":"load_capability","title":"Tool Name","default":"load_capability"},"args":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/LoadCapabilityArgs"},{"type":"null"}],"title":"Args"},"tool_kind":{"type":"string","const":"capability-load","title":"Tool Kind","default":"capability-load"},"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","title":"LoadCapabilityCallPart","description":"Typed `ToolCallPart` for the `load_capability` tool."},"LoadCapabilityReturn":{"properties":{"instructions":{"type":"string","title":"Instructions"}},"type":"object","title":"LoadCapabilityReturn","description":"Typed return value for the `load_capability` tool."},"LoadCapabilityReturnPart":{"properties":{"tool_call_id":{"type":"string","title":"Tool Call Id"},"tool_name":{"type":"string","const":"load_capability","title":"Tool Name","default":"load_capability"},"content":{"$ref":"#/components/schemas/LoadCapabilityReturn"},"tool_kind":{"type":"string","const":"capability-load","title":"Tool Kind","default":"capability-load"},"metadata":{"title":"Metadata"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"outcome":{"type":"string","enum":["success","failed","denied","interrupted"],"title":"Outcome","default":"success"},"part_kind":{"type":"string","const":"tool-return","title":"Part Kind","default":"tool-return"}},"type":"object","required":["content"],"title":"LoadCapabilityReturnPart","description":"Typed `ToolReturnPart` for the `load_capability` tool."},"MCPServerBinding":{"properties":{"credential_id":{"type":"string","format":"uuid","title":"Credential Id"},"enabled":{"type":"boolean","title":"Enabled","default":true},"selected_tools":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Selected Tools"}},"type":"object","required":["credential_id"],"title":"MCPServerBinding","description":"Per-agent binding to a workspace MCP credential.\n\n``selected_tools=None`` means \"every tool the server exposes minus the\ncredential's ``disabled_tools``\" — new server tools flow through without a\nre-probe. An explicit list is a per-agent allowlist narrowed further by the\nworkspace denials."},"Mark":{"properties":{"type":{"type":"string","title":"Type"},"attrs":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Attrs"}},"type":"object","required":["type"],"title":"Mark"},"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"},"Membership":{"properties":{"workspace_id":{"type":"string","title":"Workspace Id"},"workspace_name":{"type":"string","title":"Workspace Name"},"role_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role Id"},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role"}},"type":"object","required":["workspace_id","workspace_name","role_id","role"],"title":"Membership"},"MembershipAccess":{"properties":{"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"workspace_name":{"type":"string","title":"Workspace Name"},"role_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Role Id"},"role_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role Name"},"permissions":{"items":{"type":"string"},"type":"array","title":"Permissions"}},"type":"object","required":["workspace_id","workspace_name","role_id","role_name","permissions"],"title":"MembershipAccess"},"MembershipRequest":{"properties":{"role":{"type":"string","title":"Role","description":"Workspace role id or name"}},"type":"object","required":["role"],"title":"MembershipRequest"},"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"},"MemorySettings-Input":{"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","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Brain"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Accessing memory..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Memory operation complete"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Brain"},"bg_color":{"type":"string","title":"Bg Color","default":"#f5f3ff"},"icon_color":{"type":"string","title":"Icon Color","default":"#8e51ff"},"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"},"MemorySettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Memory"},"description":{"type":"string","title":"Description","default":"Persistent memory during a single conversation"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Brain"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Accessing memory..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Memory operation complete"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Brain"},"bg_color":{"type":"string","title":"Bg Color","default":"#f5f3ff"},"icon_color":{"type":"string","title":"Icon Color","default":"#8e51ff"},"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"},"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"},"MessageResponse":{"properties":{"message":{"type":"string","title":"Message"}},"type":"object","required":["message"],"title":"MessageResponse","description":"Standard response for operations that return a status message."},"MessageRole":{"type":"string","enum":["system","user","assistant","function","noxus","controller"],"title":"MessageRole"},"MimeTypeInfo":{"properties":{"type":{"type":"string","title":"Type"},"extension":{"type":"string","title":"Extension"},"image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image"}},"type":"object","required":["type","extension"],"title":"MimeTypeInfo","description":"Information about a supported MIME type"},"MissingDependencyPolicy":{"type":"string","enum":["fail","warn"],"title":"MissingDependencyPolicy"},"ModelCapability":{"type":"string","enum":["streaming","function_calling","parallel_function_calling","vision","system_prompt","tools","json_mode","structured_output","reasoning","web_search","audio_in","audio_out","video_in","video_out","image_generation","document_input","spreadsheet_input"],"title":"ModelCapability"},"ModelDefinition":{"properties":{"name":{"type":"string","title":"Name"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug"},"title":{"type":"string","title":"Title"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"model_type":{"type":"string","title":"Model Type"},"model_category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Model Category"},"properties":{"anyOf":[{"$ref":"#/components/schemas/LLMModelProperties"},{"$ref":"#/components/schemas/ModelProperties"}],"title":"Properties"},"image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image"},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Config"},"provider":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider"},"provider_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Id"},"provider_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Image"},"providers":{"items":{"$ref":"#/components/schemas/ProviderRef"},"type":"array","title":"Providers","default":[]},"host":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location"},"price":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Price"},"release_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Release Date"},"data_cutoff_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Data Cutoff Date"},"retirement_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Retirement Date"},"replaced_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Replaced By"},"privacy_level":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Privacy Level"},"visible":{"type":"boolean","title":"Visible","default":true},"is_available":{"type":"boolean","title":"Is Available","default":true},"capabilities":{"items":{"$ref":"#/components/schemas/ModelCapability"},"type":"array","uniqueItems":true,"title":"Capabilities","default":[]},"is_active":{"type":"boolean","title":"Is Active","default":true},"provider_is_active":{"type":"boolean","title":"Provider Is Active","default":true},"has_link":{"type":"boolean","title":"Has Link","default":false},"is_valid":{"type":"boolean","title":"Is Valid","default":true},"is_healthy":{"type":"boolean","title":"Is Healthy","default":true},"lifecycle_state":{"type":"string","title":"Lifecycle State","default":"healthy"},"last_error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Error"},"consecutive_failures":{"type":"integer","title":"Consecutive Failures","default":0},"last_checked_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Checked At"}},"type":"object","required":["name","title","model_type","properties"],"title":"ModelDefinition"},"ModelParameters":{"properties":{"temperature":{"anyOf":[{"type":"number"},{"type":"string","const":"NOT_GIVEN"}],"title":"Temperature","description":"Controls randomness in generation","default":"NOT_GIVEN"},"top_p":{"anyOf":[{"type":"number"},{"type":"string","const":"NOT_GIVEN"}],"title":"Top P","description":"Nucleus sampling threshold","default":"NOT_GIVEN"},"top_k":{"anyOf":[{"type":"integer"},{"type":"string","const":"NOT_GIVEN"}],"title":"Top K","description":"Top-k sampling threshold","default":"NOT_GIVEN"},"frequency_penalty":{"anyOf":[{"type":"number"},{"type":"string","const":"NOT_GIVEN"}],"title":"Frequency Penalty","description":"Penalty for token frequency","default":"NOT_GIVEN"},"presence_penalty":{"anyOf":[{"type":"number"},{"type":"string","const":"NOT_GIVEN"}],"title":"Presence Penalty","description":"Penalty for token presence","default":"NOT_GIVEN"},"logit_bias":{"anyOf":[{"additionalProperties":{"type":"number"},"type":"object"},{"type":"string","const":"NOT_GIVEN"}],"title":"Logit Bias","description":"Token biasing dictionary","default":"NOT_GIVEN"},"max_tokens":{"anyOf":[{"type":"integer"},{"type":"string","const":"NOT_GIVEN"}],"title":"Max Tokens","description":"Maximum number of tokens to generate","default":"NOT_GIVEN"},"stop":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"string","const":"NOT_GIVEN"}],"title":"Stop","description":"Stop sequences","default":"NOT_GIVEN"},"logprobs":{"anyOf":[{"type":"integer"},{"type":"string","const":"NOT_GIVEN"}],"title":"Logprobs","description":"Number of logprobs to return","default":"NOT_GIVEN"},"top_logprobs":{"anyOf":[{"type":"integer"},{"type":"string","const":"NOT_GIVEN"}],"title":"Top Logprobs","description":"Number of most likely tokens to return","default":"NOT_GIVEN"},"seed":{"anyOf":[{"type":"integer"},{"type":"string","const":"NOT_GIVEN"}],"title":"Seed","description":"Random seed for reproducibility","default":"NOT_GIVEN"},"timeout":{"anyOf":[{"type":"number"},{"type":"string","const":"NOT_GIVEN"}],"title":"Timeout","description":"Request timeout in seconds","default":"NOT_GIVEN"},"include_reasoning":{"anyOf":[{"type":"boolean"},{"type":"string","const":"NOT_GIVEN"}],"title":"Include Reasoning","description":"Whether to include reasoning steps","default":"NOT_GIVEN"},"reasoning_effort":{"anyOf":[{"type":"string","enum":["off","low","medium","high","xhigh"]},{"type":"string","const":"NOT_GIVEN"}],"title":"Reasoning Effort","description":"Reasoning level","default":"NOT_GIVEN"},"parallel_tool_calls":{"anyOf":[{"type":"boolean"},{"type":"string","const":"NOT_GIVEN"}],"title":"Parallel Tool Calls","description":"Whether to allow parallel function calling","default":"NOT_GIVEN"},"model_override":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/ModelParameters"},"type":"object"},{"type":"string","const":"NOT_GIVEN"}],"title":"Model Override","description":"Model override parameters","default":"NOT_GIVEN"}},"type":"object","title":"ModelParameters"},"ModelPreset":{"properties":{"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle","description":"Unique handle for the preset, e.g. 'cost', 'chat-quality'"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon","description":"Icon identifier for the preset, e.g. 'dollar', 'gauge', 'zap'"},"models":{"items":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/ModelPreset"}]},"type":"array","title":"Models","description":"List of model IDs"},"required_capabilities":{"items":{"$ref":"#/components/schemas/ModelCapability"},"type":"array","uniqueItems":true,"title":"Required Capabilities","description":"Capabilities required for the preset","default":[]},"capability_check_mode":{"type":"string","enum":["any","all"],"title":"Capability Check Mode","description":"Whether a model must have 'all' required capabilities or just 'any' one of them","default":"all"},"minimum_speed_tier":{"anyOf":[{"$ref":"#/components/schemas/TierQuality"},{"type":"null"}],"description":"Minimum speed tier required for the preset"},"minimum_quality_tier":{"anyOf":[{"$ref":"#/components/schemas/TierQuality"},{"type":"null"}],"description":"Minimum quality tier required for the preset"},"title":{"type":"string","title":"Title","description":"Title of the preset","default":"A Model Preset"},"subtitle":{"type":"string","title":"Subtitle","description":"Subtitle of the preset","default":"A model preset"},"description":{"type":"string","title":"Description","description":"Description of the preset","default":"A model preset"},"parameters":{"anyOf":[{"$ref":"#/components/schemas/ModelParameters"},{"type":"null"}],"description":"Parameters of the preset"},"data_center_fallback":{"type":"boolean","title":"Data Center Fallback","description":"Whether to use data center fallback, meaning to change regions of the model when available","default":true},"exhaustive":{"type":"boolean","title":"Exhaustive","description":"Whether to exhaustively search for models in the registry, after preset if done","default":false}},"type":"object","required":["models"],"title":"ModelPreset"},"ModelProperties":{"properties":{"speed":{"type":"number","title":"Speed"},"quality":{"type":"number","title":"Quality"}},"type":"object","required":["speed","quality"],"title":"ModelProperties"},"ModelRequest":{"properties":{"parts":{"items":{"oneOf":[{"$ref":"#/components/schemas/SystemPromptPart"},{"$ref":"#/components/schemas/UserPromptPart"},{"$ref":"#/components/schemas/SpeechPart"},{"$ref":"#/components/schemas/ToolSearchReturnPart"},{"$ref":"#/components/schemas/LoadCapabilityReturnPart"},{"$ref":"#/components/schemas/ToolReturnPart"},{"$ref":"#/components/schemas/RetryPromptPart"},{"$ref":"#/components/schemas/ToolAvailabilityDeltaPart"}]},"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"},"conversation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Conversation Id"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"state":{"type":"string","enum":["complete","interrupted"],"title":"State","default":"complete"}},"type":"object","required":["parts"],"title":"ModelRequest","description":"A request generated by Pydantic AI and sent to a model, e.g. a message from the Pydantic AI app to the model."},"ModelResponse":{"properties":{"parts":{"items":{"oneOf":[{"$ref":"#/components/schemas/TextPart"},{"$ref":"#/components/schemas/ToolSearchCallPart"},{"$ref":"#/components/schemas/LoadCapabilityCallPart"},{"$ref":"#/components/schemas/ToolCallPart"},{"$ref":"#/components/schemas/NativeToolSearchCallPart"},{"$ref":"#/components/schemas/NativeToolCallPart"},{"$ref":"#/components/schemas/NativeToolSearchReturnPart"},{"$ref":"#/components/schemas/NativeToolReturnPart"},{"$ref":"#/components/schemas/ThinkingPart"},{"$ref":"#/components/schemas/CompactionPart"},{"$ref":"#/components/schemas/FilePart"},{"$ref":"#/components/schemas/SpeechPart"}]},"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"},"conversation_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Conversation Id"},"metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metadata"},"workspace_ref":{"anyOf":[{"$ref":"#/components/schemas/WorkspaceRef"},{"type":"null"}]},"state":{"type":"string","enum":["complete","incomplete","suspended","interrupted"],"title":"State","default":"complete"}},"type":"object","required":["parts"],"title":"ModelResponse","description":"A response from a model, e.g. a message from the model to the Pydantic AI app."},"NativeTeamsAppState":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"status":{"$ref":"#/components/schemas/NativeTeamsAppStatus"},"is_paused":{"type":"boolean","title":"Is Paused"},"bound_tenant_id":{"type":"string","title":"Bound Tenant Id"},"tenant_admin_credential_id":{"type":"string","format":"uuid","title":"Tenant Admin Credential Id"},"manifest_app_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manifest App Id"},"provisioning_step":{"anyOf":[{"type":"string","enum":["application_retired","bot_credential","bot_credential_cleanup_pending","bot_credential_rotated","bot_endpoint","bot_resource","bot_retired","catalog_retired","entra_application","entra_sign_in_audience","metadata_republished","old_bot_credential_removed","package_publish","publishing_observed","retirement_completed","service_principal","teams_channel","update_approved"]},{"type":"null"}],"title":"Provisioning Step"},"observed_publishing_state":{"anyOf":[{"type":"string","enum":["submitted","published","rejected"]},{"type":"null"}],"title":"Observed Publishing State"},"package_version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Package Version"},"error_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Code"},"error_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error Message"},"attempt_count":{"type":"integer","title":"Attempt Count"},"next_retry_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next Retry At"},"last_reconciled_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Reconciled At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"retryable":{"type":"boolean","title":"Retryable","readOnly":true}},"type":"object","required":["id","status","is_paused","bound_tenant_id","tenant_admin_credential_id","manifest_app_id","provisioning_step","observed_publishing_state","package_version","error_code","error_message","attempt_count","next_retry_at","last_reconciled_at","created_at","updated_at","retryable"],"title":"NativeTeamsAppState"},"NativeTeamsAppStatus":{"type":"string","enum":["publishing","awaiting_approval","active","failed","retiring","retirement_failed","retired"],"title":"NativeTeamsAppStatus"},"NativeToolCallPart":{"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"},"tool_kind":{"anyOf":[{"type":"string","enum":["tool-search","capability-load"]},{"type":"null"}],"title":"Tool Kind"},"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":"NativeToolCallPart","description":"A tool call to a native tool.\n\nFor native tools with a stable cross-provider shape (currently `tool_search`), this base\nclass can be promoted to a typed subclass with a narrowed `args` `TypedDict`. See\n[`NativeToolSearchCallPart`][pydantic_ai.messages.NativeToolSearchCallPart] for the\ncanonical example.\n\nAdding a typed subclass for a future native tool (see `pydantic_ai._tool_search` for\na worked example):\n\n1. Add a sibling `pydantic_ai/_<name>.py` module that defines the cross-provider\n   `TypedDict`s, the `NativeToolCallPart` / `NativeToolReturnPart` subclasses,\n   and registers their narrowers into `_NATIVE_CALL_NARROWERS` /\n   `_NATIVE_RETURN_NARROWERS` keyed by `tool_kind`. Subclass overrides\n   `tool_kind: Literal['<emitter>']` to match the emitting\n   [`AbstractNativeTool.kind`][pydantic_ai.native_tools.AbstractNativeTool.kind],\n   and shadows `args` / `content` with a narrower type.\n2. Late-import the new module from this file (alongside the existing tool-search\n   import) so registration runs whenever `pydantic_ai.messages` is imported.\n3. Add the subclass to `ModelResponsePart`'s discriminated union and to\n   `_model_response_part_discriminator` so Pydantic deserialization auto-promotes\n   on `model_validate` / `model_validate_json`.\n\nDispatch is by `tool_kind`, not `tool_name`. This protects users whose tools happen to\nshare a name with one of ours from accidentally getting their parts promoted (and\nfailing shape validation against the typed `args`/`content`).\n\nThe `provider_details` field carries genuinely non-portable provider extras\n(e.g. Anthropic's `strategy: 'bm25' | 'regex'` for tool search). Promote a field\nto a typed slot in `args` / `content` only when at least two of OpenAI, Anthropic,\nand Google support it (cf. [issue #3885](https://github.com/pydantic/pydantic-ai/issues/3885)).\n\nMCP server tools land here with `tool_kind='mcp_server'` (label stays in\n`tool_name='mcp_server:<label>'`); typed-subclass work for MCP is tracked by\n[issue #3561](https://github.com/pydantic/pydantic-ai/issues/3561)."},"NativeToolReturnPart":{"properties":{"tool_name":{"type":"string","title":"Tool Name"},"content":{"$ref":"#/components/schemas/ToolReturnContent"},"tool_call_id":{"type":"string","title":"Tool Call Id"},"tool_kind":{"anyOf":[{"type":"string","enum":["tool-search","capability-load"]},{"type":"null"}],"title":"Tool Kind"},"metadata":{"title":"Metadata"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"outcome":{"type":"string","enum":["success","failed","denied","interrupted"],"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":"NativeToolReturnPart","description":"A tool return message from a native tool.\n\nFor native tools with a stable cross-provider shape (currently `tool_search`), a\n`NativeToolReturnPart` may be promoted to a typed subclass like\n[`NativeToolSearchReturnPart`][pydantic_ai.messages.NativeToolSearchReturnPart]\nwith a narrowed `content` `TypedDict`. See `NativeToolCallPart` for the pattern."},"NativeToolSearchCallPart":{"properties":{"tool_name":{"type":"string","const":"tool_search","title":"Tool Name","default":"tool_search"},"args":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/ToolSearchArgs"},{"type":"null"}],"title":"Args"},"tool_call_id":{"type":"string","title":"Tool Call Id"},"tool_kind":{"type":"string","const":"tool-search","title":"Tool Kind","default":"tool-search"},"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","title":"NativeToolSearchCallPart","description":"Typed view of a [`NativeToolCallPart`][pydantic_ai.messages.NativeToolCallPart] for tool search.\n\nUsed on the native server-side tool-search path (Anthropic BM25/regex, OpenAI\nResponses) where the provider executes the search and emits a native result.\nThe local-fallback path uses\n[`ToolSearchCallPart`][pydantic_ai.messages.ToolSearchCallPart] instead.\n\nTo detect a tool-search part regardless of execution path (native server-side\nvs. local fallback), check `part.tool_kind == 'tool-search'` — this works\nacross both call/return and both server/local variants.\n\nShadows `args` with a narrower type. The `str` variant covers the\nstreaming / partial-args case before parsing completes; once parsed,\n`args` is a [`ToolSearchArgs`][pydantic_ai.messages.ToolSearchArgs]\n`TypedDict`."},"NativeToolSearchReturnPart":{"properties":{"tool_name":{"type":"string","const":"tool_search","title":"Tool Name","default":"tool_search"},"tool_call_id":{"type":"string","title":"Tool Call Id"},"tool_kind":{"type":"string","const":"tool-search","title":"Tool Kind","default":"tool-search"},"content":{"$ref":"#/components/schemas/ToolSearchReturnContent"},"metadata":{"title":"Metadata"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"outcome":{"type":"string","enum":["success","failed","denied","interrupted"],"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":["content"],"title":"NativeToolSearchReturnPart","description":"Typed view of a [`NativeToolReturnPart`][pydantic_ai.messages.NativeToolReturnPart] for tool search.\n\nUsed on the native server-side tool-search path (Anthropic BM25/regex, OpenAI\nResponses) where the provider executes the search and emits a native result.\nThe local-fallback path uses\n[`ToolSearchReturnPart`][pydantic_ai.messages.ToolSearchReturnPart] instead.\n\nTo detect a tool-search part regardless of execution path (native server-side\nvs. local fallback), check `part.tool_kind == 'tool-search'` — this works\nacross both call/return and both server/local variants.\n\nShadows `content` with a narrower\n[`ToolSearchReturnContent`][pydantic_ai.messages.ToolSearchReturnContent]\n`TypedDict`."},"Node-Input":{"properties":{"type":{"type":"string","title":"Type"},"attrs":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Attrs"},"content":{"anyOf":[{"items":{"$ref":"#/components/schemas/Node-Input"},"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"},"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"},"NodeDefinition":{"properties":{"inputs":{"items":{},"type":"array","title":"Inputs"},"outputs":{"items":{},"type":"array","title":"Outputs"},"details":{"items":{},"type":"array","title":"Details"},"config":{"additionalProperties":true,"type":"object","title":"Config"},"type":{"type":"string","title":"Type"},"color":{"type":"string","title":"Color"},"image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"small_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Small Description"},"documentation_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Documentation Url"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"sub_category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sub Category"},"example":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Example"},"ai_instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ai Instructions"},"integrations":{"anyOf":[{"items":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"}]},"type":"array"},{"type":"null"}],"title":"Integrations"},"providers":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Providers"},"config_endpoint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Config Endpoint"},"subflow_config":{"anyOf":[{"$ref":"#/components/schemas/SubflowConfig"},{"type":"null"}]},"is_valid":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Valid"},"visible":{"type":"boolean","title":"Visible","default":true},"superseded_by":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Superseded By"},"is_tool":{"type":"boolean","title":"Is Tool","default":false},"is_available":{"type":"boolean","title":"Is Available","default":true},"show_to_user":{"type":"boolean","title":"Show To User","default":true},"paywalled":{"type":"boolean","title":"Paywalled","default":false},"plugin_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plugin Id"},"plugin_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plugin Name"},"supports_mocking":{"type":"boolean","title":"Supports Mocking","default":false},"deletable":{"type":"boolean","title":"Deletable","default":true},"unique":{"type":"boolean","title":"Unique","default":false},"supports_error_handling":{"type":"boolean","title":"Supports Error Handling","default":true},"supports_iteration":{"type":"boolean","title":"Supports Iteration","default":true},"no_repeated_names":{"type":"boolean","title":"No Repeated Names","default":false},"allowed_in_flow_types":{"items":{"type":"string"},"type":"array","title":"Allowed In Flow Types","default":["flow","handler","ingestion"]},"pinned_fields":{"items":{"type":"string"},"type":"array","title":"Pinned Fields","default":[]},"picker_priority":{"type":"integer","title":"Picker Priority","default":0},"output_paths":{"items":{"type":"string"},"type":"array","title":"Output Paths","default":[]},"input_paths":{"items":{"type":"string"},"type":"array","title":"Input Paths","default":[]},"v2_ready":{"type":"boolean","title":"V2 Ready","default":false},"accepts_inline_files":{"type":"boolean","title":"Accepts Inline Files","default":false},"default_output_type":{"anyOf":[{"prefixItems":[{"type":"string"},{"type":"integer"}],"type":"array","maxItems":2,"minItems":2},{"type":"null"}],"title":"Default Output Type"},"gathers_list":{"type":"boolean","title":"Gathers List","default":false},"gather_fields":{"items":{"type":"string"},"type":"array","title":"Gather Fields","default":[]},"is_loop_scope":{"type":"boolean","title":"Is Loop Scope","default":false},"scope_only_outputs":{"items":{"type":"string"},"type":"array","title":"Scope Only Outputs","default":[]},"referenced_assets":{"items":{"$ref":"#/components/schemas/ReferencedAssetField"},"type":"array","title":"Referenced Assets","default":[]}},"type":"object","required":["inputs","outputs","details","config","type","color"],"title":"NodeDefinition"},"NodePreview":{"properties":{"node_config":{"additionalProperties":true,"type":"object","title":"Node Config"},"connector_config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Connector Config"},"credential_ids":{"additionalProperties":{"type":"string"},"type":"object","title":"Credential Ids","default":{}},"subflow_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subflow Id"},"id":{"type":"string","title":"Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"type":{"type":"string","title":"Type"},"subflow_config":{"anyOf":[{"$ref":"#/components/schemas/SubflowConfig"},{"type":"null"}]},"plugin_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Plugin Name"}},"type":"object","required":["node_config","id","type"],"title":"NodePreview"},"NodeProgress":{"properties":{"current_it":{"type":"integer","title":"Current It"},"total_it":{"type":"integer","title":"Total It"},"status":{"$ref":"#/components/schemas/NodeStatus"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At"},"warnings":{"items":{"$ref":"#/components/schemas/SpotWarning"},"type":"array","title":"Warnings"}},"type":"object","required":["current_it","total_it","status"],"title":"NodeProgress"},"NodeStatus":{"type":"string","enum":["running","errored","succeeded","skipped","payment_required","awaiting_human_feedback","paused"],"title":"NodeStatus"},"NoticedFeed":{"properties":{"items":{"items":{"$ref":"#/components/schemas/NoticedItem"},"type":"array","title":"Items"}},"type":"object","required":["items"],"title":"NoticedFeed"},"NoticedItem":{"properties":{"sub_topic":{"type":"string","title":"Sub Topic"},"parent_topic":{"type":"string","title":"Parent Topic"},"badge":{"type":"string","enum":["emerging","rising","needs_attention"],"title":"Badge"},"stat":{"type":"string","title":"Stat"},"blurb":{"type":"string","title":"Blurb"},"share":{"type":"number","title":"Share"},"conversation_id":{"type":"string","format":"uuid","title":"Conversation Id"}},"type":"object","required":["sub_topic","parent_topic","badge","stat","blurb","share","conversation_id"],"title":"NoticedItem"},"NoxusQaSettings-Input":{"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","Agents"],"title":"Category","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Bot"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Noxus Q&A"},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Noxus Q&A complete"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Bot"},"bg_color":{"type":"string","title":"Bg Color","default":"#EFF6FF"},"icon_color":{"type":"string","title":"Icon Color","default":"#2B7FFF"},"deprecated":{"type":"boolean","title":"Deprecated","default":true},"type":{"type":"string","const":"noxus_qa","title":"Type","default":"noxus_qa"}},"type":"object","title":"NoxusQaSettings"},"NoxusQaSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Noxus Q&A"},"description":{"type":"string","title":"Description","default":"Noxus Q&A"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Bot"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Noxus Q&A"},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Noxus Q&A complete"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Bot"},"bg_color":{"type":"string","title":"Bg Color","default":"#EFF6FF"},"icon_color":{"type":"string","title":"Icon Color","default":"#2B7FFF"},"deprecated":{"type":"boolean","title":"Deprecated","default":true},"type":{"type":"string","const":"noxus_qa","title":"Type","default":"noxus_qa"}},"type":"object","title":"NoxusQaSettings"},"NoxusTipTapDocument-Input":{"properties":{"text":{"type":"string","title":"Text"},"definition":{"$ref":"#/components/schemas/TiptapDocument-Input"}},"type":"object","required":["text"],"title":"NoxusTipTapDocument"},"NoxusTipTapDocument-Output":{"properties":{"text":{"type":"string","title":"Text"},"definition":{"$ref":"#/components/schemas/TiptapDocument-Output"}},"type":"object","required":["text"],"title":"NoxusTipTapDocument"},"NumberContainer":{"properties":{"total_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Size"},"taken":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Taken"},"truncated":{"type":"boolean","title":"Truncated","default":false},"preview_file":{"anyOf":[{"$ref":"#/components/schemas/FileType"},{"type":"null"}]},"list_offset":{"type":"integer","title":"List Offset","default":0},"type":{"type":"string","const":"number","title":"Type","default":"number"},"value":{"title":"Value"}},"type":"object","required":["value"],"title":"NumberContainer"},"ObjectContainer":{"properties":{"total_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Size"},"taken":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Taken"},"truncated":{"type":"boolean","title":"Truncated","default":false},"preview_file":{"anyOf":[{"$ref":"#/components/schemas/FileType"},{"type":"null"}]},"list_offset":{"type":"integer","title":"List Offset","default":0},"type":{"type":"string","const":"object","title":"Type","default":"object"},"value":{"title":"Value"}},"type":"object","required":["value"],"title":"ObjectContainer"},"OneDriveFile":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"mime_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mime Type"},"image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"drive_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Drive Id"},"site_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Site Name"}},"type":"object","required":["id","name"],"title":"OneDriveFile"},"OneDriveSource":{"properties":{"source_type":{"type":"string","const":"OneDrive","title":"Source Type","default":"OneDrive"},"subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subtype"},"config_cls":{"title":"Config Cls"},"config":{"$ref":"#/components/schemas/OneDriveSourceConfig"},"integration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration"},"image":{"type":"string","title":"Image","default":"https://storage.googleapis.com/image-storage-spot-manual/logos/onedrive.png"},"name":{"type":"string","title":"Name","default":"OneDrive"},"exposed":{"type":"boolean","title":"Exposed","default":true}},"type":"object","required":["config"],"title":"OneDriveSource"},"OneDriveSourceConfig":{"properties":{"connection":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connection","display":{"col_span":12,"integration_type":"onedrive","is_disabled":false,"is_subconfig":false,"label":"Onedrive Connection","needs_confirmation":false,"show_optional_label":false,"type":"credential_picker"},"field_type":"config","tab":"Configuration","tool_mode":"hidden"},"files":{"items":{"$ref":"#/components/schemas/OneDriveFile"},"type":"array","title":"Files","description":"Document to read","display":{"col_span":12,"file_type":"folder","is_disabled":false,"is_subconfig":false,"label":"","multi_select":true,"name":"OneDrive","needs_confirmation":false,"set_include_folders":true,"show_optional_label":false,"type":"onedrive_picker"},"placeholder":[{"id":"123","image":"123","name":"123"}],"tab":"Configuration","tool_mode":"hidden"}},"type":"object","required":["files"],"title":"OneDriveSourceConfig","description":"text_display_1: str = Parameter(\n    default=\"\",\n    display=ConfigTextDisplay(\n        title=\"Select files to add to knowledge base\",\n        text=\"\",\n    ),\n)"},"OverflowSettings-Input":{"properties":{"title":{"type":"string","title":"Title","default":"Tool output overflow"},"description":{"type":"string","title":"Description","default":"Move an oversized tool result out of the context window: it is stored, the agent sees a preview, and reads the rest back on demand"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","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":"ArchiveRestore"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Reading stored tool output..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Stored output read"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"ArchiveRestore"},"bg_color":{"type":"string","title":"Bg Color","default":"#cffafe"},"icon_color":{"type":"string","title":"Icon Color","default":"#0891b2"},"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":"overflow","title":"Type","default":"overflow"},"storage_backend":{"type":"string","enum":["blob","redis"],"title":"Storage Backend","description":"Where a stored tool output lives until it is read back.","default":"blob","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":false,"is_subconfig":false,"label":"Storage","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"label":"Blob storage (durable, no expiry)","value":"blob"},{"label":"Redis (bounded by a TTL)","value":"redis"}]},"tab":"Configuration","tool_mode":"hidden"}},"type":"object","title":"OverflowSettings","description":"Where an oversized tool output is stored, owned by the quick action.\n\nIt lives here rather than on ``AgentSettings`` so the capability that\n    reads it carries it: a quick action is only present on agents that\n    added it, so an agent without overflow is never shown knobs for it, and no\n    settings version has to exist to say so."},"OverflowSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Tool output overflow"},"description":{"type":"string","title":"Description","default":"Move an oversized tool result out of the context window: it is stored, the agent sees a preview, and reads the rest back on demand"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","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":"ArchiveRestore"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Reading stored tool output..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Stored output read"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"ArchiveRestore"},"bg_color":{"type":"string","title":"Bg Color","default":"#cffafe"},"icon_color":{"type":"string","title":"Icon Color","default":"#0891b2"},"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":"overflow","title":"Type","default":"overflow"},"storage_backend":{"type":"string","enum":["blob","redis"],"title":"Storage Backend","description":"Where a stored tool output lives until it is read back.","default":"blob","display":{"col_span":12,"icons":false,"is_clearable":false,"is_disabled":false,"is_horizontal":false,"is_searchable":false,"is_subconfig":false,"label":"Storage","needs_confirmation":false,"show_optional_label":false,"type":"select","values":[{"label":"Blob storage (durable, no expiry)","value":"blob"},{"label":"Redis (bounded by a TTL)","value":"redis"}]},"tab":"Configuration","tool_mode":"hidden"}},"type":"object","title":"OverflowSettings","description":"Where an oversized tool output is stored, owned by the quick action.\n\nIt lives here rather than on ``AgentSettings`` so the capability that\n    reads it carries it: a quick action is only present on agents that\n    added it, so an agent without overflow is never shown knobs for it, and no\n    settings version has to exist to say so."},"OwnedFile":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"uri":{"type":"string","title":"Uri"},"size":{"type":"number","title":"Size"},"group_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Group Id"},"filename":{"type":"string","title":"Filename"},"content_type":{"type":"string","title":"Content Type"},"source_type":{"$ref":"#/components/schemas/SourceType"},"source_metadata":{"anyOf":[{"$ref":"#/components/schemas/SourceMetadata"},{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Source Metadata"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"}},"type":"object","required":["id","uri","size","filename","content_type","source_type","source_metadata"],"title":"OwnedFile"},"Page_AssistantVersion_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AssistantVersion"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[AssistantVersion]"},"Page_DeploymentEvent_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/DeploymentEvent"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[DeploymentEvent]"},"Page_EvaluatorResultResponse_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/EvaluatorResultResponse"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[EvaluatorResultResponse]"},"Page_GroupTriggerEvent_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/GroupTriggerEvent"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[GroupTriggerEvent]"},"Page_KnowledgeBaseDocument_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/KnowledgeBaseDocument"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[KnowledgeBaseDocument]"},"Page_KnowledgeBaseV2_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/KnowledgeBaseV2"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[KnowledgeBaseV2]"},"Page_PublicRunWithSearchData_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PublicRunWithSearchData"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[PublicRunWithSearchData]"},"Page_PublicSimplifiedRun_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PublicSimplifiedRun"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[PublicSimplifiedRun]"},"Page_RunNoIO_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/RunNoIO"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[RunNoIO]"},"Page_SdkAssistant_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/SdkAssistant"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[SdkAssistant]"},"Page_SdkConversation_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/SdkConversation"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[SdkConversation]"},"Page_TestCaseResponse_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/TestCaseResponse"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[TestCaseResponse]"},"Page_TriggerEvent_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/TriggerEvent"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[TriggerEvent]"},"Page_Trigger_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Trigger"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[Trigger]"},"Page_WorkflowWithTriggers_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/WorkflowWithTriggers"},"type":"array","title":"Items"},"total":{"type":"integer","minimum":0.0,"title":"Total"},"page":{"type":"integer","minimum":1.0,"title":"Page"},"size":{"type":"integer","minimum":1.0,"title":"Size"},"pages":{"type":"integer","minimum":0.0,"title":"Pages"}},"type":"object","required":["items","total","page","size","pages"],"title":"Page[WorkflowWithTriggers]"},"PdfMetadata":{"properties":{"kind":{"type":"string","const":"pdf","title":"Kind","default":"pdf"},"page_count":{"type":"integer","title":"Page Count"},"page_labels":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Page Labels"}},"type":"object","required":["page_count"],"title":"PdfMetadata","description":"Structural metadata for a PDF file.\n\n``page_labels`` is only set when the document's labels differ from plain\n1..N numbering (cover pages, roman numerals), mapping physical page index\nto label."},"PluginDataSourceKB":{"properties":{"source_type":{"type":"string","const":"plugin_datasource","title":"Source Type","default":"plugin_datasource"},"subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subtype"},"config_cls":{"title":"Config Cls"},"config":{"$ref":"#/components/schemas/PluginDataSourceKBConfig"},"integration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration"},"image":{"type":"string","title":"Image","default":"icon:Puzzle"},"name":{"type":"string","title":"Name","default":"Plugin Datasource"},"exposed":{"type":"boolean","title":"Exposed","default":false}},"type":"object","required":["config"],"title":"PluginDataSourceKB"},"PluginDataSourceKBConfig":{"properties":{},"additionalProperties":true,"type":"object","title":"PluginDataSourceKBConfig","description":"KB config for a plugin-provided datasource.\n\nCarries ``{plugin_id, datasource_name}`` plus the plugin datasource's own\nconfig fields; ``extra=\"allow\"`` keeps them all. Ingestion resolves the\ngeneric ``plugin_datasource`` node (source_type == its node_name) via\n``_fetch_via_datasource_node``, so ``to_files`` is never reached — this\nentry exists so ``Source``/``KB_CONFIG_PARSEABLE`` accepts the source_type."},"PresentationMetadata":{"properties":{"kind":{"type":"string","const":"presentation","title":"Kind","default":"presentation"},"slide_count":{"type":"integer","title":"Slide Count"}},"type":"object","required":["slide_count"],"title":"PresentationMetadata","description":"Structural metadata for a presentation (PowerPoint) file."},"PresentedFileMessage":{"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":"presented_file","title":"Type","default":"presented_file"},"file_id":{"type":"string","title":"File Id"},"name":{"type":"string","title":"Name"},"content_type":{"type":"string","title":"Content Type"},"url":{"type":"string","title":"Url"},"size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Size"},"caption":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Caption"},"show_inline":{"type":"boolean","title":"Show Inline","default":false},"source_image":{"type":"boolean","title":"Source Image","default":false}},"type":"object","required":["file_id","name","content_type","url"],"title":"PresentedFileMessage","description":"A file the agent surfaced via ``present_file``.\n\nStored on ``ToolReturnPart.metadata`` since DEV-1854 and rebuilt into this\nshape by the projection, so the published payload still lists it."},"ProviderRef":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image"},"host":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Host"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location"},"is_active":{"type":"boolean","title":"Is Active","default":true},"provider_is_active":{"type":"boolean","title":"Provider Is Active","default":true},"qualified_slug":{"type":"string","title":"Qualified Slug"}},"type":"object","required":["id","name","qualified_slug"],"title":"ProviderRef","description":"One entry in :pyattr:`ModelDefinition.providers` — describes a single\nno-llm provider that can serve the parent model.\n\n``qualified_slug`` is precomputed so the frontend never has to do its own\n``f\"{id}:{name}\"`` formatting (and so the grammar lives in one place)."},"PublicAnalyticsKey":{"type":"string","enum":["flow_runs","trigger_runs","manual_runs","agent_runs","active_users","active_runs","active_triggers","errors","average_run_time","flow_runs_distribution","flow_per_user","errors_over_time","run_time_over_time","ai_models_total_cost","ai_models_total_tokens","average_cost_per_run","tokens_cost","tokens_cost_by_workflow","tokens_cost_by_user","model_tokens_total_cost","ai_operations_per_tool","model_tokens_per_tool","ai_operations_per_user","model_tokens_per_user","conversations_started","messages_sent","messages_per_conversation","conversation_users","conversations_started_over_time","messages_sent_over_time","conversations_started_by_user","messages_sent_by_user","conversation_tokens_cost","conversation_tokens_cost_by_user","conversation_chat_costs_total","api_calls_per_date","api_calls_per_endpoint","api_calls_log","kb_total_documents","kb_processed_successfully","kb_contributors","kb_failed_documents","kb_documents_over_time","kb_documents_per_kb","kb_documents_by_user","kb_document_types","kb_user_activity","kb_overview"],"title":"PublicAnalyticsKey","description":"Analytics metrics available via the public API.\n\nExcludes billing-constraint overage keys, cross-workspace/tenant aggregates,\ninfrastructure/worker metrics, internal labelling-system keys, and\nworkflow-scoped keys that need a flow id this surface does not take."},"PublicRunWithSearchData":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"workflow_id":{"type":"string","format":"uuid","title":"Workflow Id"},"input":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Input"},"output":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Output"},"node_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Node Ids"},"single_node_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Single Node Id"},"workflow_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workflow Version Id"},"status":{"$ref":"#/components/schemas/RunStatus"},"progress":{"type":"integer","title":"Progress","default":0},"progress_details":{"anyOf":[{"$ref":"#/components/schemas/WorkflowProgress"},{"type":"null"}]},"definitions":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Definitions"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta"},"similarity":{"type":"number","title":"Similarity","default":0.0},"matches":{"items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array","title":"Matches","default":[]}},"type":"object","required":["id","group_id","workflow_id","status","created_at"],"title":"PublicRunWithSearchData","description":"RunWithSearchData for public API — excludes workflow_definition."},"PublicSimplifiedRun":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"workflow_id":{"type":"string","format":"uuid","title":"Workflow Id"},"input":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Input"},"output":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Output"},"node_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Node Ids"},"single_node_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Single Node Id"},"workflow_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workflow Version Id"},"progress_details":{"anyOf":[{"$ref":"#/components/schemas/WorkflowProgress"},{"type":"null"}]},"status":{"$ref":"#/components/schemas/RunStatus"},"progress":{"type":"integer","title":"Progress","default":0},"created_at":{"type":"string","format":"date-time","title":"Created At"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At"}},"type":"object","required":["id","group_id","workflow_id","status","created_at"],"title":"PublicSimplifiedRun","description":"SimplifiedRun for public API — excludes workflow_definition."},"QAContext":{"properties":{"file_name":{"type":"string","title":"File Name"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id"},"node_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Node Id"},"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path"},"kb_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kb 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"},"QueryRequest":{"properties":{"sql":{"type":"string","title":"Sql"},"limit":{"anyOf":[{"type":"integer","maximum":1000.0,"minimum":1.0},{"type":"null"}],"title":"Limit"},"offset":{"type":"integer","minimum":0.0,"title":"Offset","default":0},"include_total":{"type":"boolean","title":"Include Total","default":true}},"type":"object","required":["sql"],"title":"QueryRequest"},"QueryResponse":{"properties":{"columns":{"items":{"type":"string"},"type":"array","title":"Columns"},"rows":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Rows"},"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total"}},"type":"object","required":["columns","rows"],"title":"QueryResponse"},"QuoteContainer":{"properties":{"total_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Size"},"taken":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Taken"},"truncated":{"type":"boolean","title":"Truncated","default":false},"preview_file":{"anyOf":[{"$ref":"#/components/schemas/FileType"},{"type":"null"}]},"list_offset":{"type":"integer","title":"List Offset","default":0},"type":{"type":"string","const":"Quote","title":"Type","default":"Quote"},"value":{"title":"Value"}},"type":"object","required":["value"],"title":"QuoteContainer"},"RatingDriver":{"properties":{"theme":{"type":"string","title":"Theme"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["theme","count"],"title":"RatingDriver"},"RatingDrivers":{"properties":{"positive":{"items":{"$ref":"#/components/schemas/RatingDriver"},"type":"array","title":"Positive"},"negative":{"items":{"$ref":"#/components/schemas/RatingDriver"},"type":"array","title":"Negative"}},"type":"object","required":["positive","negative"],"title":"RatingDrivers"},"ReadFileOut":{"properties":{"path":{"type":"string","title":"Path"},"content":{"type":"string","title":"Content"},"encoding":{"type":"string","title":"Encoding"}},"type":"object","required":["path","content","encoding"],"title":"ReadFileOut"},"ReasoningUIPart":{"properties":{"type":{"type":"string","const":"reasoning","title":"Type","default":"reasoning"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"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."},"ReferencedAssetField":{"properties":{"config_field":{"type":"string","title":"Config Field"},"kind":{"type":"string","enum":["workflow","assistant"],"title":"Kind"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"}},"type":"object","required":["config_field","kind"],"title":"ReferencedAssetField"},"RenameColumnRequest":{"properties":{"new_name":{"type":"string","title":"New Name"}},"type":"object","required":["new_name"],"title":"RenameColumnRequest"},"ReorderColumnsRequest":{"properties":{"column_names":{"items":{"type":"string"},"type":"array","title":"Column Names"}},"type":"object","required":["column_names"],"title":"ReorderColumnsRequest"},"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},"audio_seconds":{"type":"number","title":"Audio Seconds","default":0},"details":{"additionalProperties":{"type":"integer"},"type":"object","title":"Details"},"cost":{"anyOf":[{"type":"string","pattern":"^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$"},{"type":"null"}],"title":"Cost"}},"type":"object","title":"RequestUsage","description":"LLM usage associated with a single request.\n\nThis is an implementation of `genai_prices.types.AbstractUsage` so it can be used to calculate the price of the\nrequest using [genai-prices](https://github.com/pydantic/genai-prices)."},"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","description":"A message back to a model asking it to try again.\n\nThis can be sent for a number of reasons:\n\n* Pydantic validation of tool arguments failed, here content is derived from a Pydantic\n  [`ValidationError`][pydantic_core.ValidationError]\n* a tool raised a [`ModelRetry`][pydantic_ai.exceptions.ModelRetry] exception\n* no tool was found for the tool name\n* the model returned plain text when a structured response was expected\n* Pydantic validation of a structured response failed, here content is derived from a Pydantic\n  [`ValidationError`][pydantic_core.ValidationError]\n* an output validator raised a [`ModelRetry`][pydantic_ai.exceptions.ModelRetry] exception"},"RowRequest":{"properties":{"values":{"additionalProperties":true,"type":"object","title":"Values"}},"type":"object","required":["values"],"title":"RowRequest"},"RowResponse":{"properties":{"row":{"additionalProperties":true,"type":"object","title":"Row"}},"type":"object","required":["row"],"title":"RowResponse"},"RowsResponse":{"properties":{"rows":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Rows"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"},"total":{"type":"integer","title":"Total"}},"type":"object","required":["rows","limit","offset","total"],"title":"RowsResponse"},"Run":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"workflow_id":{"type":"string","format":"uuid","title":"Workflow Id"},"input":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Input"},"output":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Output"},"node_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Node Ids"},"single_node_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Single Node Id"},"workflow_definition":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Workflow Definition"},"workflow_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workflow Version Id"},"status":{"$ref":"#/components/schemas/RunStatus"},"progress":{"type":"integer","title":"Progress","default":0},"progress_details":{"anyOf":[{"$ref":"#/components/schemas/WorkflowProgress"},{"type":"null"}]},"definitions":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Definitions"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta"}},"type":"object","required":["id","group_id","workflow_id","status","created_at"],"title":"Run"},"RunCommandIn":{"properties":{"command":{"type":"string","title":"Command","description":"Shell command to run inside the sandbox."},"timeout":{"anyOf":[{"type":"integer","maximum":3600.0,"minimum":1.0},{"type":"null"}],"title":"Timeout","description":"Seconds before the command is killed."}},"type":"object","required":["command"],"title":"RunCommandIn"},"RunData":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At"},"structured_data":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Structured Data"}},"type":"object","required":["created_at"],"title":"RunData"},"RunFilters":{"properties":{"from_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"From Date"},"to_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"To Date"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"user_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Id"},"workflow_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workflow Id"},"tags":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tags"},"kb_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Kb Id"}},"type":"object","title":"RunFilters"},"RunIO":{"properties":{"inputs":{"additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/FileDataContainer"},{"$ref":"#/components/schemas/ImageDataContainer"},{"$ref":"#/components/schemas/TextDataContainer"},{"$ref":"#/components/schemas/DictContainer"},{"$ref":"#/components/schemas/ListContainer"},{"$ref":"#/components/schemas/AudioContainer"},{"$ref":"#/components/schemas/QuoteContainer"},{"$ref":"#/components/schemas/CustomContainer"},{"$ref":"#/components/schemas/NumberContainer"},{"$ref":"#/components/schemas/BoolContainer"},{"$ref":"#/components/schemas/DateTimeContainer"},{"$ref":"#/components/schemas/ObjectContainer"},{"$ref":"#/components/schemas/BaseModelContainer"},{"$ref":"#/components/schemas/ErrorContainer"},{"$ref":"#/components/schemas/IterationOutcomesContainer"}],"discriminator":{"propertyName":"type","mapping":{"Audio":"#/components/schemas/AudioContainer","Custom":"#/components/schemas/CustomContainer","File":"#/components/schemas/FileDataContainer","Image":"#/components/schemas/ImageDataContainer","Quote":"#/components/schemas/QuoteContainer","_error":"#/components/schemas/ErrorContainer","_iterations":"#/components/schemas/IterationOutcomesContainer","basemodel":"#/components/schemas/BaseModelContainer","bool":"#/components/schemas/BoolContainer","datetime":"#/components/schemas/DateTimeContainer","dict":"#/components/schemas/DictContainer","list":"#/components/schemas/ListContainer","number":"#/components/schemas/NumberContainer","object":"#/components/schemas/ObjectContainer","str":"#/components/schemas/TextDataContainer"}}},"type":"object","title":"Inputs"},"outputs":{"additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/FileDataContainer"},{"$ref":"#/components/schemas/ImageDataContainer"},{"$ref":"#/components/schemas/TextDataContainer"},{"$ref":"#/components/schemas/DictContainer"},{"$ref":"#/components/schemas/ListContainer"},{"$ref":"#/components/schemas/AudioContainer"},{"$ref":"#/components/schemas/QuoteContainer"},{"$ref":"#/components/schemas/CustomContainer"},{"$ref":"#/components/schemas/NumberContainer"},{"$ref":"#/components/schemas/BoolContainer"},{"$ref":"#/components/schemas/DateTimeContainer"},{"$ref":"#/components/schemas/ObjectContainer"},{"$ref":"#/components/schemas/BaseModelContainer"},{"$ref":"#/components/schemas/ErrorContainer"},{"$ref":"#/components/schemas/IterationOutcomesContainer"}],"discriminator":{"propertyName":"type","mapping":{"Audio":"#/components/schemas/AudioContainer","Custom":"#/components/schemas/CustomContainer","File":"#/components/schemas/FileDataContainer","Image":"#/components/schemas/ImageDataContainer","Quote":"#/components/schemas/QuoteContainer","_error":"#/components/schemas/ErrorContainer","_iterations":"#/components/schemas/IterationOutcomesContainer","basemodel":"#/components/schemas/BaseModelContainer","bool":"#/components/schemas/BoolContainer","datetime":"#/components/schemas/DateTimeContainer","dict":"#/components/schemas/DictContainer","list":"#/components/schemas/ListContainer","number":"#/components/schemas/NumberContainer","object":"#/components/schemas/ObjectContainer","str":"#/components/schemas/TextDataContainer"}}},"type":"object","title":"Outputs"},"source":{"type":"string","enum":["hot","cold","memory"],"title":"Source","default":"hot"}},"type":"object","required":["inputs","outputs"],"title":"RunIO"},"RunNoIO":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"workflow_id":{"type":"string","format":"uuid","title":"Workflow Id"},"workflow_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workflow Version Id"},"input":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Input"},"node_ids":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Node Ids"},"single_node_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Single Node Id"},"status":{"$ref":"#/components/schemas/RunStatus"},"progress":{"type":"integer","title":"Progress","default":0},"definitions":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Definitions"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"user_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"},{"type":"null"}],"title":"User Id"},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta"},"conversation_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"},{"type":"null"}],"title":"Conversation Id"},"api_key_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"string"},{"type":"null"}],"title":"Api Key Id"}},"type":"object","required":["id","group_id","workflow_id","status","created_at"],"title":"RunNoIO"},"RunOutput":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"output":{"additionalProperties":true,"type":"object","title":"Output"}},"type":"object","required":["id","output"],"title":"RunOutput"},"RunOutputWithStatus":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"output":{"additionalProperties":true,"type":"object","title":"Output"},"status":{"anyOf":[{"$ref":"#/components/schemas/RunStatus"},{"type":"string"}],"title":"Status"}},"type":"object","required":["id","output","status"],"title":"RunOutputWithStatus"},"RunStatus":{"type":"string","enum":["queued","running","failed","completed","stopped","awaiting_human_feedback"],"title":"RunStatus"},"SandboxOut":{"properties":{"id":{"type":"string","title":"Id"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"status":{"type":"string","title":"Status"},"created_at":{"type":"string","title":"Created At"},"last_activity":{"type":"string","title":"Last Activity"}},"type":"object","required":["id","status","created_at","last_activity"],"title":"SandboxOut"},"SandboxSettings-Input":{"properties":{"title":{"type":"string","title":"Title","default":"Sandbox"},"description":{"type":"string","title":"Description","default":"File operations and command execution in isolated sandbox"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Terminal"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Working in sandbox..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Command complete"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Terminal"},"bg_color":{"type":"string","title":"Bg Color","default":"#fef3c7"},"icon_color":{"type":"string","title":"Icon Color","default":"#d97706"},"deprecated":{"type":"boolean","title":"Deprecated","description":"Whether this tool type is deprecated and should be hidden from the UI","default":false},"type":{"type":"string","const":"sandbox","title":"Type","default":"sandbox"},"persistent":{"type":"boolean","title":"Persistent","description":"Keep sandbox running permanently (no idle timeout)","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Keep Running","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"include_execute":{"type":"boolean","title":"Include Execute","description":"Include shell command execution tool","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Shell Execution","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"require_write_approval":{"type":"boolean","title":"Require Write Approval","description":"Require user approval for file write/edit operations","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Approve Writes","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"require_execute_approval":{"type":"boolean","title":"Require Execute Approval","description":"Require user approval for shell command execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Approve Execution","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"execution_slots":{"type":"integer","maximum":8.0,"minimum":1.0,"title":"Execution Slots","description":"CPU/memory budget of the sandbox in manager slots (1/8 CPU + 256 MiB each)","default":4,"display":{"col_span":12,"hide_input":false,"hide_number":false,"is_disabled":false,"is_subconfig":false,"label":"Execution slots","max":8,"min":1,"needs_confirmation":false,"show_optional_label":false,"step":1,"type":"number_slider"},"tab":"Configuration","tool_mode":"hidden"}},"type":"object","title":"SandboxSettings","description":"Settings shared by every version of the sandbox capability: file\noperations and optional shell execution in an isolated sandbox."},"SandboxSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Sandbox"},"description":{"type":"string","title":"Description","default":"File operations and command execution in isolated sandbox"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Terminal"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Working in sandbox..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Command complete"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Terminal"},"bg_color":{"type":"string","title":"Bg Color","default":"#fef3c7"},"icon_color":{"type":"string","title":"Icon Color","default":"#d97706"},"deprecated":{"type":"boolean","title":"Deprecated","description":"Whether this tool type is deprecated and should be hidden from the UI","default":false},"type":{"type":"string","const":"sandbox","title":"Type","default":"sandbox"},"persistent":{"type":"boolean","title":"Persistent","description":"Keep sandbox running permanently (no idle timeout)","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Keep Running","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"include_execute":{"type":"boolean","title":"Include Execute","description":"Include shell command execution tool","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Shell Execution","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"require_write_approval":{"type":"boolean","title":"Require Write Approval","description":"Require user approval for file write/edit operations","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Approve Writes","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"require_execute_approval":{"type":"boolean","title":"Require Execute Approval","description":"Require user approval for shell command execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Approve Execution","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"execution_slots":{"type":"integer","maximum":8.0,"minimum":1.0,"title":"Execution Slots","description":"CPU/memory budget of the sandbox in manager slots (1/8 CPU + 256 MiB each)","default":4,"display":{"col_span":12,"hide_input":false,"hide_number":false,"is_disabled":false,"is_subconfig":false,"label":"Execution slots","max":8,"min":1,"needs_confirmation":false,"show_optional_label":false,"step":1,"type":"number_slider"},"tab":"Configuration","tool_mode":"hidden"}},"type":"object","title":"SandboxSettings","description":"Settings shared by every version of the sandbox capability: file\noperations and optional shell execution in an isolated sandbox."},"ScheduleToolSettings-Input":{"properties":{"title":{"type":"string","title":"Title","default":"Periodic Tasks"},"description":{"type":"string","title":"Description","default":"Create periodic tasks that call this agent on a schedule"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Clock"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Managing schedule..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Schedule updated"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Clock"},"bg_color":{"type":"string","title":"Bg Color","default":"#eff6ff"},"icon_color":{"type":"string","title":"Icon Color","default":"#2563eb"},"deprecated":{"type":"boolean","title":"Deprecated","description":"Whether this tool type is deprecated and should be hidden from the UI","default":false},"type":{"type":"string","const":"schedule_tool","title":"Type","default":"schedule_tool"}},"type":"object","title":"ScheduleToolSettings"},"ScheduleToolSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Periodic Tasks"},"description":{"type":"string","title":"Description","default":"Create periodic tasks that call this agent on a schedule"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Clock"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Managing schedule..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Schedule updated"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Clock"},"bg_color":{"type":"string","title":"Bg Color","default":"#eff6ff"},"icon_color":{"type":"string","title":"Icon Color","default":"#2563eb"},"deprecated":{"type":"boolean","title":"Deprecated","description":"Whether this tool type is deprecated and should be hidden from the UI","default":false},"type":{"type":"string","const":"schedule_tool","title":"Type","default":"schedule_tool"}},"type":"object","title":"ScheduleToolSettings"},"SdkAssistant":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"definition":{"additionalProperties":true,"type":"object","title":"Definition"},"visible":{"type":"boolean","title":"Visible","default":true},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Url"},"last_updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Updated At"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At"},"app_settings_v2":{"anyOf":[{"$ref":"#/components/schemas/AppSettingsV2"},{"type":"null"}]},"is_app_published":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is App Published"},"allow_public_access":{"type":"boolean","title":"Allow Public Access","default":false},"meta":{"anyOf":[{"$ref":"#/components/schemas/AssistantMeta"},{"type":"null"}]},"draft_definition":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Draft Definition"}},"type":"object","required":["id","group_id","name","definition"],"title":"SdkAssistant","description":"Assistant schema for the public SDK API with TipTap fields resolved to strings."},"SdkConversation":{"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"},"channel_ref":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Channel Ref"},"deployment_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id"},"public_access_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Public Access Token"},"todos":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Todos","default":[]},"is_locked":{"type":"boolean","title":"Is Locked","default":false},"lock_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lock Message"}},"type":"object","required":["id","user_id","api_key_id","name","created_at","last_updated_at","etag","settings","status"],"title":"SdkConversation","description":"Conversation schema for the public SDK — strips TipTap from settings."},"SdkConversationWithMessages":{"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"},"channel_ref":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Channel Ref"},"deployment_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Deployment Id"},"public_access_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Public Access Token"},"todos":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Todos","default":[]},"is_locked":{"type":"boolean","title":"Is Locked","default":false},"lock_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lock Message"},"messages":{"items":{"$ref":"#/components/schemas/SdkMessage"},"type":"array","title":"Messages"},"history":{"anyOf":[{"$ref":"#/components/schemas/ConversationHistoryPage"},{"type":"null"}]},"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":"SdkConversationWithMessages","description":"ConversationWithMessages for the public SDK — strips TipTap from settings."},"SdkMessage":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"pydantic_message_parts":{"items":{"oneOf":[{"$ref":"#/components/schemas/ModelRequest"},{"$ref":"#/components/schemas/ModelResponse"}],"discriminator":{"propertyName":"kind","mapping":{"request":"#/components/schemas/ModelRequest","response":"#/components/schemas/ModelResponse"}}},"type":"array","title":"Pydantic Message Parts"},"is_positive":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Positive"},"feedback_meta":{"anyOf":[{"$ref":"#/components/schemas/FeedbackMeta"},{"type":"null"}]},"sender_ref":{"anyOf":[{"$ref":"#/components/schemas/SenderRefSchema"},{"type":"null"}]},"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/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/PresentedFileMessage"}],"discriminator":{"propertyName":"type","mapping":{"audio":"#/components/schemas/AudioReferenceMessage","clear_conversation_stream":"#/components/schemas/ClearConversationStreamMessage","conversation_end":"#/components/schemas/ConversationEndMessage","document":"#/components/schemas/DocumentReferenceMessage","error":"#/components/schemas/ErrorMessage","human_in_the_loop":"#/components/schemas/HumanInTheLoopMessage","human_in_the_loop_assigned":"#/components/schemas/HumanInTheLoopAssignedMessage","image":"#/components/schemas/ImageReferenceMessage","image_carousel":"#/components/schemas/ImageCarouselMessage","info":"#/components/schemas/InfoMessage","kb_context":"#/components/schemas/KBContextMessage","markdown":"#/components/schemas/MarkdownMessage","memory":"#/components/schemas/MemoryMessage","message_end":"#/components/schemas/MessageEnd","presented_file":"#/components/schemas/PresentedFileMessage","set_conversation_title":"#/components/schemas/SetConversationTitle","source_reference":"#/components/schemas/SourceReferenceMessage","success":"#/components/schemas/SuccessMessage","system":"#/components/schemas/SystemMessage","thinking":"#/components/schemas/ThinkingMessage","thinking_ended":"#/components/schemas/ThinkingEndedMessage","tool_call":"#/components/schemas/ToolCallMessage","tool_called":"#/components/schemas/ToolCalledMessage","tool_called_end":"#/components/schemas/ToolCalledMessageEnd","tool_result":"#/components/schemas/InternalToolResultMessage","user":"#/components/schemas/UserMessage","video":"#/components/schemas/VideoReferenceMessage","warning":"#/components/schemas/WarningMessage","web_reference":"#/components/schemas/WebReferenceMessage","webpage_context":"#/components/schemas/WebpageContextMessage","workflow_running":"#/components/schemas/WorkflowRunningMessage","youtube_reference":"#/components/schemas/YoutubeReferenceMessage"}}},"type":"array","title":"Message Parts","readOnly":true}},"type":"object","required":["id","created_at","pydantic_message_parts","is_positive","message_parts"],"title":"SdkMessage","description":"Message for the public SDK — keeps the published ``message_parts``.\n\nNothing stores that shape since DEV-1854, so it is projected from the\npydantic history on the way out. Public-only: the internal payload the\nfrontend loads is the one the drop set out to shrink."},"SearchResult":{"properties":{"score":{"type":"number","title":"Score"},"content":{"type":"string","title":"Content"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"document_source":{"$ref":"#/components/schemas/DocumentResult"},"node_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Node Id"},"page_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Page Label"}},"type":"object","required":["score","content","source","document_source"],"title":"SearchResult"},"SearchRunRequest":{"properties":{"query":{"type":"string","title":"Query"},"similarity_threshold":{"type":"number","title":"Similarity Threshold","default":0.0},"limit":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Limit","default":10},"offset":{"type":"integer","title":"Offset","default":0},"context_size":{"type":"integer","title":"Context Size","default":30},"max_matches_per_run":{"type":"integer","title":"Max Matches Per Run","default":5},"exact":{"type":"boolean","title":"Exact","default":true},"search_in":{"anyOf":[{"items":{"type":"string","enum":["input","output","other","run_id"]},"type":"array"},{"type":"null"}],"title":"Search In"},"filters":{"anyOf":[{"$ref":"#/components/schemas/RunFilters"},{"type":"null"}]}},"type":"object","required":["query"],"title":"SearchRunRequest"},"SenderRefSchema":{"properties":{"type":{"type":"string","title":"Type","default":"external"},"user_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"User Id"},"agent_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Id"},"external_participant":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"External Participant"}},"type":"object","title":"SenderRefSchema","description":"External participant identity on a message."},"SentimentDay":{"properties":{"date":{"type":"string","title":"Date"},"positive":{"type":"integer","title":"Positive","default":0},"neutral":{"type":"integer","title":"Neutral","default":0},"negative":{"type":"integer","title":"Negative","default":0}},"type":"object","required":["date"],"title":"SentimentDay"},"SentimentOverTime":{"properties":{"days":{"items":{"$ref":"#/components/schemas/SentimentDay"},"type":"array","title":"Days"},"positive_pct":{"type":"number","title":"Positive Pct","default":0.0},"neutral_pct":{"type":"number","title":"Neutral Pct","default":0.0},"negative_pct":{"type":"number","title":"Negative Pct","default":0.0}},"type":"object","required":["days"],"title":"SentimentOverTime"},"ServiceNowKnowledgeBaseSource":{"properties":{"source_type":{"type":"string","const":"ServiceNow","title":"Source Type","default":"ServiceNow"},"subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subtype"},"config_cls":{"title":"Config Cls"},"config":{"$ref":"#/components/schemas/ServiceNowKnowledgeBaseSourceConfig"},"integration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration"},"image":{"type":"string","title":"Image","default":"https://storage.googleapis.com/image-storage-spot-manual/logos/servicenow.png"},"name":{"type":"string","title":"Name","default":"ServiceNow"},"exposed":{"type":"boolean","title":"Exposed","default":true}},"type":"object","required":["config"],"title":"ServiceNowKnowledgeBaseSource"},"ServiceNowKnowledgeBaseSourceConfig":{"properties":{"connection":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connection","display":{"col_span":12,"integration_type":"servicenow","is_disabled":false,"is_subconfig":false,"label":"Servicenow Connection","needs_confirmation":false,"show_optional_label":false,"type":"credential_picker"},"field_type":"config","tab":"Configuration","tool_mode":"hidden"},"knowledge_base_id":{"type":"string","title":"Knowledge Base Id","description":"ServiceNow Knowledge Base ID (optional - leave empty for all)","default":"","display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Knowledge Base ID","needs_confirmation":false,"number_of_lines":1,"placeholder":"Leave empty for all","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"published_only":{"type":"boolean","title":"Published Only","description":"Only include published articles","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Published Only","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"}},"type":"object","title":"ServiceNowKnowledgeBaseSourceConfig"},"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"},"SharepointSource":{"properties":{"source_type":{"type":"string","const":"Sharepoint","title":"Source Type","default":"Sharepoint"},"subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subtype"},"config_cls":{"title":"Config Cls"},"config":{"$ref":"#/components/schemas/SharepointSourceConfig"},"integration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration"},"image":{"type":"string","title":"Image","default":"https://storage.googleapis.com/image-storage-spot-manual/logos/sharepoint.png"},"name":{"type":"string","title":"Name","default":"Sharepoint"},"exposed":{"type":"boolean","title":"Exposed","default":true}},"type":"object","required":["config"],"title":"SharepointSource"},"SharepointSourceConfig":{"properties":{"connection":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Connection","display":{"col_span":12,"integration_type":"sharepoint","is_disabled":false,"is_subconfig":false,"label":"Sharepoint Connection","needs_confirmation":false,"show_optional_label":false,"type":"credential_picker"},"field_type":"config","tab":"Configuration","tool_mode":"hidden"},"files":{"items":{"$ref":"#/components/schemas/OneDriveFile"},"type":"array","title":"Files","description":"Document to read","display":{"col_span":12,"file_type":"folder","is_disabled":false,"is_subconfig":false,"label":"","multi_select":true,"name":"Sharepoint","needs_confirmation":false,"set_include_folders":true,"show_optional_label":false,"type":"onedrive_picker"},"placeholder":[{"id":"123","image":"123","name":"123"}],"tab":"Configuration","tool_mode":"hidden"}},"type":"object","required":["files"],"title":"SharepointSourceConfig","description":"text_display_1: str = Parameter(\n    default=\"\",\n    display=ConfigTextDisplay(\n        title=\"Select files to add to knowledge base\",\n        text=\"\",\n    ),\n)"},"SheetInfo":{"properties":{"name":{"type":"string","title":"Name"},"dimensions":{"type":"string","title":"Dimensions"}},"type":"object","required":["name","dimensions"],"title":"SheetInfo","description":"Per-worksheet metadata for a spreadsheet file."},"SkillConfig":{"properties":{"name":{"type":"string","title":"Name"},"usage_conditions":{"type":"string","maxLength":300,"title":"Usage Conditions","default":""},"tags":{"items":{"type":"string"},"type":"array","title":"Tags"},"version":{"type":"string","title":"Version","default":"1.0.0"},"author":{"type":"string","title":"Author","default":""},"instructions":{"type":"string","title":"Instructions","default":""},"enabled":{"type":"boolean","title":"Enabled","default":true},"resources":{"additionalProperties":{"type":"string"},"type":"object","title":"Resources"}},"type":"object","required":["name"],"title":"SkillConfig","description":"Full skill definition stored in agent settings.\n\nSkills are markdown-based instruction packages that extend agent\ncapabilities.  Stored directly in the agent's ``definition`` JSONB\ncolumn — no separate table or migration needed."},"Source":{"properties":{"source":{"oneOf":[{"$ref":"#/components/schemas/DocumentSource"},{"$ref":"#/components/schemas/GoogleDriveSource"},{"$ref":"#/components/schemas/OneDriveSource"},{"$ref":"#/components/schemas/SharepointSource"},{"$ref":"#/components/schemas/WebsiteSource"},{"$ref":"#/components/schemas/ServiceNowKnowledgeBaseSource"},{"$ref":"#/components/schemas/CustomSource"},{"$ref":"#/components/schemas/PluginDataSourceKB"}],"title":"Source","discriminator":{"propertyName":"source_type","mapping":{"Custom":"#/components/schemas/CustomSource","Document":"#/components/schemas/DocumentSource","Google Drive":"#/components/schemas/GoogleDriveSource","OneDrive":"#/components/schemas/OneDriveSource","ServiceNow":"#/components/schemas/ServiceNowKnowledgeBaseSource","Sharepoint":"#/components/schemas/SharepointSource","Website":"#/components/schemas/WebsiteSource","plugin_datasource":"#/components/schemas/PluginDataSourceKB"}}}},"type":"object","required":["source"],"title":"Source"},"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."},"SourceMetadata":{"properties":{"rel_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rel Path"},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id"},"file_created_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Created Date"},"file_modified_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Modified Date"},"original_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Url"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"source_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Label"},"source_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Image"}},"additionalProperties":true,"type":"object","title":"SourceMetadata","description":"Base class for source metadata across different source types.\n\n``external_id`` is the source's stable id for this item (Drive\nfile id, OneDrive item id, URL for websites, etc.). Datasource\n``download_file`` implementations stamp it explicitly, and the\nDB materialisation trigger projects it onto\n``KnowledgeBaseDocument.m_source_external_id`` — which is the\njoin key the KB sync engine uses to find existing docs by their\nsource id."},"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"},"SourceType":{"type":"string","enum":["Document","Google Drive","Notion","Website","OneDrive","Slack","Linear","Github","Teams","Sharepoint","ServiceNow","Custom"],"title":"SourceType"},"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."},"SpeechPart":{"properties":{"speaker":{"type":"string","enum":["user","assistant"],"title":"Speaker"},"transcript":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Transcript"},"audio":{"anyOf":[{"$ref":"#/components/schemas/BinaryContent"},{"type":"null"}]},"interrupted_at_ms":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Interrupted At Ms"},"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":"speech","title":"Part Kind","default":"speech"}},"type":"object","required":["speaker"],"title":"SpeechPart","description":"Spoken audio exchanged during a realtime session, paired with its transcript.\n\nThis part is a member of both [`ModelRequestPart`][pydantic_ai.messages.ModelRequestPart] and\n[`ModelResponsePart`][pydantic_ai.messages.ModelResponsePart], distinguished by `speaker`:\nin `ModelRequest.parts` the speaker is always `'user'`; in `ModelResponse.parts` it is always\n`'assistant'`. This invariant is enforced at runtime when a message is constructed.\n\nStandard (non-realtime) models can't consume this part directly; when history containing it is\nused in an agent run, [`Model.prepare_messages`][pydantic_ai.models.Model.prepare_messages]\nconverts user-speaker parts to [`UserPromptPart`][pydantic_ai.messages.UserPromptPart]s and\nassistant-speaker parts to [`TextPart`][pydantic_ai.messages.TextPart]s."},"SpotError":{"properties":{"status_code":{"type":"integer","title":"Status Code"},"message":{"type":"string","title":"Message"},"snippet":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Snippet"},"markdown":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Markdown"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"identifier":{"type":"string","title":"Identifier"},"params":{"additionalProperties":true,"type":"object","title":"Params","default":{}},"node_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Node Id"}},"type":"object","required":["status_code","message","identifier"],"title":"SpotError"},"SpotWarning":{"properties":{"detail":{"type":"string","title":"Detail"},"identifier":{"$ref":"#/components/schemas/WarningIdentifier"},"node_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Node Id"},"params":{"additionalProperties":true,"type":"object","title":"Params","default":{}},"markdown":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Markdown"},"snippet":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Snippet"}},"type":"object","required":["detail","identifier"],"title":"SpotWarning"},"SpotflowModelPreset":{"properties":{"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle","description":"Unique handle for the preset, e.g. 'cost', 'chat-quality'"},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon","description":"Icon identifier for the preset, e.g. 'dollar', 'gauge', 'zap'"},"models":{"items":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/ModelPreset"}]},"type":"array","title":"Models","description":"List of model IDs"},"required_capabilities":{"items":{"$ref":"#/components/schemas/ModelCapability"},"type":"array","uniqueItems":true,"title":"Required Capabilities","description":"Capabilities required for the preset","default":[]},"capability_check_mode":{"type":"string","enum":["any","all"],"title":"Capability Check Mode","description":"Whether a model must have 'all' required capabilities or just 'any' one of them","default":"all"},"minimum_speed_tier":{"anyOf":[{"$ref":"#/components/schemas/TierQuality"},{"type":"null"}],"description":"Minimum speed tier required for the preset"},"minimum_quality_tier":{"anyOf":[{"$ref":"#/components/schemas/TierQuality"},{"type":"null"}],"description":"Minimum quality tier required for the preset"},"title":{"type":"string","title":"Title","description":"Title of the preset","default":"A Model Preset"},"subtitle":{"type":"string","title":"Subtitle","description":"Subtitle of the preset","default":"A model preset"},"description":{"type":"string","title":"Description","description":"Description of the preset","default":"A model preset"},"parameters":{"anyOf":[{"$ref":"#/components/schemas/ModelParameters"},{"type":"null"}],"description":"Parameters of the preset"},"data_center_fallback":{"type":"boolean","title":"Data Center Fallback","description":"Whether to use data center fallback, meaning to change regions of the model when available","default":true},"exhaustive":{"type":"boolean","title":"Exhaustive","description":"Whether to exhaustively search for models in the registry, after preset if done","default":false},"type":{"type":"string","const":"spotflow","title":"Type","default":"spotflow"}},"type":"object","required":["models"],"title":"SpotflowModelPreset"},"SpreadsheetMetadata":{"properties":{"kind":{"type":"string","const":"spreadsheet","title":"Kind","default":"spreadsheet"},"sheets":{"items":{"$ref":"#/components/schemas/SheetInfo"},"type":"array","title":"Sheets"}},"type":"object","required":["sheets"],"title":"SpreadsheetMetadata","description":"Structural metadata for a spreadsheet (Excel) file."},"StartEvaluationRunRequest":{"properties":{"version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Version Id"},"test_case_ids":{"anyOf":[{"items":{"type":"string","format":"uuid"},"type":"array"},{"type":"null"}],"title":"Test Case Ids"},"wait_for_completion":{"type":"boolean","title":"Wait For Completion","default":false}},"type":"object","title":"StartEvaluationRunRequest","description":"Request to start an evaluation run.\n\nThe test suite determines whether this is a workflow or agent evaluation.\n- For workflows: version_id refers to workflow_version_id (required)\n- For agents: version_id refers to agent_version_id (None = current draft)"},"Status":{"properties":{"success":{"type":"boolean","title":"Success"}},"type":"object","required":["success"],"title":"Status"},"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."},"SubAgentDefinition":{"properties":{"name":{"type":"string","maxLength":64,"title":"Name"},"usage_conditions":{"type":"string","maxLength":300,"title":"Usage Conditions"},"instructions":{"type":"string","title":"Instructions","default":""},"model":{"items":{"type":"string"},"type":"array","title":"Model","default":[]},"enabled":{"type":"boolean","title":"Enabled","default":true}},"type":"object","required":["name","usage_conditions"],"title":"SubAgentDefinition","description":"One delegate: a stored roster entry, or the built-in general-purpose one.\n\nThe roster editor came out in DEV-2279. Agents that built one keep it,\nhidden, and it keeps running; nothing offers to write a new entry."},"SubAgentSettings-Input":{"properties":{"title":{"type":"string","title":"Title","default":"Task Delegation"},"description":{"type":"string","title":"Description","default":"Delegate tasks to specialized subagents"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":true},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Users"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Delegating task..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Task delegated"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","default":false},"icon":{"type":"string","title":"Icon","default":"Users"},"bg_color":{"type":"string","title":"Bg Color","default":"#f0f9ff"},"icon_color":{"type":"string","title":"Icon Color","default":"#0284c7"},"deprecated":{"type":"boolean","title":"Deprecated","description":"Whether this tool type is deprecated and should be hidden from the UI","default":false},"type":{"type":"string","const":"subagent","title":"Type","default":"subagent"},"subagents":{"items":{"$ref":"#/components/schemas/SubAgentDefinition"},"type":"array","title":"Subagents","default":[]}},"type":"object","title":"SubAgentSettings","description":"Settings for the subagent task delegation toolset.\n\nThe roster lives on the agent settings (``subagents``); this variant only\ncarries the tool's chat display."},"SubAgentSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Task Delegation"},"description":{"type":"string","title":"Description","default":"Delegate tasks to specialized subagents"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":true},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Users"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Delegating task..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Task delegated"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","default":false},"icon":{"type":"string","title":"Icon","default":"Users"},"bg_color":{"type":"string","title":"Bg Color","default":"#f0f9ff"},"icon_color":{"type":"string","title":"Icon Color","default":"#0284c7"},"deprecated":{"type":"boolean","title":"Deprecated","description":"Whether this tool type is deprecated and should be hidden from the UI","default":false},"type":{"type":"string","const":"subagent","title":"Type","default":"subagent"},"subagents":{"items":{"$ref":"#/components/schemas/SubAgentDefinition"},"type":"array","title":"Subagents","default":[]}},"type":"object","title":"SubAgentSettings","description":"Settings for the subagent task delegation toolset.\n\nThe roster lives on the agent settings (``subagents``); this variant only\ncarries the tool's chat display."},"SubTopic":{"properties":{"label":{"type":"string","title":"Label"},"parent_topic":{"type":"string","title":"Parent Topic"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["label","parent_topic","count"],"title":"SubTopic"},"SubTopics":{"properties":{"subtopics":{"items":{"$ref":"#/components/schemas/SubTopic"},"type":"array","title":"Subtopics"}},"type":"object","required":["subtopics"],"title":"SubTopics"},"SubflowConfig":{"properties":{"workflow_id":{"type":"string","title":"Workflow Id"},"workflow_name":{"type":"string","title":"Workflow Name"},"workflow_nodes":{"items":{"type":"string"},"type":"array","title":"Workflow Nodes","default":[]}},"type":"object","required":["workflow_id","workflow_name"],"title":"SubflowConfig"},"SubflowDefinitions":{"properties":{"workflow_definition":{"anyOf":[{"$ref":"#/components/schemas/WorkflowDefinition"},{"type":"null"}]},"raw_definition":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Definition"}},"type":"object","title":"SubflowDefinitions","description":"The definitions for one subflow node, held once per run.\n\nThe raw_definition is stored for resume purposes - when resuming a paused\nsubflow (e.g., after HITL), we must use the exact same workflow definition\nthat was used originally, not the potentially-modified current version."},"SubflowExecution":{"properties":{"node_id":{"type":"string","title":"Node Id"},"workflow_name":{"type":"string","title":"Workflow Name"},"workflow_id":{"type":"string","title":"Workflow Id"},"workflow_definition":{"anyOf":[{"$ref":"#/components/schemas/WorkflowDefinition"},{"type":"null"}]},"raw_definition":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Raw Definition"},"definition_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Definition Key"},"total_iterations":{"type":"integer","title":"Total Iterations"},"iterations":{"additionalProperties":{"$ref":"#/components/schemas/WorkflowProgress"},"type":"object","title":"Iterations","default":{}},"iteration_summaries":{"additionalProperties":{"$ref":"#/components/schemas/SubflowIterationSummary"},"type":"object","title":"Iteration Summaries","default":{}}},"type":"object","required":["node_id","workflow_name","workflow_id","total_iterations"],"title":"SubflowExecution","description":"Some important notes:\n- This stores metadata needed to display subflow results in the frontend.\n- Each iteration's progress is stored separately in the iterations dict.\n\nThe definitions live in ``WorkflowProgress.subflow_definitions`` on the run's\nROOT progress, keyed by ``node_id`` — NOT inline here. A nested subflow is\nre-registered once per parent iteration, and every progress snapshot deep\ncopies the subtree it sits in, so an inline definition is duplicated\nO(parent_iterations x depth) times. At CTT that was 625 copies of a 117KB\ndefinition: 174MB of a 190MB progress blob, and 14GB of worker RSS.\n\n``workflow_definition``/``raw_definition`` stay on the model, unset, so runs\npersisted before the registry existed still deserialize and render."},"SubflowIterationSummary":{"properties":{"has_error":{"type":"boolean","title":"Has Error","default":false},"is_complete":{"type":"boolean","title":"Is Complete","default":false},"errored_nodes":{"items":{"type":"string"},"type":"array","title":"Errored Nodes","default":[]},"executed":{"type":"integer","title":"Executed","default":0},"total":{"type":"integer","title":"Total","default":0},"started_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Started At"},"finished_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Finished At"}},"type":"object","title":"SubflowIterationSummary","description":"The always-resident description of one subflow iteration.\n\nBodies are windowed and spilled; these are not. The scrubber's iteration\nlist and its errored-iteration markers read from here, so they stay correct\nfor every iteration whether or not its body is still in memory."},"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"},"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"},"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","description":"A system prompt, generally written by the application developer.\n\nThis gives the model context and guidance on how to respond."},"TableResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"name":{"type":"string","title":"Name"},"sql_name":{"type":"string","title":"Sql Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"id_type":{"type":"string","enum":["uuid","autoincrement"],"title":"Id Type"},"columns":{"items":{"$ref":"#/components/schemas/DataTableColumn"},"type":"array","title":"Columns"},"meta":{"additionalProperties":true,"type":"object","title":"Meta"},"source":{"type":"string","enum":["custom","platform"],"title":"Source","default":"custom"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"}},"type":"object","required":["id","group_id","name","sql_name","description","id_type","columns","meta","created_at","updated_at"],"title":"TableResponse"},"TableStats":{"properties":{"row_count":{"type":"integer","title":"Row Count"},"size_bytes":{"type":"integer","title":"Size Bytes"},"column_count":{"type":"integer","title":"Column Count"}},"type":"object","required":["row_count","size_bytes","column_count"],"title":"TableStats"},"TableWithCount":{"properties":{"tags":{"anyOf":[{"items":{"$ref":"#/components/schemas/Tag"},"type":"array"},{"type":"null"}],"title":"Tags"},"id":{"type":"string","format":"uuid","title":"Id"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"name":{"type":"string","title":"Name"},"sql_name":{"type":"string","title":"Sql Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"id_type":{"type":"string","enum":["uuid","autoincrement"],"title":"Id Type"},"columns":{"items":{"$ref":"#/components/schemas/DataTableColumn"},"type":"array","title":"Columns"},"meta":{"additionalProperties":true,"type":"object","title":"Meta"},"source":{"type":"string","enum":["custom","platform"],"title":"Source","default":"custom"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"row_count":{"type":"integer","title":"Row Count"}},"type":"object","required":["id","group_id","name","sql_name","description","id_type","columns","meta","created_at","updated_at","row_count"],"title":"TableWithCount"},"TabularMetadata":{"properties":{"kind":{"type":"string","const":"tabular","title":"Kind","default":"tabular"},"row_count":{"type":"integer","title":"Row Count"},"column_count":{"type":"integer","title":"Column Count"}},"type":"object","required":["row_count","column_count"],"title":"TabularMetadata","description":"Structural metadata for a delimited-text (CSV/TSV) file."},"Tag":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"color":{"type":"string","title":"Color"}},"type":"object","required":["id","name","color"],"title":"Tag"},"TenantRoleCreate":{"properties":{"name":{"type":"string","maxLength":50,"minLength":1,"title":"Name","description":"Role name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Role description"},"permissions":{"additionalProperties":{"type":"boolean"},"type":"object","title":"Permissions","description":"Permission settings"},"meta":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Meta","description":"UI meta (color, icon, etc.)"}},"type":"object","required":["name","permissions"],"title":"TenantRoleCreate","description":"Schema for creating a tenant role."},"TenantRoleRequest":{"properties":{"role":{"type":"string","title":"Role"}},"type":"object","required":["role"],"title":"TenantRoleRequest"},"TenantUser":{"properties":{"id":{"type":"string","title":"Id"},"email":{"type":"string","title":"Email"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"tenant_admin":{"type":"boolean","title":"Tenant Admin"},"is_active":{"type":"boolean","title":"Is Active"},"status":{"type":"string","enum":["active","pending","suspended"],"title":"Status"},"tenant_role_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tenant Role Id"},"tenant_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tenant Role"}},"type":"object","required":["id","email","tenant_admin","is_active","status"],"title":"TenantUser"},"TenantUserDetail":{"properties":{"id":{"type":"string","title":"Id"},"email":{"type":"string","title":"Email"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"tenant_admin":{"type":"boolean","title":"Tenant Admin"},"is_active":{"type":"boolean","title":"Is Active"},"status":{"type":"string","enum":["active","pending","suspended"],"title":"Status"},"tenant_role_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tenant Role Id"},"tenant_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tenant Role"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","title":"Metadata"},"memberships":{"items":{"$ref":"#/components/schemas/Membership"},"type":"array","title":"Memberships"}},"type":"object","required":["id","email","tenant_admin","is_active","status"],"title":"TenantUserDetail"},"TestCaseResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"test_suite_id":{"type":"string","format":"uuid","title":"Test Suite Id"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"name":{"type":"string","title":"Name"},"inputs":{"additionalProperties":true,"type":"object","title":"Inputs"},"expected_outputs":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Expected Outputs"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","test_suite_id","group_id","name","inputs","expected_outputs","created_at","updated_at"],"title":"TestCaseResponse","description":"Response model for test case.\n\nReturns data exactly as stored in DB (canonical format):\n- inputs: {\"connector_name\": \"plain string\"}\n- expected_outputs: {\"connector_name\": \"plain string\"} (only active fields)"},"TestSuiteCreate":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["name"],"title":"TestSuiteCreate","description":"Request to create a test suite."},"TestSuiteResponse":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"workflow_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workflow Id"},"agent_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Id"},"knowledge_base_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Knowledge Base Id"},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","group_id","workflow_id","agent_id","name","description","created_at","updated_at"],"title":"TestSuiteResponse","description":"Response model for test suite."},"TestSuiteStats":{"properties":{"test_count":{"type":"integer","title":"Test Count"},"evaluator_count":{"type":"integer","title":"Evaluator Count"},"pass_rate":{"type":"number","title":"Pass Rate"},"last_run_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Run At"},"last_run_agent_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Last Run Agent Version Id"},"avg_latency_ms":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Avg Latency Ms"},"avg_cost":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Avg Cost"},"passed_count":{"type":"integer","title":"Passed Count","default":0},"failed_count":{"type":"integer","title":"Failed Count","default":0},"not_run_count":{"type":"integer","title":"Not Run Count","default":0},"outdated_count":{"type":"integer","title":"Outdated Count","default":0},"running_count":{"type":"integer","title":"Running Count","default":0},"cancelled_count":{"type":"integer","title":"Cancelled Count","default":0},"error_count":{"type":"integer","title":"Error Count","default":0}},"type":"object","required":["test_count","evaluator_count","pass_rate","last_run_at"],"title":"TestSuiteStats","description":"Statistics for a test suite."},"TestSuiteWithStats":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"workflow_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workflow Id"},"agent_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Agent Id"},"knowledge_base_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Knowledge Base Id"},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"},"stats":{"$ref":"#/components/schemas/TestSuiteStats"}},"type":"object","required":["id","group_id","workflow_id","agent_id","name","description","created_at","updated_at","stats"],"title":"TestSuiteWithStats","description":"Test suite response with stats."},"TextContent":{"properties":{"content":{"type":"string","title":"Content"},"metadata":{"title":"Metadata"},"kind":{"type":"string","const":"text-content","title":"Kind","default":"text-content"}},"type":"object","required":["content"],"title":"TextContent","description":"String content that is tagged with additional metadata.\n\nThis is useful for including metadata that can be accessed programmatically by the application, but is not sent to the LLM."},"TextDataContainer":{"properties":{"total_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Size"},"taken":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Taken"},"truncated":{"type":"boolean","title":"Truncated","default":false},"preview_file":{"anyOf":[{"$ref":"#/components/schemas/FileType"},{"type":"null"}]},"list_offset":{"type":"integer","title":"List Offset","default":0},"type":{"type":"string","const":"str","title":"Type","default":"str"},"value":{"title":"Value"}},"type":"object","required":["value"],"title":"TextDataContainer"},"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","description":"A plain text response from a model."},"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."},"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"},"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"},"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","description":"A thinking response from a model."},"TierQuality":{"type":"string","enum":["low","medium","high"],"title":"TierQuality"},"TiptapDocument-Input":{"properties":{"type":{"type":"string","title":"Type","default":"doc"},"content":{"items":{"$ref":"#/components/schemas/Node-Input"},"type":"array","title":"Content","default":[]}},"type":"object","title":"TiptapDocument"},"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"},"TodoSettings-Input":{"properties":{"title":{"type":"string","title":"Title","default":"Task Tracking"},"description":{"type":"string","title":"Description","default":"Track and manage tasks during the conversation"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"ListTodo"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Managing tasks..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Tasks updated"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"ListTodo"},"bg_color":{"type":"string","title":"Bg Color","default":"#f0fdf4"},"icon_color":{"type":"string","title":"Icon Color","default":"#16a34a"},"deprecated":{"type":"boolean","title":"Deprecated","description":"Whether this tool type is deprecated and should be hidden from the UI","default":false},"type":{"type":"string","const":"todos","title":"Type","default":"todos"},"enable_subtasks":{"type":"boolean","title":"Enable Subtasks","description":"Enable subtask hierarchy and dependency features","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enable Subtasks","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false}},"type":"object","title":"TodoSettings","description":"Settings for the task tracking toolset.\n\nWraps pydantic-ai-todo's create_todo_toolset() with Noxus settings.\nTodos are persisted in conversation.memory[\"todos\"]."},"TodoSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Task Tracking"},"description":{"type":"string","title":"Description","default":"Track and manage tasks during the conversation"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","default":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"ListTodo"},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Managing tasks..."},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Tasks updated"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"ListTodo"},"bg_color":{"type":"string","title":"Bg Color","default":"#f0fdf4"},"icon_color":{"type":"string","title":"Icon Color","default":"#16a34a"},"deprecated":{"type":"boolean","title":"Deprecated","description":"Whether this tool type is deprecated and should be hidden from the UI","default":false},"type":{"type":"string","const":"todos","title":"Type","default":"todos"},"enable_subtasks":{"type":"boolean","title":"Enable Subtasks","description":"Enable subtask hierarchy and dependency features","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enable Subtasks","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false}},"type":"object","title":"TodoSettings","description":"Settings for the task tracking toolset.\n\nWraps pydantic-ai-todo's create_todo_toolset() with Noxus settings.\nTodos are persisted in conversation.memory[\"todos\"]."},"ToolApprovalRequested":{"properties":{"id":{"type":"string","title":"Id"}},"additionalProperties":false,"type":"object","required":["id"],"title":"ToolApprovalRequested","description":"Tool approval in requested state (awaiting user response)."},"ToolApprovalRequestedPart":{"properties":{"type":{"type":"string","pattern":"^tool-","title":"Type"},"toolCallId":{"type":"string","title":"Toolcallid"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"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)."},"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)."},"ToolApprovalRespondedPart":{"properties":{"type":{"type":"string","pattern":"^tool-","title":"Type"},"toolCallId":{"type":"string","title":"Toolcallid"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"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)."},"ToolAssociationConfig":{"properties":{"tool_names":{"items":{"type":"string"},"type":"array","title":"Tool Names"},"mode":{"type":"string","title":"Mode","default":"PREFER"}},"type":"object","title":"ToolAssociationConfig","description":"Tool enforcement configuration for a guideline."},"ToolAvailabilityDeltaPart":{"properties":{"tools_added":{"items":{"type":"string"},"type":"array","title":"Tools Added"},"tool_call_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tool Call Id"},"part_kind":{"type":"string","const":"tool-availability-delta","title":"Part Kind","default":"tool-availability-delta"}},"type":"object","title":"ToolAvailabilityDeltaPart","description":"Records that the set of tools available to the model changed at this point.\n\nAdditions only. Withdrawing a tool is not supported yet, because no provider can be told about one\nwithout also invalidating the prompt cache this part exists to protect: Anthropic rejects a\nreference to a tool the request doesn't declare, so a withdrawn tool has to leave the `tools`\narray, and that is itself the invalidation. The name says *availability* rather than *addition* so\nremovals can join once they can be done cache-safely — see\nhttps://github.com/pydantic/pydantic-ai/issues/6985."},"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"},"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"},"tool_kind":{"anyOf":[{"type":"string","enum":["tool-search","capability-load"]},{"type":"null"}],"title":"Tool Kind"},"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","description":"A tool call from a model."},"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"},"ToolInputAvailablePart":{"properties":{"type":{"type":"string","pattern":"^tool-","title":"Type"},"toolCallId":{"type":"string","title":"Toolcallid"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"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."},"ToolInputStreamingPart":{"properties":{"type":{"type":"string","pattern":"^tool-","title":"Type"},"toolCallId":{"type":"string","title":"Toolcallid"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"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."},"ToolOutputAvailablePart":{"properties":{"type":{"type":"string","pattern":"^tool-","title":"Type"},"toolCallId":{"type":"string","title":"Toolcallid"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"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."},"ToolOutputDeniedPart":{"properties":{"type":{"type":"string","pattern":"^tool-","title":"Type"},"toolCallId":{"type":"string","title":"Toolcallid"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"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)."},"ToolOutputErrorPart":{"properties":{"type":{"type":"string","pattern":"^tool-","title":"Type"},"toolCallId":{"type":"string","title":"Toolcallid"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"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."},"ToolReturnContent":{"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":"#/components/schemas/AudioUrl","binary":"#/components/schemas/BinaryContent","document-url":"#/components/schemas/DocumentUrl","image-url":"#/components/schemas/ImageUrl","uploaded-file":"#/components/schemas/UploadedFile","video-url":"#/components/schemas/VideoUrl"}}},{"additionalProperties":{"$ref":"#/components/schemas/ToolReturnContent"},"type":"object"},{"items":{"$ref":"#/components/schemas/ToolReturnContent"},"type":"array"},{}]},"ToolReturnPart":{"properties":{"tool_name":{"type":"string","title":"Tool Name"},"content":{"$ref":"#/components/schemas/ToolReturnContent"},"tool_call_id":{"type":"string","title":"Tool Call Id"},"tool_kind":{"anyOf":[{"type":"string","enum":["tool-search","capability-load"]},{"type":"null"}],"title":"Tool Kind"},"metadata":{"title":"Metadata"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"outcome":{"type":"string","enum":["success","failed","denied","interrupted"],"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","description":"A tool return message, this encodes the result of running a tool."},"ToolSchemaEntry":{"properties":{"type":{"type":"string","title":"Type"},"title":{"type":"string","title":"Title"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Category"},"icon":{"type":"string","title":"Icon"},"config_schema":{"additionalProperties":true,"type":"object","title":"Config Schema"}},"type":"object","required":["type","title","description","category","icon","config_schema"],"title":"ToolSchemaEntry"},"ToolSearchArgs":{"properties":{"queries":{"items":{"type":"string"},"type":"array","title":"Queries"}},"type":"object","required":["queries"],"title":"ToolSearchArgs","description":"Typed arguments for a tool-search call.\n\nCarried on\n[`NativeToolSearchCallPart.args`][pydantic_ai.messages.NativeToolSearchCallPart.args]\n(native server-side path) and\n[`ToolSearchCallPart.args`][pydantic_ai.messages.ToolSearchCallPart.args]\n(local-fallback path) as the canonical cross-provider shape. Each adapter\nnormalizes its provider's wire format into this shape on parse, and rebuilds the\nwire format from this shape on emit."},"ToolSearchCallPart":{"properties":{"tool_name":{"type":"string","const":"search_tools","title":"Tool Name","default":"search_tools"},"args":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/ToolSearchArgs"},{"type":"null"}],"title":"Args"},"tool_call_id":{"type":"string","title":"Tool Call Id"},"tool_kind":{"type":"string","const":"tool-search","title":"Tool Kind","default":"tool-search"},"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","title":"ToolSearchCallPart","description":"Typed view of a [`ToolCallPart`][pydantic_ai.messages.ToolCallPart] for the local `search_tools` function call.\n\nUsed on the local-fallback path (and as the synthetic-injection target on\nnon-native providers receiving cross-provider history). The native server-side\npath uses\n[`NativeToolSearchCallPart`][pydantic_ai.messages.NativeToolSearchCallPart]\ninstead.\n\nTo detect a tool-search part regardless of execution path (native server-side\nvs. local fallback), check `part.tool_kind == 'tool-search'` — this works\nacross both call/return and both server/local variants.\n\nShadows `args` with the canonical typed shape. The `str` variant covers the\nstreaming / partial-args case before parsing completes; once parsed,\n`args` is a [`ToolSearchArgs`][pydantic_ai.messages.ToolSearchArgs]\n`TypedDict`."},"ToolSearchMatch":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"ToolSearchMatch","description":"A single match in a tool-search result."},"ToolSearchReturnContent":{"properties":{"discovered_tools":{"items":{"$ref":"#/components/schemas/ToolSearchMatch"},"type":"array","title":"Discovered Tools"},"message":{"type":"string","title":"Message"}},"type":"object","required":["discovered_tools"],"title":"ToolSearchReturnContent","description":"Typed return value of the framework-managed tool-search builtin.\n\nCarried on\n[`NativeToolSearchReturnPart.content`][pydantic_ai.messages.NativeToolSearchReturnPart.content]\n(native server-side path) and\n[`ToolSearchReturnPart.content`][pydantic_ai.messages.ToolSearchReturnPart.content]\n(local-fallback path) as the canonical cross-provider shape."},"ToolSearchReturnPart":{"properties":{"tool_name":{"type":"string","const":"search_tools","title":"Tool Name","default":"search_tools"},"tool_call_id":{"type":"string","title":"Tool Call Id"},"tool_kind":{"type":"string","const":"tool-search","title":"Tool Kind","default":"tool-search"},"content":{"$ref":"#/components/schemas/ToolSearchReturnContent"},"metadata":{"title":"Metadata"},"timestamp":{"type":"string","format":"date-time","title":"Timestamp"},"outcome":{"type":"string","enum":["success","failed","denied","interrupted"],"title":"Outcome","default":"success"},"part_kind":{"type":"string","const":"tool-return","title":"Part Kind","default":"tool-return"}},"type":"object","required":["content"],"title":"ToolSearchReturnPart","description":"Typed view of a [`ToolReturnPart`][pydantic_ai.messages.ToolReturnPart] for the local `search_tools` function return.\n\nUsed on the local-fallback path (and as the synthetic-injection target on\nnon-native providers receiving cross-provider history). The native server-side\npath uses\n[`NativeToolSearchReturnPart`][pydantic_ai.messages.NativeToolSearchReturnPart]\ninstead.\n\nTo detect a tool-search part regardless of execution path (native server-side\nvs. local fallback), check `part.tool_kind == 'tool-search'` — this works\nacross both call/return and both server/local variants.\n\nShadows `content` with a narrower\n[`ToolSearchReturnContent`][pydantic_ai.messages.ToolSearchReturnContent]\n`TypedDict`."},"TopTopic":{"properties":{"label":{"type":"string","title":"Label"},"count":{"type":"integer","title":"Count"}},"type":"object","required":["label","count"],"title":"TopTopic"},"TopTopics":{"properties":{"topics":{"items":{"$ref":"#/components/schemas/TopTopic"},"type":"array","title":"Topics"}},"type":"object","required":["topics"],"title":"TopTopics"},"TrainStatus":{"type":"string","enum":["created","trained","training","error"],"title":"TrainStatus"},"Trigger":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"workflow_id":{"type":"string","format":"uuid","title":"Workflow Id"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"definition":{"additionalProperties":true,"type":"object","title":"Definition"},"routing_key":{"type":"string","title":"Routing Key"},"workflow_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workflow Version Id"},"last_run_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Run At"},"last_fired_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Fired At"},"last_error":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Last Error"}},"type":"object","required":["id","group_id","workflow_id","definition","routing_key"],"title":"Trigger"},"TriggerEvent":{"properties":{"id":{"type":"string","title":"Id"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"state":{"$ref":"#/components/schemas/TriggerQueueStatus"},"matched":{"type":"boolean","title":"Matched"},"event_type":{"type":"string","title":"Event Type"},"event_data":{"additionalProperties":true,"type":"object","title":"Event Data"},"retries":{"type":"integer","title":"Retries"},"run_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Run Id"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"},"ignore_reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ignore Reason"}},"type":"object","required":["id","created_at","state","matched","event_type","event_data","retries"],"title":"TriggerEvent"},"TriggerQueueStatus":{"type":"string","enum":["Pending","Processing","Complete","Failed"],"title":"TriggerQueueStatus"},"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."},"Unset":{"properties":{},"type":"object","title":"Unset"},"UpdateAssistant":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"definition":{"anyOf":[{"$ref":"#/components/schemas/CoWorkerSettings-Input"},{"type":"null"}]},"visible":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Visible"},"image_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Url"},"app_settings_v2":{"anyOf":[{"$ref":"#/components/schemas/AppSettingsV2"},{"type":"null"}]},"is_app_published":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is App Published"}},"type":"object","title":"UpdateAssistant"},"UpdateColumnLabelRequest":{"properties":{"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"}},"type":"object","required":["label"],"title":"UpdateColumnLabelRequest"},"UpdateConversation":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"settings":{"anyOf":[{"$ref":"#/components/schemas/CoWorkerSettings-Input"},{"type":"null"}]},"is_deleted":{"type":"boolean","title":"Is Deleted","default":false}},"type":"object","title":"UpdateConversation"},"UpdateDocument":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary"},"short_summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Short Summary"},"status":{"anyOf":[{"$ref":"#/components/schemas/DocumentStatus"},{"type":"null"}]},"doc_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Type"},"error":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Error"},"warnings":{"anyOf":[{"items":{"$ref":"#/components/schemas/SpotWarning"},"type":"array"},{"type":"null"}],"title":"Warnings"},"prefix":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prefix"},"file_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"File Id"},"dismissed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Dismissed"},"needs_reingestion":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Needs Reingestion"},"doc_metadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Doc Metadata"}},"type":"object","title":"UpdateDocument"},"UpdateKnowledgeBaseRequest":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"status":{"anyOf":[{"$ref":"#/components/schemas/TrainStatus"},{"type":"null"}]},"document_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Document Types"},"kb_type":{"anyOf":[{"$ref":"#/components/schemas/KBType"},{"type":"null"}]},"error":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Error"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Summary"},"summary_embedding":{"anyOf":[{"items":{"type":"number"},"type":"array"},{"type":"null"}],"title":"Summary Embedding"},"needs_summary_update":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Needs Summary Update"},"settings_":{"anyOf":[{"$ref":"#/components/schemas/KBConfig"},{"type":"null"}]},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta"},"embedding_model":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Embedding Model"},"embedding_dimension":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Embedding Dimension"},"default_chunk_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Default Chunk Size"},"default_chunk_overlap":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Default Chunk Overlap"}},"type":"object","title":"UpdateKnowledgeBaseRequest","description":"Public KB update payload.\n\nThe attributes a knowledge base is thought of as having — how it\nchunks, what it embeds with — live inside its settings, so they can be\nsent nested under ``settings_``, which replaces the whole config. They\ncan also be sent flat here alongside the name, which changes only what\nit names. Sending both applies the flat ones on top of the nested\nconfig. Every other setting is nested-only."},"UpdateTableRequest":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":56},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}],"title":"Description"},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta"}},"type":"object","title":"UpdateTableRequest","description":"``meta`` is merged key-by-key into the table's existing meta, so a caller\nonly sends the keys it owns."},"UpdateTriggerRequest":{"properties":{"definition":{"additionalProperties":true,"type":"object","title":"Definition"},"name":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"},{"$ref":"#/components/schemas/Unset"}],"title":"Name","default":{}},"workflow_version_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Workflow Version Id"}},"type":"object","required":["definition"],"title":"UpdateTriggerRequest"},"UpdateUserRequest":{"properties":{"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Email"},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata"},"tenant_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tenant Role","description":"Tenant role id or name"}},"type":"object","title":"UpdateUserRequest"},"UpdateWorkflowRequest":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"type":{"anyOf":[{"$ref":"#/components/schemas/WorkflowType"},{"type":"null"}]},"saved":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Saved"},"definition":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Definition"},"error_handler":{"anyOf":[{"type":"string","format":"uuid"},{"$ref":"#/components/schemas/Unset"},{"type":"null"}],"title":"Error Handler","default":{}},"meta":{"anyOf":[{"$ref":"#/components/schemas/WorkflowMeta"},{"type":"null"}]},"workflow_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflow Hash"},"is_app_published":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is App Published"},"app_settings_v2":{"anyOf":[{"$ref":"#/components/schemas/AppSettingsV2"},{"type":"null"}]},"expected_workflow_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Expected Workflow Id"},"base_revision":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Base Revision"}},"type":"object","title":"UpdateWorkflowRequest"},"UploadedFile":{"properties":{"file_id":{"type":"string","title":"File Id"},"provider_name":{"type":"string","enum":["anthropic","openai","google","google-cloud","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.\n\nNote: Inference relies on the file extension in `file_id`.\nFor opaque file IDs (e.g., `'file-abc123'`), the media type will default to `'application/octet-stream'`.\nInference relies on Python's `mimetypes` module, whose results may vary across platforms.\n\nRequired 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.\n\nThis identifier can be provided to the model in a message to allow it to refer to this file in a tool call argument,\nand the tool can look up the file in question by iterating over the message history and finding the matching `UploadedFile`.\n\nThis identifier is only automatically passed to the model when the `UploadedFile` is returned by a tool.\nIf you're passing the `UploadedFile` as a user message, it's up to you to include a separate text part with the identifier,\ne.g. \"This is file <identifier>:\" 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.\n\nThis allows referencing files that have been uploaded via provider-specific file APIs\nrather than providing the file content directly.\n\nSupported by:\n\n- [`AnthropicModel`][pydantic_ai.models.anthropic.AnthropicModel]\n- [`OpenAIChatModel`][pydantic_ai.models.openai.OpenAIChatModel]\n- [`OpenAIResponsesModel`][pydantic_ai.models.openai.OpenAIResponsesModel]\n- [`BedrockConverseModel`][pydantic_ai.models.bedrock.BedrockConverseModel]\n- [`GoogleModel`][pydantic_ai.models.google.GoogleModel] (Gemini API: [Files API](https://ai.google.dev/gemini-api/docs/files) URIs, Google Cloud: GCS `gs://` URIs)\n- [`XaiModel`][pydantic_ai.models.xai.XaiModel]"},"UserAccess":{"properties":{"user_id":{"type":"string","format":"uuid","title":"User Id"},"email":{"type":"string","title":"Email"},"is_active":{"type":"boolean","title":"Is Active"},"tenant_role_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Tenant Role Id"},"tenant_role_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tenant Role Name"},"tenant_permissions":{"items":{"type":"string"},"type":"array","title":"Tenant Permissions"},"memberships":{"items":{"$ref":"#/components/schemas/MembershipAccess"},"type":"array","title":"Memberships"}},"type":"object","required":["user_id","email","is_active","tenant_role_id","tenant_role_name","tenant_permissions","memberships"],"title":"UserAccess"},"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"},"UserPromptPart":{"properties":{"content":{"anyOf":[{"type":"string"},{"items":{"anyOf":[{"type":"string"},{"$ref":"#/components/schemas/TextContent"},{"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":"#/components/schemas/AudioUrl","binary":"#/components/schemas/BinaryContent","document-url":"#/components/schemas/DocumentUrl","image-url":"#/components/schemas/ImageUrl","uploaded-file":"#/components/schemas/UploadedFile","video-url":"#/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","description":"A user prompt, generally written by the end user.\n\nContent comes from the `user_prompt` parameter of [`Agent.run`][pydantic_ai.agent.AbstractAgent.run],\n[`Agent.run_sync`][pydantic_ai.agent.AbstractAgent.run_sync], and [`Agent.run_stream`][pydantic_ai.agent.AbstractAgent.run_stream]."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VariableDefinition":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"VariableDefinition","description":"A user-defined variable available to the agent and its tools.\n\nValues are supplied at runtime (e.g. by the embed host page), so a variable\nis just a name."},"VariablePatchRequest":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"value_type":{"anyOf":[{"type":"string","enum":["string","number","boolean","object","datetime","file"]},{"type":"null"}],"title":"Value Type"},"source":{"anyOf":[{"type":"string","enum":["inline","vault","environment"]},{"type":"null"}],"title":"Source"},"inline_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Inline Value"},"vault_credential_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vault Credential Id"},"vault_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vault Path"},"vault_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vault Key"},"env_var_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Env Var Name"}},"type":"object","title":"VariablePatchRequest","description":"Partial-update payload — same shape, all fields optional."},"VariableUpsertRequest":{"properties":{"name":{"type":"string","title":"Name"},"kind":{"type":"string","enum":["variable","secret"],"title":"Kind","default":"variable"},"value_type":{"type":"string","enum":["string","number","boolean","object","datetime","file"],"title":"Value Type","default":"string"},"source":{"type":"string","enum":["inline","vault","environment"],"title":"Source","default":"inline"},"inline_value":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Inline Value"},"vault_credential_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vault Credential Id"},"vault_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vault Path"},"vault_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vault Key"},"env_var_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Env Var Name"}},"type":"object","required":["name"],"title":"VariableUpsertRequest","description":"Create payload — used by both group and workflow CRUD."},"VersionMeta":{"properties":{"source":{"anyOf":[{"$ref":"#/components/schemas/EntitySource"},{"type":"null"}]}},"type":"object","title":"VersionMeta"},"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"},"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.\n\nThis identifier can be provided to the model in a message to allow it to refer to this file in a tool call argument,\nand the tool can look up the file in question by iterating over the message history and finding the matching `FileUrl`.\n\nThis identifier is only automatically passed to the model when the `FileUrl` is returned by a tool.\nIf you're passing the `FileUrl` as a user message, it's up to you to include a separate text part with the identifier,\ne.g. \"This is file <identifier>:\" preceding the `FileUrl`.\n\nIt's also included in inline-text delimiters for providers that require inlining text documents, so the model can\ndistinguish multiple files.","readOnly":true}},"type":"object","required":["url","media_type","identifier"],"title":"VideoUrl","description":"A URL to a video."},"WarningIdentifier":{"type":"string","enum":["general","model_fallback","model_timeout","reading_spreadsheet","invalid_search","no_results_returned","integration_warning","failed_scraping","invalid_value","continue_on_error","data_ingestion","document_already_exists","ingestion_timeout","libreoffice_conversion","low_confidence","guardrail_validation","kb_creation","kb_empty","unsupported_qa_file_type","unsupported_file_type","no_files_to_add_to_kb","no_files_added_to_kb","no_google_drive_files","no_one_drive_files","no_sharepoint_files","no_websites_scraped","websites_failed_scraping","empty_file","document_overwrite","no_content_provided","invalid_folder","document_name_too_long","retry_warning","tabular_truncated","results_truncated","nested_list_flattened","iteration_failures","password_protected","malformed_document","unreadable_encoding"],"title":"WarningIdentifier"},"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"},"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"},"WebResearchSettings-Input":{"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","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","description":"Whether the tool is enabled","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enabled","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Globe","tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Searching the web...","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Start message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the web search starts.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Searched the web","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"End message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the web search completes.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Globe"},"bg_color":{"type":"string","title":"Bg Color","default":"#D1FADF"},"icon_color":{"type":"string","title":"Icon Color","default":"#027A48"},"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"},"WebResearchSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Web Research"},"description":{"type":"string","title":"Description","default":"Search the web for information"},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","description":"The category of the tool","default":"QuickAction"},"enabled":{"type":"boolean","title":"Enabled","description":"Whether the tool is enabled","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enabled","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","default":"Globe","tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Searching the web...","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Start message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the web search starts.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Searched the web","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"End message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the web search completes.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"icon":{"type":"string","title":"Icon","default":"Globe"},"bg_color":{"type":"string","title":"Bg Color","default":"#D1FADF"},"icon_color":{"type":"string","title":"Icon Color","default":"#027A48"},"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"},"WebpageContext":{"properties":{"url":{"type":"string","title":"Url"},"context":{"type":"string","title":"Context"}},"type":"object","required":["url","context"],"title":"WebpageContext"},"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"},"WebsiteSource":{"properties":{"source_type":{"type":"string","const":"Website","title":"Source Type","default":"Website"},"subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subtype"},"config_cls":{"title":"Config Cls"},"config":{"$ref":"#/components/schemas/WebsiteSourceConfig"},"integration":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Integration"},"image":{"type":"string","title":"Image","default":"icon:Globe"},"name":{"type":"string","title":"Name","default":"Website"},"exposed":{"type":"boolean","title":"Exposed","default":true}},"type":"object","required":["config"],"title":"WebsiteSource"},"WebsiteSourceConfig":{"properties":{"urls":{"items":{"$ref":"#/components/schemas/WebsiteWithDepth"},"type":"array","title":"Urls","description":"URLs to scrape","display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Website URLs","max_depth":2,"needs_confirmation":false,"show_optional_label":false,"type":"config_scrape_website_list"},"tab":"Configuration","tool_mode":"hidden"}},"type":"object","required":["urls"],"title":"WebsiteSourceConfig"},"WebsiteWithDepth":{"properties":{"url":{"type":"string","title":"Url"},"depth":{"type":"integer","title":"Depth"},"max_urls":{"type":"integer","title":"Max Urls","default":50}},"type":"object","required":["url","depth"],"title":"WebsiteWithDepth"},"Workflow":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"name":{"type":"string","title":"Name"},"type":{"$ref":"#/components/schemas/WorkflowType"},"definition":{"additionalProperties":true,"type":"object","title":"Definition"},"workflow_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflow Hash"},"revision":{"type":"integer","title":"Revision","default":0},"meta":{"anyOf":[{"$ref":"#/components/schemas/WorkflowMeta"},{"type":"null"}]},"last_updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Updated At"},"last_run_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Run At"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At"},"runs_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Runs Count"},"author_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Author Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"saved":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Saved"},"error_handler":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Error Handler"},"is_app_published":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is App Published"},"app_settings_v2":{"anyOf":[{"$ref":"#/components/schemas/AppSettingsV2"},{"type":"null"}]},"flow_version":{"type":"string","title":"Flow Version","default":"v1"}},"type":"object","required":["id","group_id","name","type","definition"],"title":"Workflow"},"WorkflowDefinition":{"properties":{"nodes":{"items":{"$ref":"#/components/schemas/NodePreview"},"type":"array","title":"Nodes"},"edges":{"items":{"$ref":"#/components/schemas/EdgePreview"},"type":"array","title":"Edges"}},"type":"object","required":["nodes","edges"],"title":"WorkflowDefinition"},"WorkflowLogColumn":{"properties":{"name":{"type":"string","title":"Name"},"visible":{"type":"boolean","title":"Visible","default":true}},"type":"object","required":["name"],"title":"WorkflowLogColumn"},"WorkflowLogSheet":{"properties":{"name":{"type":"string","title":"Name"},"id":{"type":"string","title":"Id"},"time_created":{"type":"string","title":"Time Created"}},"type":"object","required":["name","id","time_created"],"title":"WorkflowLogSheet"},"WorkflowLogSpreadsheet":{"properties":{"name":{"type":"string","title":"Name"},"id":{"type":"string","title":"Id"},"timestamp":{"type":"string","title":"Timestamp"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"}},"type":"object","required":["name","id","timestamp"],"title":"WorkflowLogSpreadsheet"},"WorkflowLogs":{"properties":{"keys":{"items":{"type":"string"},"type":"array","title":"Keys"},"values":{"items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array","title":"Values"}},"type":"object","required":["keys","values"],"title":"WorkflowLogs"},"WorkflowMeta":{"properties":{"tags":{"items":{"$ref":"#/components/schemas/WorkflowTag"},"type":"array","title":"Tags","default":[]},"icon":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Icon"},"log_sync_sheet":{"anyOf":[{"$ref":"#/components/schemas/WorkflowLogSheet"},{"type":"null"}]},"columns":{"anyOf":[{"items":{"$ref":"#/components/schemas/WorkflowLogColumn"},"type":"array"},{"type":"null"}],"title":"Columns"},"spreadsheet":{"anyOf":[{"$ref":"#/components/schemas/WorkflowLogSpreadsheet"},{"type":"null"}]},"template_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Template Id"},"variables":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Variables"},"source":{"anyOf":[{"$ref":"#/components/schemas/EntitySource"},{"type":"null"}]}},"type":"object","title":"WorkflowMeta"},"WorkflowProgress":{"properties":{"executed_nodes":{"items":{"type":"string"},"type":"array","title":"Executed Nodes"},"running_nodes":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Running Nodes"},"remaining_nodes":{"items":{"type":"string"},"type":"array","title":"Remaining Nodes"},"skipped_nodes":{"items":{"type":"string"},"type":"array","title":"Skipped Nodes","default":[]},"error_handler_nodes":{"items":{"type":"string"},"type":"array","title":"Error Handler Nodes","default":[]},"per_node_progress":{"additionalProperties":{"$ref":"#/components/schemas/NodeProgress"},"type":"object","title":"Per Node Progress"},"terminal_error":{"type":"boolean","title":"Terminal Error","default":false},"subflow_executions":{"additionalProperties":{"$ref":"#/components/schemas/SubflowExecution"},"type":"object","title":"Subflow Executions","default":{}},"subflow_definitions":{"additionalProperties":{"$ref":"#/components/schemas/SubflowDefinitions"},"type":"object","title":"Subflow Definitions","default":{}},"per_edge_progress":{"additionalProperties":{"$ref":"#/components/schemas/EdgeProgress"},"type":"object","title":"Per Edge Progress","default":{}},"run_logs":{"additionalProperties":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object"},{"type":"number"},{"type":"integer"}]},"type":"object","title":"Run Logs"}},"type":"object","required":["executed_nodes","remaining_nodes","per_node_progress"],"title":"WorkflowProgress"},"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"},"WorkflowSettings-Input":{"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","Agents"],"title":"Category","default":"Flows","tab":"Configuration","tool_mode":"hidden","visible":false},"enabled":{"type":"boolean","title":"Enabled","description":"Whether the tool is enabled","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enabled","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","description":"The lucide icon to display for this tool","default":"Cog","tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Running a workflow","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Start message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the workflow starts.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Workflow run complete","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"End message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the workflow finishes.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Input"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"type":{"type":"string","const":"workflow","title":"Type","default":"workflow","tab":"Configuration","tool_mode":"hidden","visible":false},"workflow_id":{"type":"string","format":"uuid","title":"Workflow Id","description":"The ID of the workflow to run. Comes unselected, and should be selected by the user.","tab":"Configuration","tool_mode":"hidden","visible":false},"inputs_descriptions":{"additionalProperties":{"type":"string"},"type":"object","title":"Inputs Descriptions","description":"A dictionary of input names to descriptions.","tab":"Configuration","tool_mode":"hidden","visible":false},"input_overrides":{"additionalProperties":{"$ref":"#/components/schemas/InputOverride"},"type":"object","title":"Input Overrides","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"},"WorkflowSettings-Output":{"properties":{"title":{"type":"string","title":"Title","default":"Workflow Runner","tab":"Configuration","tool_mode":"hidden","visible":false},"description":{"type":"string","title":"Description","default":"Run a workflow","tab":"Configuration","tool_mode":"hidden","visible":false},"category":{"type":"string","enum":["QuickAction","Flows","Knowledge","Actions","MCP","Agents"],"title":"Category","default":"Flows","tab":"Configuration","tool_mode":"hidden","visible":false},"enabled":{"type":"boolean","title":"Enabled","description":"Whether the tool is enabled","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Enabled","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_icon":{"type":"string","title":"Tool Display Icon","description":"The lucide icon to display for this tool","default":"Cog","tab":"Configuration","tool_mode":"hidden","visible":false},"tool_display_message_start":{"type":"string","title":"Tool Display Message Start","default":"Running a workflow","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"Start message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the workflow starts.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"tool_display_message_end":{"type":"string","title":"Tool Display Message End","default":"Workflow run complete","col_span":6,"display":{"col_span":12,"is_code":false,"is_disabled":false,"is_subconfig":false,"is_textarea":false,"label":"End message","needs_confirmation":false,"number_of_lines":1,"placeholder":"Message displayed when the workflow finishes.","show_optional_label":false,"show_refresh":false,"type":"text"},"tab":"Configuration","tool_mode":"hidden"},"extra_instructions":{"anyOf":[{"$ref":"#/components/schemas/NoxusTipTapDocument-Output"},{"type":"null"}],"description":"Any extra instructions for the tool","display":{"allow_reference_mentions":false,"col_span":12,"connector_name":"","enable_heuristics":true,"heuristic_context":"Tool usage 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":"Usage Conditions","needs_confirmation":false,"number_of_lines":5,"show_optional_label":false,"type":"rich_text_variables_ai"},"tab":"Configuration","tool_mode":"hidden"},"requires_approval":{"type":"boolean","title":"Requires Approval","description":"Whether tool calls require user approval before execution","default":false,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Require Approval","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden"},"visible":{"type":"boolean","title":"Visible","description":"Whether the tool is visible","default":true,"display":{"col_span":12,"is_disabled":false,"is_subconfig":false,"label":"Visible","needs_confirmation":false,"show_optional_label":false,"toggle_position":"right","type":"toggle"},"tab":"Configuration","tool_mode":"hidden","visible":false},"type":{"type":"string","const":"workflow","title":"Type","default":"workflow","tab":"Configuration","tool_mode":"hidden","visible":false},"workflow_id":{"type":"string","format":"uuid","title":"Workflow Id","description":"The ID of the workflow to run. Comes unselected, and should be selected by the user.","tab":"Configuration","tool_mode":"hidden","visible":false},"inputs_descriptions":{"additionalProperties":{"type":"string"},"type":"object","title":"Inputs Descriptions","description":"A dictionary of input names to descriptions.","tab":"Configuration","tool_mode":"hidden","visible":false},"input_overrides":{"additionalProperties":{"$ref":"#/components/schemas/InputOverride"},"type":"object","title":"Input Overrides","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"},"WorkflowTag":{"properties":{"value":{"type":"string","title":"Value"},"color":{"type":"string","title":"Color"}},"type":"object","required":["value","color"],"title":"WorkflowTag"},"WorkflowType":{"type":"string","enum":["flow","handler","ingestion","inbox_process","inbox_filtering","inbox_extraction","task_automation"],"title":"WorkflowType"},"WorkflowVersion":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"created_by":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Created By"},"definition":{"additionalProperties":true,"type":"object","title":"Definition"},"meta":{"anyOf":[{"$ref":"#/components/schemas/VersionMeta"},{"type":"null"}]},"is_valid":{"type":"boolean","title":"Is Valid","default":true}},"type":"object","required":["id","name","created_at","definition"],"title":"WorkflowVersion"},"WorkflowWithTriggers":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"group_id":{"type":"string","format":"uuid","title":"Group Id"},"name":{"type":"string","title":"Name"},"type":{"$ref":"#/components/schemas/WorkflowType"},"definition":{"additionalProperties":true,"type":"object","title":"Definition"},"workflow_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Workflow Hash"},"revision":{"type":"integer","title":"Revision","default":0},"meta":{"anyOf":[{"$ref":"#/components/schemas/WorkflowMeta"},{"type":"null"}]},"last_updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Updated At"},"last_run_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Run At"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At"},"runs_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Runs Count"},"author_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Author Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"saved":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Saved"},"error_handler":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Error Handler"},"is_app_published":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is App Published"},"app_settings_v2":{"anyOf":[{"$ref":"#/components/schemas/AppSettingsV2"},{"type":"null"}]},"flow_version":{"type":"string","title":"Flow Version","default":"v1"},"triggers":{"items":{"$ref":"#/components/schemas/Trigger"},"type":"array","title":"Triggers","default":[]}},"type":"object","required":["id","group_id","name","type","definition"],"title":"WorkflowWithTriggers"},"WorkspaceAssignment":{"properties":{"workspace_id":{"type":"string","format":"uuid","title":"Workspace Id"},"role":{"type":"string","title":"Role","description":"Workspace role id or name, e.g. Editor"}},"type":"object","required":["workspace_id","role"],"title":"WorkspaceAssignment"},"WorkspaceRef":{"properties":{"provider":{"type":"string","title":"Provider"},"id":{"type":"string","title":"Id"}},"type":"object","required":["provider","id"],"title":"WorkspaceRef","description":"Serializable identity of a [workspace](../workspace.md) environment, without credentials.\n\nPass it to a later run as `workspace=` to continue in that environment."},"WriteFileIn":{"properties":{"path":{"type":"string","title":"Path","description":"Absolute path inside the sandbox."},"content":{"type":"string","title":"Content","description":"File content."},"encoding":{"type":"string","title":"Encoding","description":"'utf-8' for text, or 'base64' when content is binary.","default":"utf-8"}},"type":"object","required":["path","content"],"title":"WriteFileIn"},"WriteFileOut":{"properties":{"path":{"type":"string","title":"Path"}},"type":"object","required":["path"],"title":"WriteFileOut"},"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"}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Key"}}}}