Get the top K snippets that match the given query.
You 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.
The number of snippets to return. If there are not enough snippets matching your filters, then fewer may be returned. This number must be between 1 and 128, inclusive.
Enable precise responses. Precise responses will have higher latency, but provide much more precise snippets. When precise_responses is set to true, the responses will average 200 characters. If set to false, the responses will average 2000 characters. The default is false.
If true, the document_results returns will additionally contain document metadata. This is false by default, as returning metadata can add overhead if the amount of data to return is large.
The array of snippets returned by this endpoint. Each snippet result refers to a particular document path, and index range. Note that all documents, regardless of filetype, are converted into UTF-8-encoded strings. The start_index and end_index of a snippet refer to the range of characters in that string, that have been matched by this snippet.
The array of associated document information. Note how each snippet 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 snippet 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":""},"chroma":{"liveDeploymentHistoryId":"6a21e656572b750f6b6f9fab","collectionId":"225e924e-4d36-409f-bad8-21b0833e7a0c","schemaVersion":"v2"},"entitlements":{},"buildId":"6ae9222b5bfa35cf90449953:success","clientVersion":"0.0.4054","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":"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":"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":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/queries/top-snippets","slug":"/api-reference/queries/top-snippets","pageMetadata":{"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"},"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: \"Get the top K snippets that match the given query.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"You 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 \", _jsx(_components.code, {\n children: \"precise_responses\"\n }), \" parameter to adjust.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /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"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Queries"],"summary":"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.","operationId":"top_snippets_queries_top_snippets_post","requestBody":"7ce70228-de2a-4be9-bde0-bd6ee95795f8","responses":{"200":"26447182-de27-4423-a323-917190e8418c","400":"b52e5665-92a0-4697-ac5e-418fef44cb7a","404":"668b6ba6-bad9-4897-89f8-7a1227fa0a53","422":"dc179463-8030-4504-ab8d-52b8f77fe4ad"},"security":["f9467102-1615-40b5-8c24-781745b8ff65"],"method":"post","type":"path","servers":["0cde098e-13a5-4967-a867-cb1c6027236e","378be2ab-b06b-4fad-8ceb-c71a9acec23c"],"path":"/queries/top-snippets","baseUrlOptions":["https://api.zeroentropy.dev/v1","https://eu-api.zeroentropy.dev/v1"],"title":"Top Snippets","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 characters (A single UTF-8 codepoint, is considered to be 1 character).","isRequired":true,"uniqueKey":"query","typeLabel":"string"},"k":{"type":"integer","title":"K","description":"The number of snippets to return. If there are not enough snippets matching your filters, then fewer may be returned. This number must be between 1 and 128, inclusive.","isRequired":true,"uniqueKey":"k","typeLabel":"integer"},"reranker":{"oneOf":[{"type":"string","title":"Reranker","description":"The reranker to use after initial retrieval. The default is `null`. You can find available model ids, along with more information, at [/models/rerank](/api-reference/models/rerank).","uniqueKey":"reranker.oneOf.0","typeLabel":"string"},{"type":"null","title":"Reranker","description":"The reranker to use after initial retrieval. The default is `null`. You can find available model ids, along with more information, at [/models/rerank](/api-reference/models/rerank).","uniqueKey":"reranker.oneOf.1","typeLabel":"null"}],"uniqueKey":"reranker","typeLabel":"string | null"},"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"},"precise_responses":{"type":"boolean","title":"Precise Responses","description":"Enable precise responses. Precise responses will have higher latency, but provide much more precise snippets. When `precise_responses` is set to `true`, the responses will average 200 characters. If set to `false`, the responses will average 2000 characters. The default is `false`.","default":false,"uniqueKey":"precise_responses","typeLabel":"boolean"},"include_document_metadata":{"type":"boolean","title":"Include Document Metadata","description":"If true, the `document_results` returns will additionally contain document metadata. This is false by default, as returning metadata can add overhead if the amount of data to return is large.","default":false,"uniqueKey":"include_document_metadata","typeLabel":"boolean"}},"type":"object","required":["collection_name","query","k"],"title":"TopSnippetsRequest","uniqueKey":"","typeLabel":"TopSnippetsRequest · object"},"examples":{"Example":{"title":"Example","value":{"collection_name":"\u003cstring>","query":"\u003cstring>","k":123,"reranker":"\u003cstring>","filter":"\u003cstring>","precise_responses":false,"include_document_metadata":false}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"26447182-de27-4423-a323-917190e8418c":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"results":{"items":{"properties":{"path":{"type":"string","title":"Path","description":"The path of the document that this snippet comes from.","isRequired":true,"uniqueKey":"results.items.[INDEX].path","typeLabel":"string"},"start_index":{"type":"integer","title":"Start Index","description":"The start index of this snippet.","isRequired":true,"uniqueKey":"results.items.[INDEX].start_index","typeLabel":"integer"},"end_index":{"type":"integer","title":"End Index","description":"The end index of this snippet.","isRequired":true,"uniqueKey":"results.items.[INDEX].end_index","typeLabel":"integer"},"page_span":{"type":"object","_tupleOriginal":true,"properties":{"[0]":{"type":"integer","uniqueKey":"results.items.[INDEX].page_span.[0]","typeLabel":"integer"},"[1]":{"type":"integer","uniqueKey":"results.items.[INDEX].page_span.[1]","typeLabel":"integer"}},"title":"Page Span","description":"The range of page indices spanned by this snippet, as a 2-tuple of integers. Inclusive on the first page_index and exclusive on the second page_index.","isRequired":true,"uniqueKey":"results.items.[INDEX].page_span","typeLabel":"Page Span · tuple"},"content":{"type":"string","title":"Content","description":"The full string content of this snippet.","isRequired":true,"uniqueKey":"results.items.[INDEX].content","typeLabel":"string"},"score":{"type":"number","title":"Score","description":"The relevancy score assigned to this snippet.","isRequired":true,"uniqueKey":"results.items.[INDEX].score","typeLabel":"number"}},"type":"object","required":["path","start_index","end_index","page_span","content","score"],"title":"SnippetResponse","description":"This is a Snippet.\n\nA snippet refers to a particular document path, and index range. Note that all documents, regardless of filetype, are converted into `UTF-8`-encoded strings. The `start_index` and `end_index` refer to the range of characters in that string, that have been matched by this snippet.","uniqueKey":"results.items.[INDEX]","typeLabel":"SnippetResponse · object"},"type":"array","title":"Results","description":"The array of snippets returned by this endpoint. Each snippet result refers to a particular document path, and index range. Note that all documents, regardless of filetype, are converted into `UTF-8`-encoded strings. The `start_index` and `end_index` of a snippet refer to the range of characters in that string, that have been matched by this snippet.","isRequired":true,"uniqueKey":"results","typeLabel":"SnippetResponse · 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 snippet 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 snippet result.","isRequired":true,"uniqueKey":"document_results","typeLabel":"DocumentRetrievalResponse · object[]"}},"type":"object","required":["results","document_results"],"title":"TopSnippetsResponse","uniqueKey":"","typeLabel":"TopSnippetsResponse · object"},"examples":{"Example":{"title":"Example","value":{"results":[{"path":"\u003cstring>","start_index":123,"end_index":123,"page_span":[123,123],"content":"\u003cstring>","score":123}],"document_results":[{"path":"\u003cstring>","score":123,"metadata":{},"file_url":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"},"b52e5665-92a0-4697-ac5e-418fef44cb7a":{"description":"Bad Request","content":{"application/json":{"example":{"detail":"Description of Error"},"examples":{"Example":{"title":"Example","value":{"detail":"Description of Error"}}},"exampleType":"examples"}},"exampleType":"examples"},"668b6ba6-bad9-4897-89f8-7a1227fa0a53":{"description":"Not Found","content":{"application/json":{"example":{"detail":"Description of Error"},"examples":{"Example":{"title":"Example","value":{"detail":"Description of Error"}}},"exampleType":"examples"}},"exampleType":"examples"},"dc179463-8030-4504-ab8d-52b8f77fe4ad":{"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":{"f9467102-1615-40b5-8c24-781745b8ff65":{"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 Snippets - ZeroEntropy","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-23T21:33:04.668Z","originalFileLocation":"api-reference/queries/top-snippets.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 snippets that match the given query. You 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.\">\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 Snippets - ZeroEntropy\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get the top K snippets that match the given query. You 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.\">\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-snippets\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://zeroentropy.mintlify.app/_mintlify/api/og/v2?division=Queries\u0026amp;title=Top+Snippets\u0026amp;description=Get+the+top+K+snippets+that+match+the+given+query.%0A%0AYou+may+choose+between+coarse+and+precise+snippets.+Precise+snippets+will+average+%7E200+characters%2C+while+coa\u0026amp;theme=c9ad13182ecba320a6704ed8\u0026amp;signature=8731f66580ee1d28ba0cdff37eb71414a98aa21ba201038bf1bdbcc622a6a859\">\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 Snippets - ZeroEntropy\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get the top K snippets that match the given query. You 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.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://zeroentropy.mintlify.app/_mintlify/api/og/v2?division=Queries\u0026amp;title=Top+Snippets\u0026amp;description=Get+the+top+K+snippets+that+match+the+given+query.%0A%0AYou+may+choose+between+coarse+and+precise+snippets.+Precise+snippets+will+average+%7E200+characters%2C+while+coa\u0026amp;theme=c9ad13182ecba320a6704ed8\u0026amp;signature=8731f66580ee1d28ba0cdff37eb71414a98aa21ba201038bf1bdbcc622a6a859\">\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-snippets\">\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-snippets.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-snippets#webpage\",\"url\":\"https://docs.zeroentropy.dev/api-reference/queries/top-snippets\",\"name\":\"Top Snippets\",\"description\":\"Get the top K snippets that match the given query. You 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.\",\"dateModified\":\"2026-04-23T21:33:04.668Z\",\"isPartOf\":{\"@id\":\"https://docs.zeroentropy.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.zeroentropy.dev/api-reference/queries/top-snippets#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.zeroentropy.dev/api-reference/queries/top-snippets#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Queries\",\"item\":\"https://docs.zeroentropy.dev/api-reference/queries/top-documents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Top Snippets\",\"item\":\"https://docs.zeroentropy.dev/api-reference/queries/top-snippets\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.zeroentropy.dev/api-reference/queries/top-snippets#apireference\",\"headline\":\"Top Snippets\",\"name\":\"Top Snippets\",\"description\":\"Get the top K snippets that match the given query. You 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.\",\"url\":\"https://docs.zeroentropy.dev/api-reference/queries/top-snippets\",\"mainEntityOfPage\":{\"@id\":\"https://docs.zeroentropy.dev/api-reference/queries/top-snippets#webpage\"},\"dateModified\":\"2026-04-23T21:33:04.668Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","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","href":"/api-reference/queries/top-documents"},{"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"},{"openapi":"post /queries/top-snippets","title":"Top Snippets","href":"/api-reference/queries/top-snippets"}]}]}]},"basePath":"","title":"Top Snippets - ZeroEntropy","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["10e4515597","c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["BannerMarkdown-DIeMibn4.js","dist-DJnKvr0g.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","clsx-B2v50t8t.js","html-void-elements-mCSPHezU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-C8RPHPxo.js","utils-0BK-9q6z.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B4v9psJ4.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-BNP-Fvr0.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","Page-Buji1S4J.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js","Markdown-h4cOoD8d.js","AssistantPageLink-BHrrjR1K.js"]}