The natural language query to search with. This cannot exceed 4096 UTF-8 bytes.
k
integer
required
The number of pages to return. If there are not enough pages matching your filters, then fewer may be returned. This number must be between 1 and 1024, inclusive.
filter
stringstring[]any[]object
The query filter to apply. Please read Metadata Filtering for more information. If not provided, then all documents will be searched.
include_content
boolean
default:false
If set to true, then the content of all pages will be returned.
include_metadata
boolean
default:false
Whether or not to include the document metadata in the response. If not provided, then the default will be False.
latency_mode
enum<string>
default:low
This option selects between our two latency modes. The higher latency mode takes longer, but can allow for more accurate responses. If desired, test both to customize your search experience for your particular use-case, or use the default of "low" and only swap if you need an additional improvement in search result quality.
Available options:
low,
high
Response
Successful Response
results
PageRetrievalResponse · object[]
required
Show child attributes
document_results
DocumentRetrievalResponse · object[]
required
The array of associated document information. Note how each result page has an associated document path. After deduplicating the document paths, this array will contain document info for each document path that is referenced by at least one page result.
Show child attributes
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ZeroEntropy","colors":{"primary":"#4594FF","light":"#4594FF","dark":"#4594FF"},"logo":{"light":"https://mintcdn.com/zeroentropy/vsoWdCzEUkYmTkNx/logo/light.svg?fit=max\u0026auto=format\u0026n=vsoWdCzEUkYmTkNx\u0026q=85\u0026s=883fffb78ee34586b7a4f0388d52b135","dark":"https://mintcdn.com/zeroentropy/vsoWdCzEUkYmTkNx/logo/dark.svg?fit=max\u0026auto=format\u0026n=vsoWdCzEUkYmTkNx\u0026q=85\u0026s=5bd022926ce0618ee02fe0091c65ddad","href":"https://www.zeroentropy.dev"},"favicon":"https://mintcdn.com/zeroentropy/vsoWdCzEUkYmTkNx/logo/favicon.svg?fit=max\u0026auto=format\u0026n=vsoWdCzEUkYmTkNx\u0026q=85\u0026s=180816b99903482a5743598ed4ba0205","navbar":{"links":[{"href":"mailto:founders@zeroentropy.dev","label":"Support"},{"href":"https://go.zeroentropy.dev/slack","label":"Community"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.zeroentropy.dev/"}},"footer":{"socials":{"github":"https://github.com/orgs/ZeroEntropy-AI","linkedin":"https://www.linkedin.com/company/zeroentropy-inc"}},"banner":{"content":"🚀 [zembed-1](https://docs.zeroentropy.dev/models#zembed-1) is now generally available through the API, all SDKs, and on the AWS Marketplace!","dismissible":true},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Home page","icon":"house","href":"https://zeroentropy.dev"},{"anchor":"Dashboard","icon":"gauge","href":"https://dashboard.zeroentropy.dev"},{"anchor":"Slack Community","icon":"Slack","href":"https://go.zeroentropy.dev/slack"},{"anchor":"Discord Community","icon":"Discord","href":"https://go.zeroentropy.dev/discord"},{"anchor":"Blog","icon":"newspaper","href":"https://www.zeroentropy.dev/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"zeroentropy","hasAudioNarration":false,"actualSubdomain":"zeroentropy","customDomains":["docs.zeroentropy.dev"],"gitSource":{"type":"github","owner":"zeroentropy-ai","repo":"docs","deployBranch":"master","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae9222b5bfa35cf90449953:success","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":15},{"language":"default","tag":"Documentation","count":12},{"language":"default","tag":"Get Started","count":12},{"language":"default","tag":"Documents","count":6},{"language":"default","tag":"Examples","count":5},{"language":"default","tag":"Queries","count":3},{"language":"default","tag":"Collections","count":3},{"language":"default","tag":"Models","count":2},{"language":"default","tag":"Status","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"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":"editor-metadata","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},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/queries/top-pages","slug":"/api-reference/queries/top-pages","pageMetadata":{"title":"Top Pages","description":"Get the top K pages that match the given query","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /queries/top-pages","href":"/api-reference/queries/top-pages","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: \"Get the top K pages that match the given query\"\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":"Top Pages","description":"Get the top K pages that match the given query","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /queries/top-pages","href":"/api-reference/queries/top-pages","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Queries"],"summary":"Top Pages","description":"Get the top K pages that match the given query","operationId":"top_pages_queries_top_pages_post","requestBody":"83c89408-e73c-402d-8795-590b71e39fda","responses":{"200":"d4f8c102-96a9-4e5c-93bd-c534373f1545","400":"8c57d390-0973-4779-a7de-3cec066accec","404":"c72d9e2a-494b-4a93-9b71-ac6e32458c0e","422":"4d14146a-420a-4172-87cd-35ef73360a84"},"security":["254f283a-1d4a-487e-91a9-49be593190f8"],"method":"post","type":"path","servers":["0cde098e-13a5-4967-a867-cb1c6027236e","378be2ab-b06b-4fad-8ceb-c71a9acec23c"],"path":"/queries/top-pages","baseUrlOptions":["https://api.zeroentropy.dev/v1","https://eu-api.zeroentropy.dev/v1"],"title":"Top Pages","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"properties":{"collection_name":{"type":"string","title":"Collection Name","description":"The name of the collection.","isRequired":true,"uniqueKey":"collection_name","typeLabel":"string"},"query":{"type":"string","title":"Query","description":"The natural language query to search with. This cannot exceed 4096 UTF-8 bytes.","isRequired":true,"uniqueKey":"query","typeLabel":"string"},"k":{"type":"integer","title":"K","description":"The number of pages to return. If there are not enough pages matching your filters, then fewer may be returned. This number must be between 1 and 1024, inclusive.","isRequired":true,"uniqueKey":"k","typeLabel":"integer"},"filter":{"oneOf":[{"type":"string","description":"The query filter to apply. Please read [Metadata Filtering](/metadata-filtering) for more information. If not provided, then all documents will be searched.","uniqueKey":"filter.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"filter.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"The query filter to apply. Please read [Metadata Filtering](/metadata-filtering) for more information. If not provided, then all documents will be searched.","uniqueKey":"filter.oneOf.1","typeLabel":"string[]"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"filter.oneOf.2.items.[INDEX]","typeLabel":"any"},"description":"The query filter to apply. Please read [Metadata Filtering](/metadata-filtering) for more information. If not provided, then all documents will be searched.","uniqueKey":"filter.oneOf.2","typeLabel":"any[]"},{"type":"object","description":"The query filter to apply. Please read [Metadata Filtering](/metadata-filtering) for more information. If not provided, then all documents will be searched.","uniqueKey":"filter.oneOf.3","typeLabel":"object"},{"type":"null","description":"The query filter to apply. Please read [Metadata Filtering](/metadata-filtering) for more information. If not provided, then all documents will be searched.","uniqueKey":"filter.oneOf.4","typeLabel":"null"}],"uniqueKey":"filter","typeLabel":"string | string[] | any[] | object | null"},"include_content":{"type":"boolean","title":"Include Content","description":"If set to true, then the content of all pages will be returned.","default":false,"uniqueKey":"include_content","typeLabel":"boolean"},"include_metadata":{"type":"boolean","title":"Include Metadata","description":"Whether or not to include the document metadata in the response. If not provided, then the default will be `False`.","default":false,"uniqueKey":"include_metadata","typeLabel":"boolean"},"latency_mode":{"type":"string","enum":["low","high"],"title":"Latency Mode","description":"This option selects between our two latency modes. The higher latency mode takes longer, but can allow for more accurate responses. If desired, test both to customize your search experience for your particular use-case, or use the default of \"low\" and only swap if you need an additional improvement in search result quality.","default":"low","uniqueKey":"latency_mode","typeLabel":"enum\u003cstring>"}},"type":"object","required":["collection_name","query","k"],"title":"TopPagesRequest","uniqueKey":"","typeLabel":"TopPagesRequest · object"},"examples":{"Example":{"title":"Example","value":{"collection_name":"\u003cstring>","query":"\u003cstring>","k":123,"filter":"\u003cstring>","include_content":false,"include_metadata":false,"latency_mode":"low"}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"d4f8c102-96a9-4e5c-93bd-c534373f1545":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"results":{"items":{"properties":{"path":{"type":"string","title":"Path","description":"The path of the document that this page comes from.","isRequired":true,"uniqueKey":"results.items.[INDEX].path","typeLabel":"string"},"page_index":{"type":"integer","title":"Page Index","description":"The index of this page in the document. This field is 0-indexed. So, the 1st page has index 0, and the 2nd page has index 1.","isRequired":true,"uniqueKey":"results.items.[INDEX].page_index","typeLabel":"integer"},"score":{"type":"number","title":"Score","description":"The relevancy score assigned to this page.","isRequired":true,"uniqueKey":"results.items.[INDEX].score","typeLabel":"number"},"content":{"oneOf":[{"type":"string","title":"Content","description":"The contents of this page. This property will be null when `include_content` is `false`, and a string when `include_content` is `true`.","isRequired":true,"uniqueKey":"results.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"null","title":"Content","description":"The contents of this page. This property will be null when `include_content` is `false`, and a string when `include_content` is `true`.","isRequired":true,"uniqueKey":"results.items.[INDEX].content.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].content","typeLabel":"string | null"},"image_url":{"oneOf":[{"type":"string","title":"Image Url","description":"A URL to an image of the page. This field will only be provided if the document has finished parsing, and if it is a filetype that is capable of producing images (e.g. PDF, DOCX, PPT, etc). In all other cases, this field will be `null`.\n\nNOTE: If a `/documents/update-document` call returned a new document id, then this url will be invalidated and must be retrieved again.","isRequired":true,"uniqueKey":"results.items.[INDEX].image_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Image Url","description":"A URL to an image of the page. This field will only be provided if the document has finished parsing, and if it is a filetype that is capable of producing images (e.g. PDF, DOCX, PPT, etc). In all other cases, this field will be `null`.\n\nNOTE: If a `/documents/update-document` call returned a new document id, then this url will be invalidated and must be retrieved again.","isRequired":true,"uniqueKey":"results.items.[INDEX].image_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"results.items.[INDEX].image_url","typeLabel":"string | null"}},"type":"object","required":["path","page_index","score","content","image_url"],"title":"PageRetrievalResponse","description":"A Page's metadata.","uniqueKey":"results.items.[INDEX]","typeLabel":"PageRetrievalResponse · object"},"type":"array","title":"Results","isRequired":true,"uniqueKey":"results","typeLabel":"PageRetrievalResponse · object[]"},"document_results":{"items":{"properties":{"path":{"type":"string","title":"Path","description":"The path of the document.","isRequired":true,"uniqueKey":"document_results.items.[INDEX].path","typeLabel":"string"},"score":{"type":"number","title":"Score","description":"The relevancy score assigned to this document.","isRequired":true,"uniqueKey":"document_results.items.[INDEX].score","typeLabel":"number"},"metadata":{"oneOf":[{"type":"object","description":"The metadata for that document. Will be `None` if `include_metadata` is `False`.","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"document_results.items.[INDEX].metadata.oneOf.0.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"string","uniqueKey":"document_results.items.[INDEX].metadata.oneOf.0.additionalProperties.oneOf.1.items.[INDEX]","typeLabel":"string"},"uniqueKey":"document_results.items.[INDEX].metadata.oneOf.0.additionalProperties.oneOf.1","typeLabel":"string[]"}],"uniqueKey":"document_results.items.[INDEX].metadata.oneOf.0.additionalProperties","typeLabel":"string | string[]"},"isRequired":true,"uniqueKey":"document_results.items.[INDEX].metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"The metadata for that document. Will be `None` if `include_metadata` is `False`.","isRequired":true,"uniqueKey":"document_results.items.[INDEX].metadata.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"document_results.items.[INDEX].metadata","typeLabel":"object | null"},"file_url":{"type":"string","title":"File Url","description":"A URL to the document data, which can be used to download the raw document content or to display the document in frontend applications.\n\nNOTE: If a `/documents/update-document` call returned a new document id, then this url will be invalidated and must be retrieved again.","isRequired":true,"uniqueKey":"document_results.items.[INDEX].file_url","typeLabel":"string"}},"type":"object","required":["path","score","metadata","file_url"],"title":"DocumentRetrievalResponse","uniqueKey":"document_results.items.[INDEX]","typeLabel":"DocumentRetrievalResponse · object"},"type":"array","title":"Document Results","description":"The array of associated document information. Note how each result page has an associated document path. After deduplicating the document paths, this array will contain document info for each document path that is referenced by at least one page result.","isRequired":true,"uniqueKey":"document_results","typeLabel":"DocumentRetrievalResponse · object[]"}},"type":"object","required":["results","document_results"],"title":"TopPagesResponse","uniqueKey":"","typeLabel":"TopPagesResponse · object"},"examples":{"Example":{"title":"Example","value":{"results":[{"path":"\u003cstring>","page_index":123,"score":123,"content":"\u003cstring>","image_url":"\u003cstring>"}],"document_results":[{"path":"\u003cstring>","score":123,"metadata":{},"file_url":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"8c57d390-0973-4779-a7de-3cec066accec":{"description":"Bad Request","content":{"application/json":{"example":{"detail":"Description of Error"},"examples":{"Example":{"title":"Example","value":{"detail":"Description of Error"}}},"exampleType":"examples"}},"exampleType":"examples"},"c72d9e2a-494b-4a93-9b71-ac6e32458c0e":{"description":"Not Found","content":{"application/json":{"example":{"detail":"Description of Error"},"examples":{"Example":{"title":"Example","value":{"detail":"Description of Error"}}},"exampleType":"examples"}},"exampleType":"examples"},"4d14146a-420a-4172-87cd-35ef73360a84":{"description":"Validation Error","content":{"application/json":{"schema":{"properties":{"detail":{"items":{"properties":{"loc":{"items":{"oneOf":[{"type":"string","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"integer","uniqueKey":"detail.items.[INDEX].loc.items.[INDEX].oneOf.1","typeLabel":"integer"}],"uniqueKey":"detail.items.[INDEX].loc.items.[INDEX]","typeLabel":"string | integer"},"type":"array","title":"Location","isRequired":true,"uniqueKey":"detail.items.[INDEX].loc","typeLabel":"(string | integer)[]"},"msg":{"type":"string","title":"Message","isRequired":true,"uniqueKey":"detail.items.[INDEX].msg","typeLabel":"string"},"type":{"type":"string","title":"Error Type","isRequired":true,"uniqueKey":"detail.items.[INDEX].type","typeLabel":"string"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError","uniqueKey":"detail.items.[INDEX]","typeLabel":"ValidationError · object"},"type":"array","title":"Detail","uniqueKey":"detail","typeLabel":"ValidationError · object[]"}},"type":"object","title":"HTTPValidationError","uniqueKey":"","typeLabel":"HTTPValidationError · object"},"examples":{"Example":{"title":"Example","value":{"detail":[{"loc":["\u003cstring>"],"msg":"\u003cstring>","type":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"254f283a-1d4a-487e-91a9-49be593190f8":{"HTTPBearer":{"type":"http","description":"The `Authorization` header must be provided in the format `Bearer \u003cyour-api-key>`.\n\nYou can get your API Key at the [Dashboard](https://dashboard.zeroentropy.dev/)!","scheme":"bearer","scopes":[]}}},"servers":{"0cde098e-13a5-4967-a867-cb1c6027236e":{"url":"https://api.zeroentropy.dev/v1","description":"ZeroEntropy API"},"378be2ab-b06b-4fad-8ceb-c71a9acec23c":{"url":"https://eu-api.zeroentropy.dev/v1","description":"ZeroEntropy API (EU datacenters)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","description":"The `Authorization` header must be provided in the format `Bearer \u003cyour-api-key>`.\n\nYou can get your API Key at the [Dashboard](https://dashboard.zeroentropy.dev/)!","scheme":"bearer","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"The `Authorization` header must be provided in the format `Bearer \u003cyour-api-key>`.\n\nYou can get your API Key at the [Dashboard](https://dashboard.zeroentropy.dev/)!","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"HTTPBearer","name":"Authorization"}],"title":"HTTPBearer"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"zeroentropy","siteName":"ZeroEntropy","title":"Top Pages - ZeroEntropy","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-23T21:33:04.656Z","originalFileLocation":"api-reference/queries/top-pages.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=\"Get the top K pages that match the given query\">\u003cmeta data-mint-head name=\"application-name\" content=\"ZeroEntropy\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/zeroentropy/5_rZbyFM3AN4lygt/_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/zeroentropy/5_rZbyFM3AN4lygt/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/zeroentropy/5_rZbyFM3AN4lygt/_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/zeroentropy/5_rZbyFM3AN4lygt/_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/zeroentropy/5_rZbyFM3AN4lygt/_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/zeroentropy/5_rZbyFM3AN4lygt/_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/zeroentropy/5_rZbyFM3AN4lygt/_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/zeroentropy/5_rZbyFM3AN4lygt/_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/zeroentropy/5_rZbyFM3AN4lygt/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Top Pages - ZeroEntropy\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get the top K pages that match the given query\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ZeroEntropy\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.zeroentropy.dev/api-reference/queries/top-pages\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zeroentropy.mintlify.site/_mintlify/api/og/v2?division=Queries\u0026amp;title=Top+Pages\u0026amp;description=Get+the+top+K+pages+that+match+the+given+query\u0026amp;theme=38c1d81a5ac6ecb7f773b329\u0026amp;signature=e9a95b2d22454473fb5aab05dcd1aa20786edba714b46d6a99091f3bd1f65a36\">\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=\"Top Pages - ZeroEntropy\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get the top K pages that match the given query\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zeroentropy.mintlify.site/_mintlify/api/og/v2?division=Queries\u0026amp;title=Top+Pages\u0026amp;description=Get+the+top+K+pages+that+match+the+given+query\u0026amp;theme=38c1d81a5ac6ecb7f773b329\u0026amp;signature=e9a95b2d22454473fb5aab05dcd1aa20786edba714b46d6a99091f3bd1f65a36\">\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/zeroentropy/5_rZbyFM3AN4lygt/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ZeroEntropy\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4594FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.zeroentropy.dev/api-reference/queries/top-pages\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/queries/top-pages.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.zeroentropy.dev/#organization\",\"name\":\"ZeroEntropy\",\"url\":\"https://docs.zeroentropy.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/zeroentropy/vsoWdCzEUkYmTkNx/logo/light.svg?fit=max\u0026auto=format\u0026n=vsoWdCzEUkYmTkNx\u0026q=85\u0026s=883fffb78ee34586b7a4f0388d52b135\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.zeroentropy.dev#website\",\"name\":\"ZeroEntropy\",\"url\":\"https://docs.zeroentropy.dev\",\"publisher\":{\"@id\":\"https://docs.zeroentropy.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.zeroentropy.dev/api-reference/queries/top-pages#webpage\",\"url\":\"https://docs.zeroentropy.dev/api-reference/queries/top-pages\",\"name\":\"Top Pages\",\"description\":\"Get the top K pages that match the given query\",\"dateModified\":\"2026-04-23T21:33:04.656Z\",\"isPartOf\":{\"@id\":\"https://docs.zeroentropy.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.zeroentropy.dev/api-reference/queries/top-pages#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.zeroentropy.dev/api-reference/queries/top-pages#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Queries\",\"item\":\"https://docs.zeroentropy.dev/api-reference/queries/top-documents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Top Pages\",\"item\":\"https://docs.zeroentropy.dev/api-reference/queries/top-pages\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.zeroentropy.dev/api-reference/queries/top-pages#apireference\",\"headline\":\"Top Pages\",\"name\":\"Top Pages\",\"description\":\"Get the top K pages that match the given query\",\"url\":\"https://docs.zeroentropy.dev/api-reference/queries/top-pages\",\"mainEntityOfPage\":{\"@id\":\"https://docs.zeroentropy.dev/api-reference/queries/top-pages#webpage\"},\"dateModified\":\"2026-04-23T21:33:04.656Z\",\"publisher\":{\"@id\":\"https://docs.zeroentropy.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.zeroentropy.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ZeroEntropy\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"ZeroEntropy\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/queries/top-pages.md","siteName":"ZeroEntropy","nav":{"global":{"anchors":[{"anchor":"Home page","icon":"house","href":"https://zeroentropy.dev"},{"anchor":"Dashboard","icon":"gauge","href":"https://dashboard.zeroentropy.dev"},{"anchor":"Slack Community","icon":"Slack","href":"https://go.zeroentropy.dev/slack"},{"anchor":"Discord Community","icon":"Discord","href":"https://go.zeroentropy.dev/discord"},{"anchor":"Blog","icon":"newspaper","href":"https://www.zeroentropy.dev/blog"}]},"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Admin","pages":[]},{"group":"Usage","pages":[]},{"group":"Models","pages":[{"title":"Rerank","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /models/rerank","href":"/api-reference/models/rerank"},{"title":"Embed","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /models/embed","href":"/api-reference/models/embed"}]},{"group":"Status","pages":[{"openapi":"post /status/get-status","title":"Get Status","href":"/api-reference/status/get-status"}]},{"group":"Collections","pages":[{"title":"Add Collection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /collections/add-collection","href":"/api-reference/collections/add-collection"},{"title":"Get Collection List","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /collections/get-collection-list","href":"/api-reference/collections/get-collection-list"},{"title":"Delete Collection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /collections/delete-collection","href":"/api-reference/collections/delete-collection"}]},{"group":"Documents","pages":[{"title":"Add Document","openapi":"POST /documents/add-document","href":"/api-reference/documents/add-document"},{"title":"Update Document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /documents/update-document","href":"/api-reference/documents/update-document"},{"openapi":"post /documents/get-document-info","title":"Get Document Info","href":"/api-reference/documents/get-document-info"},{"openapi":"post /documents/get-document-info-list","title":"Get Document Info List","href":"/api-reference/documents/get-document-info-list"},{"openapi":"post /documents/delete-document","title":"Delete Document","href":"/api-reference/documents/delete-document"},{"title":"Get Page Info","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /documents/get-page-info","href":"/api-reference/documents/get-page-info"}]},{"group":"Queries","pages":[{"openapi":"post /queries/top-documents","title":"Top Documents","description":"Get the top K documents that match the given query","href":"/api-reference/queries/top-documents"},{"title":"Top Pages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /queries/top-pages","href":"/api-reference/queries/top-pages"},{"openapi":"post /queries/top-snippets","title":"Top Snippets","description":"Get the top K snippets that match the given query.\n\nYou may choose between coarse and precise snippets. Precise snippets will average ~200 characters, while coarse snippets will average ~2000 characters. The default is coarse snippets. Use the `precise_responses` parameter to adjust.","href":"/api-reference/queries/top-snippets"}]}]}]},"basePath":"","title":"Top Pages - ZeroEntropy","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-Dlc3Qr3h.js","dist-D2J8knkn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-Dq9TQuNi.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","AssistantPageLink-BgZ2ThuU.js"]}