{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Profound","colors":{"primary":"#505050","light":"#ffffff","dark":"#000000"},"logo":{"light":"https://mintcdn.com/profound-37face47/GFG246038OVoAEi7/logo/profound-light.svg?fit=max\u0026auto=format\u0026n=GFG246038OVoAEi7\u0026q=85\u0026s=37dd421873254e856c630468bff5009f","dark":"https://mintcdn.com/profound-37face47/GFG246038OVoAEi7/logo/profound-dark.svg?fit=max\u0026auto=format\u0026n=GFG246038OVoAEi7\u0026q=85\u0026s=fbb7ed0b03bac21d149032d4ac05b63e","href":"https://www.tryprofound.com"},"favicon":{"light":"https://mintcdn.com/profound-37face47/KURP1oJG5Y6w8LYE/images/favicons/light.svg?fit=max\u0026auto=format\u0026n=KURP1oJG5Y6w8LYE\u0026q=85\u0026s=3352a1e759f49cf8de6791a40538ca90","dark":"https://mintcdn.com/profound-37face47/KURP1oJG5Y6w8LYE/images/favicons/dark.svg?fit=max\u0026auto=format\u0026n=KURP1oJG5Y6w8LYE\u0026q=85\u0026s=83a7d2990c523d7c83f87e49345717ea"},"navbar":{"links":[{"href":"https://www.tryprofound.com/blog","label":"Blog"},{"href":"mailto:support@tryprofound.com","label":"Contact"},{"href":"https://university.tryprofound.com/","label":"University"}]},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Changelog","icon":"clock-rotate-left","href":"https://product.tryprofound.com/changelog"},{"anchor":"Status","icon":"traffic-light","href":"https://status.tryprofound.com"}]},"languages":[{"language":"en","href":""},{"language":"es","href":"es"},{"language":"ja-jp","href":"ja-jp"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"profound-37face47","hasAudioNarration":false,"actualSubdomain":"profound-37face47","customDomains":["docs.tryprofound.com"],"gitSource":{"type":"github","owner":"cooper-square-technologies","repo":"public-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae272558239f0bc1ca242f9","collectionId":"74c1b33a-2820-4a68-964f-f36fb2da69da","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae272558239f0bc1ca242f9"},"feedback":{"thumbs":true,"issues":true,"edits":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae272558239f0bc1ca242f9","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"en","tag":"Platform guides","count":202},{"language":"es","tag":"Guías de la plataforma","count":202},{"language":"ja-jp","tag":"プラットフォームガイド","count":202},{"language":"en","tag":"Analytics","count":73},{"language":"es","tag":"Analítica","count":73},{"language":"ja-jp","tag":"アナリティクス","count":73},{"language":"en","tag":"Developer docs","count":67},{"language":"es","tag":"Documentación para desarrolladores","count":67},{"language":"ja-jp","tag":"開発者向けドキュメント","count":67},{"language":"en","tag":"Platform Configuration","count":66},{"language":"es","tag":"Configuración de la plataforma","count":66},{"language":"ja-jp","tag":"プラットフォーム設定","count":66},{"language":"en","tag":"AI Marketer \u0026 Agents","count":53},{"language":"es","tag":"AI Marketer y Agents","count":53},{"language":"ja-jp","tag":"AI Marketer と Agents","count":53},{"language":"en","tag":"Integrations and Connectors","count":46},{"language":"es","tag":"Integraciones y conectores","count":46},{"language":"ja-jp","tag":"インテグレーションとコネクタ","count":46},{"language":"en","tag":"Integration guides","count":45},{"language":"es","tag":"Guías de integración","count":45},{"language":"ja-jp","tag":"インテグレーションガイド","count":45},{"language":"default","tag":"Developer docs","count":40},{"language":"default","tag":"REST API \u0026 SDKs","count":40},{"language":"default","tag":"API Reference","count":40},{"language":"default","tag":"Endpoints","count":40},{"language":"en","tag":"Agents","count":37},{"language":"es","tag":"Agents","count":37},{"language":"ja-jp","tag":"Agents","count":37},{"language":"en","tag":"Agent Analytics","count":31},{"language":"en","tag":"REST API \u0026 SDKs","count":31},{"language":"es","tag":"Agent Analytics","count":31},{"language":"es","tag":"REST API y SDKs","count":31},{"language":"ja-jp","tag":"Agent Analytics","count":31},{"language":"ja-jp","tag":"REST API と SDK","count":31},{"language":"default","tag":"Categories","count":8},{"language":"default","tag":"Reports","count":8},{"language":"default","tag":"Knowledge Bases","count":7},{"language":"default","tag":"Organization","count":5},{"language":"default","tag":"Agents","count":4},{"language":"default","tag":"Prompts","count":4}],"searchSettings":{"showContentSnippets":false}},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"deflection":{"enabled":true,"type":"email","email":"support@tryprofound.com"}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"[data-nav-tag=BETA]{color:#92400e!important;background-color:#fef3c7!important}.dark [data-nav-tag=BETA]{color:#fde68a!important;background-color:rgba(251,191,36,.15)!important}.role-permissions-table table{table-layout:fixed;width:100%}.role-permissions-table td:first-child,.role-permissions-table th:first-child{width:34%}.role-permissions-table td,.role-permissions-table th{padding-left:.375rem;padding-right:.375rem;overflow-wrap:break-word}[class*=RequestExample],[class*=request-example],aside:has(pre),aside[class*=example]{position:static!important;top:auto!important;align-self:start!important;height:auto!important;max-height:none!important;overflow:visible!important}[class*=RequestExample] *,[class*=request-example] *,aside:has(pre) *{max-height:none!important}[class*=RequestExample] pre,[class*=request-example] pre,aside:has(pre) pre{max-height:none!important;height:auto!important;overflow-y:visible!important;overflow-x:auto!important}.katex-display,.katex-display>.katex,.katex-display>.katex>.katex-html{overflow:visible!important;max-height:none!important;padding:.5rem 0}.ai-disclaimer{font-size:.875rem;color:#6b7280}.dark .ai-disclaimer{color:#9ca3af}#navbar div:has(>#localization-select-trigger){position:absolute;right:0;top:0;height:100%;z-index:40}#navbar div:has(>nav[aria-label=Main]){padding-right:4.5rem}html[lang=en] #localization-select-trigger>span,html[lang=es] #localization-select-trigger>span{font-size:0;line-height:1}html[lang=en] #localization-select-trigger>span::after,html[lang=es] #localization-select-trigger>span::after{font-size:.875rem;line-height:1.25rem}html[lang=en] #localization-select-trigger>span::after{content:\"EN\"}html[lang=es] #localization-select-trigger>span::after{content:\"ES\"}#navigation-items .sidebar-group-header.pf-collapsible{cursor:pointer;user-select:none;padding-right:.75rem}#navigation-items .sidebar-group-header.pf-collapsible .pf-chevron{margin-left:auto;flex-shrink:0;color:#9ca3af;transition:transform .15s ease}#navigation-items .sidebar-group-header.pf-collapsible[aria-expanded=true] .pf-chevron{transform:rotate(90deg)}"}],"page":{"pagePath":"api-reference/knowledge-bases/search-knowledge-base","slug":"/api-reference/knowledge-bases/search-knowledge-base","pageMetadata":{"title":"Search Knowledge Base","description":"Search a knowledge base and return matching snippets or pages.","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/knowledge-bases/{knowledge_base_id}/search","href":"/api-reference/knowledge-bases/search-knowledge-base","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Search a knowledge base and return matching snippets or pages.\"\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":{"title":"Search Knowledge Base","description":"Search a knowledge base and return matching snippets or pages.","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/knowledge-bases/{knowledge_base_id}/search","href":"/api-reference/knowledge-bases/search-knowledge-base","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/profound-37face47/8d265647b0ea078b/sidebar-collapsible-groups.js"],"openApiReferenceData":{"operation":{"tags":["Knowledge bases"],"summary":"Search Knowledge Base","description":"Search a knowledge base and return matching snippets or pages.","operationId":"search_knowledge_base_v1_knowledge_bases__knowledge_base_id__search_post","security":["4b9254f9-6d5d-4ea4-979e-91f01f294bef","94d13ee8-3d49-451c-b307-eba7f37dc828"],"parameters":["8e5e9015-52dc-4c5b-a554-0c55673e2b57","470def74-9827-4ce5-9002-63b6443de832"],"requestBody":"1185c8e4-023c-429c-8c3f-495f6154144e","responses":{"200":"8dc23617-91f7-4ebd-a2c7-9b3a1d87e0a9","422":"fbfda375-9b95-435f-98aa-6e6897b10eb4"},"x-codeSamples":[{"label":"Python","lang":"Python","source":"import os\n\nfrom profound import Profound\n\nclient = Profound(\n api_key=os.environ.get(\"PROFOUND_API_KEY\"),\n)\n\nknowledge_base = client.knowledge_bases.search(\n knowledge_base_id=\"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n query=\"x\",\n top_k=1,\n return_full_page=False,\n)\n\nprint(knowledge_base)"},{"label":"TypeScript","lang":"TypeScript","source":"import Profound from '@profoundai/client';\n\nconst client = new Profound({\n apiKey: process.env['PROFOUND_API_KEY'], // defaults to the PROFOUND_API_KEY env var\n environment: 'production',\n});\n\nconst knowledgeBase = await client.knowledgeBases.search('7c9e6679-7425-40de-944b-e07fc1f90ae7', {\n query: 'x',\n top_k: 1,\n return_full_page: false,\n});\n\nconsole.log(knowledgeBase);"},{"label":"rust","lang":"rust","source":"use profound::*;\n\n#[tokio::main]\nasync fn main() -> Result\u003c(), Box\u003cdyn std::error::Error>> {\n let client = ProfoundClient::builder()\n .api_key(std::env::var(\"PROFOUND_API_KEY\")?)\n .build()?;\n\n let response = client\n .knowledge_bases()\n .search(\n \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n SearchKnowledgeBaseRequest {\n query: \"x\".to_string(),\n top_k: 1,\n return_full_page: None,\n filters: None,\n },\n )\n .send()\n .await?;\n\n println!(\"{:?}\", response);\n\n Ok(())\n}"}],"method":"post","type":"path","servers":["fd2d7f74-a362-4675-8ec6-79dea62910ed"],"path":"/v1/knowledge-bases/{knowledge_base_id}/search","baseUrlOptions":["https://api.tryprofound.com"],"title":"Search Knowledge Base","codeSamples":[{"label":"Python","lang":"Python","source":"import os\n\nfrom profound import Profound\n\nclient = Profound(\n api_key=os.environ.get(\"PROFOUND_API_KEY\"),\n)\n\nknowledge_base = client.knowledge_bases.search(\n knowledge_base_id=\"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n query=\"x\",\n top_k=1,\n return_full_page=False,\n)\n\nprint(knowledge_base)"},{"label":"TypeScript","lang":"TypeScript","source":"import Profound from '@profoundai/client';\n\nconst client = new Profound({\n apiKey: process.env['PROFOUND_API_KEY'], // defaults to the PROFOUND_API_KEY env var\n environment: 'production',\n});\n\nconst knowledgeBase = await client.knowledgeBases.search('7c9e6679-7425-40de-944b-e07fc1f90ae7', {\n query: 'x',\n top_k: 1,\n return_full_page: false,\n});\n\nconsole.log(knowledgeBase);"},{"label":"rust","lang":"rust","source":"use profound::*;\n\n#[tokio::main]\nasync fn main() -> Result\u003c(), Box\u003cdyn std::error::Error>> {\n let client = ProfoundClient::builder()\n .api_key(std::env::var(\"PROFOUND_API_KEY\")?)\n .build()?;\n\n let response = client\n .knowledge_bases()\n .search(\n \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n SearchKnowledgeBaseRequest {\n query: \"x\".to_string(),\n top_k: 1,\n return_full_page: None,\n filters: None,\n },\n )\n .send()\n .await?;\n\n println!(\"{:?}\", response);\n\n Ok(())\n}"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"8e5e9015-52dc-4c5b-a554-0c55673e2b57":{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Unique knowledge base ID.","title":"Knowledge Base Id","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Unique knowledge base ID."},"470def74-9827-4ce5-9002-63b6443de832":{"name":"organization_id","in":"query","required":false,"schema":{"oneOf":[{"type":"string","title":"Organization Id","description":"Organization scope for API keys that can access multiple organizations.","format":"uuid","uniqueKey":"oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","title":"Organization Id","description":"Organization scope for API keys that can access multiple organizations.","uniqueKey":"oneOf.1","typeLabel":"null"}],"isRequired":false,"uniqueKey":"","typeLabel":"string\u003cuuid> | null"},"description":"Organization scope for API keys that can access multiple organizations."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"query":{"type":"string","minLength":1,"title":"Query","description":"Search query.","isRequired":true,"uniqueKey":"query","typeLabel":"string"},"top_k":{"type":"integer","maximum":100,"minimum":1,"title":"Top K","description":"Maximum number of results to return.","isRequired":true,"uniqueKey":"top_k","typeLabel":"integer"},"return_full_page":{"type":"boolean","title":"Return Full Page","description":"Return full page content instead of snippets.","default":false,"uniqueKey":"return_full_page","typeLabel":"boolean"},"filters":{"oneOf":[{"type":"object","title":"SearchKnowledgeBaseFilters","description":"Optional search filters.","properties":{"tags":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"filters.oneOf.0.tags.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Tags","description":"Optional tags to match. Documents with any matching tag are included.","minItems":1,"uniqueKey":"filters.oneOf.0.tags.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Tags","description":"Optional tags to match. Documents with any matching tag are included.","uniqueKey":"filters.oneOf.0.tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"filters.oneOf.0.tags","typeLabel":"string[] | null"},"folders":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"filters.oneOf.0.folders.oneOf.0.items.[INDEX]","typeLabel":"string"},"title":"Folders","description":"Optional folder paths to search within. Currently limited to one folder.","maxItems":1,"minItems":1,"uniqueKey":"filters.oneOf.0.folders.oneOf.0","typeLabel":"string[]"},{"type":"null","title":"Folders","description":"Optional folder paths to search within. Currently limited to one folder.","uniqueKey":"filters.oneOf.0.folders.oneOf.1","typeLabel":"null"}],"uniqueKey":"filters.oneOf.0.folders","typeLabel":"string[] | null"}},"additionalProperties":false,"uniqueKey":"filters.oneOf.0","typeLabel":"SearchKnowledgeBaseFilters · object"},{"type":"null","description":"Optional search filters.","uniqueKey":"filters.oneOf.1","typeLabel":"null"}],"uniqueKey":"filters","typeLabel":"SearchKnowledgeBaseFilters · object | null"}},"additionalProperties":false,"type":"object","required":["query","top_k"],"title":"SearchKnowledgeBaseRequest","uniqueKey":"","typeLabel":"SearchKnowledgeBaseRequest · object"},"examples":{"Example":{"title":"Example","value":{"query":"\u003cstring>","top_k":50,"return_full_page":false,"filters":{"tags":["\u003cstring>"],"folders":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8dc23617-91f7-4ebd-a2c7-9b3a1d87e0a9":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"data":{"items":{"properties":{"id":{"type":"string","title":"Id","description":"Document or chunk path.","isRequired":true,"uniqueKey":"data.items.[INDEX].id","typeLabel":"string"},"score":{"type":"number","title":"Score","description":"Relevance score.","isRequired":true,"uniqueKey":"data.items.[INDEX].score","typeLabel":"number"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata","description":"Result metadata, including folder path.","isRequired":true,"uniqueKey":"data.items.[INDEX].metadata","typeLabel":"Metadata · object"},"content":{"type":"string","title":"Content","description":"Matched content.","isRequired":true,"uniqueKey":"data.items.[INDEX].content","typeLabel":"string"}},"additionalProperties":false,"type":"object","required":["id","score","metadata","content"],"title":"KnowledgeBaseSearchResult","uniqueKey":"data.items.[INDEX]","typeLabel":"KnowledgeBaseSearchResult · object"},"type":"array","title":"Data","description":"Knowledge base search results.","isRequired":true,"uniqueKey":"data","typeLabel":"KnowledgeBaseSearchResult · object[]"},"pagination":{"properties":{"limit":{"type":"integer","maximum":50000,"exclusiveMinimum":0,"title":"Limit","description":"Maximum number of results to return. Default is 10,000, maximum is 50,000.","default":10000,"uniqueKey":"pagination.limit","typeLabel":"integer"},"next_cursor":{"oneOf":[{"type":"string","title":"Next Cursor","description":"Token for the next page, if more results are available.","uniqueKey":"pagination.next_cursor.oneOf.0","typeLabel":"string"},{"type":"null","title":"Next Cursor","description":"Token for the next page, if more results are available.","uniqueKey":"pagination.next_cursor.oneOf.1","typeLabel":"null"}],"uniqueKey":"pagination.next_cursor","typeLabel":"string | null"}},"additionalProperties":false,"type":"object","title":"CursorPagination","description":"Pagination metadata.","uniqueKey":"pagination","typeLabel":"CursorPagination · object"}},"additionalProperties":false,"type":"object","required":["data"],"title":"KnowledgeBaseSearchResponse","uniqueKey":"","typeLabel":"KnowledgeBaseSearchResponse · object"},"examples":{"Example":{"title":"Example","value":{"data":[{"id":"\u003cstring>","score":123,"metadata":{},"content":"\u003cstring>"}],"pagination":{"limit":10000,"next_cursor":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"fbfda375-9b95-435f-98aa-6e6897b10eb4":{"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"},"input":{"oneOf":[{"title":"Input"}],"uniqueKey":"detail.items.[INDEX].input","typeLabel":"any"},"ctx":{"type":"object","title":"Context","uniqueKey":"detail.items.[INDEX].ctx","typeLabel":"Context · object"}},"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>","input":"\u003cunknown>","ctx":{}}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"4b9254f9-6d5d-4ea4-979e-91f01f294bef":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[]}},"94d13ee8-3d49-451c-b307-eba7f37dc828":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[]}}},"servers":{"fd2d7f74-a362-4675-8ec6-79dea62910ed":{"url":"https://api.tryprofound.com","description":"Production Server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","scopes":[]},"schema":{"title":"X-API-Key","type":"string","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"APIKeyHeader","name":"X-API-Key"}],"title":"APIKeyHeader"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[]},"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":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed"},"subdomain":"profound-37face47","siteName":"Profound","title":"Search Knowledge Base - Profound","contextualStarterQuestions":[{"_id":"6ac540f2eb11365506ef431c","deploymentId":"6753b750487e67e4ea1247ee","questionText":"How do I search a knowledge base?","status":"active","generatedBy":"contextual","path":"api-reference/knowledge-bases/search-knowledge-base","createdAt":"2026-10-06T18:41:54.122Z","updatedAt":"2026-10-06T18:41:54.122Z","__v":0},{"_id":"6ac540f2eb11365506ef431d","deploymentId":"6753b750487e67e4ea1247ee","questionText":"What results can I get from search?","status":"active","generatedBy":"contextual","path":"api-reference/knowledge-bases/search-knowledge-base","createdAt":"2026-10-06T18:41:54.122Z","updatedAt":"2026-10-06T18:41:54.122Z","__v":0},{"_id":"6ac540f2eb11365506ef431e","deploymentId":"6753b750487e67e4ea1247ee","questionText":"How do I filter search results?","status":"active","generatedBy":"contextual","path":"api-reference/knowledge-bases/search-knowledge-base","createdAt":"2026-10-06T18:41:54.122Z","updatedAt":"2026-10-06T18:41:54.122Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-29T02:41:59.843Z","originalFileLocation":"api-reference/knowledge-bases/search-knowledge-base.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 a knowledge base and return matching snippets or pages.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Profound\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/profound-37face47/Q1dMJpKvzw6s9pGb/_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/profound-37face47/Q1dMJpKvzw6s9pGb/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/profound-37face47/Q1dMJpKvzw6s9pGb/_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/profound-37face47/Q1dMJpKvzw6s9pGb/_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/profound-37face47/Q1dMJpKvzw6s9pGb/_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/profound-37face47/Q1dMJpKvzw6s9pGb/_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/profound-37face47/Q1dMJpKvzw6s9pGb/_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/profound-37face47/Q1dMJpKvzw6s9pGb/_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/profound-37face47/Q1dMJpKvzw6s9pGb/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Search Knowledge Base - Profound\">\u003cmeta data-mint-head property=\"og:description\" content=\"Search a knowledge base and return matching snippets or pages.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Profound\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tryprofound.com/api-reference/knowledge-bases/search-knowledge-base\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://profound-37face47.mintlify.app/_mintlify/api/og/v2?division=Knowledge+Bases\u0026amp;title=Search+Knowledge+Base\u0026amp;description=Search+a+knowledge+base+and+return+matching+snippets+or+pages.\u0026amp;theme=35989b645bd94dc4d427cadb\u0026amp;signature=c3d6ac1769065c87e723a56364183b7680d7a4fb4ec80b3ee9b12f69a792673f\">\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 Knowledge Base - Profound\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Search a knowledge base and return matching snippets or pages.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://profound-37face47.mintlify.app/_mintlify/api/og/v2?division=Knowledge+Bases\u0026amp;title=Search+Knowledge+Base\u0026amp;description=Search+a+knowledge+base+and+return+matching+snippets+or+pages.\u0026amp;theme=35989b645bd94dc4d427cadb\u0026amp;signature=c3d6ac1769065c87e723a56364183b7680d7a4fb4ec80b3ee9b12f69a792673f\">\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/profound-37face47/Q1dMJpKvzw6s9pGb/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Profound\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#505050\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tryprofound.com/api-reference/knowledge-bases/search-knowledge-base\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/knowledge-bases/search-knowledge-base.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tryprofound.com/#organization\",\"name\":\"Profound\",\"url\":\"https://docs.tryprofound.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/profound-37face47/GFG246038OVoAEi7/logo/profound-light.svg?fit=max\u0026auto=format\u0026n=GFG246038OVoAEi7\u0026q=85\u0026s=37dd421873254e856c630468bff5009f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tryprofound.com#website\",\"name\":\"Profound\",\"url\":\"https://docs.tryprofound.com\",\"publisher\":{\"@id\":\"https://docs.tryprofound.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tryprofound.com/api-reference/knowledge-bases/search-knowledge-base#webpage\",\"url\":\"https://docs.tryprofound.com/api-reference/knowledge-bases/search-knowledge-base\",\"name\":\"Search Knowledge Base\",\"description\":\"Search a knowledge base and return matching snippets or pages.\",\"dateModified\":\"2026-09-29T02:41:59.843Z\",\"isPartOf\":{\"@id\":\"https://docs.tryprofound.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tryprofound.com/api-reference/knowledge-bases/search-knowledge-base#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tryprofound.com/api-reference/knowledge-bases/search-knowledge-base#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.tryprofound.com/api-reference/agents/list-agents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Endpoints\",\"item\":\"https://docs.tryprofound.com/api-reference/agents/list-agents\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Knowledge Bases\",\"item\":\"https://docs.tryprofound.com/api-reference/knowledge-bases/list-knowledge-bases\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Search Knowledge Base\",\"item\":\"https://docs.tryprofound.com/api-reference/knowledge-bases/search-knowledge-base\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tryprofound.com/api-reference/knowledge-bases/search-knowledge-base#apireference\",\"headline\":\"Search Knowledge Base\",\"name\":\"Search Knowledge Base\",\"description\":\"Search a knowledge base and return matching snippets or pages.\",\"url\":\"https://docs.tryprofound.com/api-reference/knowledge-bases/search-knowledge-base\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tryprofound.com/api-reference/knowledge-bases/search-knowledge-base#webpage\"},\"dateModified\":\"2026-09-29T02:41:59.843Z\",\"publisher\":{\"@id\":\"https://docs.tryprofound.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tryprofound.com#website\"}}]}\u003c/script>","siteName":"Profound","nav":{"global":{"anchors":[{"anchor":"Changelog","icon":"clock-rotate-left","href":"https://product.tryprofound.com/changelog"},{"anchor":"Status","icon":"traffic-light","href":"https://status.tryprofound.com"}]},"languages":[{"language":"en","products":[{"product":"Platform guides","icon":"layer-group","description":"Profound products, features, and settings","pages":[{"title":"Platform guides","href":""}]},{"product":"Developer docs","icon":"code","description":"REST API, SDKs, and MCP server","tabs":[{"tab":"Home","pages":[{"title":"Home","href":""}]},{"tab":"REST API \u0026 SDKs","groups":[{"group":"Get Started","icon":"rocket","pages":[{"title":"Introduction","href":"/rest-api/introduction"},{"title":"Authentication","href":"/rest-api/authentication"},{"title":"Date ranges and timezones","href":"/rest-api/date-ranges"},{"title":"Response format","href":"/rest-api/response-format"},{"title":"Changelog","href":"/rest-api/changelog"}]},{"group":"API Reference","icon":"code","pages":[{"group":"Endpoints","pages":[{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/agents","href":"/api-reference/agents/list-agents"},{"title":"Get an agent","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/agents/{agent_id}","href":"/api-reference/agents/get-an-agent"},{"title":"Run an agent","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/agents/{agent_id}/runs","href":"/api-reference/agents/run-an-agent"},{"title":"Get an agent run","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/agents/{agent_id}/runs/{run_id}","href":"/api-reference/agents/get-an-agent-run"}]},{"group":"Answers","pages":[{"group":"Answers v2","tag":"Beta","pages":[{"title":"Get answers","openapi":"POST /v2/prompts/answers","href":"/rest-api/reports/query-answers-v2"}]},{"group":"Answers v1","pages":[{"title":"Get Answers","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/prompts/answers","href":"/api-reference/prompts/get-answers"}]}]},{"group":"Categories","pages":[{"title":"Get Categories","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories","href":"/api-reference/organization/get-categories"},{"title":"Get Category Topics","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/topics","href":"/api-reference/organization/get-category-topics"},{"title":"Get Category Tags","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/tags","href":"/api-reference/organization/get-category-tags"},{"title":"Get Category Regions","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/regions","href":"/api-reference/organization/get-category-regions"},{"title":"Get Category Assets","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/assets","href":"/api-reference/organization/get-category-assets"},{"title":"Get Category Personas","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/personas","href":"/api-reference/organization/get-category-personas"},{"title":"Get Category Citation Categories","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/citation-categories","href":"/api-reference/organization/get-category-citation-categories"},{"title":"Get Category Citation Tags","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/citation-tags","href":"/api-reference/organization/get-category-citation-tags"}]},{"group":"Content optimization","pages":[{"title":"Optimization List","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/content/{asset_id}/optimization","href":"/api-reference/content/optimization-list"},{"title":"Optimization Analysis","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/content/{asset_id}/optimization/{content_id}","href":"/api-reference/content/optimization-analysis"}]},{"group":"Knowledge Bases","pages":[{"title":"List Knowledge Bases","description":"List knowledge bases accessible to the API key.","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/knowledge-bases","href":"/api-reference/knowledge-bases/list-knowledge-bases"},{"title":"Search Knowledge Base","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/knowledge-bases/{knowledge_base_id}/search","href":"/api-reference/knowledge-bases/search-knowledge-base"},{"title":"Add Document","description":"Add a document to a knowledge base using JSON text or multipart file upload.","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/knowledge-bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge-bases/add-document"},{"title":"Update Document","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed put /v1/knowledge-bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge-bases/update-document"},{"title":"Delete Document","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed delete /v1/knowledge-bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge-bases/delete-document"},{"title":"Add Folder","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/knowledge-bases/{knowledge_base_id}/folders","href":"/api-reference/knowledge-bases/add-folder"},{"title":"Delete Folder","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed delete /v1/knowledge-bases/{knowledge_base_id}/folders","href":"/api-reference/knowledge-bases/delete-folder"}]},{"group":"OpenAI ads","tag":"Beta","pages":[{"title":"Get Account Insights","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/ads/openai-ads/ad-account/insights","href":"/api-reference/openai-ads/get-account-insights"}]},{"group":"Organization","pages":[{"title":"Get Regions","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/regions","href":"/api-reference/organization/get-regions"},{"title":"Get Models","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/models","href":"/api-reference/organization/get-models"},{"title":"Get Domains","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/domains","href":"/api-reference/organization/get-domains"},{"title":"Get Assets","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/assets","href":"/api-reference/organization/get-assets"},{"title":"Get Personas","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/personas","href":"/api-reference/organization/get-personas"}]},{"group":"Prompts","pages":[{"title":"List prompts","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/prompts","href":"/api-reference/organization/list-prompts"},{"title":"Create prompts","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/org/categories/{category_id}/prompts","href":"/api-reference/organization/create-prompts"},{"title":"Update prompts","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed patch /v1/org/categories/{category_id}/prompts","href":"/api-reference/organization/update-prompts"},{"title":"Update prompt status","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed patch /v1/org/categories/{category_id}/prompts/status","href":"/api-reference/organization/update-prompt-status"}]},{"group":"Prompt Volumes","pages":[{"title":"Keyword Volume","openapi":"POST /v2/prompt-volumes/volume/on-the-fly","href":"/rest-api/prompt-volumes/query-volume-v2"},{"title":"Keyword Intent Shares","openapi":"POST /v2/prompt-volumes/intents/on-the-fly","href":"/rest-api/prompt-volumes/query-intents-v2"}]},{"group":"Reports","pages":[{"group":"Reports v2","tag":"Beta","pages":[{"title":"Filtering \u0026 concepts","href":"/rest-api/reports/reports-v2-overview"},{"title":"Citations","openapi":"POST /v2/reports/citations","tag":"Beta","href":"/rest-api/reports/query-citations-v2"},{"title":"Visibility","openapi":"POST /v2/reports/visibility","tag":"Beta","href":"/rest-api/reports/query-visibility-v2"},{"title":"Sentiment","openapi":"POST /v2/reports/sentiment","tag":"Beta","href":"/rest-api/reports/query-sentiment-v2"},{"title":"Query Fanouts","openapi":"POST /v2/reports/query-fanouts","tag":"Beta","href":"/rest-api/reports/query-fanouts-v2"},{"group":"FactCheck","tag":"Beta","pages":[{"title":"FactCheck","openapi":"POST /v2/reports/factcheck","tag":"Beta","href":"/rest-api/reports/query-factcheck-v2"},{"title":"FactCheck claims","openapi":"POST /v2/reports/factcheck/claims","tag":"Beta","href":"/rest-api/reports/query-factcheck-claims-v2"}]},{"group":"Shopping","tag":"Beta","pages":[{"title":"Brands","openapi":"POST /v2/reports/shopping/brands","tag":"Beta","href":"/rest-api/reports/query-shopping-brands-v2"},{"title":"Products","openapi":"POST /v2/reports/shopping/products","tag":"Beta","href":"/rest-api/reports/query-shopping-products-v2"},{"title":"Merchants","openapi":"POST /v2/reports/shopping/merchants","tag":"Beta","href":"/rest-api/reports/query-shopping-merchants-v2"},{"title":"Trigger rate","openapi":"POST /v2/reports/shopping/trigger-rate","tag":"Beta","href":"/rest-api/reports/query-shopping-trigger-rate-v2"}]},{"group":"YouTube","tag":"Beta","pages":[{"title":"Channels","openapi":"POST /v2/reports/social/youtube/channels","tag":"Beta","href":"/rest-api/reports/query-youtube-channels-v2"},{"title":"Videos","openapi":"POST /v2/reports/social/youtube/videos","tag":"Beta","href":"/rest-api/reports/query-youtube-videos-v2"}]}]},{"group":"Reports v1","pages":[{"title":"Query Citations","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/reports/citations","href":"/api-reference/reports/query-citations"},{"title":"Query Visibility","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/reports/visibility","href":"/api-reference/reports/query-visibility"},{"title":"Query Sentiment","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/reports/sentiment","href":"/api-reference/reports/query-sentiment"},{"title":"Query Fanouts","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/reports/query-fanouts","href":"/api-reference/reports/query-fanouts"}]},{"group":"Bot traffic","pages":[{"title":"Get Bots Report V1","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/reports/bots","href":"/api-reference/reports/get-bots-report-v1"},{"title":"Get Bots Report V2","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v2/reports/bots","href":"/api-reference/reports/get-bots-report-v2"}]},{"group":"Human referrals","pages":[{"title":"Get Referrals Report V1","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/reports/referrals","href":"/api-reference/reports/get-referrals-report-v1"},{"title":"Get Referrals Report V2","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v2/reports/referrals","href":"/api-reference/reports/get-referrals-report-v2"}]}]}]},{"group":"Example requests","root":{"title":"Example requests","href":"/rest-api/examples/example"},"pages":[{"title":"Answer Engine Insights","href":"/rest-api/examples/answer-engine-insights"},{"title":"Agent Analytics","href":"/rest-api/examples/agent-analytics"},{"title":"Workflows","href":"/rest-api/examples/workflows"},{"title":"Knowledge Bases","href":"/rest-api/examples/knowledge-bases"},{"title":"OpenAI ads","tag":"Beta","href":"/rest-api/examples/openai-ads"}]}]},{"group":"Integrations","icon":"plug","pages":[{"group":"Tableau","pages":[{"group":"Usage","root":{"title":"Usage","href":"/rest-api/integrations/tableau/usage"},"pages":[{"title":"WDC 2.0","tag":"Deprecated","href":"/rest-api/integrations/tableau/wdc-2"}]},{"title":"Releases","href":"/rest-api/integrations/tableau/releases"}]}]},{"group":"SDKs","icon":"cube","pages":[{"title":"Get started with SDKs","href":"/sdks/overview"},{"title":"Python SDK","href":"/sdks/python-package"},{"title":"JavaScript SDK","href":"/sdks/javascript-package"}]}]},{"tab":"Profound MCP","pages":[{"title":"Profound MCP","href":"/mcp/overview"}]},{"tab":"Bots","pages":[{"title":"Bots","href":"/bots/introduction"}]},{"tab":"Cookbook","pages":[{"title":"Cookbook","href":"/cookbook/introduction"}]}]}]},{"language":"es","products":[{"product":"Guías de la plataforma","icon":"layer-group","description":"Productos, funciones y configuración de Profound","pages":[{"title":"Guías de la plataforma","href":"/es"}]},{"product":"Documentación para desarrolladores","icon":"code","description":"REST API, SDKs y servidor MCP","tabs":[{"tab":"Inicio","pages":[{"title":"Inicio","href":"/es"}]},{"tab":"REST API y SDKs","groups":[{"group":"Primeros pasos","icon":"rocket","pages":[{"title":"Introducción","href":"/es/rest-api/introduction"},{"title":"Autenticación","href":"/es/rest-api/authentication"},{"title":"Rangos de fechas y zonas horarias","href":"/es/rest-api/date-ranges"},{"title":"Formato de respuesta","href":"/es/rest-api/response-format"},{"title":"Registro de cambios","href":"/es/rest-api/changelog"}]},{"group":"Referencia de la API","icon":"code","pages":[{"group":"Endpoints","pages":[{"group":"Agentes","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/agents","href":"/api-reference/agents/list-agents"},{"title":"Get an agent","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/agents/{agent_id}","href":"/api-reference/agents/get-an-agent"},{"title":"Run an agent","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/agents/{agent_id}/runs","href":"/api-reference/agents/run-an-agent"},{"title":"Get an agent run","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/agents/{agent_id}/runs/{run_id}","href":"/api-reference/agents/get-an-agent-run"}]},{"group":"Respuestas","pages":[{"group":"Respuestas v2","tag":"Beta","pages":[{"title":"Obtener respuestas","openapi":"POST /v2/prompts/answers","href":"/es/rest-api/reports/query-answers-v2"}]},{"group":"Respuestas v1","pages":[{"title":"Get Answers","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/prompts/answers","href":"/api-reference/prompts/get-answers"}]}]},{"group":"Categorías","pages":[{"title":"Get Categories","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories","href":"/api-reference/organization/get-categories"},{"title":"Get Category Topics","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/topics","href":"/api-reference/organization/get-category-topics"},{"title":"Get Category Tags","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/tags","href":"/api-reference/organization/get-category-tags"},{"title":"Get Category Regions","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/regions","href":"/api-reference/organization/get-category-regions"},{"title":"Get Category Assets","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/assets","href":"/api-reference/organization/get-category-assets"},{"title":"Get Category Personas","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/personas","href":"/api-reference/organization/get-category-personas"},{"title":"Get Category Citation Categories","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/citation-categories","href":"/api-reference/organization/get-category-citation-categories"},{"title":"Get Category Citation Tags","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/citation-tags","href":"/api-reference/organization/get-category-citation-tags"}]},{"group":"Optimización de contenido","pages":[{"title":"Optimization List","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/content/{asset_id}/optimization","href":"/api-reference/content/optimization-list"},{"title":"Optimization Analysis","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/content/{asset_id}/optimization/{content_id}","href":"/api-reference/content/optimization-analysis"}]},{"group":"Bases de conocimiento","pages":[{"title":"List Knowledge Bases","description":"List knowledge bases accessible to the API key.","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/knowledge-bases","href":"/api-reference/knowledge-bases/list-knowledge-bases"},{"title":"Search Knowledge Base","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/knowledge-bases/{knowledge_base_id}/search","href":"/api-reference/knowledge-bases/search-knowledge-base"},{"title":"Add Document","description":"Add a document to a knowledge base using JSON text or multipart file upload.","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/knowledge-bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge-bases/add-document"},{"title":"Update Document","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed put /v1/knowledge-bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge-bases/update-document"},{"title":"Delete Document","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed delete /v1/knowledge-bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge-bases/delete-document"},{"title":"Add Folder","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/knowledge-bases/{knowledge_base_id}/folders","href":"/api-reference/knowledge-bases/add-folder"},{"title":"Delete Folder","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed delete /v1/knowledge-bases/{knowledge_base_id}/folders","href":"/api-reference/knowledge-bases/delete-folder"}]},{"group":"Anuncios de OpenAI","tag":"Beta","pages":[{"title":"Get Account Insights","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/ads/openai-ads/ad-account/insights","href":"/api-reference/openai-ads/get-account-insights"}]},{"group":"Organización","pages":[{"title":"Get Regions","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/regions","href":"/api-reference/organization/get-regions"},{"title":"Get Models","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/models","href":"/api-reference/organization/get-models"},{"title":"Get Domains","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/domains","href":"/api-reference/organization/get-domains"},{"title":"Get Assets","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/assets","href":"/api-reference/organization/get-assets"},{"title":"Get Personas","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/personas","href":"/api-reference/organization/get-personas"}]},{"group":"Prompts","pages":[{"title":"List prompts","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/prompts","href":"/api-reference/organization/list-prompts"},{"title":"Create prompts","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/org/categories/{category_id}/prompts","href":"/api-reference/organization/create-prompts"},{"title":"Update prompts","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed patch /v1/org/categories/{category_id}/prompts","href":"/api-reference/organization/update-prompts"},{"title":"Update prompt status","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed patch /v1/org/categories/{category_id}/prompts/status","href":"/api-reference/organization/update-prompt-status"}]},{"group":"Volúmenes de prompts","pages":[{"title":"Volumen de palabras clave","openapi":"POST /v2/prompt-volumes/volume/on-the-fly","href":"/es/rest-api/prompt-volumes/query-volume-v2"},{"title":"Distribución de intenciones por palabra clave","openapi":"POST /v2/prompt-volumes/intents/on-the-fly","href":"/es/rest-api/prompt-volumes/query-intents-v2"}]},{"group":"Informes","pages":[{"group":"Informes v2","tag":"Beta","pages":[{"title":"Filtrado y conceptos","href":"/es/rest-api/reports/reports-v2-overview"},{"title":"Citas","openapi":"POST /v2/reports/citations","tag":"Beta","href":"/es/rest-api/reports/query-citations-v2"},{"title":"Visibilidad","openapi":"POST /v2/reports/visibility","tag":"Beta","href":"/es/rest-api/reports/query-visibility-v2"},{"title":"Sentimiento","openapi":"POST /v2/reports/sentiment","tag":"Beta","href":"/es/rest-api/reports/query-sentiment-v2"},{"title":"Consultas fanout","openapi":"POST /v2/reports/query-fanouts","tag":"Beta","href":"/es/rest-api/reports/query-fanouts-v2"},{"group":"FactCheck","tag":"Beta","pages":[{"title":"FactCheck","openapi":"POST /v2/reports/factcheck","tag":"Beta","href":"/es/rest-api/reports/query-factcheck-v2"},{"title":"Afirmaciones de FactCheck","openapi":"POST /v2/reports/factcheck/claims","tag":"Beta","href":"/es/rest-api/reports/query-factcheck-claims-v2"}]},{"group":"Compras","tag":"Beta","pages":[{"title":"Marcas","openapi":"POST /v2/reports/shopping/brands","tag":"Beta","href":"/es/rest-api/reports/query-shopping-brands-v2"},{"title":"Productos","openapi":"POST /v2/reports/shopping/products","tag":"Beta","href":"/es/rest-api/reports/query-shopping-products-v2"},{"title":"Comerciantes","openapi":"POST /v2/reports/shopping/merchants","tag":"Beta","href":"/es/rest-api/reports/query-shopping-merchants-v2"},{"title":"Tasa de activación","openapi":"POST /v2/reports/shopping/trigger-rate","tag":"Beta","href":"/es/rest-api/reports/query-shopping-trigger-rate-v2"}]},{"group":"YouTube","tag":"Beta","pages":[{"title":"Canales","openapi":"POST /v2/reports/social/youtube/channels","tag":"Beta","href":"/es/rest-api/reports/query-youtube-channels-v2"},{"title":"Videos","openapi":"POST /v2/reports/social/youtube/videos","tag":"Beta","href":"/es/rest-api/reports/query-youtube-videos-v2"}]}]},{"group":"Informes v1","pages":[{"title":"Query Citations","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/reports/citations","href":"/api-reference/reports/query-citations"},{"title":"Query Visibility","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/reports/visibility","href":"/api-reference/reports/query-visibility"},{"title":"Query Sentiment","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/reports/sentiment","href":"/api-reference/reports/query-sentiment"},{"title":"Query Fanouts","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/reports/query-fanouts","href":"/api-reference/reports/query-fanouts"}]},{"group":"Tráfico de bots","pages":[{"title":"Get Bots Report V1","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/reports/bots","href":"/api-reference/reports/get-bots-report-v1"},{"title":"Get Bots Report V2","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v2/reports/bots","href":"/api-reference/reports/get-bots-report-v2"}]},{"group":"Referencias humanas","pages":[{"title":"Get Referrals Report V1","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/reports/referrals","href":"/api-reference/reports/get-referrals-report-v1"},{"title":"Get Referrals Report V2","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v2/reports/referrals","href":"/api-reference/reports/get-referrals-report-v2"}]}]}]},{"group":"Solicitudes de ejemplo","root":{"title":"Solicitudes de ejemplo","href":"/es/rest-api/examples/example"},"pages":[{"title":"Answer Engine Insights","href":"/es/rest-api/examples/answer-engine-insights"},{"title":"Agent Analytics","href":"/es/rest-api/examples/agent-analytics"},{"title":"Workflows","href":"/es/rest-api/examples/workflows"},{"title":"Knowledge Bases","href":"/es/rest-api/examples/knowledge-bases"},{"title":"Anuncios de OpenAI","tag":"Beta","href":"/es/rest-api/examples/openai-ads"}]}]},{"group":"Integraciones","icon":"plug","pages":[{"group":"Tableau","pages":[{"group":"Uso","root":{"title":"Uso","href":"/es/rest-api/integrations/tableau/usage"},"pages":[{"title":"WDC 2.0","tag":"Deprecated","href":"/es/rest-api/integrations/tableau/wdc-2"}]},{"title":"Versiones","href":"/es/rest-api/integrations/tableau/releases"}]}]},{"group":"SDKs","icon":"cube","pages":[{"title":"Primeros pasos con los SDKs","href":"/es/sdks/overview"},{"title":"SDK de Python","href":"/es/sdks/python-package"},{"title":"SDK de JavaScript","href":"/es/sdks/javascript-package"}]}]},{"tab":"Profound MCP","pages":[{"title":"Profound MCP","href":"/es/mcp/overview"}]},{"tab":"Bots","pages":[{"title":"Bots","href":"/es/bots/introduction"}]},{"tab":"Recetario","pages":[{"title":"Recetario","href":"/es/cookbook/introduction"}]}]}]},{"language":"ja-jp","products":[{"product":"プラットフォームガイド","icon":"layer-group","description":"Profound の製品、機能、設定","pages":[{"title":"プラットフォームガイド","href":"/ja-jp"}]},{"product":"開発者向けドキュメント","icon":"code","description":"REST API、SDK、MCP サーバー","tabs":[{"tab":"ホーム","pages":[{"title":"ホーム","href":"/ja-jp"}]},{"tab":"REST API と SDK","groups":[{"group":"はじめに","icon":"rocket","pages":[{"title":"はじめに","href":"/ja-jp/rest-api/introduction"},{"title":"認証","href":"/ja-jp/rest-api/authentication"},{"title":"日付範囲とタイムゾーン","href":"/ja-jp/rest-api/date-ranges"},{"title":"レスポンス形式","href":"/ja-jp/rest-api/response-format"},{"title":"Changelog","href":"/ja-jp/rest-api/changelog"}]},{"group":"API リファレンス","icon":"code","pages":[{"group":"エンドポイント","pages":[{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/agents","href":"/api-reference/agents/list-agents"},{"title":"Get an agent","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/agents/{agent_id}","href":"/api-reference/agents/get-an-agent"},{"title":"Run an agent","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/agents/{agent_id}/runs","href":"/api-reference/agents/run-an-agent"},{"title":"Get an agent run","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/agents/{agent_id}/runs/{run_id}","href":"/api-reference/agents/get-an-agent-run"}]},{"group":"回答","pages":[{"group":"回答 v2","tag":"Beta","pages":[{"title":"回答を取得","openapi":"POST /v2/prompts/answers","href":"/ja-jp/rest-api/reports/query-answers-v2"}]},{"group":"回答 v1","pages":[{"title":"Get Answers","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/prompts/answers","href":"/api-reference/prompts/get-answers"}]}]},{"group":"カテゴリ","pages":[{"title":"Get Categories","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories","href":"/api-reference/organization/get-categories"},{"title":"Get Category Topics","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/topics","href":"/api-reference/organization/get-category-topics"},{"title":"Get Category Tags","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/tags","href":"/api-reference/organization/get-category-tags"},{"title":"Get Category Regions","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/regions","href":"/api-reference/organization/get-category-regions"},{"title":"Get Category Assets","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/assets","href":"/api-reference/organization/get-category-assets"},{"title":"Get Category Personas","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/personas","href":"/api-reference/organization/get-category-personas"},{"title":"Get Category Citation Categories","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/citation-categories","href":"/api-reference/organization/get-category-citation-categories"},{"title":"Get Category Citation Tags","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/citation-tags","href":"/api-reference/organization/get-category-citation-tags"}]},{"group":"コンテンツ最適化","pages":[{"title":"Optimization List","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/content/{asset_id}/optimization","href":"/api-reference/content/optimization-list"},{"title":"Optimization Analysis","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/content/{asset_id}/optimization/{content_id}","href":"/api-reference/content/optimization-analysis"}]},{"group":"Knowledge Bases","pages":[{"title":"List Knowledge Bases","description":"List knowledge bases accessible to the API key.","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/knowledge-bases","href":"/api-reference/knowledge-bases/list-knowledge-bases"},{"title":"Search Knowledge Base","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/knowledge-bases/{knowledge_base_id}/search","href":"/api-reference/knowledge-bases/search-knowledge-base"},{"title":"Add Document","description":"Add a document to a knowledge base using JSON text or multipart file upload.","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/knowledge-bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge-bases/add-document"},{"title":"Update Document","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed put /v1/knowledge-bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge-bases/update-document"},{"title":"Delete Document","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed delete /v1/knowledge-bases/{knowledge_base_id}/documents","href":"/api-reference/knowledge-bases/delete-document"},{"title":"Add Folder","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/knowledge-bases/{knowledge_base_id}/folders","href":"/api-reference/knowledge-bases/add-folder"},{"title":"Delete Folder","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed delete /v1/knowledge-bases/{knowledge_base_id}/folders","href":"/api-reference/knowledge-bases/delete-folder"}]},{"group":"OpenAI 広告","tag":"Beta","pages":[{"title":"Get Account Insights","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/ads/openai-ads/ad-account/insights","href":"/api-reference/openai-ads/get-account-insights"}]},{"group":"組織","pages":[{"title":"Get Regions","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/regions","href":"/api-reference/organization/get-regions"},{"title":"Get Models","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/models","href":"/api-reference/organization/get-models"},{"title":"Get Domains","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/domains","href":"/api-reference/organization/get-domains"},{"title":"Get Assets","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/assets","href":"/api-reference/organization/get-assets"},{"title":"Get Personas","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/personas","href":"/api-reference/organization/get-personas"}]},{"group":"プロンプト","pages":[{"title":"List prompts","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed get /v1/org/categories/{category_id}/prompts","href":"/api-reference/organization/list-prompts"},{"title":"Create prompts","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/org/categories/{category_id}/prompts","href":"/api-reference/organization/create-prompts"},{"title":"Update prompts","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed patch /v1/org/categories/{category_id}/prompts","href":"/api-reference/organization/update-prompts"},{"title":"Update prompt status","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed patch /v1/org/categories/{category_id}/prompts/status","href":"/api-reference/organization/update-prompt-status"}]},{"group":"Prompt Volumes","pages":[{"title":"キーワードボリューム","openapi":"POST /v2/prompt-volumes/volume/on-the-fly","href":"/ja-jp/rest-api/prompt-volumes/query-volume-v2"},{"title":"キーワードのインテント構成比","openapi":"POST /v2/prompt-volumes/intents/on-the-fly","href":"/ja-jp/rest-api/prompt-volumes/query-intents-v2"}]},{"group":"レポート","pages":[{"group":"レポート v2","tag":"Beta","pages":[{"title":"フィルタリングと概念","href":"/ja-jp/rest-api/reports/reports-v2-overview"},{"title":"引用","openapi":"POST /v2/reports/citations","tag":"Beta","href":"/ja-jp/rest-api/reports/query-citations-v2"},{"title":"可視性","openapi":"POST /v2/reports/visibility","tag":"Beta","href":"/ja-jp/rest-api/reports/query-visibility-v2"},{"title":"センチメント","openapi":"POST /v2/reports/sentiment","tag":"Beta","href":"/ja-jp/rest-api/reports/query-sentiment-v2"},{"title":"クエリファンアウト","openapi":"POST /v2/reports/query-fanouts","tag":"Beta","href":"/ja-jp/rest-api/reports/query-fanouts-v2"},{"group":"FactCheck","tag":"Beta","pages":[{"title":"FactCheck","openapi":"POST /v2/reports/factcheck","tag":"Beta","href":"/ja-jp/rest-api/reports/query-factcheck-v2"},{"title":"FactCheck の主張","openapi":"POST /v2/reports/factcheck/claims","tag":"Beta","href":"/ja-jp/rest-api/reports/query-factcheck-claims-v2"}]},{"group":"Shopping","tag":"Beta","pages":[{"title":"ブランド","openapi":"POST /v2/reports/shopping/brands","tag":"Beta","href":"/ja-jp/rest-api/reports/query-shopping-brands-v2"},{"title":"商品","openapi":"POST /v2/reports/shopping/products","tag":"Beta","href":"/ja-jp/rest-api/reports/query-shopping-products-v2"},{"title":"マーチャント","openapi":"POST /v2/reports/shopping/merchants","tag":"Beta","href":"/ja-jp/rest-api/reports/query-shopping-merchants-v2"},{"title":"トリガー率","openapi":"POST /v2/reports/shopping/trigger-rate","tag":"Beta","href":"/ja-jp/rest-api/reports/query-shopping-trigger-rate-v2"}]},{"group":"YouTube","tag":"Beta","pages":[{"title":"チャンネル","openapi":"POST /v2/reports/social/youtube/channels","tag":"Beta","href":"/ja-jp/rest-api/reports/query-youtube-channels-v2"},{"title":"動画","openapi":"POST /v2/reports/social/youtube/videos","tag":"Beta","href":"/ja-jp/rest-api/reports/query-youtube-videos-v2"}]}]},{"group":"レポート v1","pages":[{"title":"Query Citations","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/reports/citations","href":"/api-reference/reports/query-citations"},{"title":"Query Visibility","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/reports/visibility","href":"/api-reference/reports/query-visibility"},{"title":"Query Sentiment","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/reports/sentiment","href":"/api-reference/reports/query-sentiment"},{"title":"Query Fanouts","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/reports/query-fanouts","href":"/api-reference/reports/query-fanouts"}]},{"group":"ボットトラフィック","pages":[{"title":"Get Bots Report V1","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/reports/bots","href":"/api-reference/reports/get-bots-report-v1"},{"title":"Get Bots Report V2","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v2/reports/bots","href":"/api-reference/reports/get-bots-report-v2"}]},{"group":"人間による参照トラフィック","pages":[{"title":"Get Referrals Report V1","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v1/reports/referrals","href":"/api-reference/reports/get-referrals-report-v1"},{"title":"Get Referrals Report V2","deprecated":null,"version":null,"openapi":"https://registry.scalar.com/@profound/apis/external-api/latest/openapi.json?variant=processed post /v2/reports/referrals","href":"/api-reference/reports/get-referrals-report-v2"}]}]}]},{"group":"リクエスト例","root":{"title":"リクエスト例","href":"/ja-jp/rest-api/examples/example"},"pages":[{"title":"Answer Engine Insights","href":"/ja-jp/rest-api/examples/answer-engine-insights"},{"title":"Agent Analytics","href":"/ja-jp/rest-api/examples/agent-analytics"},{"title":"Workflows","href":"/ja-jp/rest-api/examples/workflows"},{"title":"Knowledge Bases","href":"/ja-jp/rest-api/examples/knowledge-bases"},{"title":"OpenAI 広告","tag":"Beta","href":"/ja-jp/rest-api/examples/openai-ads"}]}]},{"group":"インテグレーション","icon":"plug","pages":[{"group":"Tableau","pages":[{"group":"使い方","root":{"title":"使い方","href":"/ja-jp/rest-api/integrations/tableau/usage"},"pages":[{"title":"WDC 2.0","tag":"Deprecated","href":"/ja-jp/rest-api/integrations/tableau/wdc-2"}]},{"title":"リリース","href":"/ja-jp/rest-api/integrations/tableau/releases"}]}]},{"group":"SDK","icon":"cube","pages":[{"title":"SDK を使い始める","href":"/ja-jp/sdks/overview"},{"title":"Python SDK","href":"/ja-jp/sdks/python-package"},{"title":"JavaScript SDK","href":"/ja-jp/sdks/javascript-package"}]}]},{"tab":"Profound MCP","pages":[{"title":"Profound MCP","href":"/ja-jp/mcp/overview"}]},{"tab":"Bots","pages":[{"title":"Bots","href":"/ja-jp/bots/introduction"}]},{"tab":"Cookbook","pages":[{"title":"Cookbook","href":"/ja-jp/cookbook/introduction"}]}]}]}]},"title":"Search Knowledge Base - Profound","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}