Args:
collection: Target collection to search within.
query_text: Query text to search for.
embedding_model_id: Embedding model ID (required for dense/hybrid search).
search_type: Search strategy (dense, sparse, or hybrid).
top_k: Maximum number of results to return.
filters: Optional filters for search.
fusion_config: Optional fusion configuration for hybrid search.
rerank_model_id: Optional rerank model for result reordering.
rerank_top_k: Override for rerank result count.
readonly: Whether to avoid index modifications.
nprobes: Number of partitions to probe for ANN search.
refine_factor: Refine factor for ANN search re-ranking.
fallback_to_sparse: Allow hybrid search to fallback to sparse.
Optional filters to apply during search. Format: {field: value} for equality filters. For advanced filters, use {field: {operator: str, value: Any}} where operator can be: eq, ne, gt, gte, lt, lte, in, contains.
{"docsConfig":{"theme":"willow","$schema":"https://mintlify.com/docs.json","name":"Xagent","colors":{"primary":"#6A0CF5","light":"#AB66F3","dark":"#5A0BD3"},"logo":{"light":"https://mintcdn.com/xorbitsinc/iidWB4pLRl1L1AC4/images/logo/xagent-logo-light.png?fit=max\u0026auto=format\u0026n=iidWB4pLRl1L1AC4\u0026q=85\u0026s=d45e51a54fae46740727ec694e10dbda","dark":"https://mintcdn.com/xorbitsinc/iidWB4pLRl1L1AC4/images/logo/xagent-logo-dark.png?fit=max\u0026auto=format\u0026n=iidWB4pLRl1L1AC4\u0026q=85\u0026s=6c316247f095e6ffc81aa2fd470b492c"},"favicon":"https://mintcdn.com/xorbitsinc/iidWB4pLRl1L1AC4/favicon.png?fit=max\u0026auto=format\u0026n=iidWB4pLRl1L1AC4\u0026q=85\u0026s=25d06ff0abe8bcf002173d802165bbe0","api":{"openapi":"api-reference/openapi.json"},"navbar":{"links":[{"href":"https://github.com/xorbitsai/xagent","label":"GitHub"}],"primary":{"type":"button","label":"Get Started","href":"/quickstart"}},"footer":{"socials":{"github":"https://github.com/xorbitsai/xagent","x":"https://x.com/xorbitsai"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"xorbitsinc","hasAudioNarration":false,"actualSubdomain":"xorbitsinc","customDomains":["docs.xagent.co"],"gitSource":{"type":"github","owner":"xorbitsai","repo":"xagent-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae55edaa11e082850869934","collectionId":"0bfcd2b1-0e76-49e2-b17b-87d132f9c8f4","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae55edaa11e082850869934"},"entitlements":{},"buildId":"6ae55edaa11e082850869934","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"en","tag":"API Reference","count":199},{"language":"en","tag":"Models","count":38},{"language":"en","tag":"Use Xagent","count":29},{"language":"en","tag":"Agents","count":21},{"language":"en","tag":"Authentication","count":20},{"language":"en","tag":"Workforces","count":19},{"language":"en","tag":"Knowledge Base","count":18},{"language":"en","tag":"Files","count":13},{"language":"en","tag":"Tools","count":13},{"language":"en","tag":"MCP","count":11}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":true},"customCss":[{"filePath":"custom.css","content":"html[data-page-mode=wide] #content-area:has(.xagent-homewide),html[data-page-mode=wide] #content-area:has(.xagent-homewide) #content,html[data-page-mode=wide] #content-area:has(.xagent-homewide) .xagent-homewide,html[data-page-mode=wide] #content-area:has(.xagent-homewide)>div,html[data-page-mode=wide] #content-area:has(.xagent-homewide)>div>div{width:100%;max-width:none}html[data-page-mode=wide] #content-area:has(.xagent-homewide) div:has(>.xagent-homewide){box-sizing:border-box;padding-inline:clamp(1.5rem,3vw,4rem)}"}],"page":{"pagePath":"api-reference/kb/search","slug":"/api-reference/kb/search","pageMetadata":{"openapi":"post /api/kb/search","title":"Search","description":"Search documents in the knowledge base.\n\nArgs:\n collection: Target collection to search within.\n query_text: Query text to search for.\n embedding_model_id: Embedding model ID (required for dense/hybrid search).\n search_type: Search strategy (dense, sparse, or hybrid).\n top_k: Maximum number of results to return.\n filters: Optional filters for search.\n fusion_config: Optional fusion configuration for hybrid search.\n rerank_model_id: Optional rerank model for result reordering.\n rerank_top_k: Override for rerank result count.\n readonly: Whether to avoid index modifications.\n nprobes: Number of partitions to probe for ANN search.\n refine_factor: Refine factor for ANN search re-ranking.\n fallback_to_sparse: Allow hybrid search to fallback to sparse.","href":"/api-reference/kb/search"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Search documents in the knowledge base.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Args:\\ncollection: Target collection to search within.\\nquery_text: Query text to search for.\\nembedding_model_id: Embedding model ID (required for dense/hybrid search).\\nsearch_type: Search strategy (dense, sparse, or hybrid).\\ntop_k: Maximum number of results to return.\\nfilters: Optional filters for search.\\nfusion_config: Optional fusion configuration for hybrid search.\\nrerank_model_id: Optional rerank model for result reordering.\\nrerank_top_k: Override for rerank result count.\\nreadonly: Whether to avoid index modifications.\\nnprobes: Number of partitions to probe for ANN search.\\nrefine_factor: Refine factor for ANN search re-ranking.\\nfallback_to_sparse: Allow hybrid search to fallback to sparse.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /api/kb/search","title":"Search","description":"Search documents in the knowledge base.\n\nArgs:\n collection: Target collection to search within.\n query_text: Query text to search for.\n embedding_model_id: Embedding model ID (required for dense/hybrid search).\n search_type: Search strategy (dense, sparse, or hybrid).\n top_k: Maximum number of results to return.\n filters: Optional filters for search.\n fusion_config: Optional fusion configuration for hybrid search.\n rerank_model_id: Optional rerank model for result reordering.\n rerank_top_k: Override for rerank result count.\n readonly: Whether to avoid index modifications.\n nprobes: Number of partitions to probe for ANN search.\n refine_factor: Refine factor for ANN search re-ranking.\n fallback_to_sparse: Allow hybrid search to fallback to sparse.","href":"/api-reference/kb/search"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["kb"],"summary":"Search","description":"Search documents in the knowledge base.\n\nArgs:\n collection: Target collection to search within.\n query_text: Query text to search for.\n embedding_model_id: Embedding model ID (required for dense/hybrid search).\n search_type: Search strategy (dense, sparse, or hybrid).\n top_k: Maximum number of results to return.\n filters: Optional filters for search.\n fusion_config: Optional fusion configuration for hybrid search.\n rerank_model_id: Optional rerank model for result reordering.\n rerank_top_k: Override for rerank result count.\n readonly: Whether to avoid index modifications.\n nprobes: Number of partitions to probe for ANN search.\n refine_factor: Refine factor for ANN search re-ranking.\n fallback_to_sparse: Allow hybrid search to fallback to sparse.","operationId":"search_api_kb_search_post","requestBody":"88d4b223-6144-4218-9d22-a6dd7cc4128d","responses":{"200":"daa9f67b-f56e-4b34-b3c0-1ad8babfa087","422":"ca6bb8ce-233a-4dd8-a151-bdcb3aa471a9"},"security":["e1cb2fbb-77ac-447d-8551-3e4e90a7ab01"],"method":"post","type":"path","servers":[],"path":"/api/kb/search","baseUrlOptions":[],"title":"Search","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"collection":{"type":"string","title":"Collection","description":"Target collection to search within","isRequired":true,"uniqueKey":"collection","typeLabel":"string"},"query_text":{"type":"string","title":"Query Text","description":"Query text to search for","isRequired":true,"uniqueKey":"query_text","typeLabel":"string"},"embedding_model_id":{"type":"string","title":"Embedding Model Id","description":"Embedding model ID (default: text-embedding-v4)","default":"text-embedding-v4","uniqueKey":"embedding_model_id","typeLabel":"string"},"search_type":{"oneOf":[{"type":"string","title":"SearchType","description":"Search strategy: dense, sparse, or hybrid (default: hybrid)","enum":["dense","sparse","hybrid"],"uniqueKey":"search_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Search strategy: dense, sparse, or hybrid (default: hybrid)","uniqueKey":"search_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"search_type","typeLabel":"enum\u003cstring> | null"},"top_k":{"oneOf":[{"type":"integer","title":"Top K","description":"Maximum number of results to return (default: 5)","maximum":100,"minimum":1,"uniqueKey":"top_k.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Top K","description":"Maximum number of results to return (default: 5)","uniqueKey":"top_k.oneOf.1","typeLabel":"null"}],"uniqueKey":"top_k","typeLabel":"integer | null"},"filters":{"oneOf":[{"type":"object","title":"Filters","description":"Optional filters to apply during search. Format: {field: value} for equality filters. For advanced filters, use {field: {operator: str, value: Any}} where operator can be: eq, ne, gt, gte, lt, lte, in, contains.","additionalProperties":true,"uniqueKey":"filters.oneOf.0","typeLabel":"Filters · object"},{"type":"null","title":"Filters","description":"Optional filters to apply during search. Format: {field: value} for equality filters. For advanced filters, use {field: {operator: str, value: Any}} where operator can be: eq, ne, gt, gte, lt, lte, in, contains.","uniqueKey":"filters.oneOf.1","typeLabel":"null"}],"uniqueKey":"filters","typeLabel":"Filters · object | null"},"fusion_config":{"oneOf":[{"type":"object","title":"Fusion Config","description":"Optional fusion configuration for hybrid search","additionalProperties":true,"uniqueKey":"fusion_config.oneOf.0","typeLabel":"Fusion Config · object"},{"type":"null","title":"Fusion Config","description":"Optional fusion configuration for hybrid search","uniqueKey":"fusion_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"fusion_config","typeLabel":"Fusion Config · object | null"},"rerank_model_id":{"oneOf":[{"type":"string","title":"Rerank Model Id","description":"Optional rerank model ID for result reordering","uniqueKey":"rerank_model_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Rerank Model Id","description":"Optional rerank model ID for result reordering","uniqueKey":"rerank_model_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"rerank_model_id","typeLabel":"string | null"},"rerank_top_k":{"oneOf":[{"type":"integer","title":"Rerank Top K","description":"Optional override for rerank result count","uniqueKey":"rerank_top_k.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Rerank Top K","description":"Optional override for rerank result count","uniqueKey":"rerank_top_k.oneOf.1","typeLabel":"null"}],"uniqueKey":"rerank_top_k","typeLabel":"integer | null"},"readonly":{"oneOf":[{"type":"boolean","title":"Readonly","description":"Avoid index modifications (default: False)","uniqueKey":"readonly.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Readonly","description":"Avoid index modifications (default: False)","uniqueKey":"readonly.oneOf.1","typeLabel":"null"}],"uniqueKey":"readonly","typeLabel":"boolean | null"},"nprobes":{"oneOf":[{"type":"integer","title":"Nprobes","description":"Number of partitions to probe for ANN search","uniqueKey":"nprobes.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Nprobes","description":"Number of partitions to probe for ANN search","uniqueKey":"nprobes.oneOf.1","typeLabel":"null"}],"uniqueKey":"nprobes","typeLabel":"integer | null"},"refine_factor":{"oneOf":[{"type":"integer","title":"Refine Factor","description":"Refine factor for ANN search re-ranking","uniqueKey":"refine_factor.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Refine Factor","description":"Refine factor for ANN search re-ranking","uniqueKey":"refine_factor.oneOf.1","typeLabel":"null"}],"uniqueKey":"refine_factor","typeLabel":"integer | null"},"fallback_to_sparse":{"oneOf":[{"type":"boolean","title":"Fallback To Sparse","description":"Allow hybrid search to fallback to sparse (default: True)","uniqueKey":"fallback_to_sparse.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Fallback To Sparse","description":"Allow hybrid search to fallback to sparse (default: True)","uniqueKey":"fallback_to_sparse.oneOf.1","typeLabel":"null"}],"uniqueKey":"fallback_to_sparse","typeLabel":"boolean | null"}},"type":"object","required":["collection","query_text"],"title":"Body_search_api_kb_search_post","uniqueKey":"","typeLabel":"Body_search_api_kb_search_post · object"},"examples":{"Example":{"title":"Example","value":{"collection":"\u003cstring>","query_text":"\u003cstring>","embedding_model_id":"text-embedding-v4","top_k":50,"filters":{},"fusion_config":{},"rerank_model_id":"\u003cstring>","rerank_top_k":123,"readonly":true,"nprobes":123,"refine_factor":123,"fallback_to_sparse":true}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"daa9f67b-f56e-4b34-b3c0-1ad8babfa087":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"status":{"type":"string","title":"Status","description":"Pipeline status: success|partial_success|error","isRequired":true,"uniqueKey":"status","typeLabel":"string"},"search_type":{"type":"string","enum":["dense","sparse","hybrid"],"title":"SearchType","description":"Actual search strategy executed (post-fallback if any)","isRequired":true,"uniqueKey":"search_type","typeLabel":"enum\u003cstring>"},"result_count":{"type":"integer","title":"Result Count","description":"Number of results returned","isRequired":true,"uniqueKey":"result_count","typeLabel":"integer"},"message":{"type":"string","title":"Message","description":"Human-readable pipeline outcome message","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"results":{"items":{"properties":{"doc_id":{"type":"string","title":"Doc Id","description":"Document ID","isRequired":true,"uniqueKey":"results.items.[INDEX].doc_id","typeLabel":"string"},"chunk_id":{"type":"string","title":"Chunk Id","description":"Chunk ID within the document","isRequired":true,"uniqueKey":"results.items.[INDEX].chunk_id","typeLabel":"string"},"text":{"type":"string","title":"Text","description":"Text content of the chunk","isRequired":true,"uniqueKey":"results.items.[INDEX].text","typeLabel":"string"},"score":{"type":"number","maximum":1,"minimum":0,"title":"Score","description":"Similarity score (0-1, higher is better); must be between 0 and 1 inclusive","isRequired":true,"uniqueKey":"results.items.[INDEX].score","typeLabel":"number"},"parse_hash":{"type":"string","title":"Parse Hash","description":"Parse version hash","isRequired":true,"uniqueKey":"results.items.[INDEX].parse_hash","typeLabel":"string"},"model_tag":{"type":"string","title":"Model Tag","description":"Embedding model identifier","isRequired":true,"uniqueKey":"results.items.[INDEX].model_tag","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Chunk creation timestamp","uniqueKey":"results.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"metadata":{"oneOf":[{"type":"object","title":"Metadata","description":"Additional metadata for the chunk (page_number, section, source, etc.)","additionalProperties":true,"uniqueKey":"results.items.[INDEX].metadata.oneOf.0","typeLabel":"Metadata · object"},{"type":"null","title":"Metadata","description":"Additional metadata for the chunk (page_number, section, source, etc.)","uniqueKey":"results.items.[INDEX].metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].metadata","typeLabel":"Metadata · object | null"},"vector_score":{"oneOf":[{"type":"number","title":"Vector Score","description":"Original vector search score (before rerank/fusion)","uniqueKey":"results.items.[INDEX].vector_score.oneOf.0","typeLabel":"number"},{"type":"null","title":"Vector Score","description":"Original vector search score (before rerank/fusion)","uniqueKey":"results.items.[INDEX].vector_score.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].vector_score","typeLabel":"number | null"},"fts_score":{"oneOf":[{"type":"number","title":"Fts Score","description":"Original FTS search score (before rerank/fusion)","uniqueKey":"results.items.[INDEX].fts_score.oneOf.0","typeLabel":"number"},{"type":"null","title":"Fts Score","description":"Original FTS search score (before rerank/fusion)","uniqueKey":"results.items.[INDEX].fts_score.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].fts_score","typeLabel":"number | null"},"vector_rank":{"oneOf":[{"type":"integer","title":"Vector Rank","description":"Original rank in vector search results (1-based)","minimum":1,"uniqueKey":"results.items.[INDEX].vector_rank.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Vector Rank","description":"Original rank in vector search results (1-based)","uniqueKey":"results.items.[INDEX].vector_rank.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].vector_rank","typeLabel":"integer | null"},"fts_rank":{"oneOf":[{"type":"integer","title":"Fts Rank","description":"Original rank in FTS search results (1-based)","minimum":1,"uniqueKey":"results.items.[INDEX].fts_rank.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Fts Rank","description":"Original rank in FTS search results (1-based)","uniqueKey":"results.items.[INDEX].fts_rank.oneOf.1","typeLabel":"null"}],"uniqueKey":"results.items.[INDEX].fts_rank","typeLabel":"integer | null"}},"type":"object","required":["doc_id","chunk_id","text","score","parse_hash","model_tag"],"title":"SearchResult","description":"Individual search result item.","uniqueKey":"results.items.[INDEX]","typeLabel":"SearchResult · object"},"type":"array","title":"Results","description":"Search results (possibly reranked)","uniqueKey":"results","typeLabel":"SearchResult · object[]"},"warnings":{"items":{"type":"string","uniqueKey":"warnings.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Warnings","description":"Non-fatal warnings and fallback messages","uniqueKey":"warnings","typeLabel":"string[]"},"used_rerank":{"type":"boolean","title":"Used Rerank","description":"Whether rerank model was applied to the results","default":false,"uniqueKey":"used_rerank","typeLabel":"boolean"}},"type":"object","required":["status","search_type","result_count","message"],"title":"SearchPipelineResult","description":"Unified response payload for document search pipeline.","uniqueKey":"","typeLabel":"SearchPipelineResult · object"},"examples":{"Example":{"title":"Example","value":{"status":"\u003cstring>","search_type":"dense","result_count":123,"message":"\u003cstring>","results":[{"doc_id":"\u003cstring>","chunk_id":"\u003cstring>","text":"\u003cstring>","score":0.5,"parse_hash":"\u003cstring>","model_tag":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","metadata":{},"vector_score":123,"fts_score":123,"vector_rank":2,"fts_rank":2}],"warnings":["\u003cstring>"],"used_rerank":false}}},"exampleType":"generated"}},"exampleType":"generated"},"ca6bb8ce-233a-4dd8-a151-bdcb3aa471a9":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"e1cb2fbb-77ac-447d-8551-3e4e90a7ab01":{"HTTPBearer":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"HTTPBearer"}}},"servers":{},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"HTTPBearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"xorbitsinc","siteName":"Xagent","title":"Search - Xagent","navMaps":{"firstHrefInVersion":{"Latest":{"href":"/api-reference/kb/search","matchLevel":0}},"firstHrefInLanguage":{"en":{"href":"/api-reference/kb/search","matchLevel":0}}},"lastModified":"2026-02-19T13:36:08.577Z","originalFileLocation":"api-reference/kb/search.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Search documents in the knowledge base. Args: collection: Target collection to search within. query_text: Query text to search for. embedding_model_id: Embedding model ID (required for dense/hybrid search). search_type: Search strategy (dense, sparse, or hybrid). top_k: Maximum number of results to return. filters: Optional filters for search. fusion_config: Optional fusion configuration for hybrid search. rerank_model_id: Optional rerank model for result reordering. rerank_top_k: Override for rerank result count. readonly: Whether to avoid index modifications. nprobes: Number of partitions to probe for ANN search. refine_factor: Refine factor for ANN search re-ranking. fallback_to_sparse: Allow hybrid search to fallback to sparse.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Xagent\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/xorbitsinc/PSDisYJ6JNoefUDf/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/xorbitsinc/PSDisYJ6JNoefUDf/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/xorbitsinc/PSDisYJ6JNoefUDf/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/xorbitsinc/PSDisYJ6JNoefUDf/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/xorbitsinc/PSDisYJ6JNoefUDf/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/xorbitsinc/PSDisYJ6JNoefUDf/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/xorbitsinc/PSDisYJ6JNoefUDf/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/xorbitsinc/PSDisYJ6JNoefUDf/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/xorbitsinc/PSDisYJ6JNoefUDf/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Search - Xagent\">\u003cmeta data-mint-head property=\"og:description\" content=\"Search documents in the knowledge base. Args: collection: Target collection to search within. query_text: Query text to search for. embedding_model_id: Embedding model ID (required for dense/hybrid search). search_type: Search strategy (dense, sparse, or hybrid). top_k: Maximum number of results to return. filters: Optional filters for search. fusion_config: Optional fusion configuration for hybrid search. rerank_model_id: Optional rerank model for result reordering. rerank_top_k: Override for rerank result count. readonly: Whether to avoid index modifications. nprobes: Number of partitions to probe for ANN search. refine_factor: Refine factor for ANN search re-ranking. fallback_to_sparse: Allow hybrid search to fallback to sparse.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Xagent\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.xagent.co/api-reference/kb/search\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://xorbitsinc.mintlify.app/_mintlify/api/og/v2?division=Knowledge+Base\u0026amp;title=Search\u0026amp;description=Search+documents+in+the+knowledge+base.%0A%0AArgs%3A%0A++++collection%3A+Target+collection+to+search+within.%0A++++query_text%3A+Query+text+to+search+for.%0A++++embedding_model\u0026amp;theme=7a21b44f6d5c94939f15c745\u0026amp;signature=40a68024719e6df0702148e2f1ad208ebf2f4251df9b68418c941edda5d643a4\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Search - Xagent\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Search documents in the knowledge base. Args: collection: Target collection to search within. query_text: Query text to search for. embedding_model_id: Embedding model ID (required for dense/hybrid search). search_type: Search strategy (dense, sparse, or hybrid). top_k: Maximum number of results to return. filters: Optional filters for search. fusion_config: Optional fusion configuration for hybrid search. rerank_model_id: Optional rerank model for result reordering. rerank_top_k: Override for rerank result count. readonly: Whether to avoid index modifications. nprobes: Number of partitions to probe for ANN search. refine_factor: Refine factor for ANN search re-ranking. fallback_to_sparse: Allow hybrid search to fallback to sparse.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://xorbitsinc.mintlify.app/_mintlify/api/og/v2?division=Knowledge+Base\u0026amp;title=Search\u0026amp;description=Search+documents+in+the+knowledge+base.%0A%0AArgs%3A%0A++++collection%3A+Target+collection+to+search+within.%0A++++query_text%3A+Query+text+to+search+for.%0A++++embedding_model\u0026amp;theme=7a21b44f6d5c94939f15c745\u0026amp;signature=40a68024719e6df0702148e2f1ad208ebf2f4251df9b68418c941edda5d643a4\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/xorbitsinc/PSDisYJ6JNoefUDf/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Xagent\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6A0CF5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.xagent.co/api-reference/kb/search\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/kb/search.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.xagent.co/#organization\",\"name\":\"Xagent\",\"url\":\"https://docs.xagent.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/xorbitsinc/iidWB4pLRl1L1AC4/images/logo/xagent-logo-light.png?fit=max\u0026auto=format\u0026n=iidWB4pLRl1L1AC4\u0026q=85\u0026s=d45e51a54fae46740727ec694e10dbda\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.xagent.co#website\",\"name\":\"Xagent\",\"url\":\"https://docs.xagent.co\",\"publisher\":{\"@id\":\"https://docs.xagent.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.xagent.co/api-reference/kb/search#webpage\",\"url\":\"https://docs.xagent.co/api-reference/kb/search\",\"name\":\"Search\",\"description\":\"Search documents in the knowledge base. Args: collection: Target collection to search within. query_text: Query text to search for. embedding_model_id: Embedding model ID (required for dense/hybrid search). search_type: Search strategy (dense, sparse, or hybrid). top_k: Maximum number of results to return. filters: Optional filters for search. fusion_config: Optional fusion configuration for hybrid search. rerank_model_id: Optional rerank model for result reordering. rerank_top_k: Override for rerank result count. readonly: Whether to avoid index modifications. nprobes: Number of partitions to probe for ANN search. refine_factor: Refine factor for ANN search re-ranking. fallback_to_sparse: Allow hybrid search to fallback to sparse.\",\"dateModified\":\"2026-02-19T13:36:08.577Z\",\"isPartOf\":{\"@id\":\"https://docs.xagent.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.xagent.co/api-reference/kb/search#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.xagent.co/api-reference/kb/search#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Knowledge Base\",\"item\":\"https://docs.xagent.co/api-reference/kb/ingest\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Search\",\"item\":\"https://docs.xagent.co/api-reference/kb/search\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.xagent.co/api-reference/kb/search#apireference\",\"headline\":\"Search\",\"name\":\"Search\",\"description\":\"Search documents in the knowledge base. Args: collection: Target collection to search within. query_text: Query text to search for. embedding_model_id: Embedding model ID (required for dense/hybrid search). search_type: Search strategy (dense, sparse, or hybrid). top_k: Maximum number of results to return. filters: Optional filters for search. fusion_config: Optional fusion configuration for hybrid search. rerank_model_id: Optional rerank model for result reordering. rerank_top_k: Override for rerank result count. readonly: Whether to avoid index modifications. nprobes: Number of partitions to probe for ANN search. refine_factor: Refine factor for ANN search re-ranking. fallback_to_sparse: Allow hybrid search to fallback to sparse.\",\"url\":\"https://docs.xagent.co/api-reference/kb/search\",\"mainEntityOfPage\":{\"@id\":\"https://docs.xagent.co/api-reference/kb/search#webpage\"},\"dateModified\":\"2026-02-19T13:36:08.577Z\",\"publisher\":{\"@id\":\"https://docs.xagent.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.xagent.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Xagent\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Xagent","nav":{"global":null,"versions":[{"version":"Latest","languages":[{"language":"en","default":true,"dropdowns":[{"dropdown":"Use Xagent","icon":"sparkles","pages":[{"group":" ","pages":[{"group":"Overview","expanded":true,"pages":[{"title":"What is Xagent","mode":"wide","icon":"rocket","href":""},{"title":"Quick Start","icon":"zap","href":"/quickstart"},{"title":"Installation","icon":"download","href":"/installation"}]},{"group":"Tasks","expanded":false,"pages":[{"title":"Tasks Overview","icon":"play","href":"/tasks/overview"},{"title":"Task Execution","icon":"play-circle","href":"/tasks/execution"}]},{"group":"Agents","expanded":false,"pages":[{"title":"Agents Overview","icon":"robot","href":"/agents/overview"},{"title":"Building Agents","icon":"wrench","href":"/agents/building"},{"title":"Sharing Agents","icon":"share","href":"/agents/sharing"},{"title":"Embedding Agents as Widgets","icon":"layout-panel-top","href":"/agents/widget-embed"}]},{"group":"Workforces","expanded":false,"pages":[{"title":"Workforces Overview","icon":"users","href":"/workforces/overview"},{"title":"Building Workforces","icon":"workflow","href":"/workforces/building"}]},{"group":"Templates","expanded":false,"pages":[{"title":"Templates","icon":"copy","href":"/templates/overview"},{"title":"Creating Templates","icon":"plus","href":"/templates/creating"}]},{"group":"Knowledge Base","expanded":false,"pages":[{"title":"Knowledge Base Overview","icon":"database","href":"/knowledge/overview"},{"title":"Uploading Knowledge","icon":"upload","href":"/knowledge/uploading"},{"title":"Knowledge Retrieval","icon":"search","href":"/knowledge/retrieval"}]},{"group":"Models","expanded":false,"pages":[{"title":"Models Overview","icon":"box","href":"/models/overview"},{"title":"LLM Models","icon":"brain","href":"/models/llm"},{"title":"Embedding Models","icon":"database","href":"/models/embedding"},{"title":"Image Generation Models","icon":"image","href":"/models/image-generation"}]},{"group":"Tools","expanded":false,"pages":[{"title":"Tools Overview","icon":"wrench","href":"/tools/overview"},{"title":"Built-in Tools","icon":"box","href":"/tools/built-in"},{"title":"Custom Tools via MCP","icon":"code","href":"/tools/custom"}]},{"group":"Memory","expanded":false,"pages":[{"title":"Memory Overview","icon":"brain","href":"/memory/overview"},{"title":"Memory Types","icon":"database","href":"/memory/types"},{"title":"Memory Configuration","icon":"sliders","href":"/memory/configuration"}]},{"group":"Files","expanded":false,"pages":[{"title":"Files Overview","icon":"file","href":"/files/overview"},{"title":"File Upload","icon":"upload","href":"/files/upload"},{"title":"File Management","icon":"folder","href":"/files/management"}]},{"title":"Release Notes","href":"/release-notes"}]}]},{"dropdown":"Release Notes","icon":"clock-rotate-left","pages":[{"title":"Release Notes","href":"/release-notes"}]},{"dropdown":"Platform","icon":"server","pages":[{"title":"MCP Providers Configuration","href":"/tools/mcp-providers"},{"title":"SDK \u0026 API Keys","icon":"key-round","href":"/guides/sdk"},{"group":"Channels","expanded":false,"pages":[{"title":"Channels Overview","icon":"message-square","href":"/channels/overview"},{"title":"Telegram","icon":"send","href":"/channels/telegram"}]},{"group":"Deployment","expanded":false,"pages":[{"title":"Configuration","href":"/deployment/configuration"},{"title":"Self-Hosted Deployment","href":"/deployment/self-hosted"}]}]},{"dropdown":"API Reference","icon":"code","pages":[{"title":"API Reference","href":"/api-reference/introduction"},{"group":"Authentication","expanded":false,"pages":[{"openapi":"get /api/auth/setup-status","title":"Setup Status","href":"/api-reference/authentication/setup-status"},{"openapi":"post /api/auth/setup-admin","title":"Setup Admin","href":"/api-reference/authentication/setup-admin"},{"openapi":"get /api/auth/register-switch","title":"Get Register Switch","href":"/api-reference/authentication/get-register-switch"},{"openapi":"patch /api/auth/register-switch","title":"Update Register Switch","href":"/api-reference/authentication/update-register-switch"},{"openapi":"post /api/auth/login","title":"Login","href":"/api-reference/authentication/login"},{"openapi":"post /api/auth/register","title":"Register","href":"/api-reference/authentication/register"},{"openapi":"post /api/auth/forgot-password","title":"Forgot Password","href":"/api-reference/authentication/forgot-password"},{"openapi":"post /api/auth/reset-password","title":"Reset Password","href":"/api-reference/authentication/reset-password"},{"openapi":"get /api/auth/me","title":"Get Current User Profile","href":"/api-reference/authentication/get-current-user-profile"},{"openapi":"patch /api/auth/email","title":"Update Current User Email","href":"/api-reference/authentication/update-current-user-email"},{"openapi":"post /api/auth/refresh","title":"Refresh Token","href":"/api-reference/authentication/refresh-token"},{"openapi":"post /api/auth/change-password","title":"Change Password","href":"/api-reference/authentication/change-password"},{"openapi":"get /api/auth/check","title":"Check Auth","href":"/api-reference/authentication/check-auth"},{"openapi":"get /api/auth/verify","title":"Verify Current Token","href":"/api-reference/authentication/verify-current-token"},{"openapi":"get /api/auth/{provider}/login","title":"Oauth Login","href":"/api-reference/authentication/oauth-login"},{"openapi":"get /api/auth/{provider}/callback","title":"Oauth Callback","href":"/api-reference/authentication/oauth-callback"},{"openapi":"get /api/auth/oidc/google/status","title":"Google Oidc Status","href":"/api-reference/authentication/google-oidc-status"},{"openapi":"get /api/auth/oidc/google/login","title":"Google Oidc Login","href":"/api-reference/authentication/google-oidc-login"},{"openapi":"get /api/auth/oidc/google/callback","title":"Google Oidc Callback","href":"/api-reference/authentication/google-oidc-callback"},{"openapi":"post /api/auth/oidc/google/exchange","title":"Google Oidc Exchange","href":"/api-reference/authentication/google-oidc-exchange"}]},{"group":"Agents","expanded":false,"pages":[{"openapi":"post /api/agents/optimize-instructions","title":"Optimize Instructions","href":"/api-reference/agents/optimize-instructions"},{"openapi":"get /api/agents","title":"List Agents","href":"/api-reference/agents/list-agents"},{"openapi":"post /api/agents","title":"Create Agent","href":"/api-reference/agents/create-agent"},{"openapi":"get /api/agents/{agent_id}","title":"Get Agent","href":"/api-reference/agents/get-agent"},{"openapi":"put /api/agents/{agent_id}","title":"Update Agent","href":"/api-reference/agents/update-agent"},{"openapi":"delete /api/agents/{agent_id}","title":"Delete Agent","href":"/api-reference/agents/delete-agent"},{"openapi":"post /api/agents/{agent_id}/publish","title":"Publish Agent","href":"/api-reference/agents/publish-agent"},{"openapi":"post /api/agents/{agent_id}/unpublish","title":"Unpublish Agent","href":"/api-reference/agents/unpublish-agent"},{"openapi":"get /api/agents/{agent_id}/share-link","title":"Get Agent Share Link","href":"/api-reference/agents/get-agent-share-link"},{"openapi":"post /api/agents/{agent_id}/share-link","title":"Enable Agent Share Link","href":"/api-reference/agents/enable-agent-share-link"},{"openapi":"delete /api/agents/{agent_id}/share-link","title":"Disable Agent Share Link","href":"/api-reference/agents/disable-agent-share-link"},{"openapi":"post /api/agents/{agent_id}/share-link/rotate","title":"Rotate Agent Share Link","href":"/api-reference/agents/rotate-agent-share-link"},{"openapi":"post /api/agents/preview","title":"Preview Agent","href":"/api-reference/agents/preview-agent"},{"openapi":"post /api/agents/{agent_id}/logo","title":"Upload Agent Logo","href":"/api-reference/agents/upload-agent-logo"},{"openapi":"get /api/agents/{agent_id}/api-key","title":"Get Agent Api Key","href":"/api-reference/agents/get-agent-api-key"},{"openapi":"post /api/agents/{agent_id}/api-key","title":"Generate Agent Api Key","href":"/api-reference/agents/generate-agent-api-key"},{"openapi":"delete /api/agents/{agent_id}/api-key","title":"Revoke Agent Api Key","href":"/api-reference/agents/revoke-agent-api-key"}]},{"group":"SDK v1","expanded":false,"pages":[{"openapi":"get /v1/me","title":"Get Me","href":"/api-reference/sdk-v1/get-me"},{"openapi":"get /v1/templates","title":"List Templates","href":"/api-reference/sdk-v1/list-templates"},{"openapi":"get /v1/templates/{template_id}","title":"Get Template","href":"/api-reference/sdk-v1/get-template"},{"openapi":"get /v1/agents","title":"List Agents","href":"/api-reference/sdk-v1/list-agents"},{"openapi":"post /v1/agents","title":"Create Agent","href":"/api-reference/sdk-v1/create-agent"},{"openapi":"post /v1/agents/from-template","title":"Create Agent From Template","href":"/api-reference/sdk-v1/create-agent-from-template"},{"openapi":"post /v1/agents/{agent_id}/api-key","title":"Rotate Agent Runtime Key","href":"/api-reference/sdk-v1/rotate-agent-runtime-key"},{"openapi":"post /v1/chat/tasks","title":"Create Chat Task","href":"/api-reference/sdk-v1/create-chat-task"},{"openapi":"post /v1/chat/tasks/{task_id}/messages","title":"Append Message To Task","href":"/api-reference/sdk-v1/append-message-to-task"},{"openapi":"get /v1/chat/tasks/{task_id}","title":"Get Chat Task","href":"/api-reference/sdk-v1/get-chat-task"},{"openapi":"get /v1/chat/tasks/{task_id}/steps","title":"Get Chat Task Steps","href":"/api-reference/sdk-v1/get-chat-task-steps"}]},{"group":"Web App Tasks","expanded":false,"pages":[{"openapi":"post /api/chat/task/create","title":"Create Task","href":"/api-reference/chat/create-task"},{"openapi":"get /api/chat/tasks","title":"Get Tasks","href":"/api-reference/chat/get-tasks"},{"openapi":"get /api/chat/task/{task_id}","title":"Get Task","href":"/api-reference/chat/get-task"},{"openapi":"put /api/chat/task/{task_id}","title":"Update Task","href":"/api-reference/chat/update-task"},{"openapi":"delete /api/chat/task/{task_id}","title":"Delete Task","href":"/api-reference/chat/delete-task"},{"openapi":"get /api/chat/task/{task_id}/status","title":"Get Task Status","href":"/api-reference/chat/get-task-status"},{"openapi":"get /api/chat/workspace/{task_id}/output","title":"Get Task Output Files","href":"/api-reference/chat/get-task-output-files"},{"openapi":"get /api/chat/workspace/{task_id}/files","title":"Get Task Workspace Files","href":"/api-reference/chat/get-task-workspace-files"}]},{"group":"Files","expanded":false,"pages":[{"openapi":"post /api/files/upload","title":"Upload File","href":"/api-reference/files/upload-file"},{"openapi":"get /api/files/list","title":"List Files","href":"/api-reference/files/list-files"},{"openapi":"get /api/files/tasks","title":"List File Tasks","href":"/api-reference/files/list-file-tasks"},{"openapi":"get /api/files/task/{task_id}","title":"List Task Files","href":"/api-reference/files/list-task-files"},{"openapi":"get /api/files/download/{file_id}","title":"Download File","href":"/api-reference/files/download-file"},{"openapi":"get /api/files/preview/{file_id}","title":"Preview File","href":"/api-reference/files/preview-file"},{"openapi":"get /api/files/preview-pdf/{file_id}","title":"Preview Pptx As Pdf","href":"/api-reference/files/preview-pptx-as-pdf"},{"openapi":"get /api/files/public/download/{file_id}","title":"Public Download File","href":"/api-reference/files/public-download-file"},{"openapi":"get /api/files/public/preview/{file_id}","title":"Public Preview File","href":"/api-reference/files/public-preview-file"},{"openapi":"delete /api/files/{file_id}","title":"Delete File","href":"/api-reference/files/delete-file"}]},{"group":"Knowledge Base","expanded":false,"pages":[{"openapi":"post /api/kb/ingest","title":"Ingest","href":"/api-reference/kb/ingest"},{"openapi":"post /api/kb/ingest/jobs","title":"Create Ingest Job","href":"/api-reference/kb/create-ingest-job"},{"openapi":"post /api/kb/ingest-cloud","title":"Ingest Cloud","description":"Ingest files from cloud storage.","href":"/api-reference/kb/ingest-cloud"},{"openapi":"post /api/kb/search","title":"Search","href":"/api-reference/kb/search"},{"openapi":"post /api/kb/ingest-web","title":"Ingest Web","description":"Ingest website content into the knowledge base.\n\nArgs:\n collection: Target collection name\n start_url: Starting URL for crawling\n max_pages: Maximum number of pages to crawl\n max_depth: Maximum crawl depth\n url_patterns: Comma-separated URL match patterns (regex)\n exclude_patterns: Comma-separated exclusion patterns (regex)\n same_domain_only: Only crawl same domain\n content_selector: CSS selector for main content area\n remove_selectors: Comma-separated CSS selectors to remove\n concurrent_requests: Number of concurrent requests\n request_delay: Delay between requests in seconds\n timeout: Request timeout in seconds\n respect_robots_txt: Respect robots.txt rules\n parse_method: Parser for document ingestion\n chunk_strategy: Chunking strategy\n chunk_size: Chunk size in characters\n chunk_overlap: Chunk overlap in characters\n embedding_model_id: Embedding model ID\n embedding_batch_size: Batch size for embedding\n max_retries: Maximum retry attempts\n retry_delay: Delay between retries","href":"/api-reference/kb/ingest-web"},{"openapi":"post /api/kb/ingest-web/jobs","title":"Create Ingest Web Job","href":"/api-reference/kb/create-ingest-web-job"},{"openapi":"post /api/kb/collections/{collection}/config","title":"Save Collection Config","href":"/api-reference/kb/save-collection-config"},{"openapi":"patch /api/kb/collections/{collection}/rerank-model","title":"Set Collection Rerank Model","href":"/api-reference/kb/set-collection-rerank-model"},{"openapi":"get /api/kb/collections","title":"List Collections Api","href":"/api-reference/kb/list-collections-api"},{"openapi":"post /api/kb/collections/batch-delete","title":"Batch Delete Collections Api","href":"/api-reference/kb/batch-delete-collections-api"},{"openapi":"post /api/kb/collections/{collection_name}/documents/check","title":"Check Documents Exist Api","href":"/api-reference/kb/check-documents-exist-api"},{"openapi":"put /api/kb/collections/{collection_name}","title":"Rename Collection Api","href":"/api-reference/kb/rename-collection-api"},{"openapi":"delete /api/kb/collections/{collection_name}","title":"Delete Collection Api","href":"/api-reference/kb/delete-collection-api"},{"openapi":"delete /api/kb/collections/{collection_name}/documents/{filename}","title":"Delete Document Api","href":"/api-reference/kb/delete-document-api"},{"openapi":"get /api/kb/collections/{collection_name}/parses/{doc_id}/parse_result","title":"Get Parse Result Api","href":"/api-reference/kb/get-parse-result-api"}]},{"group":"Memory","expanded":false,"pages":[{"openapi":"get /api/memory/{memory_id}","title":"Get Memory","href":"/api-reference/memory/get-memory"},{"openapi":"get /api/memory/list","title":"List Memories","href":"/api-reference/memory/list-memories"},{"openapi":"post /api/memory","title":"Create Memory","href":"/api-reference/memory/create-memory"},{"openapi":"put /api/memory/{memory_id}","title":"Update Memory","href":"/api-reference/memory/update-memory"},{"openapi":"delete /api/memory/{memory_id}","title":"Delete Memory","href":"/api-reference/memory/delete-memory"},{"openapi":"get /api/memory/stats","title":"Get Memory Stats","href":"/api-reference/memory/get-memory-stats"},{"openapi":"get /api/memory/store-info","title":"Get Store Info","href":"/api-reference/memory/get-store-info"}]},{"group":"Models","expanded":false,"pages":[{"openapi":"post /api/models/register","title":"Create Model","href":"/api-reference/models/create-model"},{"openapi":"get /api/models/","title":"List Models","href":"/api-reference/models/list-models"},{"openapi":"post /api/models/","title":"Create Model","href":"/api-reference/models/create-model-1"},{"openapi":"get /api/models/user-default","title":"Get User Default Models","href":"/api-reference/models/get-user-default-models"},{"openapi":"post /api/models/user-default","title":"Set User Default Model","href":"/api-reference/models/set-user-default-model"},{"openapi":"get /api/models/by-id/{model_id}","title":"Get Model By Path","href":"/api-reference/models/get-model-by-path"},{"openapi":"put /api/models/by-id/{model_id}","title":"Update Model By Path","href":"/api-reference/models/update-model-by-path"},{"openapi":"delete /api/models/by-id/{model_id}","title":"Delete Model By Path","href":"/api-reference/models/delete-model-by-path"},{"openapi":"get /api/models/{model_id}","title":"Get Model","href":"/api-reference/models/get-model"},{"openapi":"put /api/models/{model_id}","title":"Update Model","href":"/api-reference/models/update-model"},{"openapi":"delete /api/models/{model_id}","title":"Delete Model","href":"/api-reference/models/delete-model"},{"openapi":"post /api/models/test-connection","title":"Test Model Connection","href":"/api-reference/models/test-model-connection"},{"openapi":"post /api/models/test","title":"Test Models","href":"/api-reference/models/test-models"},{"openapi":"get /api/models/types/available","title":"Get Available Model Providers","href":"/api-reference/models/get-available-model-providers"},{"openapi":"get /api/models/categories","title":"List Model Categories","href":"/api-reference/models/list-model-categories"},{"openapi":"get /api/models/summary","title":"Get Models Summary","href":"/api-reference/models/get-models-summary"},{"openapi":"get /api/models/default/{model_provider}","title":"Get Default Model","href":"/api-reference/models/get-default-model"},{"openapi":"get /api/models/default/general","title":"Get General Default Model","href":"/api-reference/models/get-general-default-model"},{"openapi":"get /api/models/default/small-fast","title":"Get Small Fast Default Model","href":"/api-reference/models/get-small-fast-default-model"},{"openapi":"get /api/models/default/visual","title":"Get Visual Default Model","href":"/api-reference/models/get-visual-default-model"},{"openapi":"get /api/models/default/compact","title":"Get Compact Default Model","href":"/api-reference/models/get-compact-default-model"},{"openapi":"get /api/models/default/embedding","title":"Get Embedding Default Model","href":"/api-reference/models/get-embedding-default-model"},{"openapi":"get /api/models/providers","title":"List Model Providers","href":"/api-reference/models/list-model-providers"},{"openapi":"get /api/models/abilities","title":"List Model Abilities","href":"/api-reference/models/list-model-abilities"},{"openapi":"get /api/models/user-default/{config_type}","title":"Get User Default Model","href":"/api-reference/models/get-user-default-model"},{"openapi":"delete /api/models/user-default/{config_type}","title":"Delete User Default Model","href":"/api-reference/models/delete-user-default-model"},{"openapi":"get /api/models/public/list","title":"List Public Models","href":"/api-reference/models/list-public-models"},{"openapi":"get /api/models/public/categories","title":"List Public Categories","href":"/api-reference/models/list-public-categories"},{"openapi":"get /api/models/public/providers","title":"List Public Providers","href":"/api-reference/models/list-public-providers"},{"openapi":"get /api/models/public/summary","title":"Get Public Summary","href":"/api-reference/models/get-public-summary"},{"openapi":"get /api/models/providers/supported","title":"List Supported Providers","href":"/api-reference/models/list-supported-providers"},{"openapi":"post /api/models/providers/{provider}/models","title":"Fetch Provider Models","href":"/api-reference/models/fetch-provider-models"},{"openapi":"post /api/models/providers/fetch","title":"Fetch Multiple Providers Models","href":"/api-reference/models/fetch-multiple-providers-models"},{"openapi":"get /api/models/xinference/tts-models","title":"List Xinference Tts Models","href":"/api-reference/models/list-xinference-tts-models"}]},{"group":"Tools","expanded":false,"pages":[{"openapi":"get /api/tools/available","title":"Get Available Tools","href":"/api-reference/tools/get-available-tools"},{"openapi":"get /api/tools/configurable","title":"Get Configurable Tools","href":"/api-reference/tools/get-configurable-tools"},{"openapi":"get /api/tools/sql-connections","title":"Get Sql Connections","href":"/api-reference/tools/get-sql-connections"},{"openapi":"put /api/tools/sql-connections/{name}","title":"Upsert Sql Connection","href":"/api-reference/tools/upsert-sql-connection"},{"openapi":"delete /api/tools/sql-connections/{name}","title":"Remove Sql Connection","href":"/api-reference/tools/remove-sql-connection"},{"openapi":"put /api/tools/{tool_name}/enabled","title":"Update Tool Enabled","href":"/api-reference/tools/update-tool-enabled"},{"openapi":"get /api/tools/{tool_name}/credentials","title":"Get Tool Credentials","href":"/api-reference/tools/get-tool-credentials"},{"openapi":"put /api/tools/{tool_name}/credentials","title":"Update Tool Credentials","href":"/api-reference/tools/update-tool-credentials"},{"openapi":"delete /api/tools/{tool_name}/credentials/{field_name}","title":"Delete Tool Credential","href":"/api-reference/tools/delete-tool-credential"},{"openapi":"get /api/tools/usage","title":"Get Tool Usage","href":"/api-reference/tools/get-tool-usage"}]},{"group":"Cloud storage","expanded":false,"pages":[{"openapi":"get /api/cloud/accounts","title":"List Connected Accounts","href":"/api-reference/cloud-storage/list-connected-accounts"},{"openapi":"delete /api/cloud/accounts/{account_id}","title":"Delete Connected Account","href":"/api-reference/cloud-storage/delete-connected-account"},{"openapi":"get /api/cloud/google-drive/drives","title":"List Google Drives","href":"/api-reference/cloud-storage/list-google-drives"},{"openapi":"get /api/cloud/google-drive/files","title":"List Google Drive Files","href":"/api-reference/cloud-storage/list-google-drive-files"}]},{"group":"Channels","expanded":false,"pages":[{"openapi":"get /api/channels","title":"Get User Channels","href":"/api-reference/channels/get-user-channels"},{"openapi":"post /api/channels","title":"Create User Channel","href":"/api-reference/channels/create-user-channel"},{"openapi":"put /api/channels/{channel_id}","title":"Update User Channel","href":"/api-reference/channels/update-user-channel"},{"openapi":"delete /api/channels/{channel_id}","title":"Delete User Channel","href":"/api-reference/channels/delete-user-channel"}]},{"group":"Personal API keys","expanded":false,"pages":[{"openapi":"get /api/me/personal-keys","title":"List Personal Keys","href":"/api-reference/me/list-personal-keys"},{"openapi":"post /api/me/personal-keys","title":"Create Personal Key","href":"/api-reference/me/create-personal-key"},{"openapi":"delete /api/me/personal-keys/{key_id}","title":"Revoke Personal Key","href":"/api-reference/me/revoke-personal-key"}]},{"group":"Skills","expanded":false,"pages":[{"openapi":"get /api/skills/","title":"List Skills","href":"/api-reference/skills/list-skills"},{"openapi":"get /api/skills/{skill_name}","title":"Get Skill","href":"/api-reference/skills/get-skill"},{"openapi":"post /api/skills/recall","title":"Recall Skill","href":"/api-reference/skills/recall-skill"},{"openapi":"post /api/skills/reload","title":"Reload Skills","href":"/api-reference/skills/reload-skills"}]},{"group":"Templates","expanded":false,"pages":[{"openapi":"get /api/templates/","title":"List Templates","href":"/api-reference/templates/list-templates"},{"openapi":"get /api/templates/{template_id}","title":"Get Template","href":"/api-reference/templates/get-template"},{"openapi":"post /api/templates/{template_id}/use","title":"Use Template","href":"/api-reference/templates/use-template"},{"openapi":"post /api/templates/{template_id}/like","title":"Like Template","href":"/api-reference/templates/like-template"}]},{"group":"MCP","expanded":false,"pages":[{"openapi":"get /api/mcp/apps","title":"List Mcp Apps","href":"/api-reference/mcp-management/list-mcp-apps"},{"openapi":"get /api/mcp/servers","title":"Get Mcp Servers","href":"/api-reference/mcp-management/get-mcp-servers"},{"openapi":"get /api/mcp/servers/{server_id}","title":"Get Mcp Server","href":"/api-reference/mcp-management/get-mcp-server"},{"openapi":"post /api/mcp/servers","title":"Create Mcp Server","href":"/api-reference/mcp-management/create-mcp-server"},{"openapi":"put /api/mcp/servers/{server_id}","title":"Update Mcp Server","href":"/api-reference/mcp-management/update-mcp-server"},{"openapi":"delete /api/mcp/servers/{server_id}","title":"Delete Mcp Server","href":"/api-reference/mcp-management/delete-mcp-server"},{"openapi":"post /api/mcp/servers/{server_id}/toggle","title":"Toggle Mcp Server","href":"/api-reference/mcp-management/toggle-mcp-server"},{"openapi":"post /api/mcp/test-connection","title":"Test Mcp Connection","href":"/api-reference/mcp-management/test-mcp-connection"},{"openapi":"get /api/mcp/servers/{server_id}/tools","title":"Get Mcp Server Tools","href":"/api-reference/mcp-management/get-mcp-server-tools"},{"openapi":"get /api/mcp/servers/{server_id}/logs","title":"Get Mcp Server Logs","href":"/api-reference/mcp-management/get-mcp-server-logs"},{"openapi":"get /api/mcp/transports","title":"Get Supported Transports","href":"/api-reference/mcp-management/get-supported-transports"}]},{"group":"Custom APIs","expanded":false,"pages":[{"openapi":"get /api/custom-apis","title":"List Custom Apis","href":"/api-reference/custom-api-management/list-custom-apis"},{"openapi":"post /api/custom-apis","title":"Create Custom Api","href":"/api-reference/custom-api-management/create-custom-api"},{"openapi":"get /api/custom-apis/{api_id}","title":"Get Custom Api","href":"/api-reference/custom-api-management/get-custom-api"},{"openapi":"put /api/custom-apis/{api_id}","title":"Update Custom Api","href":"/api-reference/custom-api-management/update-custom-api"},{"openapi":"delete /api/custom-apis/{api_id}","title":"Delete Custom Api","href":"/api-reference/custom-api-management/delete-custom-api"}]},{"group":"Share","expanded":false,"pages":[{"openapi":"post /api/share/auth","title":"Authenticate Share Link","href":"/api-reference/share/authenticate-share-link"},{"openapi":"post /api/share/files/upload","title":"Upload Share File","href":"/api-reference/share/upload-share-file"},{"openapi":"post /api/share/chat/task/create","title":"Create Share Task","href":"/api-reference/share/create-share-task"}]},{"group":"Workforces","expanded":false,"pages":[{"openapi":"get /api/workforces","title":"List Workforces","href":"/api-reference/workforces/list-workforces"},{"openapi":"post /api/workforces","title":"Create Workforce","href":"/api-reference/workforces/create-workforce"},{"openapi":"post /api/workforces/from-prompt","title":"Create Workforce From Prompt Endpoint","href":"/api-reference/workforces/create-workforce-from-prompt-endpoint"},{"openapi":"get /api/workforces/agent-options","title":"List Workforce Agent Options","href":"/api-reference/workforces/list-workforce-agent-options"},{"openapi":"get /api/workforces/{workforce_id}","title":"Get Workforce","href":"/api-reference/workforces/get-workforce"},{"openapi":"delete /api/workforces/{workforce_id}","title":"Archive Workforce","href":"/api-reference/workforces/archive-workforce"},{"openapi":"patch /api/workforces/{workforce_id}","title":"Update Workforce","href":"/api-reference/workforces/update-workforce"},{"openapi":"post /api/workforces/{workforce_id}/publish","title":"Publish Workforce","href":"/api-reference/workforces/publish-workforce"},{"openapi":"post /api/workforces/{workforce_id}/unpublish","title":"Unpublish Workforce","href":"/api-reference/workforces/unpublish-workforce"},{"openapi":"post /api/workforces/{workforce_id}/agents","title":"Add Workforce Agent","href":"/api-reference/workforces/add-workforce-agent"},{"openapi":"delete /api/workforces/{workforce_id}/agents/{member_id}","title":"Remove Workforce Agent","href":"/api-reference/workforces/remove-workforce-agent"},{"openapi":"patch /api/workforces/{workforce_id}/agents/{member_id}","title":"Update Workforce Agent","href":"/api-reference/workforces/update-workforce-agent"},{"openapi":"post /api/workforces/{workforce_id}/runs","title":"Create Workforce Run","href":"/api-reference/workforces/create-workforce-run"},{"openapi":"get /api/workforces/{workforce_id}/builder/messages","title":"Get Workforce Builder Messages","href":"/api-reference/workforces/get-workforce-builder-messages"},{"openapi":"post /api/workforces/{workforce_id}/builder/propose","title":"Propose Workforce Changes","href":"/api-reference/workforces/propose-workforce-changes"},{"openapi":"post /api/workforces/{workforce_id}/builder/apply","title":"Apply Workforce Changes","href":"/api-reference/workforces/apply-workforce-changes"},{"openapi":"get /api/workforces/{workforce_id}/canvas","title":"Get Workforce Canvas","href":"/api-reference/workforces/get-workforce-canvas"}]},{"group":"Monitor","expanded":false,"pages":[{"openapi":"get /api/monitor/dashboard-stats","title":"Get Dashboard Stats","href":"/api-reference/monitor/get-dashboard-stats"},{"openapi":"get /api/monitor/stats","title":"Get Monitoring Stats","href":"/api-reference/monitor/get-monitoring-stats"},{"openapi":"get /api/monitor/agents","title":"Get Agents","href":"/api-reference/monitor/get-agents"},{"openapi":"get /api/monitor/tools","title":"Get Tools","href":"/api-reference/monitor/get-tools"},{"openapi":"get /api/monitor/popular-tools","title":"Get Popular Tools","href":"/api-reference/monitor/get-popular-tools"},{"openapi":"get /api/monitor/model-stats","title":"Get Model Stats","href":"/api-reference/monitor/get-model-stats"}]},{"group":"Widget","expanded":false,"pages":[{"openapi":"post /api/widget/auth","title":"Authenticate Widget","href":"/api-reference/widget/authenticate-widget"},{"openapi":"post /api/widget/files/upload","title":"Upload Widget File","href":"/api-reference/widget/upload-widget-file"},{"openapi":"post /api/widget/chat/task/create","title":"Create Widget Task","href":"/api-reference/widget/create-widget-task"}]},{"group":"WebSocket","expanded":false,"pages":[{"title":"WebSocket API","icon":"radio","href":"/api-reference/websocket/websocket"},{"title":"Trace Events Reference","icon":"pulse","href":"/api-reference/websocket/trace-events"}]}]}]}]}]},"basePath":"","title":"Search - Xagent","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}