Required permission: Search — Read (read:search), which basic includes, so any signed-in user has it.
A limited Personal Access Token needs the Search — Read scope.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Onyx Documentation","colors":{"primary":"#0069ED","light":"#4D9CFF","dark":"#0050B4"},"logo":{"light":"https://mintcdn.com/danswer/TrJ0UalhtrxYEGaI/assets/logo/onyx_logo.svg?fit=max\u0026auto=format\u0026n=TrJ0UalhtrxYEGaI\u0026q=85\u0026s=7c6a59073e62a51c501463d3d7d79c42","dark":"https://mintcdn.com/danswer/TrJ0UalhtrxYEGaI/assets/logo/onyx_logo_inverted.svg?fit=max\u0026auto=format\u0026n=TrJ0UalhtrxYEGaI\u0026q=85\u0026s=4e38630166675e463d97d41929b6a99e","href":"https://onyx.app/"},"favicon":"https://mintcdn.com/danswer/TrJ0UalhtrxYEGaI/assets/logo/onyx_favicon.svg?fit=max\u0026auto=format\u0026n=TrJ0UalhtrxYEGaI\u0026q=85\u0026s=6ea820a642e7069f78fe8f46af23a81a","api":{"openapi":["developers/api_reference/openapi.json"]},"navbar":{"links":[{"icon":"github","href":"https://github.com/onyx-dot-app/onyx","label":"onyx-dot-app/onyx"}],"primary":{"type":"button","label":"Onyx Cloud","href":"https://cloud.onyx.app/?utm_source=docs"}},"footer":{"socials":{"github":"https://github.com/onyx-dot-app/onyx","twitter":"https://x.com/onyx_dot_app","linkedin":"https://linkedin.com/company/onyx-dot-app"}},"seo":{"metatags":{"keywords":"enterprise search, onyx ai, onyx, open source ai, enterprise ai, generative ai platform, ai assistant, knowledge management, danswer"}},"integrations":{"posthog":{"apiKey":"phc_ghlrcfXpgWq9XxZeVMfoJpfaISgFGoXhHYOEcBwdulK","apiHost":"https://us.i.posthog.com"}},"banner":{"content":"**Permissions update:** Onyx now uses group-based permissions. [Understand permissions](/admins/permissions/understanding_permissions) or [review migration details](/admins/permissions/whats_changing)","dismissible":true},"contextual":{"options":[],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://onyx.app/"},{"anchor":"Discord","icon":"discord","href":"https://discord.gg/TDJ59cGV2X"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"danswer","hasAudioNarration":false,"actualSubdomain":"danswer","customDomains":["docs.onyx.app"],"gitSource":{"type":"github","owner":"onyx-dot-app","repo":"onyx","deployBranch":"docs/live","contentDirectory":"documentation","isPrivate":false,"mountPath":"","label":"","_id":"6ae27ebc5efec986e272d162"},"chroma":{"liveDeploymentHistoryId":"6aea074c2d9111c67b18a97e","collectionId":"a9724df8-0265-47fa-9cff-3363a20e3195","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aea074c2d9111c67b18a97e"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aea074c2d9111c67b18a97e","clientVersion":"0.0.4064","searchFilterCounts":[{"language":"default","tag":"Developers","count":161},{"language":"default","tag":"API Reference","count":153},{"language":"default","tag":"Admins","count":129},{"language":"default","tag":"Connectors","count":93},{"language":"default","tag":"Supported Connectors","count":69},{"language":"default","tag":"Connectors \u0026 Credentials","count":38},{"language":"default","tag":"Deployment","count":36},{"language":"default","tag":"Overview","count":27},{"language":"default","tag":"Managing Features","count":19},{"language":"default","tag":"Projects \u0026 Files","count":16}]},"assistantConfig":{},"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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".rounded-image{border-radius:1rem;margin:8px auto;display:block}.prose table,table{display:table;width:100%;max-width:100%;table-layout:auto}.prose table th{text-align:left!important}.icon-dark-invert [data-component-part=\"card-icon\"] img{background:transparent!important}.dark .icon-dark-invert [data-component-part=\"card-icon\"] img{filter:invert(1)!important}.docs-image-placeholder{align-items:center;background:repeating-linear-gradient(\n 45deg,\n rgba(0, 105, 237, 0.08),\n rgba(0, 105, 237, 0.08) 12px,\n rgba(0, 105, 237, 0.14) 12px,\n rgba(0, 105, 237, 0.14) 24px\n );border:1px dashed rgba(0, 105, 237, 0.55);border-radius:0.75rem;color:#0050b4;display:flex;font-weight:600;justify-content:center;margin:1rem 0;min-height:220px;padding:1.5rem;text-align:center}.dark .docs-image-placeholder{color:#9ec8ff}.permission-pyramid{display:flex;flex-direction:column;gap:0.5rem;margin:1.5rem auto;max-width:760px}.permission-pyramid-layer{align-items:center;border:1px solid rgba(0, 105, 237, 0.18);border-radius:0.75rem;display:flex;flex-direction:column;gap:0.2rem;margin:0 auto;padding:0.85rem 1rem;text-align:center}.permission-pyramid-layer span{font-size:0.9rem}.permission-pyramid-admin{background:#0b1f3a;color:#ffffff;width:100%}.permission-pyramid-org{background:#0050b4;color:#ffffff;width:82%}.permission-pyramid-scoped{background:#4d9cff;color:#07172b;width:62%}.permission-pyramid-basic{background:#eaf4ff;color:#07172b;width:42%}.permission-pyramid-limited{background:#f5f8fc;border-style:dashed;color:#37536f;width:26%}@media (max-width: 640px){.permission-pyramid-admin,.permission-pyramid-org,.permission-pyramid-scoped,.permission-pyramid-basic,.permission-pyramid-limited{width:100%}}"}],"page":{"pagePath":"developers/api_reference/search/execute_web_search","slug":"/developers/api_reference/search/execute_web_search","pageMetadata":{"title":"Execute Web Search","openapi":"POST /web-search/search","description":"Perform a web search and immediately fetch content for the returned URLs.\n\nUse this when you want both snippets and page contents from one call.\n\nIf you want to selectively fetch content (i.e. let the LLM decide which URLs to read),\nuse `/search-lite` and then call `/open-urls` separately.","href":"/developers/api_reference/search/execute_web_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 code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Perform a web search and immediately fetch content for the returned URLs.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Use this when you want both snippets and page contents from one call.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"If you want to selectively fetch content (i.e. let the LLM decide which URLs to read),\\nuse \", _jsx(_components.code, {\n children: \"/search-lite\"\n }), \" and then call \", _jsx(_components.code, {\n children: \"/open-urls\"\n }), \" separately.\"]\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Info}=_components;if(!Info)_missingMdxReference(`Info`,true);return _jsx(Info,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Required permission:`}),` Search — Read (`,_jsx(_components.code,{children:`read:search`}),`), which `,_jsx(_components.code,{children:`basic`}),` includes, so any signed-in user has it.\nA limited `,_jsx(_components.a,{href:`/developers/overview#personal-access-tokens`,children:`Personal Access Token`}),` needs the Search — Read scope.`]})})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Execute Web Search","openapi":"POST /web-search/search","description":"Perform a web search and immediately fetch content for the returned URLs.\n\nUse this when you want both snippets and page contents from one call.\n\nIf you want to selectively fetch content (i.e. let the LLM decide which URLs to read),\nuse `/search-lite` and then call `/open-urls` separately.","href":"/developers/api_reference/search/execute_web_search"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["public"],"summary":"Execute Web Search","description":"Perform a web search and immediately fetch content for the returned URLs.\n\nUse this when you want both snippets and page contents from one call.\n\nIf you want to selectively fetch content (i.e. let the LLM decide which URLs to read),\nuse `/search-lite` and then call `/open-urls` separately.","operationId":"execute_web_search","security":["274a179e-b88b-47e2-9780-44e011a7f885"],"requestBody":"602678e9-0ba2-49c6-b649-8193a683b5bc","responses":{"200":"36e059b7-02ae-4972-abc0-080c98f2d721","422":"6f20dcd3-5a1e-46e6-a7af-9e084d0f04b1"},"method":"post","type":"path","servers":["9d089e9e-fb61-4e73-bcf8-f2767e34348d"],"path":"/web-search/search","baseUrlOptions":["https://cloud.onyx.app/api"],"title":"Execute Web Search","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"queries":{"items":{"type":"string","uniqueKey":"queries.items.[INDEX]","typeLabel":"string"},"type":"array","minItems":1,"title":"Queries","description":"List of search queries to send to the configured provider.","isRequired":true,"uniqueKey":"queries","typeLabel":"string[]"},"max_results":{"oneOf":[{"type":"integer","title":"Max Results","description":"Optional cap on number of results to return per query. Defaults to 10.","default":10,"uniqueKey":"max_results.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Max Results","description":"Optional cap on number of results to return per query. Defaults to 10.","default":10,"uniqueKey":"max_results.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_results","typeLabel":"integer | null"}},"type":"object","required":["queries"],"title":"WebSearchToolRequest","uniqueKey":"","typeLabel":"WebSearchToolRequest · object"},"examples":{"Example":{"title":"Example","value":{"queries":["\u003cstring>"],"max_results":10}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"36e059b7-02ae-4972-abc0-080c98f2d721":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"search_provider_type":{"type":"string","enum":["google_pse","serper","exa","searxng","brave","tavily","firecrawl"],"title":"WebSearchProviderType","isRequired":true,"uniqueKey":"search_provider_type","typeLabel":"enum\u003cstring>"},"search_results":{"items":{"properties":{"document_citation_number":{"type":"integer","title":"Document Citation Number","isRequired":true,"uniqueKey":"search_results.items.[INDEX].document_citation_number","typeLabel":"integer"},"url":{"type":"string","title":"Url","isRequired":true,"uniqueKey":"search_results.items.[INDEX].url","typeLabel":"string"},"title":{"type":"string","title":"Title","isRequired":true,"uniqueKey":"search_results.items.[INDEX].title","typeLabel":"string"},"snippet":{"type":"string","title":"Snippet","isRequired":true,"uniqueKey":"search_results.items.[INDEX].snippet","typeLabel":"string"},"unique_identifier_to_strip_away":{"oneOf":[{"type":"string","title":"Unique Identifier To Strip Away","uniqueKey":"search_results.items.[INDEX].unique_identifier_to_strip_away.oneOf.0","typeLabel":"string"},{"type":"null","title":"Unique Identifier To Strip Away","uniqueKey":"search_results.items.[INDEX].unique_identifier_to_strip_away.oneOf.1","typeLabel":"null"}],"uniqueKey":"search_results.items.[INDEX].unique_identifier_to_strip_away","typeLabel":"string | null"},"type":{"type":"string","const":"web_search","title":"Type","default":"web_search","uniqueKey":"search_results.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["document_citation_number","url","title","snippet"],"title":"LlmWebSearchResult","description":"Result from a web search query","uniqueKey":"search_results.items.[INDEX]","typeLabel":"LlmWebSearchResult · object"},"type":"array","title":"Search Results","isRequired":true,"uniqueKey":"search_results","typeLabel":"LlmWebSearchResult · object[]"},"full_content_results":{"items":{"properties":{"document_citation_number":{"type":"integer","title":"Document Citation Number","isRequired":true,"uniqueKey":"full_content_results.items.[INDEX].document_citation_number","typeLabel":"integer"},"content":{"type":"string","title":"Content","isRequired":true,"uniqueKey":"full_content_results.items.[INDEX].content","typeLabel":"string"},"unique_identifier_to_strip_away":{"oneOf":[{"type":"string","title":"Unique Identifier To Strip Away","uniqueKey":"full_content_results.items.[INDEX].unique_identifier_to_strip_away.oneOf.0","typeLabel":"string"},{"type":"null","title":"Unique Identifier To Strip Away","uniqueKey":"full_content_results.items.[INDEX].unique_identifier_to_strip_away.oneOf.1","typeLabel":"null"}],"uniqueKey":"full_content_results.items.[INDEX].unique_identifier_to_strip_away","typeLabel":"string | null"},"type":{"type":"string","const":"open_url","title":"Type","default":"open_url","uniqueKey":"full_content_results.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["document_citation_number","content"],"title":"LlmOpenUrlResult","description":"Result from opening/fetching a URL","uniqueKey":"full_content_results.items.[INDEX]","typeLabel":"LlmOpenUrlResult · object"},"type":"array","title":"Full Content Results","isRequired":true,"uniqueKey":"full_content_results","typeLabel":"LlmOpenUrlResult · object[]"},"content_provider_type":{"oneOf":[{"type":"string","title":"WebContentProviderType","enum":["onyx_web_crawler","firecrawl","exa","tavily"],"uniqueKey":"content_provider_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","uniqueKey":"content_provider_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"content_provider_type","typeLabel":"enum\u003cstring> | null"}},"type":"object","required":["search_provider_type","search_results","full_content_results"],"title":"WebSearchWithContentResponse","uniqueKey":"","typeLabel":"WebSearchWithContentResponse · object"},"examples":{"Example":{"title":"Example","value":{"search_provider_type":"google_pse","search_results":[{"document_citation_number":123,"url":"\u003cstring>","title":"\u003cstring>","snippet":"\u003cstring>","unique_identifier_to_strip_away":"\u003cstring>","type":"web_search"}],"full_content_results":[{"document_citation_number":123,"content":"\u003cstring>","unique_identifier_to_strip_away":"\u003cstring>","type":"open_url"}],"content_provider_type":"onyx_web_crawler"}}},"exampleType":"generated"}},"exampleType":"generated"},"6f20dcd3-5a1e-46e6-a7af-9e084d0f04b1":{"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":{"274a179e-b88b-47e2-9780-44e011a7f885":{"BearerAuth":{"type":"http","scheme":"bearer","description":"Authorization header with Bearer token","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"9d089e9e-fb61-4e73-bcf8-f2767e34348d":{"url":"https://cloud.onyx.app/api"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Authorization header with Bearer token","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Authorization header with Bearer token","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"developers/api_reference/openapi.json"},"subdomain":"danswer","siteName":"Onyx Documentation","title":"Execute Web Search - Onyx Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-08-25T07:40:56.677Z","originalFileLocation":"developers/api_reference/search/execute_web_search.mdx"},"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=\"Perform a web search and immediately fetch content for the returned URLs. Use this when you want both snippets and page contents from one call. If you want to selectively fetch content (i.e. let the LLM decide which URLs to read), use /search-lite and then call /open-urls separately.\">\u003cmeta data-mint-head name=\"keywords\" content=\"enterprise search, onyx ai, onyx, open source ai, enterprise ai, generative ai platform, ai assistant, knowledge management, danswer\">\u003cmeta data-mint-head name=\"application-name\" content=\"Onyx Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/danswer/dnsxLL69h2aR36l9/_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/danswer/dnsxLL69h2aR36l9/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/danswer/dnsxLL69h2aR36l9/_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/danswer/dnsxLL69h2aR36l9/_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/danswer/dnsxLL69h2aR36l9/_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/danswer/dnsxLL69h2aR36l9/_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/danswer/dnsxLL69h2aR36l9/_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/danswer/dnsxLL69h2aR36l9/_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/danswer/dnsxLL69h2aR36l9/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Execute Web Search - Onyx Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Perform a web search and immediately fetch content for the returned URLs. Use this when you want both snippets and page contents from one call. If you want to selectively fetch content (i.e. let the LLM decide which URLs to read), use /search-lite and then call /open-urls separately.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Onyx Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.onyx.app/developers/api_reference/search/execute_web_search\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://danswer.mintlify.app/_mintlify/api/og/v2?division=Search\u0026amp;title=Execute+Web+Search\u0026amp;description=Perform+a+web+search+and+immediately+fetch+content+for+the+returned+URLs.%0A%0AUse+this+when+you+want+both+snippets+and+page+contents+from+one+call.%0A%0AIf+you+want+to\u0026amp;theme=602dd50adaaee2498be7103f\u0026amp;signature=2b12fcc0b26b3cfa68cd17d7cfa023c3ae0e83de9473e6a41a4accb6ad061ece\">\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=\"Execute Web Search - Onyx Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Perform a web search and immediately fetch content for the returned URLs. Use this when you want both snippets and page contents from one call. If you want to selectively fetch content (i.e. let the LLM decide which URLs to read), use /search-lite and then call /open-urls separately.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://danswer.mintlify.app/_mintlify/api/og/v2?division=Search\u0026amp;title=Execute+Web+Search\u0026amp;description=Perform+a+web+search+and+immediately+fetch+content+for+the+returned+URLs.%0A%0AUse+this+when+you+want+both+snippets+and+page+contents+from+one+call.%0A%0AIf+you+want+to\u0026amp;theme=602dd50adaaee2498be7103f\u0026amp;signature=2b12fcc0b26b3cfa68cd17d7cfa023c3ae0e83de9473e6a41a4accb6ad061ece\">\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/danswer/dnsxLL69h2aR36l9/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Onyx Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0069ED\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.onyx.app/developers/api_reference/search/execute_web_search\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developers/api_reference/search/execute_web_search.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.onyx.app/#organization\",\"name\":\"Onyx Documentation\",\"url\":\"https://docs.onyx.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/danswer/TrJ0UalhtrxYEGaI/assets/logo/onyx_logo.svg?fit=max\u0026auto=format\u0026n=TrJ0UalhtrxYEGaI\u0026q=85\u0026s=7c6a59073e62a51c501463d3d7d79c42\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.onyx.app#website\",\"name\":\"Onyx Documentation\",\"url\":\"https://docs.onyx.app\",\"publisher\":{\"@id\":\"https://docs.onyx.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.onyx.app/developers/api_reference/search/execute_web_search#webpage\",\"url\":\"https://docs.onyx.app/developers/api_reference/search/execute_web_search\",\"name\":\"Execute Web Search\",\"description\":\"Perform a web search and immediately fetch content for the returned URLs. Use this when you want both snippets and page contents from one call. If you want to selectively fetch content (i.e. let the LLM decide which URLs to read), use /search-lite and then call /open-urls separately.\",\"dateModified\":\"2026-08-25T07:40:56.677Z\",\"isPartOf\":{\"@id\":\"https://docs.onyx.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.onyx.app/developers/api_reference/search/execute_web_search#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.onyx.app/developers/api_reference/search/execute_web_search#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.onyx.app/developers/api_reference/chat/create_new_chat_session\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Search\",\"item\":\"https://docs.onyx.app/developers/api_reference/search/search\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Execute Web Search\",\"item\":\"https://docs.onyx.app/developers/api_reference/search/execute_web_search\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.onyx.app/developers/api_reference/search/execute_web_search#apireference\",\"headline\":\"Execute Web Search\",\"name\":\"Execute Web Search\",\"description\":\"Perform a web search and immediately fetch content for the returned URLs. Use this when you want both snippets and page contents from one call. If you want to selectively fetch content (i.e. let the LLM decide which URLs to read), use /search-lite and then call /open-urls separately.\",\"url\":\"https://docs.onyx.app/developers/api_reference/search/execute_web_search\",\"mainEntityOfPage\":{\"@id\":\"https://docs.onyx.app/developers/api_reference/search/execute_web_search#webpage\"},\"dateModified\":\"2026-08-25T07:40:56.677Z\",\"publisher\":{\"@id\":\"https://docs.onyx.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.onyx.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Onyx Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Onyx Documentation","nav":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://onyx.app/"},{"anchor":"Discord","icon":"discord","href":"https://discord.gg/TDJ59cGV2X"}]},"tabs":[{"tab":"Overview","icon":"house","pages":[{"title":"Overview","href":"/welcome"}]},{"tab":"Deployment","icon":"server","pages":[{"title":"Deployment","href":"/deployment/overview"}]},{"tab":"Admins","icon":"user-shield","pages":[{"title":"Admins","href":"/admins/overview"}]},{"tab":"Developers","icon":"square-terminal","pages":[{"group":"Getting Started","pages":[{"title":"Overview \u0026 Auth","icon":"code","href":"/developers/overview"},{"title":"Core Concepts","icon":"lightbulb","href":"/developers/core_concepts"}]},{"group":"Guides \u0026 Examples","icon":"book-open","pages":[{"title":"Send a Message to Onyx","icon":"bolt","href":"/developers/guides/chat_new_guide"},{"title":"Search with the API","icon":"magnifying-glass","href":"/developers/guides/search_api_guide"},{"title":"LLM Gateway","icon":"route","href":"/developers/guides/llm_gateway"},{"title":"Index Files with the Ingestion API","icon":"upload","href":"/developers/guides/index_files_ingestion_api"},{"title":"Create Connectors","icon":"link","href":"/developers/guides/create_connector"}]},{"group":"API Reference","pages":[{"group":"Chat","icon":"comment","pages":[{"title":"Create New Chat Session","openapi":"POST /chat/create-chat-session","href":"/developers/api_reference/chat/create_new_chat_session"},{"title":"Handle Send Chat Message","openapi":"POST /chat/send-chat-message","href":"/developers/api_reference/chat/handle_send_chat_message"},{"title":"Stop Chat Session","openapi":"POST /chat/stop-chat-session/{chat_session_id}","href":"/developers/api_reference/chat/stop_chat_session"},{"title":"Search Chats","openapi":"GET /chat/search","href":"/developers/api_reference/chat/search_chats"},{"title":"Get Chat Session","openapi":"GET /chat/get-chat-session/{session_id}","href":"/developers/api_reference/chat/get_chat_session"},{"title":"Get User Chat Sessions","openapi":"GET /chat/get-user-chat-sessions","href":"/developers/api_reference/chat/get_user_chat_sessions"},{"title":"Fetch Chat File","openapi":"GET /chat/file/{file_id}","href":"/developers/api_reference/chat/fetch_chat_file"},{"title":"Delete Chat Session By Id","openapi":"DELETE /chat/delete-chat-session/{session_id}","href":"/developers/api_reference/chat/delete_chat_session_by_id"},{"title":"Delete All Chat Sessions","openapi":"DELETE /chat/delete-all-chat-sessions","href":"/developers/api_reference/chat/delete_all_chat_sessions"},{"title":"End Incognito Session","openapi":"POST /chat/end-incognito-session/{session_id}","href":"/developers/api_reference/chat/end_incognito_session"}]},{"group":"Search","icon":"magnifying-glass","pages":[{"title":"Search","openapi":"POST /search","href":"/developers/api_reference/search/search"},{"title":"Handle Send Search Message","openapi":"POST /search/send-search-message","href":"/developers/api_reference/search/handle_send_search_message"},{"title":"Get Search History","openapi":"GET /search/search-history","href":"/developers/api_reference/search/get_search_history"},{"title":"Search Flow Classification","openapi":"POST /search/search-flow-classification","description":"Classify whether a query should be answered by search or by chat.\n\nQueries longer than 200 characters are classified as a chat flow without an\nLLM call. A failed classification falls back to ``is_search_flow: false``\nrather than raising.","href":"/developers/api_reference/search/search_flow_classification"},{"title":"Execute Web Search","openapi":"POST /web-search/search","href":"/developers/api_reference/search/execute_web_search"},{"title":"Execute Web Search Lite","openapi":"POST /web-search/search-lite","description":"Lightweight search-only endpoint. Returns search snippets and URLs without\nfetching page contents. Pair with `/open-urls` if you need to fetch content\nlater.","href":"/developers/api_reference/search/execute_web_search_lite"},{"title":"Execute Open Urls","openapi":"POST /web-search/open-urls","href":"/developers/api_reference/search/execute_open_urls"}]},{"group":"Agents","icon":"robot","pages":[{"title":"Create Agent","openapi":"POST /persona","href":"/developers/api_reference/agents/create_persona"},{"title":"Get Agent","openapi":"GET /persona/{persona_id}","href":"/developers/api_reference/agents/get_persona"},{"title":"Update Agent","openapi":"PATCH /persona/{persona_id}","href":"/developers/api_reference/agents/update_persona"},{"title":"Delete Agent","openapi":"DELETE /persona/{persona_id}","href":"/developers/api_reference/agents/delete_persona"},{"title":"Get Agents Paginated","openapi":"GET /agents","href":"/developers/api_reference/agents/get_agents_paginated"},{"title":"Get Agents Admin Paginated","openapi":"GET /admin/agents","href":"/developers/api_reference/agents/get_agents_admin_paginated"},{"title":"List Agents Admin","openapi":"GET /admin/persona","href":"/developers/api_reference/agents/list_personas_admin"},{"title":"Undelete Agent","openapi":"PATCH /admin/persona/{persona_id}/undelete","href":"/developers/api_reference/agents/undelete_persona"}]},{"group":"Actions","icon":"play","pages":[{"title":"Create Custom Tool","openapi":"POST /admin/tool/custom","href":"/developers/api_reference/actions/create_custom_tool"},{"title":"Update Custom Tool","openapi":"PUT /admin/tool/custom/{tool_id}","href":"/developers/api_reference/actions/update_custom_tool"},{"title":"Delete Custom Tool","openapi":"DELETE /admin/tool/custom/{tool_id}","href":"/developers/api_reference/actions/delete_custom_tool"},{"title":"Validate Tool","openapi":"POST /admin/tool/custom/validate","href":"/developers/api_reference/actions/validate_tool"},{"title":"List Tools","openapi":"GET /tool","href":"/developers/api_reference/actions/list_tools"},{"title":"List OpenAPI Tools","openapi":"GET /tool/openapi","href":"/developers/api_reference/actions/list_openapi_tools"},{"title":"Get Custom Tool","openapi":"GET /tool/{tool_id}","href":"/developers/api_reference/actions/get_custom_tool"},{"title":"Update Tool User Preferences","openapi":"PATCH /tool/{tool_id}/preferences","href":"/developers/api_reference/actions/update_tool_user_preferences"}]},{"group":"Connectors \u0026 Credentials","icon":"plug","pages":[{"group":"Connectors","pages":[{"title":"Create Connector From Model","openapi":"POST /manage/admin/connector","href":"/developers/api_reference/files_connectors/create_connector_from_model"},{"title":"Update Connector From Model","openapi":"PATCH /manage/admin/connector/{connector_id}","href":"/developers/api_reference/files_connectors/update_connector_from_model"},{"title":"Get Connectors By Credential","openapi":"GET /manage/admin/connector","href":"/developers/api_reference/files_connectors/get_connectors_by_credential"},{"title":"Get Connectors","openapi":"GET /manage/connector","href":"/developers/api_reference/files_connectors/get_connectors"},{"title":"Get Connector By Id","openapi":"GET /manage/connector/{connector_id}","href":"/developers/api_reference/files_connectors/get_connector_by_id"},{"title":"Get Basic Connector Indexing Status","openapi":"GET /manage/connector-status","href":"/developers/api_reference/files_connectors/get_basic_connector_indexing_status"},{"title":"Get Connector Status","openapi":"GET /manage/admin/connector/status","href":"/developers/api_reference/files_connectors/get_connector_status"},{"title":"Get Currently Failed Indexing Status","openapi":"GET /manage/admin/connector/failed-indexing-status","href":"/developers/api_reference/files_connectors/get_currently_failed_indexing_status"},{"title":"Get Connector Indexing Status","openapi":"POST /manage/admin/connector/indexing-status","href":"/developers/api_reference/files_connectors/get_connector_indexing_status"},{"title":"Connector Run Once","openapi":"POST /manage/admin/connector/run-once","href":"/developers/api_reference/files_connectors/connector_run_once"},{"title":"Upload Files Api","openapi":"POST /manage/admin/connector/file/upload","href":"/developers/api_reference/files_connectors/upload_files_api"},{"title":"List Connector Files","openapi":"GET /manage/admin/connector/{connector_id}/files","href":"/developers/api_reference/files_connectors/list_connector_files"},{"title":"Update Connector Files","openapi":"POST /manage/admin/connector/{connector_id}/files/update","href":"/developers/api_reference/files_connectors/update_connector_files"},{"title":"Delete Connector By Id","openapi":"DELETE /manage/admin/connector/{connector_id}","href":"/developers/api_reference/files_connectors/delete_connector_by_id"},{"title":"Create Deletion Attempt For Connector Id","openapi":"POST /manage/admin/deletion-attempt","href":"/developers/api_reference/files_connectors/create_deletion_attempt_for_connector_id"},{"title":"Get Indexed Sources","openapi":"GET /manage/indexed-sources","href":"/developers/api_reference/files_connectors/get_indexed_sources"},{"title":"Get CC Pair Full Info","openapi":"GET /manage/admin/cc-pair/{cc_pair_id}","href":"/developers/api_reference/files_connectors/get_cc_pair_full_info"},{"title":"Get CC Pair Index Attempts","openapi":"GET /manage/admin/cc-pair/{cc_pair_id}/index-attempts","href":"/developers/api_reference/files_connectors/get_cc_pair_index_attempts"},{"title":"Get CC Pair Indexing Errors","openapi":"GET /manage/admin/cc-pair/{cc_pair_id}/errors","href":"/developers/api_reference/files_connectors/get_cc_pair_indexing_errors"},{"title":"Update CC Pair Status","openapi":"PUT /manage/admin/cc-pair/{cc_pair_id}/status","href":"/developers/api_reference/files_connectors/update_cc_pair_status"},{"title":"Prune Cc Pair","openapi":"POST /manage/admin/cc-pair/{cc_pair_id}/prune","href":"/developers/api_reference/files_connectors/prune_cc_pair"},{"title":"Get Cc Source Full Info","openapi":"GET /manage/admin/similar-credentials/{source_type}","href":"/developers/api_reference/files_connectors/get_cc_source_full_info"},{"title":"Get Docs By Connector Credential Pair","openapi":"GET /onyx-api/connector-docs/{cc_pair_id}","href":"/developers/api_reference/files_connectors/get_docs_by_connector_credential_pair"}]},{"group":"Credentials","pages":[{"title":"List Credentials Admin","openapi":"GET /manage/admin/credential","href":"/developers/api_reference/files_connectors/list_credentials_admin"},{"title":"List Credentials","openapi":"GET /manage/credential","href":"/developers/api_reference/files_connectors/list_credentials"},{"title":"Get Credential By Id","openapi":"GET /manage/credential/{credential_id}","href":"/developers/api_reference/files_connectors/get_credential_by_id"},{"title":"Create Credential From Model","openapi":"POST /manage/credential","href":"/developers/api_reference/files_connectors/create_credential_from_model"},{"title":"Create Credential With Private Key","openapi":"POST /manage/credential/private-key","href":"/developers/api_reference/files_connectors/create_credential_with_private_key"},{"title":"Update Credential From Model","openapi":"PATCH /manage/credential/{credential_id}","href":"/developers/api_reference/files_connectors/update_credential_from_model"},{"title":"Update Credential Data","openapi":"PUT /manage/admin/credential/{credential_id}","href":"/developers/api_reference/files_connectors/update_credential_data"},{"title":"Update Credential Private Key","openapi":"PUT /manage/admin/credential/private-key/{credential_id}","href":"/developers/api_reference/files_connectors/update_credential_private_key"},{"title":"Delete Credential By Id","openapi":"DELETE /manage/credential/{credential_id}","href":"/developers/api_reference/files_connectors/delete_credential_by_id"},{"title":"Delete Credential By Id Admin","openapi":"DELETE /manage/admin/credential/{credential_id}","href":"/developers/api_reference/files_connectors/delete_credential_by_id_admin"},{"title":"Force Delete Credential By Id","openapi":"DELETE /manage/credential/force/{credential_id}","href":"/developers/api_reference/files_connectors/force_delete_credential_by_id"},{"title":"Swap Credentials For Connector","openapi":"PUT /manage/admin/credential/swap","href":"/developers/api_reference/files_connectors/swap_credentials_for_connector"},{"title":"Associate Credential To Connector","openapi":"PUT /manage/connector/{connector_id}/credential/{credential_id}","href":"/developers/api_reference/files_connectors/associate_credential_to_connector"},{"title":"Dissociate Credential From Connector","openapi":"DELETE /manage/connector/{connector_id}/credential/{credential_id}","href":"/developers/api_reference/files_connectors/dissociate_credential_from_connector"}]},{"title":"Update Credential Sharing","openapi":"PUT /manage/admin/credential/{credential_id}/sharing","href":"/developers/api_reference/files_connectors/update_credential_sharing"}]},{"group":"Projects \u0026 Files","icon":"folder","pages":[{"title":"Get Projects","openapi":"GET /user/projects","href":"/developers/api_reference/projects/get_projects"},{"title":"Create Project","openapi":"POST /user/projects/create","href":"/developers/api_reference/projects/create_project"},{"title":"Get Project","openapi":"GET /user/projects/{project_id}","href":"/developers/api_reference/projects/get_project"},{"title":"Update Project","openapi":"PATCH /user/projects/{project_id}","href":"/developers/api_reference/projects/update_project"},{"title":"Delete Project","openapi":"DELETE /user/projects/{project_id}","href":"/developers/api_reference/projects/delete_project"},{"title":"Get Project Details","openapi":"GET /user/projects/{project_id}/details","href":"/developers/api_reference/projects/get_project_details"},{"title":"Get Project Instructions","openapi":"GET /user/projects/{project_id}/instructions","href":"/developers/api_reference/projects/get_project_instructions"},{"title":"Upsert Project Instructions","openapi":"POST /user/projects/{project_id}/instructions","href":"/developers/api_reference/projects/upsert_project_instructions"},{"title":"Get Files In Project","openapi":"GET /user/projects/files/{project_id}","href":"/developers/api_reference/projects/get_files_in_project"},{"title":"Get Chat Session Project Files","openapi":"GET /user/projects/session/{chat_session_id}/files","href":"/developers/api_reference/projects/get_chat_session_project_files"},{"title":"Upload User Files","openapi":"POST /user/projects/file/upload","href":"/developers/api_reference/projects/upload_user_files"},{"title":"Get User File Statuses","openapi":"POST /user/projects/file/statuses","href":"/developers/api_reference/projects/get_user_file_statuses"},{"title":"Get User File","openapi":"GET /user/projects/file/{file_id}","href":"/developers/api_reference/projects/get_user_file"},{"title":"Delete User File","openapi":"DELETE /user/projects/file/{file_id}","href":"/developers/api_reference/projects/delete_user_file"},{"title":"Link User File To Project","openapi":"POST /user/projects/{project_id}/files/{file_id}","href":"/developers/api_reference/projects/link_user_file_to_project"},{"title":"Unlink User File From Project","openapi":"DELETE /user/projects/{project_id}/files/{file_id}","href":"/developers/api_reference/projects/unlink_user_file_from_project"}]},{"group":"Ingestion API","icon":"file-arrow-up","pages":[{"title":"Get Ingestion Docs","openapi":"GET /onyx-api/ingestion","href":"/developers/api_reference/ingestion/get_ingestion_docs"},{"title":"Upsert Ingestion Doc","openapi":"POST /onyx-api/ingestion","href":"/developers/api_reference/ingestion/upsert_ingestion_doc"},{"title":"Delete Ingestion Doc","openapi":"DELETE /onyx-api/ingestion/{document_id}","href":"/developers/api_reference/ingestion/delete_ingestion_doc"}]},{"group":"User Management","icon":"user","pages":[{"title":"Get Auth Type","openapi":"GET /auth/type","href":"/developers/api_reference/user_management/get_auth_type"},{"title":"Verify User Logged In","openapi":"GET /me","href":"/developers/api_reference/user_management/verify_user_logged_in"},{"title":"Get Current User Permissions","openapi":"GET /me/permissions","href":"/developers/api_reference/user_management/get_current_user_permissions"},{"title":"Set User Admin Access","openapi":"PATCH /manage/admin/users/admin-access","href":"/developers/api_reference/user_management/set_user_admin_access"},{"title":"List All Users Basic Info","openapi":"GET /users","href":"/developers/api_reference/user_management/list_all_users_basic_info"},{"title":"List All Users","openapi":"GET /manage/users","href":"/developers/api_reference/user_management/list_all_users"},{"title":"List Invited Users","openapi":"GET /manage/users/invited","href":"/developers/api_reference/user_management/list_invited_users"},{"title":"List Accepted Users","openapi":"GET /manage/users/accepted","href":"/developers/api_reference/user_management/list_accepted_users"},{"title":"Bulk Invite Users","openapi":"PUT /manage/admin/users","href":"/developers/api_reference/user_management/bulk_invite_users"},{"title":"Remove Invited User","openapi":"PATCH /manage/admin/remove-invited-user","href":"/developers/api_reference/user_management/remove_invited_user"},{"title":"Activate User Api","openapi":"PATCH /manage/admin/activate-user","href":"/developers/api_reference/user_management/activate_user_api"},{"title":"Deactivate User Api","openapi":"PATCH /manage/admin/deactivate-user","href":"/developers/api_reference/user_management/deactivate_user_api"},{"title":"Delete User","openapi":"DELETE /manage/admin/delete-user","href":"/developers/api_reference/user_management/delete_user"},{"title":"List All Accepted Users","openapi":"GET /manage/users/accepted/all","href":"/developers/api_reference/user_management/list_all_accepted_users"},{"title":"List Minimal User Groups","openapi":"GET /manage/user-groups/minimal","href":"/developers/api_reference/user_management/list_minimal_user_groups"},{"title":"Get Permission Registry","openapi":"GET /manage/admin/permissions/registry","href":"/developers/api_reference/user_management/get_permission_registry"}]},{"group":"User Groups","icon":"users","pages":[{"title":"List User Groups","openapi":"GET /manage/admin/user-group","href":"/developers/api_reference/user_groups/list_user_groups"},{"title":"Create User Group","openapi":"POST /manage/admin/user-group","href":"/developers/api_reference/user_groups/create_user_group"},{"title":"Get User Group","openapi":"GET /manage/admin/user-group/{user_group_id}","href":"/developers/api_reference/user_groups/get_user_group"},{"title":"Patch User Group","openapi":"PATCH /manage/admin/user-group/{user_group_id}","href":"/developers/api_reference/user_groups/patch_user_group"},{"title":"Delete User Group","openapi":"DELETE /manage/admin/user-group/{user_group_id}","href":"/developers/api_reference/user_groups/delete_user_group"},{"title":"Get User Group Permissions","openapi":"GET /manage/admin/user-group/{user_group_id}/permissions","href":"/developers/api_reference/user_groups/get_user_group_permissions"},{"title":"Set User Group Permissions","openapi":"PUT /manage/admin/user-group/{user_group_id}/permissions","href":"/developers/api_reference/user_groups/set_user_group_permissions"},{"title":"Rename User Group","openapi":"PATCH /manage/admin/user-group/rename","href":"/developers/api_reference/user_groups/rename_user_group"},{"title":"Patch User Group Incognito","openapi":"PATCH /manage/admin/user-group/{user_group_id}/incognito","href":"/developers/api_reference/user_groups/patch_user_group_incognito"},{"title":"Set User Group Data Access CC Pairs","openapi":"PUT /manage/admin/user-group/{user_group_id}/data-access-cc-pairs","href":"/developers/api_reference/user_groups/set_user_group_data_access_cc_pairs"},{"title":"Set Group Managed CC Pairs","openapi":"PUT /manage/admin/user-group/{user_group_id}/managed-cc-pairs","href":"/developers/api_reference/user_groups/set_group_managed_cc_pairs"},{"title":"Add Users","openapi":"POST /manage/admin/user-group/{user_group_id}/add-users","href":"/developers/api_reference/user_groups/add_users"},{"title":"Update Group Agents","openapi":"PATCH /manage/admin/user-group/{user_group_id}/agents","href":"/developers/api_reference/user_groups/update_group_agents"},{"title":"Update Group Document Sets","openapi":"PATCH /manage/admin/user-group/{user_group_id}/document-sets","href":"/developers/api_reference/user_groups/update_group_document_sets"},{"title":"Set Group Manager","openapi":"PUT /manage/admin/user-group/{user_group_id}/manager","href":"/developers/api_reference/user_groups/set_group_manager"}]},{"group":"Token Limits","icon":"gauge","pages":[{"title":"Get Global Token Limit Settings","openapi":"GET /admin/token-rate-limits/global","href":"/developers/api_reference/miscellaneous/get_global_token_limit_settings"},{"title":"Create Global Token Limit Settings","openapi":"POST /admin/token-rate-limits/global","href":"/developers/api_reference/miscellaneous/create_global_token_limit_settings"},{"title":"Update Token Limit Settings","openapi":"PUT /admin/token-rate-limits/rate-limit/{token_rate_limit_id}","href":"/developers/api_reference/miscellaneous/update_token_limit_settings"},{"title":"Delete Token Limit Settings","openapi":"DELETE /admin/token-rate-limits/rate-limit/{token_rate_limit_id}","href":"/developers/api_reference/miscellaneous/delete_token_limit_settings"},{"title":"Get All Group Token Limit Settings","openapi":"GET /admin/token-rate-limits/user-groups","href":"/developers/api_reference/miscellaneous/get_all_group_token_limit_settings"},{"title":"Get Group Token Limit Settings","openapi":"GET /admin/token-rate-limits/user-group/{group_id}","href":"/developers/api_reference/miscellaneous/get_group_token_limit_settings"},{"title":"Create Group Token Limit Settings","openapi":"POST /admin/token-rate-limits/user-group/{group_id}","href":"/developers/api_reference/miscellaneous/create_group_token_limit_settings"},{"title":"Update Group Token Limit Settings","openapi":"PUT /admin/token-rate-limits/user-group/{group_id}/rate-limit/{rate_limit_id}","href":"/developers/api_reference/miscellaneous/update_group_token_limit_settings"},{"title":"Delete Group Token Limit Settings","openapi":"DELETE /admin/token-rate-limits/user-group/{group_id}/rate-limit/{rate_limit_id}","href":"/developers/api_reference/miscellaneous/delete_group_token_limit_settings"},{"title":"Get User Token Limit Settings","openapi":"GET /admin/token-rate-limits/users","href":"/developers/api_reference/miscellaneous/get_user_token_limit_settings"},{"title":"Create User Token Limit Settings","openapi":"POST /admin/token-rate-limits/users","href":"/developers/api_reference/miscellaneous/create_user_token_limit_settings"}]},{"group":"Usage \u0026 Cost","icon":"chart-line","pages":[{"title":"List Cost Overrides","openapi":"GET /admin/cost-overrides","href":"/developers/api_reference/usage/list_cost_overrides"},{"title":"Create Cost Override","openapi":"POST /admin/cost-overrides","href":"/developers/api_reference/usage/create_cost_override"},{"title":"Update Cost Override","openapi":"PUT /admin/cost-overrides/{model_configuration_id}","href":"/developers/api_reference/usage/update_cost_override"},{"title":"Delete Cost Override","openapi":"DELETE /admin/cost-overrides/{model_configuration_id}","href":"/developers/api_reference/usage/delete_cost_override"},{"title":"Get My Usage","openapi":"GET /user/usage","href":"/developers/api_reference/usage/get_my_usage"},{"title":"Export Usage","openapi":"GET /admin/usage/export","href":"/developers/api_reference/usage/export_usage"},{"title":"Get System Usage","openapi":"GET /admin/usage/system","href":"/developers/api_reference/usage/get_system_usage"},{"title":"Reset Usage","openapi":"POST /admin/usage/reset","href":"/developers/api_reference/usage/reset_usage"}]},{"group":"Analytics","icon":"chart-bar","pages":[{"title":"Get Query Analytics","openapi":"GET /analytics/admin/query","href":"/developers/api_reference/analytics/get_query_analytics"},{"title":"Get User Analytics","openapi":"GET /analytics/admin/user","href":"/developers/api_reference/analytics/get_user_analytics"},{"title":"Get OnyxBot Analytics","openapi":"GET /analytics/admin/onyxbot","href":"/developers/api_reference/analytics/get_onyxbot_analytics"},{"title":"Get Persona Messages","openapi":"GET /analytics/admin/persona/messages","href":"/developers/api_reference/analytics/get_persona_messages"},{"title":"Get Persona Unique Users","openapi":"GET /analytics/admin/persona/unique-users","href":"/developers/api_reference/analytics/get_persona_unique_users"},{"title":"Get Assistant Stats","openapi":"GET /analytics/assistant/{assistant_id}/stats","href":"/developers/api_reference/analytics/get_assistant_stats"}]},{"group":"Query History","icon":"clock-rotate-left","pages":[{"title":"Start Query History Export","openapi":"POST /admin/query-history/start-export","href":"/developers/api_reference/query_history/start_query_history_export"},{"title":"Get Query History Export Status","openapi":"GET /admin/query-history/export-status","href":"/developers/api_reference/query_history/get_query_history_export_status"},{"title":"Download Query History CSV","openapi":"GET /admin/query-history/download","href":"/developers/api_reference/query_history/download_query_history_csv"}]},{"group":"Miscellaneous","icon":"list","pages":[{"title":"Healthcheck","openapi":"GET /health","href":"/developers/api_reference/miscellaneous/healthcheck"},{"title":"Get Backend Version","openapi":"GET /version","href":"/developers/api_reference/miscellaneous/get_version"},{"title":"Get Latest App Version Tags","openapi":"GET /versions","href":"/developers/api_reference/miscellaneous/get_versions"},{"title":"Readiness","openapi":"GET /health/ready","href":"/developers/api_reference/miscellaneous/readiness"}]}]},{"group":"Miscellaneous","pages":[{"title":"Contact Us","icon":"comments","href":"/developers/contact_us"}]}]},{"tab":"Security","icon":"shield","pages":[{"title":"Security","href":"/security/architecture/system_description"}]},{"tab":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/changelog"}]},{"tab":"Agent Wiki","icon":"book","hidden":true,"pages":[{"title":"Agent Wiki","href":"/agent-wiki/welcome"}]}]},"basePath":"","title":"Execute Web Search - Onyx Documentation","buildId":"dpl_2gSLkbMoF5kkLsBqYzq9KWtDyJRo","deploymentId":"dpl_2gSLkbMoF5kkLsBqYzq9KWtDyJRo","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-CiLHwMiK.js","dist-CjboTi0T.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-v8ssfMzu.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-hfTk6MZX.js","utils-Bfp7HcY4.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D8dSW7yV.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CFgQXcZO.js","snippetPresets-dMW1-pV3.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-DyrCOido.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Bwwdcyh3.js","shallow-drVXTg79.js","getApiPlaygroundDisplay-GMPxUzWV.js","CodeSnippet-wTmV0wP6.js","CodeSnippets-D_QxCJEq.js","Page-BsZAA8xk.js","getPastedJson-Dev-X0Xy.js","icon-7L2WL0jD.js","MethodPill-Ble59Dl_.js","DuplicateIcon-r-98uLGh.js","createIcon-DaFzipjW.js","DynamicMarkdown-Jk8YAWGN.js","SectionHeading-nLgrCDOg.js","axios-vUo_bRtp.js","Markdown-_QGow1Wo.js","AssistantPageLink-DkAyo-p5.js"]}