{
"message": "The Authorization header is missing. It must use the bearer authorization method.",
"code": "missing_authorization_header",
"type": "auth",
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}
Multi-search
Perform a multi-search
Run multiple search queries in a single API request.
Each query can target a different index, so you can search across several indexes at once and get one combined response.
Warning: If Meilisearch encounters an error processing any query in the request, it immediately
stops and returns an error message for the first error encountered. Partial results are not returned.
{
"message": "The Authorization header is missing. It must use the bearer authorization method.",
"code": "missing_authorization_header",
"type": "auth",
"link": "https://docs.meilisearch.com/errors#missing_authorization_header"
}
If you use a SDK, ensure you instantiate the client with the API key, for instance with JS SDK:
const client = new MeiliSearch({ host: 'MEILISEARCH_URL', apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1' });
Body
application/json
Request body for federated multi-search across multiple indexes. This
allows you to execute multiple search queries in a single request and
optionally combine their results into a unified response. Use this for
cross-index search scenarios or to reduce network round-trips.
An array of search queries to execute. Each query can target a
different index and have its own parameters. When federation is
null, results are returned separately for each query. When
federation is set, results are merged.
Each query object must include indexUid to specify which index to search.
Configuration for combining results from multiple queries into a
single response. When set, results are merged and ranked together.
When null, each query's results are returned separately in an
array.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Meilisearch Documentation","colors":{"primary":"#FF5CB2","light":"#FF5CB2","dark":"#FF5CB2"},"logo":{"light":"https://mintcdn.com/meilisearch-6b28dec2/YRn82YKcWv02OWrg/assets/repo/meilisearch-logo-light.svg?fit=max\u0026auto=format\u0026n=YRn82YKcWv02OWrg\u0026q=85\u0026s=331f9ce2d1f557db3b679795f4707aa5","dark":"https://mintcdn.com/meilisearch-6b28dec2/YRn82YKcWv02OWrg/assets/repo/meilisearch-logo-dark.svg?fit=max\u0026auto=format\u0026n=YRn82YKcWv02OWrg\u0026q=85\u0026s=81634cdd715f6f159c69841b5d539d5a"},"favicon":"https://mintcdn.com/meilisearch-6b28dec2/YRn82YKcWv02OWrg/assets/repo/favicon.svg?fit=max\u0026auto=format\u0026n=YRn82YKcWv02OWrg\u0026q=85\u0026s=33f47c7e13dd4d7005f570f6299328a5","api":{"playground":{"display":"simple"}},"appearance":{"default":"dark"},"background":{"decoration":"grid","color":{"light":"#F7F7F7","dark":"#1A003B"}},"navbar":{"links":[{"href":"https://www.meilisearch.com","label":"Website"},{"href":"https://github.com/meilisearch/meilisearch","label":"GitHub"},{"href":"https://discord.meilisearch.com/","label":"Discord"}],"primary":{"type":"button","label":"Start a trial","href":"https://cloud.meilisearch.com"}},"footer":{"socials":{"x":"https://x.com/meilisearch","github":"https://github.com/meilisearch","linkedin":"https://www.linkedin.com/company/meilisearch","website":"https://www.meilisearch.com"},"links":[{"header":"Product","items":[{"label":"Meilisearch Cloud","href":"https://www.meilisearch.com/cloud"},{"label":"AI search","href":"https://www.meilisearch.com/solutions/hybrid-search"},{"label":"Pricing","href":"https://www.meilisearch.com/pricing"},{"label":"Documentation","href":"https://www.meilisearch.com/docs"},{"label":"Roadmap","href":"https://roadmap.meilisearch.com"},{"label":"Release notes","href":"https://updates.cloud.meilisearch.com/"},{"label":"Comparisons","href":"https://www.meilisearch.com/docs/resources/comparisons/alternatives"},{"label":"Trust center","href":"https://trust.meilisearch.com/"}]},{"header":"Contact us","items":[{"label":"GitHub","href":"https://github.com/meilisearch"},{"label":"Discord","href":"https://discord.gg/meilisearch"},{"label":"Newsletter","href":"https://share-eu1.hsforms.com/1LN5N0x_GQgq7ss7tXmSykwfg3aq"},{"label":"Helpdesk","href":"https://help.meilisearch.com/"}]},{"header":"Company","items":[{"label":"Blog","href":"https://meilisearch.com/blog"},{"label":"Customers","href":"https://www.meilisearch.com/customers"},{"label":"Careers","href":"https://www.meilisearch.com/careers"},{"label":"Code of Conduct","href":"https://github.com/meilisearch/MeiliSearch/blob/main/CODE_OF_CONDUCT.md"},{"label":"Privacy Policy","href":"https://www.meilisearch.com/privacy-policy"},{"label":"Terms of Use","href":"https://www.meilisearch.com/terms-of-use"},{"label":"Swag","href":"https://swag.meilisearch.com/"}]}]},"seo":{"metatags":{"canonical":"https://www.meilisearch.com/docs"}},"integrations":{"fathom":{"siteId":"QNBPJXIV"},"gtm":{"tagId":"GTM-TNSCGVBH"},"posthog":{"apiKey":"phc_D5VtJkw6WyBzLtZ5tBvwR7ac4LvQZdFGYQTQfegRjh9n","apiHost":"https://t.meilisearch.com","sessionRecording":true},"segment":{"key":"KIC0Lcb5C9ssRY79dUKPOK8Wq6wLHiUP"}},"contextual":{"options":["copy","view","chatgpt","claude","cursor"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"meilisearch-6b28dec2","hasAudioNarration":false,"actualSubdomain":"meilisearch-6b28dec2","customDomains":["www.meilisearch.com","meilisearch.dev"],"gitSource":{"type":"github","owner":"meilisearch","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae1c4838e4709662983cc24","collectionId":"668baffb-e41e-4284-8a34-083961efc684","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae1c4838e4709662983cc24"},"feedback":{"thumbs":true,"edits":true,"issues":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae4d82d6d11d33003dd1ea2","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Capabilities","count":168},{"language":"default","tag":"Reference","count":150},{"language":"default","tag":"API Routes","count":143},{"language":"default","tag":"Resources","count":89},{"language":"default","tag":"Settings","count":69},{"language":"default","tag":"How to","count":62},{"language":"default","tag":"Getting started","count":52},{"language":"default","tag":"Advanced","count":30},{"language":"default","tag":"Self-hosting","count":29},{"language":"default","tag":"Platform","count":27}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".dark\\:text-gray-400:is(.dark *){color:rgb(var(--gray-300))}#navigation-items h5{text-transform:uppercase}.callout h2,.callout h3,.callout h4,.callout h5,.callout h6{color:inherit}.noticeTag{color:rgb(var(--primary-light));border:1px solid rgb(var(--primary-light));padding:0 .5em;margin-left:.25em;display:inline-block;border-radius:5px;font-size:.8em}.routeHighlighter{--route-highlighter-color:rgba(100, 100, 100, 0.35);display:flex;border-radius:.375rem;border:1px var(--route-highlighter-color) solid;padding:1rem;gap:2rem;align-items:center;overflow:scroll}.routeHighlighter--GET{--route-highlighter-color:oklch(0.792 0.209 151.711)}.routeHighlighter--POST{--route-highlighter-color:oklch(0.623 0.214 259.815)}.routeHighlighter--DELETE{--route-highlighter-color:oklch(63.7% 0.237 25.331)}.routeHighlighter--PATCH,.routeHighlighter--PUT{--route-highlighter-color:oklch(0.828 0.189 84.429)}.routeHighlighter__method{font-weight:700;color:var(--route-highlighter-color)}.routeHighlighter__path{font-family:var(--font-jetbrains-mono),ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,\"Liberation Mono\",\"Courier New\",monospace}"},{"filePath":"meilisearch-search-bar.css","content":".meilisearch-bar-container{max-width:480px;width:100%;margin:0 auto;padding:0 10px}.meilisearch-search-bar{background-color:#fff;color:rgba(25,25,25,.7);border:1px solid rgba(255,255,255,.1);display:flex;align-items:center;border-radius:12px;padding:8px 16px;cursor:pointer;width:100%;transition:all .2s ease;backdrop-filter:blur(8px);font-size:14px}.dark .meilisearch-search-bar{background-color:rgba(25,17,53,.5);color:rgba(255,255,255,.7);border:1px solid rgba(255,255,255,.1)}.meilisearch-search-bar__text{flex-grow:1}.meilisearch-search-bar__shortcut{opacity:.7;font-size:12px}.meilisearch-flexwrapper{display:flex;justify-content:center;align-items:center;width:100%}.meilisearch-modal-overlay{position:fixed;top:0;left:0;width:100%;height:100%;backdrop-filter:blur(8px);background-color:rgba(0,0,0,.4);z-index:9999;display:none;align-items:flex-start;justify-content:center;padding-top:0;box-sizing:border-box}.meilisearch-modal{background-color:#fff;border:1px solid rgba(0,0,0,.5);width:600px;max-width:90%;max-height:80vh;margin-top:70px;border-radius:12px;box-shadow:0 8px 32px rgba(0,0,0,.3);display:flex;flex-direction:column;overflow:hidden}.dark .meilisearch-modal{background-color:#1a1033;border:1px solid rgba(255,255,255,.1)}.meilisearch-modal__input-container{display:flex;align-items:center;padding:16px 20px;border-bottom:1px solid rgba(0,0,0,.1)}.dark .meilisearch-modal__input-container{border-bottom:1px solid rgba(255,255,255,.1)}.meilisearch-modal__input{background:0 0;border:0;font-size:16px;outline:0;width:100%;margin-right:10px;color:rgb(var(--gray-700))}.dark .meilisearch-modal__input{color:rgb(var(--gray-100))}.meilisearch-modal__escape{font-size:12px;padding:4px 8px;border-radius:4px;margin-left:auto;background-color:rgba(0,0,0,.1)}.dark .meilisearch-modal__escape{color:rgba(255,255,255,.5);background-color:rgba(255,255,255,.1)}.meilisearch-modal__results{flex-grow:1;overflow-y:auto;padding:0}.meilisearch-modal__indicator{padding:20px;text-align:center}.dark .meilisearch-modal__indicator{color:rgba(255,255,255,.7)}.meilisearch-modal__result{display:block;padding:12px 20px;text-decoration:none;border-left:3px solid transparent;transition:background-color .2s,border-color .2s}.dark .meilisearch-modal__result{color:#fff}.meilisearch-modal__result:hover{background-color:rgba(0,0,0,.05);border-left-color:#f472b6}.dark .meilisearch-modal__result:hover{background-color:rgba(255,255,255,.05)}.meilisearch-modal__category-header{padding:12px 20px 8px;font-size:14px;font-weight:600;text-transform:uppercase;color:rgba(0,0,0,.45)}.dark .meilisearch-modal__category-header{color:rgba(255,255,255,.5)}.meilisearch-modal__result-heading{font-weight:500;margin-bottom:4px}.meilisearch-modal__result-content{font-size:13px;color:rgba(0,0,0,.45)}.dark .meilisearch-modal__result-content{color:rgba(255,255,255,.6)}.meilisearch-modal__category-em{font-style:normal;color:#f472b6;font-weight:700}.meilisearch-modal__error{padding:20px;text-align:center;color:#f87171}.meilisearch-filter-container{padding:16px 20px;border-bottom:1px solid rgba(0,0,0,.1);background-color:rgba(0,0,0,.02)}.dark .meilisearch-filter-container{border-bottom:1px solid rgba(255,255,255,.1);background-color:rgba(255,255,255,.02)}.meilisearch-filter-title{font-size:14px;font-weight:500;color:rgba(0,0,0,.7);margin-bottom:12px}.dark .meilisearch-filter-title{color:rgba(255,255,255,.7)}.meilisearch-filter-tags{display:flex;flex-wrap:wrap;gap:8px}.meilisearch-filter-tag{background-color:rgba(0,0,0,.05);border:1px solid rgba(0,0,0,.1);border-radius:6px;padding:6px 12px;font-size:13px;font-weight:500;color:rgba(0,0,0,.7);cursor:pointer;transition:all .2s ease;text-transform:capitalize}.dark .meilisearch-filter-tag{background-color:rgba(255,255,255,.05);border:1px solid rgba(255,255,255,.1);color:rgba(255,255,255,.7)}.meilisearch-filter-tag:hover{background-color:rgba(0,0,0,.1);border-color:rgba(0,0,0,.2)}.dark .meilisearch-filter-tag:hover{background-color:rgba(255,255,255,.1);border-color:rgba(255,255,255,.2)}.meilisearch-filter-tag.active{background-color:#f472b6;border-color:#f472b6;color:#fff}.meilisearch-filter-tag.active:hover{background-color:#cb4d86;border-color:#cb4d86}"}],"page":{"pagePath":"reference/api/multi-search/perform-a-multi-search","slug":"/reference/api/multi-search/perform-a-multi-search","pageMetadata":{"title":"Perform a multi-search","description":"Run multiple search queries in a single API request.\n\nEach query can target a different index, so you can search across several indexes at once and get one combined response.\n\n**Warning:** If Meilisearch encounters an error processing any query in the request, it immediately\nstops and returns an error message for the first error encountered. Partial results are not returned.","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /multi-search","href":"/reference/api/multi-search/perform-a-multi-search","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Run multiple search queries in a single API request.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Each query can target a different index, so you can search across several indexes at once and get one combined response.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Warning:\"\n }), \" If Meilisearch encounters an error processing any query in the request, it immediately\\nstops and returns an error message for the first error encountered. Partial results are not returned.\"]\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":{"title":"Perform a multi-search","description":"Run multiple search queries in a single API request.\n\nEach query can target a different index, so you can search across several indexes at once and get one combined response.\n\n**Warning:** If Meilisearch encounters an error processing any query in the request, it immediately\nstops and returns an error message for the first error encountered. Partial results are not returned.","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /multi-search","href":"/reference/api/multi-search/perform-a-multi-search","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/docs/_mintlify/custom/meilisearch-6b28dec2/c598d5c5cb296702/search.js","/docs/_mintlify/custom/meilisearch-6b28dec2/92f00249b2342156/cookieyes-banner.js","/docs/_mintlify/custom/meilisearch-6b28dec2/7302b02a474aa050/fathom-data-attr.js","/docs/_mintlify/custom/meilisearch-6b28dec2/85493af1bed6e7fb/gtm.js"],"openApiReferenceData":{"operation":{"tags":["Multi-search"],"summary":"Perform a multi-search","description":"Run multiple search queries in a single API request.\n\nEach query can target a different index, so you can search across several indexes at once and get one combined response.\n\n**Warning:** If Meilisearch encounters an error processing any query in the request, it immediately\nstops and returns an error message for the first error encountered. Partial results are not returned.","operationId":"multi_search_with_post","requestBody":"72cfa830-c083-439e-b114-4847ac789457","responses":{"200":"fbe9a8d4-cfab-4afd-8de1-93412d8aeb95","401":"9e539e98-61e6-4f93-9b34-705a6ef5d13c"},"security":["421a27cd-04f3-40ca-a70f-35d362031e31"],"x-codeSamples":[{"lang":"cURL","source":"curl \\\n -X POST 'MEILISEARCH_URL/multi-search' \\\n -H 'Authorization: Bearer API_KEY' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"queries\": [\n {\n \"indexUid\": \"movies\",\n \"q\": \"pooh\",\n \"limit\": 5\n },\n {\n \"indexUid\": \"movies\",\n \"q\": \"nemo\",\n \"limit\": 5\n },\n {\n \"indexUid\": \"movie_ratings\",\n \"q\": \"us\"\n }\n ]\n }'"},{"lang":"JS","source":"client.multiSearch({ queries: [\n {\n indexUid: 'movies',\n q: 'pooh',\n limit: 5,\n },\n {\n indexUid: 'movies',\n q: 'nemo',\n limit: 5,\n },\n {\n indexUid: 'movie_ratings',\n q: 'us',\n },\n]})"},{"lang":"PHP","source":"$client->multiSearch([\n (new SearchQuery())\n ->setIndexUid('movies')\n ->setQuery('pooh')\n ->setLimit(5),\n (new SearchQuery())\n ->setIndexUid('movies')\n ->setQuery('nemo')\n ->setLimit(5),\n (new SearchQuery())\n ->setIndexUid('movie_ratings')\n ->setQuery('us')\n ]);"},{"lang":"Python","source":"client.multi_search(\n [\n {'indexUid': 'movies', 'q': 'pooh', 'limit': 5},\n {'indexUid': 'movies', 'q': 'nemo', 'limit': 5},\n {'indexUid': 'movie_ratings', 'q': 'us'}\n ]\n)"},{"lang":"Java","source":"MultiSearchRequest multiSearchRequest = new MultiSearchRequest();\nmultiIndexSearch.addQuery(new IndexSearchRequest(\"movies\").setQuery(\"pooh\").setLimit(5));\nmultiIndexSearch.addQuery(new IndexSearchRequest(\"movies\").setQuery(\"nemo\").setLimit(5));\nmultiIndexSearch.addQuery(new IndexSearchRequest(\"movie_ratings\").setQuery(\"us\"));\n\nclient.multiSearch(multiSearchRequest);"},{"lang":"Ruby","source":"client.multi_search([\n { index_uid: 'books', q: 'prince' },\n { index_uid: 'movies', q: 'pooh', limit: 5 }\n { index_uid: 'movies', q: 'nemo', limit: 5 }\n { index_uid: 'movie_ratings', q: 'us' }\n])"},{"lang":"Go","source":"client.MultiSearch(\u0026MultiSearchRequest{\n Queries: []SearchRequest{\n {\n IndexUID: \"movies\",\n Query: \"pooh\",\n Limit: 5,\n },\n {\n IndexUID: \"movies\",\n Query: \"nemo\",\n Limit: 5,\n },\n {\n IndexUID: \"movie_ratings\",\n Query: \"us\",\n },\n },\n})"},{"lang":"C#","source":"await client.MultiSearchAsync(new MultiSearchQuery()\n{\n Queries = new System.Collections.Generic.List\u003cSearchQuery>()\n {\n new SearchQuery() {\n IndexUid = \"movies\",\n Q = \"booh\",\n Limit = 5\n },\n new SearchQuery() {\n IndexUid = \"movies\",\n Q = \"nemo\",\n Limit = 5\n },\n new SearchQuery() {\n IndexUid = \"movie_ratings\",\n Q = \"us\",\n },\n }\n});"},{"lang":"Rust","source":"let movie = client.index(\"movie\");\nlet movie_ratings = client.index(\"movie_ratings\");\n\nlet search_query_1 = SearchQuery::new(\u0026movie)\n .with_query(\"pooh\")\n .with_limit(5)\n .build();\nlet search_query_2 = SearchQuery::new(\u0026movie)\n .with_query(\"nemo\")\n .with_limit(5)\n .build();\nlet search_query_3 = SearchQuery::new(\u0026movie_ratings)\n .with_query(\"us\")\n .build();\n\nlet response = client\n .multi_search()\n .with_search_query(search_query_1)\n .with_search_query(search_query_2)\n .with_search_query(search_query_3)\n .execute::\u003cDocument>()\n .await\n .unwrap();"},{"lang":"Dart","source":"await client.multiSearch(MultiSearchQuery(queries: [\n IndexSearchQuery(query: 'pooh', indexUid: 'movies', limit: 5),\n IndexSearchQuery(query: 'nemo', indexUid: 'movies', limit: 5),\n IndexSearchQuery(query: 'us', indexUid: 'movies_ratings'),\n]));"}],"method":"post","type":"path","servers":["bdde1061-cfb1-4636-a2c9-40d85a2fd614"],"path":"/multi-search","baseUrlOptions":["http://localhost:7700"],"title":"Perform a multi-search","codeSamples":[{"lang":"cURL","source":"curl \\\n -X POST 'MEILISEARCH_URL/multi-search' \\\n -H 'Authorization: Bearer API_KEY' \\\n -H 'Content-Type: application/json' \\\n --data-binary '{\n \"queries\": [\n {\n \"indexUid\": \"movies\",\n \"q\": \"pooh\",\n \"limit\": 5\n },\n {\n \"indexUid\": \"movies\",\n \"q\": \"nemo\",\n \"limit\": 5\n },\n {\n \"indexUid\": \"movie_ratings\",\n \"q\": \"us\"\n }\n ]\n }'"},{"lang":"JS","source":"client.multiSearch({ queries: [\n {\n indexUid: 'movies',\n q: 'pooh',\n limit: 5,\n },\n {\n indexUid: 'movies',\n q: 'nemo',\n limit: 5,\n },\n {\n indexUid: 'movie_ratings',\n q: 'us',\n },\n]})"},{"lang":"PHP","source":"$client->multiSearch([\n (new SearchQuery())\n ->setIndexUid('movies')\n ->setQuery('pooh')\n ->setLimit(5),\n (new SearchQuery())\n ->setIndexUid('movies')\n ->setQuery('nemo')\n ->setLimit(5),\n (new SearchQuery())\n ->setIndexUid('movie_ratings')\n ->setQuery('us')\n ]);"},{"lang":"Python","source":"client.multi_search(\n [\n {'indexUid': 'movies', 'q': 'pooh', 'limit': 5},\n {'indexUid': 'movies', 'q': 'nemo', 'limit': 5},\n {'indexUid': 'movie_ratings', 'q': 'us'}\n ]\n)"},{"lang":"Java","source":"MultiSearchRequest multiSearchRequest = new MultiSearchRequest();\nmultiIndexSearch.addQuery(new IndexSearchRequest(\"movies\").setQuery(\"pooh\").setLimit(5));\nmultiIndexSearch.addQuery(new IndexSearchRequest(\"movies\").setQuery(\"nemo\").setLimit(5));\nmultiIndexSearch.addQuery(new IndexSearchRequest(\"movie_ratings\").setQuery(\"us\"));\n\nclient.multiSearch(multiSearchRequest);"},{"lang":"Ruby","source":"client.multi_search([\n { index_uid: 'books', q: 'prince' },\n { index_uid: 'movies', q: 'pooh', limit: 5 }\n { index_uid: 'movies', q: 'nemo', limit: 5 }\n { index_uid: 'movie_ratings', q: 'us' }\n])"},{"lang":"Go","source":"client.MultiSearch(\u0026MultiSearchRequest{\n Queries: []SearchRequest{\n {\n IndexUID: \"movies\",\n Query: \"pooh\",\n Limit: 5,\n },\n {\n IndexUID: \"movies\",\n Query: \"nemo\",\n Limit: 5,\n },\n {\n IndexUID: \"movie_ratings\",\n Query: \"us\",\n },\n },\n})"},{"lang":"C#","source":"await client.MultiSearchAsync(new MultiSearchQuery()\n{\n Queries = new System.Collections.Generic.List\u003cSearchQuery>()\n {\n new SearchQuery() {\n IndexUid = \"movies\",\n Q = \"booh\",\n Limit = 5\n },\n new SearchQuery() {\n IndexUid = \"movies\",\n Q = \"nemo\",\n Limit = 5\n },\n new SearchQuery() {\n IndexUid = \"movie_ratings\",\n Q = \"us\",\n },\n }\n});"},{"lang":"Rust","source":"let movie = client.index(\"movie\");\nlet movie_ratings = client.index(\"movie_ratings\");\n\nlet search_query_1 = SearchQuery::new(\u0026movie)\n .with_query(\"pooh\")\n .with_limit(5)\n .build();\nlet search_query_2 = SearchQuery::new(\u0026movie)\n .with_query(\"nemo\")\n .with_limit(5)\n .build();\nlet search_query_3 = SearchQuery::new(\u0026movie_ratings)\n .with_query(\"us\")\n .build();\n\nlet response = client\n .multi_search()\n .with_search_query(search_query_1)\n .with_search_query(search_query_2)\n .with_search_query(search_query_3)\n .execute::\u003cDocument>()\n .await\n .unwrap();"},{"lang":"Dart","source":"await client.multiSearch(MultiSearchQuery(queries: [\n IndexSearchQuery(query: 'pooh', indexUid: 'movies', limit: 5),\n IndexSearchQuery(query: 'nemo', indexUid: 'movies', limit: 5),\n IndexSearchQuery(query: 'us', indexUid: 'movies_ratings'),\n]));"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"content":{"application/json":{"schema":{"type":"object","description":"Request body for federated multi-search across multiple indexes. This\nallows you to execute multiple search queries in a single request and\noptionally combine their results into a unified response. Use this for\ncross-index search scenarios or to reduce network round-trips.","required":["queries"],"properties":{"queries":{"type":"array","items":{"type":"object","description":"A `SearchQuery` + an index UID and optional FederationOptions.","required":["indexUid"],"properties":{"indexUid":{"type":"string","example":"movies","description":"Index unique identifier","isRequired":true,"uniqueKey":"queries.items.[INDEX].indexUid","typeLabel":"string"},"q":{"oneOf":[{"type":"string","description":"Query string","uniqueKey":"queries.items.[INDEX].q.oneOf.0","typeLabel":"string"},{"type":"null","description":"Query string","uniqueKey":"queries.items.[INDEX].q.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].q","typeLabel":"string | null"},"offset":{"oneOf":[{"type":"integer","description":"Number of documents to skip","minimum":0,"uniqueKey":"queries.items.[INDEX].offset.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Number of documents to skip","minimum":0,"uniqueKey":"queries.items.[INDEX].offset.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].offset","typeLabel":"integer | null"},"limit":{"oneOf":[{"type":"integer","description":"Maximum number of documents returned","minimum":0,"uniqueKey":"queries.items.[INDEX].limit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Maximum number of documents returned","minimum":0,"uniqueKey":"queries.items.[INDEX].limit.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].limit","typeLabel":"integer | null"},"page":{"oneOf":[{"type":"integer","description":"Request a specific page of results","minimum":0,"uniqueKey":"queries.items.[INDEX].page.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Request a specific page of results","minimum":0,"uniqueKey":"queries.items.[INDEX].page.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].page","typeLabel":"integer | null"},"hitsPerPage":{"oneOf":[{"type":"integer","description":"Maximum number of documents returned for a page","minimum":0,"uniqueKey":"queries.items.[INDEX].hitsPerPage.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Maximum number of documents returned for a page","minimum":0,"uniqueKey":"queries.items.[INDEX].hitsPerPage.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].hitsPerPage","typeLabel":"integer | null"},"attributesToRetrieve":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"queries.items.[INDEX].attributesToRetrieve.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Attributes to display in the returned documents","uniqueItems":true,"uniqueKey":"queries.items.[INDEX].attributesToRetrieve.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Attributes to display in the returned documents","uniqueItems":true,"uniqueKey":"queries.items.[INDEX].attributesToRetrieve.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].attributesToRetrieve","typeLabel":"string[] | null"},"attributesToCrop":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"queries.items.[INDEX].attributesToCrop.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Attributes whose values have to be cropped","uniqueKey":"queries.items.[INDEX].attributesToCrop.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Attributes whose values have to be cropped","uniqueKey":"queries.items.[INDEX].attributesToCrop.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].attributesToCrop","typeLabel":"string[] | null"},"cropLength":{"type":"integer","description":"Maximum length of cropped value in words","minimum":0,"uniqueKey":"queries.items.[INDEX].cropLength","typeLabel":"integer"},"cropMarker":{"type":"string","description":"String marking crop boundaries","uniqueKey":"queries.items.[INDEX].cropMarker","typeLabel":"string"},"attributesToHighlight":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"queries.items.[INDEX].attributesToHighlight.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Highlight matching terms contained in an attribute","uniqueItems":true,"uniqueKey":"queries.items.[INDEX].attributesToHighlight.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Highlight matching terms contained in an attribute","uniqueItems":true,"uniqueKey":"queries.items.[INDEX].attributesToHighlight.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].attributesToHighlight","typeLabel":"string[] | null"},"highlightPreTag":{"type":"string","description":"String inserted at the start of a highlighted term","uniqueKey":"queries.items.[INDEX].highlightPreTag","typeLabel":"string"},"highlightPostTag":{"type":"string","description":"String inserted at the end of a highlighted term","uniqueKey":"queries.items.[INDEX].highlightPostTag","typeLabel":"string"},"showMatchesPosition":{"type":"boolean","description":"Return matching terms location","uniqueKey":"queries.items.[INDEX].showMatchesPosition","typeLabel":"boolean"},"filter":{"description":"Filter queries by an attribute's value","uniqueKey":"queries.items.[INDEX].filter","typeLabel":"any"},"sort":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"queries.items.[INDEX].sort.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Sort search results by an attribute's value","uniqueKey":"queries.items.[INDEX].sort.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Sort search results by an attribute's value","uniqueKey":"queries.items.[INDEX].sort.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].sort","typeLabel":"string[] | null"},"distinct":{"oneOf":[{"type":"string","description":"Restrict search to documents with unique values of specified\nattribute","uniqueKey":"queries.items.[INDEX].distinct.oneOf.0","typeLabel":"string"},{"type":"null","description":"Restrict search to documents with unique values of specified\nattribute","uniqueKey":"queries.items.[INDEX].distinct.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].distinct","typeLabel":"string | null"},"facets":{"oneOf":[{"type":"null","uniqueKey":"queries.items.[INDEX].facets.oneOf.0","typeLabel":"null"},{"type":"array","items":{"type":"string","uniqueKey":"queries.items.[INDEX].facets.oneOf.1.items.[INDEX]","typeLabel":"string"},"description":"Display the count of matches per facet","example":"[\"*\", \"title\", \"description_*\", \"*_date\", \"*content*\"]","uniqueKey":"queries.items.[INDEX].facets.oneOf.1","typeLabel":"string[]"}],"uniqueKey":"queries.items.[INDEX].facets","typeLabel":"null | string[]"},"matchingStrategy":{"type":"string","description":"Strategy used to match query terms within documents","enum":["last","all","frequency"],"uniqueKey":"queries.items.[INDEX].matchingStrategy","typeLabel":"enum\u003cstring>"},"attributesToSearchOn":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"queries.items.[INDEX].attributesToSearchOn.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Restrict search to the specified attributes","uniqueKey":"queries.items.[INDEX].attributesToSearchOn.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Restrict search to the specified attributes","uniqueKey":"queries.items.[INDEX].attributesToSearchOn.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].attributesToSearchOn","typeLabel":"string[] | null"},"rankingScoreThreshold":{"oneOf":[{"type":"number","format":"double","description":"Stop the search at the first document whose [ranking score](https://www.meilisearch.com/docs/learn/relevancy/ranking_score) is below this value (between 0.0 and 1.0).\nAll the documents after this document are excluded from the hits.\n\nExcluded hits do not count toward `estimatedTotalHits`, `totalHits`, or facet distribution.\n\nWhen used together with `page` and `hitsPerPage`, this parameter may reduce performance because Meilisearch must score all matching documents.","uniqueKey":"queries.items.[INDEX].rankingScoreThreshold.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","description":"Stop the search at the first document whose [ranking score](https://www.meilisearch.com/docs/learn/relevancy/ranking_score) is below this value (between 0.0 and 1.0).\nAll the documents after this document are excluded from the hits.\n\nExcluded hits do not count toward `estimatedTotalHits`, `totalHits`, or facet distribution.\n\nWhen used together with `page` and `hitsPerPage`, this parameter may reduce performance because Meilisearch must score all matching documents.","uniqueKey":"queries.items.[INDEX].rankingScoreThreshold.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].rankingScoreThreshold","typeLabel":"number\u003cdouble> | null"},"locales":{"oneOf":[{"type":"array","items":{"type":"string","enum":["af","ak","am","ar","az","be","bn","bg","ca","cs","da","de","cy","el","en","eo","et","fi","fr","gu","he","hi","hr","hu","hy","id","it","jv","ja","kn","ka","km","ko","la","lv","lt","ml","mr","mk","my","ne","nl","nb","or","pa","fa","pl","pt","ro","ru","si","sk","sl","sn","es","sr","sv","ta","te","tl","th","tk","tr","uk","ur","uz","vi","yi","zh","zu","afr","aka","amh","ara","aze","bel","ben","bul","cat","ces","dan","deu","cym","ell","eng","epo","est","fin","fra","guj","heb","hin","hrv","hun","hye","ind","ita","jav","jpn","kan","kat","khm","kor","lat","lav","lit","mal","mar","mkd","mya","nep","nld","nob","ori","pan","pes","pol","por","ron","rus","sin","slk","slv","sna","spa","srp","swe","tam","tel","tgl","tha","tuk","tur","ukr","urd","uzb","vie","yid","zho","zul","cmn"],"uniqueKey":"queries.items.[INDEX].locales.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Languages to use for query tokenization","uniqueKey":"queries.items.[INDEX].locales.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"null","items":{"type":"string","enum":["af","ak","am","ar","az","be","bn","bg","ca","cs","da","de","cy","el","en","eo","et","fi","fr","gu","he","hi","hr","hu","hy","id","it","jv","ja","kn","ka","km","ko","la","lv","lt","ml","mr","mk","my","ne","nl","nb","or","pa","fa","pl","pt","ro","ru","si","sk","sl","sn","es","sr","sv","ta","te","tl","th","tk","tr","uk","ur","uz","vi","yi","zh","zu","afr","aka","amh","ara","aze","bel","ben","bul","cat","ces","dan","deu","cym","ell","eng","epo","est","fin","fra","guj","heb","hin","hrv","hun","hye","ind","ita","jav","jpn","kan","kat","khm","kor","lat","lav","lit","mal","mar","mkd","mya","nep","nld","nob","ori","pan","pes","pol","por","ron","rus","sin","slk","slv","sna","spa","srp","swe","tam","tel","tgl","tha","tuk","tur","ukr","urd","uzb","vie","yid","zho","zul","cmn"]},"description":"Languages to use for query tokenization","uniqueKey":"queries.items.[INDEX].locales.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].locales","typeLabel":"enum\u003cstring>[] | null"},"hybrid":{"oneOf":[{"type":"null","uniqueKey":"queries.items.[INDEX].hybrid.oneOf.0","typeLabel":"null"},{"type":"object","description":"Hybrid search configuration combining keyword and semantic search.\nSet `semanticRatio` to balance between keyword matching (0.0) and\nsemantic similarity (1.0). Requires an embedder to be configured.","required":["embedder"],"properties":{"embedder":{"type":"string","description":"Name of the embedder from the index embedders setting (`embedder` in JSON). Used to vectorize the query.","example":"default","isRequired":true,"uniqueKey":"queries.items.[INDEX].hybrid.oneOf.1.embedder","typeLabel":"string"},"semanticRatio":{"type":"number","format":"float","description":"Balance between keyword (0.0) and semantic (1.0) search.","example":0.5,"uniqueKey":"queries.items.[INDEX].hybrid.oneOf.1.semanticRatio","typeLabel":"number\u003cfloat>"}},"uniqueKey":"queries.items.[INDEX].hybrid.oneOf.1","typeLabel":"object"}],"uniqueKey":"queries.items.[INDEX].hybrid","typeLabel":"null | object"},"vector":{"oneOf":[{"type":"array","items":{"type":"number","format":"float","uniqueKey":"queries.items.[INDEX].vector.oneOf.0.items.[INDEX]","typeLabel":"number\u003cfloat>"},"description":"Search using a custom query vector","uniqueKey":"queries.items.[INDEX].vector.oneOf.0","typeLabel":"number\u003cfloat>[]"},{"type":"null","items":{"type":"number","format":"float"},"description":"Search using a custom query vector","uniqueKey":"queries.items.[INDEX].vector.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].vector","typeLabel":"number\u003cfloat>[] | null"},"retrieveVectors":{"type":"boolean","description":"Return document and query vector data","uniqueKey":"queries.items.[INDEX].retrieveVectors","typeLabel":"boolean"},"media":{"description":"Perform AI-powered search queries with multimodal content","uniqueKey":"queries.items.[INDEX].media","typeLabel":"any"},"personalize":{"oneOf":[{"type":"null","uniqueKey":"queries.items.[INDEX].personalize.oneOf.0","typeLabel":"null"},{"type":"object","description":"Personalize search results","required":["userContext"],"properties":{"userContext":{"type":"string","description":"String describing the user (e.g. preferences, behavior).\n\nUsed to return different results for different profiles.","isRequired":true,"uniqueKey":"queries.items.[INDEX].personalize.oneOf.1.userContext","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"queries.items.[INDEX].personalize.oneOf.1","typeLabel":"object"}],"uniqueKey":"queries.items.[INDEX].personalize","typeLabel":"null | object"},"useNetwork":{"oneOf":[{"type":"boolean","description":"When `true`, runs the query on the whole network (all shards covered exactly once).\n\nWhen `false`, the query runs locally.\n\nWhen omitted or `null`, the default value depends on whether the sharding is enabled for the instance:\n\n- If the instance has sharding enabled (has a leader), defaults to `true`.\n- Otherwise defaults to `false`.\n\nIt also requires the `network` [experimental feature](http://localhost:3000/reference/api/experimental-features/configure-experimental-features).\n\nValues: `true` = use the whole network; `false` = local, default = see above.\n\nWhen using the network, the index must exist with compatible settings on all remotes.","uniqueKey":"queries.items.[INDEX].useNetwork.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"When `true`, runs the query on the whole network (all shards covered exactly once).\n\nWhen `false`, the query runs locally.\n\nWhen omitted or `null`, the default value depends on whether the sharding is enabled for the instance:\n\n- If the instance has sharding enabled (has a leader), defaults to `true`.\n- Otherwise defaults to `false`.\n\nIt also requires the `network` [experimental feature](http://localhost:3000/reference/api/experimental-features/configure-experimental-features).\n\nValues: `true` = use the whole network; `false` = local, default = see above.\n\nWhen using the network, the index must exist with compatible settings on all remotes.","uniqueKey":"queries.items.[INDEX].useNetwork.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].useNetwork","typeLabel":"boolean | null"},"showRankingScore":{"type":"boolean","description":"Display the global ranking score of a document","uniqueKey":"queries.items.[INDEX].showRankingScore","typeLabel":"boolean"},"showRankingScoreDetails":{"type":"boolean","description":"Adds a detailed global ranking score field","uniqueKey":"queries.items.[INDEX].showRankingScoreDetails","typeLabel":"boolean"},"showPerformanceDetails":{"oneOf":[{"type":"boolean","description":"Adds a detailed performance details field","uniqueKey":"queries.items.[INDEX].showPerformanceDetails.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Adds a detailed performance details field","uniqueKey":"queries.items.[INDEX].showPerformanceDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].showPerformanceDetails","typeLabel":"boolean | null"},"federationOptions":{"oneOf":[{"type":"null","uniqueKey":"queries.items.[INDEX].federationOptions.oneOf.0","typeLabel":"null"},{"type":"object","description":"Federation options for multi-index search","properties":{"weight":{"type":"number","format":"double","description":"A multiplicative factor applied to the ranking score for hits from this query.\n\nValues less than 1.0 make hits from this query less likely to appear in final results; values greater than 1.0 make them more likely.\n\nMust be a positive number. Default: `1.0`.","uniqueKey":"queries.items.[INDEX].federationOptions.oneOf.1.weight","typeLabel":"number\u003cdouble>"},"remote":{"oneOf":[{"type":"string","description":"Remote server to send this query to","uniqueKey":"queries.items.[INDEX].federationOptions.oneOf.1.remote.oneOf.0","typeLabel":"string"},{"type":"null","description":"Remote server to send this query to","uniqueKey":"queries.items.[INDEX].federationOptions.oneOf.1.remote.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].federationOptions.oneOf.1.remote","typeLabel":"string | null"},"queryPosition":{"oneOf":[{"type":"integer","description":"Position of this query in the list of queries","minimum":0,"uniqueKey":"queries.items.[INDEX].federationOptions.oneOf.1.queryPosition.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Position of this query in the list of queries","minimum":0,"uniqueKey":"queries.items.[INDEX].federationOptions.oneOf.1.queryPosition.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].federationOptions.oneOf.1.queryPosition","typeLabel":"integer | null"}},"additionalProperties":false,"uniqueKey":"queries.items.[INDEX].federationOptions.oneOf.1","typeLabel":"object"}],"uniqueKey":"queries.items.[INDEX].federationOptions","typeLabel":"null | object"},"inlineRule":{"oneOf":[{"type":"null","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.0","typeLabel":"null"},{"type":"object","description":"An inline [search rule](/capabilities/search_rules/overview) to apply to this query.\n\n- Requires the `dynamicSearchRule` experimental feature\n- Inline rules require the Enterprise Edition of Meilisearch.","required":["uid"],"properties":{"uid":{"type":"string","example":"movies","isRequired":true,"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.uid","typeLabel":"string"},"precedence":{"oneOf":[{"type":"integer","format":"u-int64","minimum":0,"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.precedence.oneOf.0","typeLabel":"integer\u003cu-int64>"},{"type":"null","format":"u-int64","minimum":0,"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.precedence.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.precedence","typeLabel":"integer\u003cu-int64> | null"},"active":{"type":"boolean","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.active","typeLabel":"boolean"},"conditions":{"type":"object","properties":{"time":{"oneOf":[{"type":"null","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.time.oneOf.0","typeLabel":"null"},{"type":"object","description":"Time range where the rule is active","properties":{"start":{"oneOf":[{"type":"string","format":"date-time","description":"Start of the time range where this rule can be considered active.\n\nSpecify as a RFC3339 datetime.","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.time.oneOf.1.start.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Start of the time range where this rule can be considered active.\n\nSpecify as a RFC3339 datetime.","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.time.oneOf.1.start.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.time.oneOf.1.start","typeLabel":"string\u003cdate-time> | null"},"end":{"oneOf":[{"type":"string","format":"date-time","description":"End of the time range where this rule can be considered active.\n\nSpecify as a RFC3339 datetime.","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.time.oneOf.1.end.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"End of the time range where this rule can be considered active.\n\nSpecify as a RFC3339 datetime.","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.time.oneOf.1.end.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.time.oneOf.1.end","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.time.oneOf.1","typeLabel":"object"}],"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.time","typeLabel":"null | object"},"query":{"oneOf":[{"type":"null","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.query.oneOf.0","typeLabel":"null"},{"type":"object","description":"Conditions on the search query that determines whether the rule is active","properties":{"isEmpty":{"oneOf":[{"type":"boolean","description":"If present and non-null, specifies either:\n\n- That this rule can only be active when the search query is empty\n- That this rule can only be active when the search query is non-empty (contains at least one word)","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.query.oneOf.1.isEmpty.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"If present and non-null, specifies either:\n\n- That this rule can only be active when the search query is empty\n- That this rule can only be active when the search query is non-empty (contains at least one word)","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.query.oneOf.1.isEmpty.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.query.oneOf.1.isEmpty","typeLabel":"boolean | null"},"words":{"oneOf":[{"type":"string","description":"If present and non-null, specifies that the rule can only be active if all the specified words are\npresent in the search query.","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.query.oneOf.1.words.oneOf.0","typeLabel":"string"},{"type":"null","description":"If present and non-null, specifies that the rule can only be active if all the specified words are\npresent in the search query.","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.query.oneOf.1.words.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.query.oneOf.1.words","typeLabel":"string | null"}},"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.query.oneOf.1","typeLabel":"object"}],"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.query","typeLabel":"null | object"},"filter":{"oneOf":[{"type":"null","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.filter.oneOf.0","typeLabel":"null"},{"type":"object","description":"Conditions on the values matching the filter of the search query that determines whether the rule is active","properties":{"values":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.filter.oneOf.1.values.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.filter.oneOf.1.values","typeLabel":"object"}},"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.filter.oneOf.1","typeLabel":"object"}],"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions.filter","typeLabel":"null | object"}},"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.conditions","typeLabel":"object"},"actions":{"type":"object","description":"List of actions to apply when this rule is active for the query.","properties":{"pin":{"type":"array","items":{"type":"object","description":"An action that pins a selected document.","required":["id","position"],"properties":{"id":{"type":"string","description":"Document ID of the document to select.\n\nOnly the document whose [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) value\nmatches the specified id will be selected by the action.\n\nIf there is no such document in the index of the query, then no documents will be selected and no pinning will occur.","isRequired":true,"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.actions.pin.items.[INDEX].id","typeLabel":"string"},"position":{"type":"integer","format":"u-int32","description":"Position at which the document should be pinned.","minimum":0,"isRequired":true,"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.actions.pin.items.[INDEX].position","typeLabel":"integer\u003cu-int32>"},"indexUid":{"oneOf":[{"type":"string","description":"Index name.\n\nFor the action to select any document, when this parameter is provided,\nthe index of the query must match the provided parameter.","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.actions.pin.items.[INDEX].indexUid.oneOf.0","typeLabel":"string"},{"type":"null","description":"Index name.\n\nFor the action to select any document, when this parameter is provided,\nthe index of the query must match the provided parameter.","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.actions.pin.items.[INDEX].indexUid.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.actions.pin.items.[INDEX].indexUid","typeLabel":"string | null"}},"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.actions.pin.items.[INDEX]","typeLabel":"object"},"description":"Pins a selected document.","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.actions.pin","typeLabel":"object[]"},"scale":{"type":"array","items":{"type":"object","description":"An action that applies a multiplicative factor to the score of selected documents.","required":["weight"],"properties":{"weight":{"type":"number","format":"double","description":"Scale factor for selected documents.\n\n- Set it >1.0 to boost the selected documents.\n- Set it \u003c1.0 to deboost the selected documents.\n- Set it =0.0 to hide the selected documents.","isRequired":true,"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.actions.scale.items.[INDEX].weight","typeLabel":"number\u003cdouble>"},"indexUid":{"oneOf":[{"type":"string","description":"List of index patterns.\n\nFor the action to select any document, when this parameter is provided,\nthe index of the query must match the provided parameter.","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.actions.scale.items.[INDEX].indexUid.oneOf.0","typeLabel":"string"},{"type":"null","description":"List of index patterns.\n\nFor the action to select any document, when this parameter is provided,\nthe index of the query must match the provided parameter.","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.actions.scale.items.[INDEX].indexUid.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.actions.scale.items.[INDEX].indexUid","typeLabel":"string | null"},"ids":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.actions.scale.items.[INDEX].ids.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Array of specific document IDs to select.\n\nOnly documents whose [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) value\nmatches the specified ids will be selected by the action.\n\nIf `filter` is also specified,\nthe documents must also satisfy the filter to be selected.","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.actions.scale.items.[INDEX].ids.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Array of specific document IDs to select.\n\nOnly documents whose [primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) value\nmatches the specified ids will be selected by the action.\n\nIf `filter` is also specified,\nthe documents must also satisfy the filter to be selected.","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.actions.scale.items.[INDEX].ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.actions.scale.items.[INDEX].ids","typeLabel":"string[] | null"},"filter":{"description":"Filter expression to select documents. Attributes must be added to the\n`filterableAttributes` index setting before they can be used in filters.\nAccepts a string or an array of arrays of strings for AND/OR combinations.\n\nOnly documents matching the specified filter will be selected.\n\nIf `ids` is also specified,\nthe documents matching the filter must also have their primary key part of the `ids`\nlist to be selected.\n\nIf the filter cannot be evaluated for the current index due to referencing attributes\nthat are not filterable, then no document will be applied for this action.","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.actions.scale.items.[INDEX].filter","typeLabel":"any"}},"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.actions.scale.items.[INDEX]","typeLabel":"object"},"description":"Applies a multiplicative factor to the score of selected documents.","uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.actions.scale","typeLabel":"object[]"}},"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1.actions","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"queries.items.[INDEX].inlineRule.oneOf.1","typeLabel":"object"}],"uniqueKey":"queries.items.[INDEX].inlineRule","typeLabel":"null | object"}},"additionalProperties":false,"uniqueKey":"queries.items.[INDEX]","typeLabel":"object"},"description":"An array of search queries to execute. Each query can target a\ndifferent index and have its own parameters. When `federation` is\n`null`, results are returned separately for each query. When\n`federation` is set, results are merged.\n\nEach query object must include `indexUid` to specify which index to search.","isRequired":true,"uniqueKey":"queries","typeLabel":"object[]"},"federation":{"oneOf":[{"type":"null","uniqueKey":"federation.oneOf.0","typeLabel":"null"},{"type":"object","description":"Configuration for combining results from multiple queries into a\nsingle response. When set, results are merged and ranked together.\nWhen `null`, each query's results are returned separately in an\narray.","properties":{"limit":{"type":"integer","description":"Maximum number of results to return across all queries","minimum":0,"uniqueKey":"federation.oneOf.1.limit","typeLabel":"integer"},"offset":{"type":"integer","description":"Number of results to skip","minimum":0,"uniqueKey":"federation.oneOf.1.offset","typeLabel":"integer"},"page":{"oneOf":[{"type":"integer","minimum":0,"uniqueKey":"federation.oneOf.1.page.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"uniqueKey":"federation.oneOf.1.page.oneOf.1","typeLabel":"null"}],"uniqueKey":"federation.oneOf.1.page","typeLabel":"integer | null"},"hitsPerPage":{"oneOf":[{"type":"integer","minimum":0,"uniqueKey":"federation.oneOf.1.hitsPerPage.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":0,"uniqueKey":"federation.oneOf.1.hitsPerPage.oneOf.1","typeLabel":"null"}],"uniqueKey":"federation.oneOf.1.hitsPerPage","typeLabel":"integer | null"},"facetsByIndex":{"type":"object","description":"Facets to retrieve per index","additionalProperties":{"type":"array","items":{"type":"string","uniqueKey":"federation.oneOf.1.facetsByIndex.additionalProperties.items.[INDEX]","typeLabel":"string"},"description":"A collection of patterns used to match attribute names. Patterns can include wildcards (`*`) for flexible matching. For example, `title` matches exactly, `overview_*` matches any attribute starting with `overview_`, and `*_date` matches any attribute ending with `_date`.","examples":["[\"*\", \"title\", \"description_*\", \"*_date\", \"*content*\"]"],"uniqueKey":"federation.oneOf.1.facetsByIndex.additionalProperties","typeLabel":"string[]"},"propertyNames":{"type":"string","example":"movies"},"uniqueKey":"federation.oneOf.1.facetsByIndex","typeLabel":"object"},"mergeFacets":{"oneOf":[{"type":"null","uniqueKey":"federation.oneOf.1.mergeFacets.oneOf.0","typeLabel":"null"},{"type":"object","description":"Options for merging facets from multiple indexes","properties":{"maxValuesPerFacet":{"oneOf":[{"type":"integer","description":"The maximum number of facet values to return for each facet after\nmerging. Values from all indexes are combined and sorted before\ntruncation. If not specified, uses the default limit from the index\nsettings.","minimum":0,"uniqueKey":"federation.oneOf.1.mergeFacets.oneOf.1.maxValuesPerFacet.oneOf.0","typeLabel":"integer"},{"type":"null","description":"The maximum number of facet values to return for each facet after\nmerging. Values from all indexes are combined and sorted before\ntruncation. If not specified, uses the default limit from the index\nsettings.","minimum":0,"uniqueKey":"federation.oneOf.1.mergeFacets.oneOf.1.maxValuesPerFacet.oneOf.1","typeLabel":"null"}],"uniqueKey":"federation.oneOf.1.mergeFacets.oneOf.1.maxValuesPerFacet","typeLabel":"integer | null"}},"additionalProperties":false,"uniqueKey":"federation.oneOf.1.mergeFacets.oneOf.1","typeLabel":"object"}],"uniqueKey":"federation.oneOf.1.mergeFacets","typeLabel":"null | object"},"distinct":{"oneOf":[{"type":"string","description":"Restrict search to documents with unique values of the specified attribute across all queries.\n\n1. This applies across all queries in the request, regardless of index or remote of origin.\n2. This overrides the index-level distinct attribute.\n3. This requires that the passed field can be set as distinct in all the participating indexes.","uniqueKey":"federation.oneOf.1.distinct.oneOf.0","typeLabel":"string"},{"type":"null","description":"Restrict search to documents with unique values of the specified attribute across all queries.\n\n1. This applies across all queries in the request, regardless of index or remote of origin.\n2. This overrides the index-level distinct attribute.\n3. This requires that the passed field can be set as distinct in all the participating indexes.","uniqueKey":"federation.oneOf.1.distinct.oneOf.1","typeLabel":"null"}],"uniqueKey":"federation.oneOf.1.distinct","typeLabel":"string | null"},"showPerformanceDetails":{"type":"boolean","description":"Whether to include performance details in the response","uniqueKey":"federation.oneOf.1.showPerformanceDetails","typeLabel":"boolean"},"personalize":{"oneOf":[{"type":"null","uniqueKey":"federation.oneOf.1.personalize.oneOf.0","typeLabel":"null"},{"type":"object","description":"Personalize search results","required":["userContext"],"properties":{"userContext":{"type":"string","description":"String describing the user (e.g. preferences, behavior).\n\nUsed to return different results for different profiles.","isRequired":true,"uniqueKey":"federation.oneOf.1.personalize.oneOf.1.userContext","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"federation.oneOf.1.personalize.oneOf.1","typeLabel":"object"}],"uniqueKey":"federation.oneOf.1.personalize","typeLabel":"null | object"}},"additionalProperties":false,"uniqueKey":"federation.oneOf.1","typeLabel":"object"}],"uniqueKey":"federation","typeLabel":"null | object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"queries":[{"indexUid":"movies","q":"\u003cstring>","offset":1,"limit":1,"page":1,"hitsPerPage":1,"attributesToRetrieve":["\u003cstring>"],"attributesToCrop":["\u003cstring>"],"cropLength":1,"cropMarker":"\u003cstring>","attributesToHighlight":["\u003cstring>"],"highlightPreTag":"\u003cstring>","highlightPostTag":"\u003cstring>","showMatchesPosition":true,"filter":"\u003cunknown>","sort":["\u003cstring>"],"distinct":"\u003cstring>","facets":"[\"*\", \"title\", \"description_*\", \"*_date\", \"*content*\"]","attributesToSearchOn":["\u003cstring>"],"rankingScoreThreshold":123,"locales":[],"hybrid":{"embedder":"default","semanticRatio":0.5},"vector":[123],"retrieveVectors":true,"media":"\u003cunknown>","personalize":{"userContext":"\u003cstring>"},"useNetwork":true,"showRankingScore":true,"showRankingScoreDetails":true,"showPerformanceDetails":true,"federationOptions":{"weight":123,"remote":"\u003cstring>","queryPosition":1},"inlineRule":{"uid":"movies","precedence":1,"active":true,"conditions":{"time":{"start":"2023-11-07T05:31:56Z","end":"2023-11-07T05:31:56Z"},"query":{"isEmpty":true,"words":"\u003cstring>"},"filter":{"values":{}}},"actions":{"pin":[{"id":"\u003cstring>","position":1,"indexUid":"\u003cstring>"}],"scale":[{"weight":123,"indexUid":"\u003cstring>","ids":["\u003cstring>"],"filter":"\u003cunknown>"}]}}}],"federation":{"limit":1,"offset":1,"page":1,"hitsPerPage":1,"facetsByIndex":{},"mergeFacets":{"maxValuesPerFacet":1},"distinct":"\u003cstring>","showPerformanceDetails":true,"personalize":{"userContext":"\u003cstring>"}}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"fbe9a8d4-cfab-4afd-8de1-93412d8aeb95":{"description":"Federated multi-search.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"Response from a federated multi-search query","required":["hits","processingTimeMs","hitsPerPage","page","totalPages","totalHits"],"properties":{"hitsPerPage":{"type":"integer","description":"Number of results per page.","minimum":0,"isRequired":true,"uniqueKey":"oneOf.0.hitsPerPage","typeLabel":"integer"},"page":{"type":"integer","description":"Current page index (1-based).","minimum":0,"isRequired":true,"uniqueKey":"oneOf.0.page","typeLabel":"integer"},"totalPages":{"type":"integer","description":"Exhaustive total number of result pages.","minimum":0,"isRequired":true,"uniqueKey":"oneOf.0.totalPages","typeLabel":"integer"},"totalHits":{"type":"integer","description":"Exhaustive total number of matching documents.","minimum":0,"isRequired":true,"uniqueKey":"oneOf.0.totalHits","typeLabel":"integer"},"hits":{"type":"array","items":{"type":"object","description":"A single search result hit.","properties":{"_formatted":{"type":"object","description":"Document with highlighted and cropped attributes.\n\nPresent when `attributesToHighlight` or `attributesToCrop` was set.","additionalProperties":true,"uniqueKey":"oneOf.0.hits.items.[INDEX]._formatted","typeLabel":"object"},"_matchesPosition":{"oneOf":[{"type":"object","description":"Byte offsets (`start`, `length`) of each matched term per attribute.\n\nPresent when `showMatchesPosition` was true.","additionalProperties":{"type":"array","items":{"type":"object","description":"Represents the position of a matching term in a document field. Used to\nindicate where query terms were found within attribute values, enabling\nfeatures like highlighting and match position display.","required":["start","length"],"properties":{"start":{"type":"integer","description":"The byte offset where the match begins within the attribute value.\nThis is a zero-indexed position from the start of the string.","minimum":0,"isRequired":true,"uniqueKey":"oneOf.0.hits.items.[INDEX]._matchesPosition.oneOf.0.additionalProperties.items.[INDEX].start","typeLabel":"integer"},"length":{"type":"integer","description":"The length in bytes of the matched text. Combined with `start`, this\ndefines the exact substring that matched the query term.","minimum":0,"isRequired":true,"uniqueKey":"oneOf.0.hits.items.[INDEX]._matchesPosition.oneOf.0.additionalProperties.items.[INDEX].length","typeLabel":"integer"},"indices":{"oneOf":[{"type":"array","items":{"type":"integer","minimum":0,"uniqueKey":"oneOf.0.hits.items.[INDEX]._matchesPosition.oneOf.0.additionalProperties.items.[INDEX].indices.oneOf.0.items.[INDEX]","typeLabel":"integer"},"description":"Byte indices of individual matched characters when the match spans\nmultiple positions (e.g., for prefix matches). This is `null` for\nsimple contiguous matches.","uniqueKey":"oneOf.0.hits.items.[INDEX]._matchesPosition.oneOf.0.additionalProperties.items.[INDEX].indices.oneOf.0","typeLabel":"integer[]"},{"type":"null","items":{"type":"integer","minimum":0},"description":"Byte indices of individual matched characters when the match spans\nmultiple positions (e.g., for prefix matches). This is `null` for\nsimple contiguous matches.","uniqueKey":"oneOf.0.hits.items.[INDEX]._matchesPosition.oneOf.0.additionalProperties.items.[INDEX].indices.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.hits.items.[INDEX]._matchesPosition.oneOf.0.additionalProperties.items.[INDEX].indices","typeLabel":"integer[] | null"}},"uniqueKey":"oneOf.0.hits.items.[INDEX]._matchesPosition.oneOf.0.additionalProperties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.hits.items.[INDEX]._matchesPosition.oneOf.0.additionalProperties","typeLabel":"object[]"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.0.hits.items.[INDEX]._matchesPosition.oneOf.0","typeLabel":"object"},{"type":"null","description":"Byte offsets (`start`, `length`) of each matched term per attribute.\n\nPresent when `showMatchesPosition` was true.","additionalProperties":{"type":"array","items":{"type":"object","description":"Represents the position of a matching term in a document field. Used to\nindicate where query terms were found within attribute values, enabling\nfeatures like highlighting and match position display.","required":["start","length"],"properties":{"start":{"type":"integer","description":"The byte offset where the match begins within the attribute value.\nThis is a zero-indexed position from the start of the string.","minimum":0,"uniqueKey":"oneOf.0.hits.items.[INDEX]._matchesPosition.oneOf.1.additionalProperties.items.[INDEX].start","typeLabel":"integer"},"length":{"type":"integer","description":"The length in bytes of the matched text. Combined with `start`, this\ndefines the exact substring that matched the query term.","minimum":0,"uniqueKey":"oneOf.0.hits.items.[INDEX]._matchesPosition.oneOf.1.additionalProperties.items.[INDEX].length","typeLabel":"integer"},"indices":{"oneOf":[{"type":"array","items":{"type":"integer","minimum":0,"uniqueKey":"oneOf.0.hits.items.[INDEX]._matchesPosition.oneOf.1.additionalProperties.items.[INDEX].indices.oneOf.0.items.[INDEX]","typeLabel":"integer"},"description":"Byte indices of individual matched characters when the match spans\nmultiple positions (e.g., for prefix matches). This is `null` for\nsimple contiguous matches.","uniqueKey":"oneOf.0.hits.items.[INDEX]._matchesPosition.oneOf.1.additionalProperties.items.[INDEX].indices.oneOf.0","typeLabel":"integer[]"},{"type":"null","items":{"type":"integer","minimum":0},"description":"Byte indices of individual matched characters when the match spans\nmultiple positions (e.g., for prefix matches). This is `null` for\nsimple contiguous matches.","uniqueKey":"oneOf.0.hits.items.[INDEX]._matchesPosition.oneOf.1.additionalProperties.items.[INDEX].indices.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.hits.items.[INDEX]._matchesPosition.oneOf.1.additionalProperties.items.[INDEX].indices","typeLabel":"integer[] | null"}},"uniqueKey":"oneOf.0.hits.items.[INDEX]._matchesPosition.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.hits.items.[INDEX]._matchesPosition.oneOf.1.additionalProperties","typeLabel":"object[]"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.0.hits.items.[INDEX]._matchesPosition.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.hits.items.[INDEX]._matchesPosition","typeLabel":"object | null"},"_rankingScore":{"oneOf":[{"type":"number","format":"double","description":"Global [ranking score](https://www.meilisearch.com/docs/learn/relevancy/ranking_score) from 0.0 to 1.0.\n\nPresent when `showRankingScore` was true.","uniqueKey":"oneOf.0.hits.items.[INDEX]._rankingScore.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","description":"Global [ranking score](https://www.meilisearch.com/docs/learn/relevancy/ranking_score) from 0.0 to 1.0.\n\nPresent when `showRankingScore` was true.","uniqueKey":"oneOf.0.hits.items.[INDEX]._rankingScore.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.hits.items.[INDEX]._rankingScore","typeLabel":"number\u003cdouble> | null"},"_rankingScoreDetails":{"oneOf":[{"type":"object","description":"Per-rule score breakdown (words, typo, proximity, etc.).\n\nPresent when `showRankingScoreDetails` was true.","additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.hits.items.[INDEX]._rankingScoreDetails.oneOf.0.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.0.hits.items.[INDEX]._rankingScoreDetails.oneOf.0","typeLabel":"object"},{"type":"null","description":"Per-rule score breakdown (words, typo, proximity, etc.).\n\nPresent when `showRankingScoreDetails` was true.","additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.hits.items.[INDEX]._rankingScoreDetails.oneOf.1.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.0.hits.items.[INDEX]._rankingScoreDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.hits.items.[INDEX]._rankingScoreDetails","typeLabel":"object | null"}},"additionalProperties":{"description":"Document fields as stored in the index.\n\nAccording to `attributesToRetrieve`.","uniqueKey":"oneOf.0.hits.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"oneOf.0.hits.items.[INDEX]","typeLabel":"object"},"description":"Combined search results from all queries","isRequired":true,"uniqueKey":"oneOf.0.hits","typeLabel":"object[]"},"processingTimeMs":{"type":"integer","description":"Total processing time in milliseconds","minimum":0,"isRequired":true,"uniqueKey":"oneOf.0.processingTimeMs","typeLabel":"integer"},"queryVectors":{"oneOf":[{"type":"object","description":"List of vectors per query, if `retrieveVectors` is set to `true`","additionalProperties":{"type":"array","items":{"type":"number","format":"float","uniqueKey":"oneOf.0.queryVectors.oneOf.0.additionalProperties.items.[INDEX]","typeLabel":"number\u003cfloat>"},"uniqueKey":"oneOf.0.queryVectors.oneOf.0.additionalProperties","typeLabel":"number\u003cfloat>[]"},"propertyNames":{"type":"integer","minimum":0},"uniqueKey":"oneOf.0.queryVectors.oneOf.0","typeLabel":"object"},{"type":"null","description":"List of vectors per query, if `retrieveVectors` is set to `true`","additionalProperties":{"type":"array","items":{"type":"number","format":"float","uniqueKey":"oneOf.0.queryVectors.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"number\u003cfloat>"},"uniqueKey":"oneOf.0.queryVectors.oneOf.1.additionalProperties","typeLabel":"number\u003cfloat>[]"},"propertyNames":{"type":"integer","minimum":0},"uniqueKey":"oneOf.0.queryVectors.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.queryVectors","typeLabel":"object | null"},"facetDistribution":{"oneOf":[{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"u-int64","minimum":0,"uniqueKey":"oneOf.0.facetDistribution.oneOf.0.additionalProperties.additionalProperties","typeLabel":"integer\u003cu-int64>"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.0.facetDistribution.oneOf.0.additionalProperties","typeLabel":"object"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.0.facetDistribution.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"u-int64","minimum":0,"uniqueKey":"oneOf.0.facetDistribution.oneOf.1.additionalProperties.additionalProperties","typeLabel":"integer\u003cu-int64>"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.0.facetDistribution.oneOf.1.additionalProperties","typeLabel":"object"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.0.facetDistribution.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.facetDistribution","typeLabel":"object | null"},"facetStats":{"oneOf":[{"type":"object","description":"Merged facet statistics across all indexes","additionalProperties":{"type":"object","description":"Minimum and maximum numeric values for a facet.\n\nPresent when the facet attribute has numeric values among matching documents.","required":["min","max"],"properties":{"min":{"type":"number","format":"double","description":"Lowest numeric value for this facet among matching documents.","isRequired":true,"uniqueKey":"oneOf.0.facetStats.oneOf.0.additionalProperties.min","typeLabel":"number\u003cdouble>"},"max":{"type":"number","format":"double","description":"Highest numeric value for this facet among matching documents.","isRequired":true,"uniqueKey":"oneOf.0.facetStats.oneOf.0.additionalProperties.max","typeLabel":"number\u003cdouble>"}},"uniqueKey":"oneOf.0.facetStats.oneOf.0.additionalProperties","typeLabel":"object"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.0.facetStats.oneOf.0","typeLabel":"object"},{"type":"null","description":"Merged facet statistics across all indexes","additionalProperties":{"type":"object","description":"Minimum and maximum numeric values for a facet.\n\nPresent when the facet attribute has numeric values among matching documents.","required":["min","max"],"properties":{"min":{"type":"number","format":"double","description":"Lowest numeric value for this facet among matching documents.","uniqueKey":"oneOf.0.facetStats.oneOf.1.additionalProperties.min","typeLabel":"number\u003cdouble>"},"max":{"type":"number","format":"double","description":"Highest numeric value for this facet among matching documents.","uniqueKey":"oneOf.0.facetStats.oneOf.1.additionalProperties.max","typeLabel":"number\u003cdouble>"}},"uniqueKey":"oneOf.0.facetStats.oneOf.1.additionalProperties","typeLabel":"object"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.0.facetStats.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.facetStats","typeLabel":"object | null"},"facetsByIndex":{"type":"object","additionalProperties":{"type":"object","description":"Computed facet data from a search","required":["distribution","stats"],"properties":{"distribution":{"type":"object","description":"Count of documents for each facet value","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"u-int64","minimum":0,"uniqueKey":"oneOf.0.facetsByIndex.additionalProperties.distribution.additionalProperties.additionalProperties","typeLabel":"integer\u003cu-int64>"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.0.facetsByIndex.additionalProperties.distribution.additionalProperties","typeLabel":"object"},"propertyNames":{"type":"string"},"isRequired":true,"uniqueKey":"oneOf.0.facetsByIndex.additionalProperties.distribution","typeLabel":"object"},"stats":{"type":"object","description":"Numeric statistics for each facet","additionalProperties":{"type":"object","description":"Minimum and maximum numeric values for a facet.\n\nPresent when the facet attribute has numeric values among matching documents.","required":["min","max"],"properties":{"min":{"type":"number","format":"double","description":"Lowest numeric value for this facet among matching documents.","isRequired":true,"uniqueKey":"oneOf.0.facetsByIndex.additionalProperties.stats.additionalProperties.min","typeLabel":"number\u003cdouble>"},"max":{"type":"number","format":"double","description":"Highest numeric value for this facet among matching documents.","isRequired":true,"uniqueKey":"oneOf.0.facetsByIndex.additionalProperties.stats.additionalProperties.max","typeLabel":"number\u003cdouble>"}},"uniqueKey":"oneOf.0.facetsByIndex.additionalProperties.stats.additionalProperties","typeLabel":"object"},"propertyNames":{"type":"string"},"isRequired":true,"uniqueKey":"oneOf.0.facetsByIndex.additionalProperties.stats","typeLabel":"object"}},"uniqueKey":"oneOf.0.facetsByIndex.additionalProperties","typeLabel":"object"},"propertyNames":{"type":"string"},"description":"Facets grouped by index","uniqueKey":"oneOf.0.facetsByIndex","typeLabel":"object"},"requestUid":{"oneOf":[{"type":"string","format":"uuid","description":"Unique identifier for the request","uniqueKey":"oneOf.0.requestUid.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Unique identifier for the request","uniqueKey":"oneOf.0.requestUid.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.requestUid","typeLabel":"string\u003cuuid> | null"},"metadata":{"oneOf":[{"type":"array","items":{"type":"object","description":"Metadata about a search query (included when requested via header).","required":["queryUid","indexUid"],"properties":{"queryUid":{"type":"string","format":"uuid","description":"Unique identifier for the query.","isRequired":true,"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].queryUid","typeLabel":"string\u003cuuid>"},"indexUid":{"type":"string","description":"UID of the index that was searched.","isRequired":true,"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].indexUid","typeLabel":"string"},"query":{"oneOf":[{"type":"string","description":"Query string set for the query, if not already present in the response.\n\nOnly set if:\n\n1. the metadata corresponds to a query in a federated search request, **and**\n2. that federated search request query is not a placeholder search (empty or missing `q`)\n\nNever set for regular search and non-federated multi-search because\nthe query(ies) are already present in the response.","uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].query.oneOf.0","typeLabel":"string"},{"type":"null","description":"Query string set for the query, if not already present in the response.\n\nOnly set if:\n\n1. the metadata corresponds to a query in a federated search request, **and**\n2. that federated search request query is not a placeholder search (empty or missing `q`)\n\nNever set for regular search and non-federated multi-search because\nthe query(ies) are already present in the response.","uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].query.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].query","typeLabel":"string | null"},"primaryKey":{"oneOf":[{"type":"string","description":"[Primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) of the index.","uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].primaryKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"[Primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) of the index.","uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].primaryKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].primaryKey","typeLabel":"string | null"},"remote":{"oneOf":[{"type":"string","description":"Remote that processed the query (federated search only).","uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].remote.oneOf.0","typeLabel":"string"},{"type":"null","description":"Remote that processed the query (federated search only).","uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].remote.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].remote","typeLabel":"string | null"},"inlineRuleConditionOutcomes":{"oneOf":[{"type":"null","uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.0","typeLabel":"null"},{"type":"object","description":"Outcome of checking the conditions of the dynamic search rule passed in `inlineRule`.\n\nOnly present in response if `inlineRule` was set in query.","required":["satisfiesActiveCondition"],"properties":{"satisfiesActiveCondition":{"type":"boolean","description":"Whether the rule was active","isRequired":true,"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesActiveCondition","typeLabel":"boolean"},"satisfiesTimeCondition":{"type":"string","description":"Whether the current time falls in the range of time specified by the condition","enum":["satisfied","noConstraint","tooEarly","tooLate"],"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesTimeCondition","typeLabel":"enum\u003cstring>"},"satisfiesQueryEmptyCondition":{"type":"string","description":"Whether the query emptiness condition aligns with the actual query","enum":["satisfied","noConstraint","queryNotEmpty","queryEmpty"],"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesQueryEmptyCondition","typeLabel":"enum\u003cstring>"},"satisfiesQueryWordsCondition":{"oneOf":[{"type":"string","description":"Whether the query words meet the condition","enum":["satisfied","noConstraint"],"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesQueryWordsCondition.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","description":"Whether the query words meet the condition","required":["missingWord"],"properties":{"missingWord":{"type":"object","description":"At least the specified word is missing in the query","required":["word"],"properties":{"word":{"type":"string","description":"Missing word in query","isRequired":true,"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesQueryWordsCondition.oneOf.1.missingWord.word","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesQueryWordsCondition.oneOf.1.missingWord","typeLabel":"object"}},"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesQueryWordsCondition.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesQueryWordsCondition","typeLabel":"enum\u003cstring> | object"},"satisfiesFilterCondition":{"oneOf":[{"type":"string","description":"Whether the filter meets the condition","enum":["satisfied","noConstraint"],"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","description":"Whether the filter meets the condition","required":["missingConstraintOnField"],"properties":{"missingConstraintOnField":{"type":"object","description":"At least one field from the condition is missing from the filter","required":["field"],"properties":{"field":{"type":"string","description":"Missing field in filter","isRequired":true,"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.1.missingConstraintOnField.field","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.1.missingConstraintOnField","typeLabel":"object"}},"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.1","typeLabel":"object"},{"type":"object","description":"Whether the filter meets the condition","required":["unmetConstraintOnField"],"properties":{"unmetConstraintOnField":{"type":"object","description":"At least one field has a condition not met in the filter","required":["field"],"properties":{"field":{"type":"string","description":"Field with unmet constraint in filter","isRequired":true,"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.2.unmetConstraintOnField.field","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.2.unmetConstraintOnField","typeLabel":"object"}},"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.2","typeLabel":"object"},{"type":"object","description":"Whether the filter meets the condition","required":["notEnoughFields"],"properties":{"notEnoughFields":{"type":"object","description":"The filter does not constraint enough field to satisfy the condition","required":["fieldCountInFilter","fieldCountInCondition"],"properties":{"fieldCountInFilter":{"type":"integer","description":"Number of fields in the filter","minimum":0,"isRequired":true,"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.3.notEnoughFields.fieldCountInFilter","typeLabel":"integer"},"fieldCountInCondition":{"type":"integer","description":"Number of fields in the condition","minimum":0,"isRequired":true,"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.3.notEnoughFields.fieldCountInCondition","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.3.notEnoughFields","typeLabel":"object"}},"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.3","typeLabel":"object"}],"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition","typeLabel":"enum\u003cstring> · object · object · object"}},"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes","typeLabel":"null | object"}},"uniqueKey":"oneOf.0.metadata.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Metadata for each query","uniqueKey":"oneOf.0.metadata.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","description":"Metadata about a search query (included when requested via header).","required":["queryUid","indexUid"],"properties":{"query":{"oneOf":[{"type":"string","description":"Query string set for the query, if not already present in the response.\n\nOnly set if:\n\n1. the metadata corresponds to a query in a federated search request, **and**\n2. that federated search request query is not a placeholder search (empty or missing `q`)\n\nNever set for regular search and non-federated multi-search because\nthe query(ies) are already present in the response."},{"type":"null","description":"Query string set for the query, if not already present in the response.\n\nOnly set if:\n\n1. the metadata corresponds to a query in a federated search request, **and**\n2. that federated search request query is not a placeholder search (empty or missing `q`)\n\nNever set for regular search and non-federated multi-search because\nthe query(ies) are already present in the response."}]},"queryUid":{"type":"string","format":"uuid","description":"Unique identifier for the query."},"indexUid":{"type":"string","description":"UID of the index that was searched."},"primaryKey":{"oneOf":[{"type":"string","description":"[Primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) of the index."},{"type":"null","description":"[Primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) of the index."}]},"remote":{"oneOf":[{"type":"string","description":"Remote that processed the query (federated search only)."},{"type":"null","description":"Remote that processed the query (federated search only)."}]},"inlineRuleConditionOutcomes":{"oneOf":[{"type":"null"},{"type":"object","description":"Outcome of checking the conditions of the dynamic search rule passed in `inlineRule`.\n\nOnly present in response if `inlineRule` was set in query.","required":["satisfiesActiveCondition"],"properties":{"satisfiesActiveCondition":{"type":"boolean","description":"Whether the rule was active"},"satisfiesTimeCondition":{"type":"string","description":"Whether the current time falls in the range of time specified by the condition","enum":["satisfied","noConstraint","tooEarly","tooLate"]},"satisfiesQueryEmptyCondition":{"type":"string","description":"Whether the query emptiness condition aligns with the actual query","enum":["satisfied","noConstraint","queryNotEmpty","queryEmpty"]},"satisfiesQueryWordsCondition":{"oneOf":[{"type":"string","description":"Whether the query words meet the condition","enum":["satisfied","noConstraint"]},{"type":"object","description":"Whether the query words meet the condition","required":["missingWord"],"properties":{"missingWord":{"type":"object","description":"At least the specified word is missing in the query","required":["word"],"properties":{"word":{"type":"string","description":"Missing word in query"}}}}}]},"satisfiesFilterCondition":{"oneOf":[{"type":"string","description":"Whether the filter meets the condition","enum":["satisfied","noConstraint"]},{"type":"object","description":"Whether the filter meets the condition","required":["missingConstraintOnField"],"properties":{"missingConstraintOnField":{"type":"object","description":"At least one field from the condition is missing from the filter","required":["field"],"properties":{"field":{"type":"string","description":"Missing field in filter"}}}}},{"type":"object","description":"Whether the filter meets the condition","required":["unmetConstraintOnField"],"properties":{"unmetConstraintOnField":{"type":"object","description":"At least one field has a condition not met in the filter","required":["field"],"properties":{"field":{"type":"string","description":"Field with unmet constraint in filter"}}}}},{"type":"object","description":"Whether the filter meets the condition","required":["notEnoughFields"],"properties":{"notEnoughFields":{"type":"object","description":"The filter does not constraint enough field to satisfy the condition","required":["fieldCountInFilter","fieldCountInCondition"],"properties":{"fieldCountInFilter":{"type":"integer","description":"Number of fields in the filter","minimum":0},"fieldCountInCondition":{"type":"integer","description":"Number of fields in the condition","minimum":0}}}}}]}}}]}}},"description":"Metadata for each query","uniqueKey":"oneOf.0.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.metadata","typeLabel":"object[] | null"},"remoteErrors":{"oneOf":[{"type":"object","description":"Errors from remote servers","additionalProperties":{"type":"object","required":["message","code","type","link"],"properties":{"message":{"type":"string","description":"The error message.","isRequired":true,"uniqueKey":"oneOf.0.remoteErrors.oneOf.0.additionalProperties.message","typeLabel":"string"},"code":{"type":"string","enum":["api_key_already_exists","api_key_not_found","index_scoped_api_key_with_global_action","bad_parameter","bad_request","database_size_limit_reached","document_not_found","dump_already_processing","dump_not_found","dump_process_failed","duplicate_index_found","immutable_api_key_actions","immutable_api_key_created_at","immutable_api_key_expires_at","immutable_api_key_indexes","immutable_api_key_key","immutable_api_key_uid","immutable_api_key_updated_at","immutable_index_created_at","immutable_index_updated_at","import_task_already_received","import_task_unknown_remote","receive_import_finished_unknown_remote","import_task_without_network_task","index_already_exists","index_creation_failed","index_not_found","index_primary_key_already_exists","index_primary_key_multiple_candidates_found","index_primary_key_no_candidate_found","internal","invalid_api_key","invalid_api_key_actions","invalid_api_key_description","invalid_api_key_expires_at","invalid_api_key_indexes","invalid_api_key_limit","invalid_api_key_name","invalid_api_key_offset","invalid_api_key_uid","invalid_content_type","invalid_document_csv_delimiter","invalid_document_fields","invalid_document_retrieve_vectors","missing_document_filter","missing_document_edition_function","inconsistent_document_change_headers","invalid_document_filter","invalid_document_sort","invalid_document_use_network","invalid_document_retrieve","invalid_document_geo_field","invalid_document_geojson_field","invalid_header_value","invalid_vector_dimensions","invalid_vectors_type","invalid_document_id","invalid_document_ids","invalid_document_limit","invalid_document_offset","invalid_search_embedder","invalid_similar_embedder","invalid_search_hybrid_query","invalid_index_limit","invalid_index_offset","invalid_index_primary_key","invalid_index_custom_metadata","invalid_skip_creation","invalid_index_uid","invalid_multi_search_facets","invalid_multi_search_facets_by_index","invalid_multi_search_facet_order","invalid_multi_search_query_personalization","invalid_multi_search_query_show_performance_details","invalid_multi_search_federated","invalid_multi_search_federation_options","invalid_multi_search_max_values_per_facet","invalid_multi_search_merge_facets","invalid_multi_search_query_facets","invalid_multi_search_distinct","invalid_multi_search_query_pagination","invalid_multi_search_query_ranking_rules","invalid_multi_search_query_position","invalid_multi_search_remote","invalid_multi_search_weight","invalid_network_leader","invalid_network_remotes","invalid_network_shards","invalid_network_self","invalid_network_search_api_key","invalid_network_write_api_key","invalid_network_url","invalid_search_attributes_to_search_on","invalid_search_attributes_to_crop","invalid_search_attributes_to_highlight","invalid_similar_attributes_to_retrieve","invalid_similar_retrieve_vectors","invalid_search_attributes_to_retrieve","invalid_search_ranking_score_threshold","invalid_similar_ranking_score_threshold","invalid_search_retrieve_vectors","invalid_search_crop_length","invalid_search_crop_marker","invalid_search_facets","invalid_search_semantic_ratio","invalid_search_locales","invalid_facet_search_exhaustive_facet_count","invalid_facet_search_facet_name","invalid_similar_id","invalid_search_filter","invalid_similar_filter","invalid_search_highlight_post_tag","invalid_search_highlight_pre_tag","invalid_search_hits_per_page","invalid_similar_limit","invalid_search_limit","invalid_search_matching_strategy","invalid_similar_offset","invalid_search_offset","invalid_search_page","invalid_search_q","invalid_facet_search_query","invalid_facet_search_name","facet_search_disabled","invalid_search_vector","invalid_search_media","invalid_search_show_matches_position","invalid_search_show_ranking_score","invalid_similar_show_ranking_score","invalid_search_show_ranking_score_details","invalid_search_show_performance_details","invalid_search_use_network","invalid_similar_show_ranking_score_details","invalid_similar_show_performance_details","invalid_search_sort","invalid_search_distinct","invalid_search_personalize","invalid_search_personalize_user_context","invalid_search_media_and_vector","invalid_settings_displayed_attributes","invalid_settings_distinct_attribute","invalid_settings_proximity_precision","invalid_settings_facet_search","invalid_settings_prefix_search","invalid_settings_faceting","invalid_settings_filterable_attributes","invalid_settings_foreign_keys","invalid_settings_pagination","invalid_settings_search_cutoff_ms","invalid_settings_embedders","invalid_settings_ranking_rules","invalid_settings_searchable_attributes","invalid_settings_sortable_attributes","invalid_settings_stop_words","invalid_settings_non_separator_tokens","invalid_settings_separator_tokens","invalid_settings_dictionary","invalid_settings_synonyms","invalid_settings_typo_tolerance","invalid_settings_localized_attributes","invalid_state","invalid_stats_show_internal_database_sizes","invalid_stats_size_format","invalid_store_file","invalid_swap_duplicate_index_found","invalid_swap_indexes","invalid_swap_rename","invalid_task_after_enqueued_at","invalid_task_after_finished_at","invalid_task_after_started_at","invalid_task_before_enqueued_at","invalid_task_before_finished_at","invalid_task_before_started_at","invalid_task_canceled_by","invalid_task_from","invalid_task_limit","invalid_task_reverse","invalid_task_statuses","invalid_task_types","invalid_task_uids","invalid_batch_uids","io_error","feature_not_enabled","malformed_payload","max_fields_limit_exceeded","missing_api_key_actions","missing_api_key_expires_at","missing_api_key_indexes","missing_authorization_header","missing_content_type","missing_document_id","missing_facet_search_facet_name","missing_index_uid","missing_master_key","missing_network_url","missing_payload","missing_search_hybrid","missing_swap_indexes","missing_task_filters","network_version_mismatch","no_space_left_on_device","not_leader","payload_too_large","remote_bad_response","remote_bad_request","unknown_remote","remote_could_not_send_request","remote_invalid_api_key","remote_remote_error","remote_timeout","too_many_search_requests","task_not_found","task_file_not_found","batch_not_found","too_many_open_files","too_many_vectors","unexpected_network_previous_remotes","network_version_too_old","unprocessed_network_task","unretrievable_document","unretrievable_error_code","unsupported_media_type","invalid_s3_snapshot_request","invalid_s3_snapshot_parameters","s3_snapshot_server_error","vector_embedding_error","not_found_similar_id","invalid_document_edition_context","invalid_document_edition_function_filter","edit_documents_by_function_error","invalid_settings_index_chat","invalid_export_url","invalid_export_api_key","invalid_export_payload_size","invalid_export_indexes_patterns","invalid_export_index_filter","invalid_export_index_override_settings","unimplemented_external_function_calling","unimplemented_non_streaming_chat_completions","unimplemented_multi_choice_chat_completions","chat_not_found","invalid_chat_setting_document_template","invalid_chat_completion_org_id","invalid_chat_completion_project_id","invalid_chat_completion_api_version","invalid_chat_completion_deployment_id","invalid_chat_completion_source","invalid_chat_completion_base_api","invalid_chat_completion_api_key","invalid_chat_completion_prompts","invalid_chat_completion_system_prompt","invalid_chat_completion_search_description_prompt","invalid_chat_completion_search_query_param_prompt","invalid_chat_completion_search_filter_param_prompt","invalid_chat_completion_search_index_uid_param_prompt","invalid_chat_completion_pre_query_prompt","invalid_index_fields_filter","invalid_index_fields_filter_attribute_patterns","invalid_index_fields_filter_displayed","invalid_index_fields_filter_searchable","invalid_index_fields_filter_sortable","invalid_index_fields_filter_distinct","invalid_index_fields_filter_ranking_rule","invalid_index_fields_filter_filterable","requires_enterprise_edition","invalid_render_template","invalid_render_input","render_document_not_found","template_parsing_error","template_rendering_error","invalid_webhooks","invalid_webhook_url","invalid_webhook_headers","immutable_webhook","invalid_webhook_uuid","webhook_not_found","immutable_webhook_uuid","immutable_webhook_is_editable","invalid_dynamic_search_rule_uid","invalid_dynamic_search_rule_offset","invalid_dynamic_search_rule_limit","invalid_dynamic_search_rule_filter","invalid_dynamic_search_rule_description","invalid_dynamic_search_rule_priority","invalid_dynamic_search_rule_active","invalid_dynamic_search_rule_conditions","invalid_dynamic_search_rule_actions","invalid_dynamic_search_rule_filter_query","invalid_dynamic_search_rule_filter_active","dynamic_search_rule_not_found"],"description":"The error code.","isRequired":true,"uniqueKey":"oneOf.0.remoteErrors.oneOf.0.additionalProperties.code","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["internal","invalid_request","auth","system"],"description":"The error type.","isRequired":true,"uniqueKey":"oneOf.0.remoteErrors.oneOf.0.additionalProperties.type","typeLabel":"enum\u003cstring>"},"link":{"type":"string","description":"A link to the documentation about this specific error.","isRequired":true,"uniqueKey":"oneOf.0.remoteErrors.oneOf.0.additionalProperties.link","typeLabel":"string"}},"uniqueKey":"oneOf.0.remoteErrors.oneOf.0.additionalProperties","typeLabel":"object"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.0.remoteErrors.oneOf.0","typeLabel":"object"},{"type":"null","description":"Errors from remote servers","additionalProperties":{"type":"object","required":["message","code","type","link"],"properties":{"message":{"type":"string","description":"The error message.","uniqueKey":"oneOf.0.remoteErrors.oneOf.1.additionalProperties.message","typeLabel":"string"},"code":{"type":"string","enum":["api_key_already_exists","api_key_not_found","index_scoped_api_key_with_global_action","bad_parameter","bad_request","database_size_limit_reached","document_not_found","dump_already_processing","dump_not_found","dump_process_failed","duplicate_index_found","immutable_api_key_actions","immutable_api_key_created_at","immutable_api_key_expires_at","immutable_api_key_indexes","immutable_api_key_key","immutable_api_key_uid","immutable_api_key_updated_at","immutable_index_created_at","immutable_index_updated_at","import_task_already_received","import_task_unknown_remote","receive_import_finished_unknown_remote","import_task_without_network_task","index_already_exists","index_creation_failed","index_not_found","index_primary_key_already_exists","index_primary_key_multiple_candidates_found","index_primary_key_no_candidate_found","internal","invalid_api_key","invalid_api_key_actions","invalid_api_key_description","invalid_api_key_expires_at","invalid_api_key_indexes","invalid_api_key_limit","invalid_api_key_name","invalid_api_key_offset","invalid_api_key_uid","invalid_content_type","invalid_document_csv_delimiter","invalid_document_fields","invalid_document_retrieve_vectors","missing_document_filter","missing_document_edition_function","inconsistent_document_change_headers","invalid_document_filter","invalid_document_sort","invalid_document_use_network","invalid_document_retrieve","invalid_document_geo_field","invalid_document_geojson_field","invalid_header_value","invalid_vector_dimensions","invalid_vectors_type","invalid_document_id","invalid_document_ids","invalid_document_limit","invalid_document_offset","invalid_search_embedder","invalid_similar_embedder","invalid_search_hybrid_query","invalid_index_limit","invalid_index_offset","invalid_index_primary_key","invalid_index_custom_metadata","invalid_skip_creation","invalid_index_uid","invalid_multi_search_facets","invalid_multi_search_facets_by_index","invalid_multi_search_facet_order","invalid_multi_search_query_personalization","invalid_multi_search_query_show_performance_details","invalid_multi_search_federated","invalid_multi_search_federation_options","invalid_multi_search_max_values_per_facet","invalid_multi_search_merge_facets","invalid_multi_search_query_facets","invalid_multi_search_distinct","invalid_multi_search_query_pagination","invalid_multi_search_query_ranking_rules","invalid_multi_search_query_position","invalid_multi_search_remote","invalid_multi_search_weight","invalid_network_leader","invalid_network_remotes","invalid_network_shards","invalid_network_self","invalid_network_search_api_key","invalid_network_write_api_key","invalid_network_url","invalid_search_attributes_to_search_on","invalid_search_attributes_to_crop","invalid_search_attributes_to_highlight","invalid_similar_attributes_to_retrieve","invalid_similar_retrieve_vectors","invalid_search_attributes_to_retrieve","invalid_search_ranking_score_threshold","invalid_similar_ranking_score_threshold","invalid_search_retrieve_vectors","invalid_search_crop_length","invalid_search_crop_marker","invalid_search_facets","invalid_search_semantic_ratio","invalid_search_locales","invalid_facet_search_exhaustive_facet_count","invalid_facet_search_facet_name","invalid_similar_id","invalid_search_filter","invalid_similar_filter","invalid_search_highlight_post_tag","invalid_search_highlight_pre_tag","invalid_search_hits_per_page","invalid_similar_limit","invalid_search_limit","invalid_search_matching_strategy","invalid_similar_offset","invalid_search_offset","invalid_search_page","invalid_search_q","invalid_facet_search_query","invalid_facet_search_name","facet_search_disabled","invalid_search_vector","invalid_search_media","invalid_search_show_matches_position","invalid_search_show_ranking_score","invalid_similar_show_ranking_score","invalid_search_show_ranking_score_details","invalid_search_show_performance_details","invalid_search_use_network","invalid_similar_show_ranking_score_details","invalid_similar_show_performance_details","invalid_search_sort","invalid_search_distinct","invalid_search_personalize","invalid_search_personalize_user_context","invalid_search_media_and_vector","invalid_settings_displayed_attributes","invalid_settings_distinct_attribute","invalid_settings_proximity_precision","invalid_settings_facet_search","invalid_settings_prefix_search","invalid_settings_faceting","invalid_settings_filterable_attributes","invalid_settings_foreign_keys","invalid_settings_pagination","invalid_settings_search_cutoff_ms","invalid_settings_embedders","invalid_settings_ranking_rules","invalid_settings_searchable_attributes","invalid_settings_sortable_attributes","invalid_settings_stop_words","invalid_settings_non_separator_tokens","invalid_settings_separator_tokens","invalid_settings_dictionary","invalid_settings_synonyms","invalid_settings_typo_tolerance","invalid_settings_localized_attributes","invalid_state","invalid_stats_show_internal_database_sizes","invalid_stats_size_format","invalid_store_file","invalid_swap_duplicate_index_found","invalid_swap_indexes","invalid_swap_rename","invalid_task_after_enqueued_at","invalid_task_after_finished_at","invalid_task_after_started_at","invalid_task_before_enqueued_at","invalid_task_before_finished_at","invalid_task_before_started_at","invalid_task_canceled_by","invalid_task_from","invalid_task_limit","invalid_task_reverse","invalid_task_statuses","invalid_task_types","invalid_task_uids","invalid_batch_uids","io_error","feature_not_enabled","malformed_payload","max_fields_limit_exceeded","missing_api_key_actions","missing_api_key_expires_at","missing_api_key_indexes","missing_authorization_header","missing_content_type","missing_document_id","missing_facet_search_facet_name","missing_index_uid","missing_master_key","missing_network_url","missing_payload","missing_search_hybrid","missing_swap_indexes","missing_task_filters","network_version_mismatch","no_space_left_on_device","not_leader","payload_too_large","remote_bad_response","remote_bad_request","unknown_remote","remote_could_not_send_request","remote_invalid_api_key","remote_remote_error","remote_timeout","too_many_search_requests","task_not_found","task_file_not_found","batch_not_found","too_many_open_files","too_many_vectors","unexpected_network_previous_remotes","network_version_too_old","unprocessed_network_task","unretrievable_document","unretrievable_error_code","unsupported_media_type","invalid_s3_snapshot_request","invalid_s3_snapshot_parameters","s3_snapshot_server_error","vector_embedding_error","not_found_similar_id","invalid_document_edition_context","invalid_document_edition_function_filter","edit_documents_by_function_error","invalid_settings_index_chat","invalid_export_url","invalid_export_api_key","invalid_export_payload_size","invalid_export_indexes_patterns","invalid_export_index_filter","invalid_export_index_override_settings","unimplemented_external_function_calling","unimplemented_non_streaming_chat_completions","unimplemented_multi_choice_chat_completions","chat_not_found","invalid_chat_setting_document_template","invalid_chat_completion_org_id","invalid_chat_completion_project_id","invalid_chat_completion_api_version","invalid_chat_completion_deployment_id","invalid_chat_completion_source","invalid_chat_completion_base_api","invalid_chat_completion_api_key","invalid_chat_completion_prompts","invalid_chat_completion_system_prompt","invalid_chat_completion_search_description_prompt","invalid_chat_completion_search_query_param_prompt","invalid_chat_completion_search_filter_param_prompt","invalid_chat_completion_search_index_uid_param_prompt","invalid_chat_completion_pre_query_prompt","invalid_index_fields_filter","invalid_index_fields_filter_attribute_patterns","invalid_index_fields_filter_displayed","invalid_index_fields_filter_searchable","invalid_index_fields_filter_sortable","invalid_index_fields_filter_distinct","invalid_index_fields_filter_ranking_rule","invalid_index_fields_filter_filterable","requires_enterprise_edition","invalid_render_template","invalid_render_input","render_document_not_found","template_parsing_error","template_rendering_error","invalid_webhooks","invalid_webhook_url","invalid_webhook_headers","immutable_webhook","invalid_webhook_uuid","webhook_not_found","immutable_webhook_uuid","immutable_webhook_is_editable","invalid_dynamic_search_rule_uid","invalid_dynamic_search_rule_offset","invalid_dynamic_search_rule_limit","invalid_dynamic_search_rule_filter","invalid_dynamic_search_rule_description","invalid_dynamic_search_rule_priority","invalid_dynamic_search_rule_active","invalid_dynamic_search_rule_conditions","invalid_dynamic_search_rule_actions","invalid_dynamic_search_rule_filter_query","invalid_dynamic_search_rule_filter_active","dynamic_search_rule_not_found"],"description":"The error code.","uniqueKey":"oneOf.0.remoteErrors.oneOf.1.additionalProperties.code","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["internal","invalid_request","auth","system"],"description":"The error type.","uniqueKey":"oneOf.0.remoteErrors.oneOf.1.additionalProperties.type","typeLabel":"enum\u003cstring>"},"link":{"type":"string","description":"A link to the documentation about this specific error.","uniqueKey":"oneOf.0.remoteErrors.oneOf.1.additionalProperties.link","typeLabel":"string"}},"uniqueKey":"oneOf.0.remoteErrors.oneOf.1.additionalProperties","typeLabel":"object"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.0.remoteErrors.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.remoteErrors","typeLabel":"object | null"},"semanticHitCount":{"oneOf":[{"type":"integer","format":"u-int32","minimum":0,"uniqueKey":"oneOf.0.semanticHitCount.oneOf.0","typeLabel":"integer\u003cu-int32>"},{"type":"null","format":"u-int32","minimum":0,"uniqueKey":"oneOf.0.semanticHitCount.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.semanticHitCount","typeLabel":"integer\u003cu-int32> | null"},"performanceDetails":{"oneOf":[{}],"uniqueKey":"oneOf.0.performanceDetails","typeLabel":"any"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"Response from a federated multi-search query","required":["hits","processingTimeMs","limit","offset","estimatedTotalHits"],"properties":{"limit":{"type":"integer","description":"Maximum number of documents returned.","minimum":0,"isRequired":true,"uniqueKey":"oneOf.1.limit","typeLabel":"integer"},"offset":{"type":"integer","description":"Number of documents skipped.","minimum":0,"isRequired":true,"uniqueKey":"oneOf.1.offset","typeLabel":"integer"},"estimatedTotalHits":{"type":"integer","description":"Estimated total number of matches (not exhaustive).\n\nPrioritizes relevancy and performance.","minimum":0,"isRequired":true,"uniqueKey":"oneOf.1.estimatedTotalHits","typeLabel":"integer"},"hits":{"type":"array","items":{"type":"object","description":"A single search result hit.","properties":{"_formatted":{"type":"object","description":"Document with highlighted and cropped attributes.\n\nPresent when `attributesToHighlight` or `attributesToCrop` was set.","additionalProperties":true,"uniqueKey":"oneOf.1.hits.items.[INDEX]._formatted","typeLabel":"object"},"_matchesPosition":{"oneOf":[{"type":"object","description":"Byte offsets (`start`, `length`) of each matched term per attribute.\n\nPresent when `showMatchesPosition` was true.","additionalProperties":{"type":"array","items":{"type":"object","description":"Represents the position of a matching term in a document field. Used to\nindicate where query terms were found within attribute values, enabling\nfeatures like highlighting and match position display.","required":["start","length"],"properties":{"start":{"type":"integer","description":"The byte offset where the match begins within the attribute value.\nThis is a zero-indexed position from the start of the string.","minimum":0,"isRequired":true,"uniqueKey":"oneOf.1.hits.items.[INDEX]._matchesPosition.oneOf.0.additionalProperties.items.[INDEX].start","typeLabel":"integer"},"length":{"type":"integer","description":"The length in bytes of the matched text. Combined with `start`, this\ndefines the exact substring that matched the query term.","minimum":0,"isRequired":true,"uniqueKey":"oneOf.1.hits.items.[INDEX]._matchesPosition.oneOf.0.additionalProperties.items.[INDEX].length","typeLabel":"integer"},"indices":{"oneOf":[{"type":"array","items":{"type":"integer","minimum":0,"uniqueKey":"oneOf.1.hits.items.[INDEX]._matchesPosition.oneOf.0.additionalProperties.items.[INDEX].indices.oneOf.0.items.[INDEX]","typeLabel":"integer"},"description":"Byte indices of individual matched characters when the match spans\nmultiple positions (e.g., for prefix matches). This is `null` for\nsimple contiguous matches.","uniqueKey":"oneOf.1.hits.items.[INDEX]._matchesPosition.oneOf.0.additionalProperties.items.[INDEX].indices.oneOf.0","typeLabel":"integer[]"},{"type":"null","items":{"type":"integer","minimum":0},"description":"Byte indices of individual matched characters when the match spans\nmultiple positions (e.g., for prefix matches). This is `null` for\nsimple contiguous matches.","uniqueKey":"oneOf.1.hits.items.[INDEX]._matchesPosition.oneOf.0.additionalProperties.items.[INDEX].indices.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.hits.items.[INDEX]._matchesPosition.oneOf.0.additionalProperties.items.[INDEX].indices","typeLabel":"integer[] | null"}},"uniqueKey":"oneOf.1.hits.items.[INDEX]._matchesPosition.oneOf.0.additionalProperties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.hits.items.[INDEX]._matchesPosition.oneOf.0.additionalProperties","typeLabel":"object[]"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.1.hits.items.[INDEX]._matchesPosition.oneOf.0","typeLabel":"object"},{"type":"null","description":"Byte offsets (`start`, `length`) of each matched term per attribute.\n\nPresent when `showMatchesPosition` was true.","additionalProperties":{"type":"array","items":{"type":"object","description":"Represents the position of a matching term in a document field. Used to\nindicate where query terms were found within attribute values, enabling\nfeatures like highlighting and match position display.","required":["start","length"],"properties":{"start":{"type":"integer","description":"The byte offset where the match begins within the attribute value.\nThis is a zero-indexed position from the start of the string.","minimum":0,"uniqueKey":"oneOf.1.hits.items.[INDEX]._matchesPosition.oneOf.1.additionalProperties.items.[INDEX].start","typeLabel":"integer"},"length":{"type":"integer","description":"The length in bytes of the matched text. Combined with `start`, this\ndefines the exact substring that matched the query term.","minimum":0,"uniqueKey":"oneOf.1.hits.items.[INDEX]._matchesPosition.oneOf.1.additionalProperties.items.[INDEX].length","typeLabel":"integer"},"indices":{"oneOf":[{"type":"array","items":{"type":"integer","minimum":0,"uniqueKey":"oneOf.1.hits.items.[INDEX]._matchesPosition.oneOf.1.additionalProperties.items.[INDEX].indices.oneOf.0.items.[INDEX]","typeLabel":"integer"},"description":"Byte indices of individual matched characters when the match spans\nmultiple positions (e.g., for prefix matches). This is `null` for\nsimple contiguous matches.","uniqueKey":"oneOf.1.hits.items.[INDEX]._matchesPosition.oneOf.1.additionalProperties.items.[INDEX].indices.oneOf.0","typeLabel":"integer[]"},{"type":"null","items":{"type":"integer","minimum":0},"description":"Byte indices of individual matched characters when the match spans\nmultiple positions (e.g., for prefix matches). This is `null` for\nsimple contiguous matches.","uniqueKey":"oneOf.1.hits.items.[INDEX]._matchesPosition.oneOf.1.additionalProperties.items.[INDEX].indices.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.hits.items.[INDEX]._matchesPosition.oneOf.1.additionalProperties.items.[INDEX].indices","typeLabel":"integer[] | null"}},"uniqueKey":"oneOf.1.hits.items.[INDEX]._matchesPosition.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.hits.items.[INDEX]._matchesPosition.oneOf.1.additionalProperties","typeLabel":"object[]"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.1.hits.items.[INDEX]._matchesPosition.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.hits.items.[INDEX]._matchesPosition","typeLabel":"object | null"},"_rankingScore":{"oneOf":[{"type":"number","format":"double","description":"Global [ranking score](https://www.meilisearch.com/docs/learn/relevancy/ranking_score) from 0.0 to 1.0.\n\nPresent when `showRankingScore` was true.","uniqueKey":"oneOf.1.hits.items.[INDEX]._rankingScore.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","description":"Global [ranking score](https://www.meilisearch.com/docs/learn/relevancy/ranking_score) from 0.0 to 1.0.\n\nPresent when `showRankingScore` was true.","uniqueKey":"oneOf.1.hits.items.[INDEX]._rankingScore.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.hits.items.[INDEX]._rankingScore","typeLabel":"number\u003cdouble> | null"},"_rankingScoreDetails":{"oneOf":[{"type":"object","description":"Per-rule score breakdown (words, typo, proximity, etc.).\n\nPresent when `showRankingScoreDetails` was true.","additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.1.hits.items.[INDEX]._rankingScoreDetails.oneOf.0.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.1.hits.items.[INDEX]._rankingScoreDetails.oneOf.0","typeLabel":"object"},{"type":"null","description":"Per-rule score breakdown (words, typo, proximity, etc.).\n\nPresent when `showRankingScoreDetails` was true.","additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.1.hits.items.[INDEX]._rankingScoreDetails.oneOf.1.additionalProperties","typeLabel":"any"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.1.hits.items.[INDEX]._rankingScoreDetails.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.hits.items.[INDEX]._rankingScoreDetails","typeLabel":"object | null"}},"additionalProperties":{"description":"Document fields as stored in the index.\n\nAccording to `attributesToRetrieve`.","uniqueKey":"oneOf.1.hits.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"oneOf.1.hits.items.[INDEX]","typeLabel":"object"},"description":"Combined search results from all queries","isRequired":true,"uniqueKey":"oneOf.1.hits","typeLabel":"object[]"},"processingTimeMs":{"type":"integer","description":"Total processing time in milliseconds","minimum":0,"isRequired":true,"uniqueKey":"oneOf.1.processingTimeMs","typeLabel":"integer"},"queryVectors":{"oneOf":[{"type":"object","description":"List of vectors per query, if `retrieveVectors` is set to `true`","additionalProperties":{"type":"array","items":{"type":"number","format":"float","uniqueKey":"oneOf.1.queryVectors.oneOf.0.additionalProperties.items.[INDEX]","typeLabel":"number\u003cfloat>"},"uniqueKey":"oneOf.1.queryVectors.oneOf.0.additionalProperties","typeLabel":"number\u003cfloat>[]"},"propertyNames":{"type":"integer","minimum":0},"uniqueKey":"oneOf.1.queryVectors.oneOf.0","typeLabel":"object"},{"type":"null","description":"List of vectors per query, if `retrieveVectors` is set to `true`","additionalProperties":{"type":"array","items":{"type":"number","format":"float","uniqueKey":"oneOf.1.queryVectors.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"number\u003cfloat>"},"uniqueKey":"oneOf.1.queryVectors.oneOf.1.additionalProperties","typeLabel":"number\u003cfloat>[]"},"propertyNames":{"type":"integer","minimum":0},"uniqueKey":"oneOf.1.queryVectors.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.queryVectors","typeLabel":"object | null"},"facetDistribution":{"oneOf":[{"type":"object","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"u-int64","minimum":0,"uniqueKey":"oneOf.1.facetDistribution.oneOf.0.additionalProperties.additionalProperties","typeLabel":"integer\u003cu-int64>"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.1.facetDistribution.oneOf.0.additionalProperties","typeLabel":"object"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.1.facetDistribution.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"u-int64","minimum":0,"uniqueKey":"oneOf.1.facetDistribution.oneOf.1.additionalProperties.additionalProperties","typeLabel":"integer\u003cu-int64>"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.1.facetDistribution.oneOf.1.additionalProperties","typeLabel":"object"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.1.facetDistribution.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.facetDistribution","typeLabel":"object | null"},"facetStats":{"oneOf":[{"type":"object","description":"Merged facet statistics across all indexes","additionalProperties":{"type":"object","description":"Minimum and maximum numeric values for a facet.\n\nPresent when the facet attribute has numeric values among matching documents.","required":["min","max"],"properties":{"min":{"type":"number","format":"double","description":"Lowest numeric value for this facet among matching documents.","isRequired":true,"uniqueKey":"oneOf.1.facetStats.oneOf.0.additionalProperties.min","typeLabel":"number\u003cdouble>"},"max":{"type":"number","format":"double","description":"Highest numeric value for this facet among matching documents.","isRequired":true,"uniqueKey":"oneOf.1.facetStats.oneOf.0.additionalProperties.max","typeLabel":"number\u003cdouble>"}},"uniqueKey":"oneOf.1.facetStats.oneOf.0.additionalProperties","typeLabel":"object"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.1.facetStats.oneOf.0","typeLabel":"object"},{"type":"null","description":"Merged facet statistics across all indexes","additionalProperties":{"type":"object","description":"Minimum and maximum numeric values for a facet.\n\nPresent when the facet attribute has numeric values among matching documents.","required":["min","max"],"properties":{"min":{"type":"number","format":"double","description":"Lowest numeric value for this facet among matching documents.","uniqueKey":"oneOf.1.facetStats.oneOf.1.additionalProperties.min","typeLabel":"number\u003cdouble>"},"max":{"type":"number","format":"double","description":"Highest numeric value for this facet among matching documents.","uniqueKey":"oneOf.1.facetStats.oneOf.1.additionalProperties.max","typeLabel":"number\u003cdouble>"}},"uniqueKey":"oneOf.1.facetStats.oneOf.1.additionalProperties","typeLabel":"object"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.1.facetStats.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.facetStats","typeLabel":"object | null"},"facetsByIndex":{"type":"object","additionalProperties":{"type":"object","description":"Computed facet data from a search","required":["distribution","stats"],"properties":{"distribution":{"type":"object","description":"Count of documents for each facet value","additionalProperties":{"type":"object","additionalProperties":{"type":"integer","format":"u-int64","minimum":0,"uniqueKey":"oneOf.1.facetsByIndex.additionalProperties.distribution.additionalProperties.additionalProperties","typeLabel":"integer\u003cu-int64>"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.1.facetsByIndex.additionalProperties.distribution.additionalProperties","typeLabel":"object"},"propertyNames":{"type":"string"},"isRequired":true,"uniqueKey":"oneOf.1.facetsByIndex.additionalProperties.distribution","typeLabel":"object"},"stats":{"type":"object","description":"Numeric statistics for each facet","additionalProperties":{"type":"object","description":"Minimum and maximum numeric values for a facet.\n\nPresent when the facet attribute has numeric values among matching documents.","required":["min","max"],"properties":{"min":{"type":"number","format":"double","description":"Lowest numeric value for this facet among matching documents.","isRequired":true,"uniqueKey":"oneOf.1.facetsByIndex.additionalProperties.stats.additionalProperties.min","typeLabel":"number\u003cdouble>"},"max":{"type":"number","format":"double","description":"Highest numeric value for this facet among matching documents.","isRequired":true,"uniqueKey":"oneOf.1.facetsByIndex.additionalProperties.stats.additionalProperties.max","typeLabel":"number\u003cdouble>"}},"uniqueKey":"oneOf.1.facetsByIndex.additionalProperties.stats.additionalProperties","typeLabel":"object"},"propertyNames":{"type":"string"},"isRequired":true,"uniqueKey":"oneOf.1.facetsByIndex.additionalProperties.stats","typeLabel":"object"}},"uniqueKey":"oneOf.1.facetsByIndex.additionalProperties","typeLabel":"object"},"propertyNames":{"type":"string"},"description":"Facets grouped by index","uniqueKey":"oneOf.1.facetsByIndex","typeLabel":"object"},"requestUid":{"oneOf":[{"type":"string","format":"uuid","description":"Unique identifier for the request","uniqueKey":"oneOf.1.requestUid.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Unique identifier for the request","uniqueKey":"oneOf.1.requestUid.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.requestUid","typeLabel":"string\u003cuuid> | null"},"metadata":{"oneOf":[{"type":"array","items":{"type":"object","description":"Metadata about a search query (included when requested via header).","required":["queryUid","indexUid"],"properties":{"queryUid":{"type":"string","format":"uuid","description":"Unique identifier for the query.","isRequired":true,"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].queryUid","typeLabel":"string\u003cuuid>"},"indexUid":{"type":"string","description":"UID of the index that was searched.","isRequired":true,"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].indexUid","typeLabel":"string"},"query":{"oneOf":[{"type":"string","description":"Query string set for the query, if not already present in the response.\n\nOnly set if:\n\n1. the metadata corresponds to a query in a federated search request, **and**\n2. that federated search request query is not a placeholder search (empty or missing `q`)\n\nNever set for regular search and non-federated multi-search because\nthe query(ies) are already present in the response.","uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].query.oneOf.0","typeLabel":"string"},{"type":"null","description":"Query string set for the query, if not already present in the response.\n\nOnly set if:\n\n1. the metadata corresponds to a query in a federated search request, **and**\n2. that federated search request query is not a placeholder search (empty or missing `q`)\n\nNever set for regular search and non-federated multi-search because\nthe query(ies) are already present in the response.","uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].query.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].query","typeLabel":"string | null"},"primaryKey":{"oneOf":[{"type":"string","description":"[Primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) of the index.","uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].primaryKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"[Primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) of the index.","uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].primaryKey.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].primaryKey","typeLabel":"string | null"},"remote":{"oneOf":[{"type":"string","description":"Remote that processed the query (federated search only).","uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].remote.oneOf.0","typeLabel":"string"},{"type":"null","description":"Remote that processed the query (federated search only).","uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].remote.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].remote","typeLabel":"string | null"},"inlineRuleConditionOutcomes":{"oneOf":[{"type":"null","uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.0","typeLabel":"null"},{"type":"object","description":"Outcome of checking the conditions of the dynamic search rule passed in `inlineRule`.\n\nOnly present in response if `inlineRule` was set in query.","required":["satisfiesActiveCondition"],"properties":{"satisfiesActiveCondition":{"type":"boolean","description":"Whether the rule was active","isRequired":true,"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesActiveCondition","typeLabel":"boolean"},"satisfiesTimeCondition":{"type":"string","description":"Whether the current time falls in the range of time specified by the condition","enum":["satisfied","noConstraint","tooEarly","tooLate"],"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesTimeCondition","typeLabel":"enum\u003cstring>"},"satisfiesQueryEmptyCondition":{"type":"string","description":"Whether the query emptiness condition aligns with the actual query","enum":["satisfied","noConstraint","queryNotEmpty","queryEmpty"],"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesQueryEmptyCondition","typeLabel":"enum\u003cstring>"},"satisfiesQueryWordsCondition":{"oneOf":[{"type":"string","description":"Whether the query words meet the condition","enum":["satisfied","noConstraint"],"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesQueryWordsCondition.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","description":"Whether the query words meet the condition","required":["missingWord"],"properties":{"missingWord":{"type":"object","description":"At least the specified word is missing in the query","required":["word"],"properties":{"word":{"type":"string","description":"Missing word in query","isRequired":true,"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesQueryWordsCondition.oneOf.1.missingWord.word","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesQueryWordsCondition.oneOf.1.missingWord","typeLabel":"object"}},"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesQueryWordsCondition.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesQueryWordsCondition","typeLabel":"enum\u003cstring> | object"},"satisfiesFilterCondition":{"oneOf":[{"type":"string","description":"Whether the filter meets the condition","enum":["satisfied","noConstraint"],"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","description":"Whether the filter meets the condition","required":["missingConstraintOnField"],"properties":{"missingConstraintOnField":{"type":"object","description":"At least one field from the condition is missing from the filter","required":["field"],"properties":{"field":{"type":"string","description":"Missing field in filter","isRequired":true,"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.1.missingConstraintOnField.field","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.1.missingConstraintOnField","typeLabel":"object"}},"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.1","typeLabel":"object"},{"type":"object","description":"Whether the filter meets the condition","required":["unmetConstraintOnField"],"properties":{"unmetConstraintOnField":{"type":"object","description":"At least one field has a condition not met in the filter","required":["field"],"properties":{"field":{"type":"string","description":"Field with unmet constraint in filter","isRequired":true,"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.2.unmetConstraintOnField.field","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.2.unmetConstraintOnField","typeLabel":"object"}},"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.2","typeLabel":"object"},{"type":"object","description":"Whether the filter meets the condition","required":["notEnoughFields"],"properties":{"notEnoughFields":{"type":"object","description":"The filter does not constraint enough field to satisfy the condition","required":["fieldCountInFilter","fieldCountInCondition"],"properties":{"fieldCountInFilter":{"type":"integer","description":"Number of fields in the filter","minimum":0,"isRequired":true,"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.3.notEnoughFields.fieldCountInFilter","typeLabel":"integer"},"fieldCountInCondition":{"type":"integer","description":"Number of fields in the condition","minimum":0,"isRequired":true,"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.3.notEnoughFields.fieldCountInCondition","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.3.notEnoughFields","typeLabel":"object"}},"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition.oneOf.3","typeLabel":"object"}],"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1.satisfiesFilterCondition","typeLabel":"enum\u003cstring> · object · object · object"}},"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX].inlineRuleConditionOutcomes","typeLabel":"null | object"}},"uniqueKey":"oneOf.1.metadata.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Metadata for each query","uniqueKey":"oneOf.1.metadata.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","description":"Metadata about a search query (included when requested via header).","required":["queryUid","indexUid"],"properties":{"query":{"oneOf":[{"type":"string","description":"Query string set for the query, if not already present in the response.\n\nOnly set if:\n\n1. the metadata corresponds to a query in a federated search request, **and**\n2. that federated search request query is not a placeholder search (empty or missing `q`)\n\nNever set for regular search and non-federated multi-search because\nthe query(ies) are already present in the response."},{"type":"null","description":"Query string set for the query, if not already present in the response.\n\nOnly set if:\n\n1. the metadata corresponds to a query in a federated search request, **and**\n2. that federated search request query is not a placeholder search (empty or missing `q`)\n\nNever set for regular search and non-federated multi-search because\nthe query(ies) are already present in the response."}]},"queryUid":{"type":"string","format":"uuid","description":"Unique identifier for the query."},"indexUid":{"type":"string","description":"UID of the index that was searched."},"primaryKey":{"oneOf":[{"type":"string","description":"[Primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) of the index."},{"type":"null","description":"[Primary key](https://www.meilisearch.com/docs/learn/getting_started/primary_key) of the index."}]},"remote":{"oneOf":[{"type":"string","description":"Remote that processed the query (federated search only)."},{"type":"null","description":"Remote that processed the query (federated search only)."}]},"inlineRuleConditionOutcomes":{"oneOf":[{"type":"null"},{"type":"object","description":"Outcome of checking the conditions of the dynamic search rule passed in `inlineRule`.\n\nOnly present in response if `inlineRule` was set in query.","required":["satisfiesActiveCondition"],"properties":{"satisfiesActiveCondition":{"type":"boolean","description":"Whether the rule was active"},"satisfiesTimeCondition":{"type":"string","description":"Whether the current time falls in the range of time specified by the condition","enum":["satisfied","noConstraint","tooEarly","tooLate"]},"satisfiesQueryEmptyCondition":{"type":"string","description":"Whether the query emptiness condition aligns with the actual query","enum":["satisfied","noConstraint","queryNotEmpty","queryEmpty"]},"satisfiesQueryWordsCondition":{"oneOf":[{"type":"string","description":"Whether the query words meet the condition","enum":["satisfied","noConstraint"]},{"type":"object","description":"Whether the query words meet the condition","required":["missingWord"],"properties":{"missingWord":{"type":"object","description":"At least the specified word is missing in the query","required":["word"],"properties":{"word":{"type":"string","description":"Missing word in query"}}}}}]},"satisfiesFilterCondition":{"oneOf":[{"type":"string","description":"Whether the filter meets the condition","enum":["satisfied","noConstraint"]},{"type":"object","description":"Whether the filter meets the condition","required":["missingConstraintOnField"],"properties":{"missingConstraintOnField":{"type":"object","description":"At least one field from the condition is missing from the filter","required":["field"],"properties":{"field":{"type":"string","description":"Missing field in filter"}}}}},{"type":"object","description":"Whether the filter meets the condition","required":["unmetConstraintOnField"],"properties":{"unmetConstraintOnField":{"type":"object","description":"At least one field has a condition not met in the filter","required":["field"],"properties":{"field":{"type":"string","description":"Field with unmet constraint in filter"}}}}},{"type":"object","description":"Whether the filter meets the condition","required":["notEnoughFields"],"properties":{"notEnoughFields":{"type":"object","description":"The filter does not constraint enough field to satisfy the condition","required":["fieldCountInFilter","fieldCountInCondition"],"properties":{"fieldCountInFilter":{"type":"integer","description":"Number of fields in the filter","minimum":0},"fieldCountInCondition":{"type":"integer","description":"Number of fields in the condition","minimum":0}}}}}]}}}]}}},"description":"Metadata for each query","uniqueKey":"oneOf.1.metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.metadata","typeLabel":"object[] | null"},"remoteErrors":{"oneOf":[{"type":"object","description":"Errors from remote servers","additionalProperties":{"type":"object","required":["message","code","type","link"],"properties":{"message":{"type":"string","description":"The error message.","isRequired":true,"uniqueKey":"oneOf.1.remoteErrors.oneOf.0.additionalProperties.message","typeLabel":"string"},"code":{"type":"string","enum":["api_key_already_exists","api_key_not_found","index_scoped_api_key_with_global_action","bad_parameter","bad_request","database_size_limit_reached","document_not_found","dump_already_processing","dump_not_found","dump_process_failed","duplicate_index_found","immutable_api_key_actions","immutable_api_key_created_at","immutable_api_key_expires_at","immutable_api_key_indexes","immutable_api_key_key","immutable_api_key_uid","immutable_api_key_updated_at","immutable_index_created_at","immutable_index_updated_at","import_task_already_received","import_task_unknown_remote","receive_import_finished_unknown_remote","import_task_without_network_task","index_already_exists","index_creation_failed","index_not_found","index_primary_key_already_exists","index_primary_key_multiple_candidates_found","index_primary_key_no_candidate_found","internal","invalid_api_key","invalid_api_key_actions","invalid_api_key_description","invalid_api_key_expires_at","invalid_api_key_indexes","invalid_api_key_limit","invalid_api_key_name","invalid_api_key_offset","invalid_api_key_uid","invalid_content_type","invalid_document_csv_delimiter","invalid_document_fields","invalid_document_retrieve_vectors","missing_document_filter","missing_document_edition_function","inconsistent_document_change_headers","invalid_document_filter","invalid_document_sort","invalid_document_use_network","invalid_document_retrieve","invalid_document_geo_field","invalid_document_geojson_field","invalid_header_value","invalid_vector_dimensions","invalid_vectors_type","invalid_document_id","invalid_document_ids","invalid_document_limit","invalid_document_offset","invalid_search_embedder","invalid_similar_embedder","invalid_search_hybrid_query","invalid_index_limit","invalid_index_offset","invalid_index_primary_key","invalid_index_custom_metadata","invalid_skip_creation","invalid_index_uid","invalid_multi_search_facets","invalid_multi_search_facets_by_index","invalid_multi_search_facet_order","invalid_multi_search_query_personalization","invalid_multi_search_query_show_performance_details","invalid_multi_search_federated","invalid_multi_search_federation_options","invalid_multi_search_max_values_per_facet","invalid_multi_search_merge_facets","invalid_multi_search_query_facets","invalid_multi_search_distinct","invalid_multi_search_query_pagination","invalid_multi_search_query_ranking_rules","invalid_multi_search_query_position","invalid_multi_search_remote","invalid_multi_search_weight","invalid_network_leader","invalid_network_remotes","invalid_network_shards","invalid_network_self","invalid_network_search_api_key","invalid_network_write_api_key","invalid_network_url","invalid_search_attributes_to_search_on","invalid_search_attributes_to_crop","invalid_search_attributes_to_highlight","invalid_similar_attributes_to_retrieve","invalid_similar_retrieve_vectors","invalid_search_attributes_to_retrieve","invalid_search_ranking_score_threshold","invalid_similar_ranking_score_threshold","invalid_search_retrieve_vectors","invalid_search_crop_length","invalid_search_crop_marker","invalid_search_facets","invalid_search_semantic_ratio","invalid_search_locales","invalid_facet_search_exhaustive_facet_count","invalid_facet_search_facet_name","invalid_similar_id","invalid_search_filter","invalid_similar_filter","invalid_search_highlight_post_tag","invalid_search_highlight_pre_tag","invalid_search_hits_per_page","invalid_similar_limit","invalid_search_limit","invalid_search_matching_strategy","invalid_similar_offset","invalid_search_offset","invalid_search_page","invalid_search_q","invalid_facet_search_query","invalid_facet_search_name","facet_search_disabled","invalid_search_vector","invalid_search_media","invalid_search_show_matches_position","invalid_search_show_ranking_score","invalid_similar_show_ranking_score","invalid_search_show_ranking_score_details","invalid_search_show_performance_details","invalid_search_use_network","invalid_similar_show_ranking_score_details","invalid_similar_show_performance_details","invalid_search_sort","invalid_search_distinct","invalid_search_personalize","invalid_search_personalize_user_context","invalid_search_media_and_vector","invalid_settings_displayed_attributes","invalid_settings_distinct_attribute","invalid_settings_proximity_precision","invalid_settings_facet_search","invalid_settings_prefix_search","invalid_settings_faceting","invalid_settings_filterable_attributes","invalid_settings_foreign_keys","invalid_settings_pagination","invalid_settings_search_cutoff_ms","invalid_settings_embedders","invalid_settings_ranking_rules","invalid_settings_searchable_attributes","invalid_settings_sortable_attributes","invalid_settings_stop_words","invalid_settings_non_separator_tokens","invalid_settings_separator_tokens","invalid_settings_dictionary","invalid_settings_synonyms","invalid_settings_typo_tolerance","invalid_settings_localized_attributes","invalid_state","invalid_stats_show_internal_database_sizes","invalid_stats_size_format","invalid_store_file","invalid_swap_duplicate_index_found","invalid_swap_indexes","invalid_swap_rename","invalid_task_after_enqueued_at","invalid_task_after_finished_at","invalid_task_after_started_at","invalid_task_before_enqueued_at","invalid_task_before_finished_at","invalid_task_before_started_at","invalid_task_canceled_by","invalid_task_from","invalid_task_limit","invalid_task_reverse","invalid_task_statuses","invalid_task_types","invalid_task_uids","invalid_batch_uids","io_error","feature_not_enabled","malformed_payload","max_fields_limit_exceeded","missing_api_key_actions","missing_api_key_expires_at","missing_api_key_indexes","missing_authorization_header","missing_content_type","missing_document_id","missing_facet_search_facet_name","missing_index_uid","missing_master_key","missing_network_url","missing_payload","missing_search_hybrid","missing_swap_indexes","missing_task_filters","network_version_mismatch","no_space_left_on_device","not_leader","payload_too_large","remote_bad_response","remote_bad_request","unknown_remote","remote_could_not_send_request","remote_invalid_api_key","remote_remote_error","remote_timeout","too_many_search_requests","task_not_found","task_file_not_found","batch_not_found","too_many_open_files","too_many_vectors","unexpected_network_previous_remotes","network_version_too_old","unprocessed_network_task","unretrievable_document","unretrievable_error_code","unsupported_media_type","invalid_s3_snapshot_request","invalid_s3_snapshot_parameters","s3_snapshot_server_error","vector_embedding_error","not_found_similar_id","invalid_document_edition_context","invalid_document_edition_function_filter","edit_documents_by_function_error","invalid_settings_index_chat","invalid_export_url","invalid_export_api_key","invalid_export_payload_size","invalid_export_indexes_patterns","invalid_export_index_filter","invalid_export_index_override_settings","unimplemented_external_function_calling","unimplemented_non_streaming_chat_completions","unimplemented_multi_choice_chat_completions","chat_not_found","invalid_chat_setting_document_template","invalid_chat_completion_org_id","invalid_chat_completion_project_id","invalid_chat_completion_api_version","invalid_chat_completion_deployment_id","invalid_chat_completion_source","invalid_chat_completion_base_api","invalid_chat_completion_api_key","invalid_chat_completion_prompts","invalid_chat_completion_system_prompt","invalid_chat_completion_search_description_prompt","invalid_chat_completion_search_query_param_prompt","invalid_chat_completion_search_filter_param_prompt","invalid_chat_completion_search_index_uid_param_prompt","invalid_chat_completion_pre_query_prompt","invalid_index_fields_filter","invalid_index_fields_filter_attribute_patterns","invalid_index_fields_filter_displayed","invalid_index_fields_filter_searchable","invalid_index_fields_filter_sortable","invalid_index_fields_filter_distinct","invalid_index_fields_filter_ranking_rule","invalid_index_fields_filter_filterable","requires_enterprise_edition","invalid_render_template","invalid_render_input","render_document_not_found","template_parsing_error","template_rendering_error","invalid_webhooks","invalid_webhook_url","invalid_webhook_headers","immutable_webhook","invalid_webhook_uuid","webhook_not_found","immutable_webhook_uuid","immutable_webhook_is_editable","invalid_dynamic_search_rule_uid","invalid_dynamic_search_rule_offset","invalid_dynamic_search_rule_limit","invalid_dynamic_search_rule_filter","invalid_dynamic_search_rule_description","invalid_dynamic_search_rule_priority","invalid_dynamic_search_rule_active","invalid_dynamic_search_rule_conditions","invalid_dynamic_search_rule_actions","invalid_dynamic_search_rule_filter_query","invalid_dynamic_search_rule_filter_active","dynamic_search_rule_not_found"],"description":"The error code.","isRequired":true,"uniqueKey":"oneOf.1.remoteErrors.oneOf.0.additionalProperties.code","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["internal","invalid_request","auth","system"],"description":"The error type.","isRequired":true,"uniqueKey":"oneOf.1.remoteErrors.oneOf.0.additionalProperties.type","typeLabel":"enum\u003cstring>"},"link":{"type":"string","description":"A link to the documentation about this specific error.","isRequired":true,"uniqueKey":"oneOf.1.remoteErrors.oneOf.0.additionalProperties.link","typeLabel":"string"}},"uniqueKey":"oneOf.1.remoteErrors.oneOf.0.additionalProperties","typeLabel":"object"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.1.remoteErrors.oneOf.0","typeLabel":"object"},{"type":"null","description":"Errors from remote servers","additionalProperties":{"type":"object","required":["message","code","type","link"],"properties":{"message":{"type":"string","description":"The error message.","uniqueKey":"oneOf.1.remoteErrors.oneOf.1.additionalProperties.message","typeLabel":"string"},"code":{"type":"string","enum":["api_key_already_exists","api_key_not_found","index_scoped_api_key_with_global_action","bad_parameter","bad_request","database_size_limit_reached","document_not_found","dump_already_processing","dump_not_found","dump_process_failed","duplicate_index_found","immutable_api_key_actions","immutable_api_key_created_at","immutable_api_key_expires_at","immutable_api_key_indexes","immutable_api_key_key","immutable_api_key_uid","immutable_api_key_updated_at","immutable_index_created_at","immutable_index_updated_at","import_task_already_received","import_task_unknown_remote","receive_import_finished_unknown_remote","import_task_without_network_task","index_already_exists","index_creation_failed","index_not_found","index_primary_key_already_exists","index_primary_key_multiple_candidates_found","index_primary_key_no_candidate_found","internal","invalid_api_key","invalid_api_key_actions","invalid_api_key_description","invalid_api_key_expires_at","invalid_api_key_indexes","invalid_api_key_limit","invalid_api_key_name","invalid_api_key_offset","invalid_api_key_uid","invalid_content_type","invalid_document_csv_delimiter","invalid_document_fields","invalid_document_retrieve_vectors","missing_document_filter","missing_document_edition_function","inconsistent_document_change_headers","invalid_document_filter","invalid_document_sort","invalid_document_use_network","invalid_document_retrieve","invalid_document_geo_field","invalid_document_geojson_field","invalid_header_value","invalid_vector_dimensions","invalid_vectors_type","invalid_document_id","invalid_document_ids","invalid_document_limit","invalid_document_offset","invalid_search_embedder","invalid_similar_embedder","invalid_search_hybrid_query","invalid_index_limit","invalid_index_offset","invalid_index_primary_key","invalid_index_custom_metadata","invalid_skip_creation","invalid_index_uid","invalid_multi_search_facets","invalid_multi_search_facets_by_index","invalid_multi_search_facet_order","invalid_multi_search_query_personalization","invalid_multi_search_query_show_performance_details","invalid_multi_search_federated","invalid_multi_search_federation_options","invalid_multi_search_max_values_per_facet","invalid_multi_search_merge_facets","invalid_multi_search_query_facets","invalid_multi_search_distinct","invalid_multi_search_query_pagination","invalid_multi_search_query_ranking_rules","invalid_multi_search_query_position","invalid_multi_search_remote","invalid_multi_search_weight","invalid_network_leader","invalid_network_remotes","invalid_network_shards","invalid_network_self","invalid_network_search_api_key","invalid_network_write_api_key","invalid_network_url","invalid_search_attributes_to_search_on","invalid_search_attributes_to_crop","invalid_search_attributes_to_highlight","invalid_similar_attributes_to_retrieve","invalid_similar_retrieve_vectors","invalid_search_attributes_to_retrieve","invalid_search_ranking_score_threshold","invalid_similar_ranking_score_threshold","invalid_search_retrieve_vectors","invalid_search_crop_length","invalid_search_crop_marker","invalid_search_facets","invalid_search_semantic_ratio","invalid_search_locales","invalid_facet_search_exhaustive_facet_count","invalid_facet_search_facet_name","invalid_similar_id","invalid_search_filter","invalid_similar_filter","invalid_search_highlight_post_tag","invalid_search_highlight_pre_tag","invalid_search_hits_per_page","invalid_similar_limit","invalid_search_limit","invalid_search_matching_strategy","invalid_similar_offset","invalid_search_offset","invalid_search_page","invalid_search_q","invalid_facet_search_query","invalid_facet_search_name","facet_search_disabled","invalid_search_vector","invalid_search_media","invalid_search_show_matches_position","invalid_search_show_ranking_score","invalid_similar_show_ranking_score","invalid_search_show_ranking_score_details","invalid_search_show_performance_details","invalid_search_use_network","invalid_similar_show_ranking_score_details","invalid_similar_show_performance_details","invalid_search_sort","invalid_search_distinct","invalid_search_personalize","invalid_search_personalize_user_context","invalid_search_media_and_vector","invalid_settings_displayed_attributes","invalid_settings_distinct_attribute","invalid_settings_proximity_precision","invalid_settings_facet_search","invalid_settings_prefix_search","invalid_settings_faceting","invalid_settings_filterable_attributes","invalid_settings_foreign_keys","invalid_settings_pagination","invalid_settings_search_cutoff_ms","invalid_settings_embedders","invalid_settings_ranking_rules","invalid_settings_searchable_attributes","invalid_settings_sortable_attributes","invalid_settings_stop_words","invalid_settings_non_separator_tokens","invalid_settings_separator_tokens","invalid_settings_dictionary","invalid_settings_synonyms","invalid_settings_typo_tolerance","invalid_settings_localized_attributes","invalid_state","invalid_stats_show_internal_database_sizes","invalid_stats_size_format","invalid_store_file","invalid_swap_duplicate_index_found","invalid_swap_indexes","invalid_swap_rename","invalid_task_after_enqueued_at","invalid_task_after_finished_at","invalid_task_after_started_at","invalid_task_before_enqueued_at","invalid_task_before_finished_at","invalid_task_before_started_at","invalid_task_canceled_by","invalid_task_from","invalid_task_limit","invalid_task_reverse","invalid_task_statuses","invalid_task_types","invalid_task_uids","invalid_batch_uids","io_error","feature_not_enabled","malformed_payload","max_fields_limit_exceeded","missing_api_key_actions","missing_api_key_expires_at","missing_api_key_indexes","missing_authorization_header","missing_content_type","missing_document_id","missing_facet_search_facet_name","missing_index_uid","missing_master_key","missing_network_url","missing_payload","missing_search_hybrid","missing_swap_indexes","missing_task_filters","network_version_mismatch","no_space_left_on_device","not_leader","payload_too_large","remote_bad_response","remote_bad_request","unknown_remote","remote_could_not_send_request","remote_invalid_api_key","remote_remote_error","remote_timeout","too_many_search_requests","task_not_found","task_file_not_found","batch_not_found","too_many_open_files","too_many_vectors","unexpected_network_previous_remotes","network_version_too_old","unprocessed_network_task","unretrievable_document","unretrievable_error_code","unsupported_media_type","invalid_s3_snapshot_request","invalid_s3_snapshot_parameters","s3_snapshot_server_error","vector_embedding_error","not_found_similar_id","invalid_document_edition_context","invalid_document_edition_function_filter","edit_documents_by_function_error","invalid_settings_index_chat","invalid_export_url","invalid_export_api_key","invalid_export_payload_size","invalid_export_indexes_patterns","invalid_export_index_filter","invalid_export_index_override_settings","unimplemented_external_function_calling","unimplemented_non_streaming_chat_completions","unimplemented_multi_choice_chat_completions","chat_not_found","invalid_chat_setting_document_template","invalid_chat_completion_org_id","invalid_chat_completion_project_id","invalid_chat_completion_api_version","invalid_chat_completion_deployment_id","invalid_chat_completion_source","invalid_chat_completion_base_api","invalid_chat_completion_api_key","invalid_chat_completion_prompts","invalid_chat_completion_system_prompt","invalid_chat_completion_search_description_prompt","invalid_chat_completion_search_query_param_prompt","invalid_chat_completion_search_filter_param_prompt","invalid_chat_completion_search_index_uid_param_prompt","invalid_chat_completion_pre_query_prompt","invalid_index_fields_filter","invalid_index_fields_filter_attribute_patterns","invalid_index_fields_filter_displayed","invalid_index_fields_filter_searchable","invalid_index_fields_filter_sortable","invalid_index_fields_filter_distinct","invalid_index_fields_filter_ranking_rule","invalid_index_fields_filter_filterable","requires_enterprise_edition","invalid_render_template","invalid_render_input","render_document_not_found","template_parsing_error","template_rendering_error","invalid_webhooks","invalid_webhook_url","invalid_webhook_headers","immutable_webhook","invalid_webhook_uuid","webhook_not_found","immutable_webhook_uuid","immutable_webhook_is_editable","invalid_dynamic_search_rule_uid","invalid_dynamic_search_rule_offset","invalid_dynamic_search_rule_limit","invalid_dynamic_search_rule_filter","invalid_dynamic_search_rule_description","invalid_dynamic_search_rule_priority","invalid_dynamic_search_rule_active","invalid_dynamic_search_rule_conditions","invalid_dynamic_search_rule_actions","invalid_dynamic_search_rule_filter_query","invalid_dynamic_search_rule_filter_active","dynamic_search_rule_not_found"],"description":"The error code.","uniqueKey":"oneOf.1.remoteErrors.oneOf.1.additionalProperties.code","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["internal","invalid_request","auth","system"],"description":"The error type.","uniqueKey":"oneOf.1.remoteErrors.oneOf.1.additionalProperties.type","typeLabel":"enum\u003cstring>"},"link":{"type":"string","description":"A link to the documentation about this specific error.","uniqueKey":"oneOf.1.remoteErrors.oneOf.1.additionalProperties.link","typeLabel":"string"}},"uniqueKey":"oneOf.1.remoteErrors.oneOf.1.additionalProperties","typeLabel":"object"},"propertyNames":{"type":"string"},"uniqueKey":"oneOf.1.remoteErrors.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.remoteErrors","typeLabel":"object | null"},"semanticHitCount":{"oneOf":[{"type":"integer","format":"u-int32","minimum":0,"uniqueKey":"oneOf.1.semanticHitCount.oneOf.0","typeLabel":"integer\u003cu-int32>"},{"type":"null","format":"u-int32","minimum":0,"uniqueKey":"oneOf.1.semanticHitCount.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.semanticHitCount","typeLabel":"integer\u003cu-int32> | null"},"performanceDetails":{"oneOf":[{}],"uniqueKey":"oneOf.1.performanceDetails","typeLabel":"any"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"example":{"hits":[{"id":42,"title":"Batman returns","overview":"The overview of batman returns","_federation":{"indexUid":"movies","queriesPosition":0}},{"comicsId":"batman-killing-joke","description":"This comic is really awesome","title":"Batman: the killing joke","_federation":{"indexUid":"comics","queriesPosition":1}}],"processingTimeMs":0,"limit":20,"offset":0,"estimatedTotalHits":2,"semanticHitCount":0},"examples":{"Example":{"title":"Example","value":{"hits":[{"id":42,"title":"Batman returns","overview":"The overview of batman returns","_federation":{"indexUid":"movies","queriesPosition":0}},{"comicsId":"batman-killing-joke","description":"This comic is really awesome","title":"Batman: the killing joke","_federation":{"indexUid":"comics","queriesPosition":1}}],"processingTimeMs":0,"limit":20,"offset":0,"estimatedTotalHits":2,"semanticHitCount":0}}},"exampleType":"examples"}},"exampleType":"examples"},"9e539e98-61e6-4f93-9b34-705a6ef5d13c":{"description":"The authorization header is missing.","content":{"application/json":{"schema":{"type":"object","required":["message","code","type","link"],"properties":{"message":{"type":"string","description":"The error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"string","enum":["api_key_already_exists","api_key_not_found","index_scoped_api_key_with_global_action","bad_parameter","bad_request","database_size_limit_reached","document_not_found","dump_already_processing","dump_not_found","dump_process_failed","duplicate_index_found","immutable_api_key_actions","immutable_api_key_created_at","immutable_api_key_expires_at","immutable_api_key_indexes","immutable_api_key_key","immutable_api_key_uid","immutable_api_key_updated_at","immutable_index_created_at","immutable_index_updated_at","import_task_already_received","import_task_unknown_remote","receive_import_finished_unknown_remote","import_task_without_network_task","index_already_exists","index_creation_failed","index_not_found","index_primary_key_already_exists","index_primary_key_multiple_candidates_found","index_primary_key_no_candidate_found","internal","invalid_api_key","invalid_api_key_actions","invalid_api_key_description","invalid_api_key_expires_at","invalid_api_key_indexes","invalid_api_key_limit","invalid_api_key_name","invalid_api_key_offset","invalid_api_key_uid","invalid_content_type","invalid_document_csv_delimiter","invalid_document_fields","invalid_document_retrieve_vectors","missing_document_filter","missing_document_edition_function","inconsistent_document_change_headers","invalid_document_filter","invalid_document_sort","invalid_document_use_network","invalid_document_retrieve","invalid_document_geo_field","invalid_document_geojson_field","invalid_header_value","invalid_vector_dimensions","invalid_vectors_type","invalid_document_id","invalid_document_ids","invalid_document_limit","invalid_document_offset","invalid_search_embedder","invalid_similar_embedder","invalid_search_hybrid_query","invalid_index_limit","invalid_index_offset","invalid_index_primary_key","invalid_index_custom_metadata","invalid_skip_creation","invalid_index_uid","invalid_multi_search_facets","invalid_multi_search_facets_by_index","invalid_multi_search_facet_order","invalid_multi_search_query_personalization","invalid_multi_search_query_show_performance_details","invalid_multi_search_federated","invalid_multi_search_federation_options","invalid_multi_search_max_values_per_facet","invalid_multi_search_merge_facets","invalid_multi_search_query_facets","invalid_multi_search_distinct","invalid_multi_search_query_pagination","invalid_multi_search_query_ranking_rules","invalid_multi_search_query_position","invalid_multi_search_remote","invalid_multi_search_weight","invalid_network_leader","invalid_network_remotes","invalid_network_shards","invalid_network_self","invalid_network_search_api_key","invalid_network_write_api_key","invalid_network_url","invalid_search_attributes_to_search_on","invalid_search_attributes_to_crop","invalid_search_attributes_to_highlight","invalid_similar_attributes_to_retrieve","invalid_similar_retrieve_vectors","invalid_search_attributes_to_retrieve","invalid_search_ranking_score_threshold","invalid_similar_ranking_score_threshold","invalid_search_retrieve_vectors","invalid_search_crop_length","invalid_search_crop_marker","invalid_search_facets","invalid_search_semantic_ratio","invalid_search_locales","invalid_facet_search_exhaustive_facet_count","invalid_facet_search_facet_name","invalid_similar_id","invalid_search_filter","invalid_similar_filter","invalid_search_highlight_post_tag","invalid_search_highlight_pre_tag","invalid_search_hits_per_page","invalid_similar_limit","invalid_search_limit","invalid_search_matching_strategy","invalid_similar_offset","invalid_search_offset","invalid_search_page","invalid_search_q","invalid_facet_search_query","invalid_facet_search_name","facet_search_disabled","invalid_search_vector","invalid_search_media","invalid_search_show_matches_position","invalid_search_show_ranking_score","invalid_similar_show_ranking_score","invalid_search_show_ranking_score_details","invalid_search_show_performance_details","invalid_search_use_network","invalid_similar_show_ranking_score_details","invalid_similar_show_performance_details","invalid_search_sort","invalid_search_distinct","invalid_search_personalize","invalid_search_personalize_user_context","invalid_search_media_and_vector","invalid_settings_displayed_attributes","invalid_settings_distinct_attribute","invalid_settings_proximity_precision","invalid_settings_facet_search","invalid_settings_prefix_search","invalid_settings_faceting","invalid_settings_filterable_attributes","invalid_settings_foreign_keys","invalid_settings_pagination","invalid_settings_search_cutoff_ms","invalid_settings_embedders","invalid_settings_ranking_rules","invalid_settings_searchable_attributes","invalid_settings_sortable_attributes","invalid_settings_stop_words","invalid_settings_non_separator_tokens","invalid_settings_separator_tokens","invalid_settings_dictionary","invalid_settings_synonyms","invalid_settings_typo_tolerance","invalid_settings_localized_attributes","invalid_state","invalid_stats_show_internal_database_sizes","invalid_stats_size_format","invalid_store_file","invalid_swap_duplicate_index_found","invalid_swap_indexes","invalid_swap_rename","invalid_task_after_enqueued_at","invalid_task_after_finished_at","invalid_task_after_started_at","invalid_task_before_enqueued_at","invalid_task_before_finished_at","invalid_task_before_started_at","invalid_task_canceled_by","invalid_task_from","invalid_task_limit","invalid_task_reverse","invalid_task_statuses","invalid_task_types","invalid_task_uids","invalid_batch_uids","io_error","feature_not_enabled","malformed_payload","max_fields_limit_exceeded","missing_api_key_actions","missing_api_key_expires_at","missing_api_key_indexes","missing_authorization_header","missing_content_type","missing_document_id","missing_facet_search_facet_name","missing_index_uid","missing_master_key","missing_network_url","missing_payload","missing_search_hybrid","missing_swap_indexes","missing_task_filters","network_version_mismatch","no_space_left_on_device","not_leader","payload_too_large","remote_bad_response","remote_bad_request","unknown_remote","remote_could_not_send_request","remote_invalid_api_key","remote_remote_error","remote_timeout","too_many_search_requests","task_not_found","task_file_not_found","batch_not_found","too_many_open_files","too_many_vectors","unexpected_network_previous_remotes","network_version_too_old","unprocessed_network_task","unretrievable_document","unretrievable_error_code","unsupported_media_type","invalid_s3_snapshot_request","invalid_s3_snapshot_parameters","s3_snapshot_server_error","vector_embedding_error","not_found_similar_id","invalid_document_edition_context","invalid_document_edition_function_filter","edit_documents_by_function_error","invalid_settings_index_chat","invalid_export_url","invalid_export_api_key","invalid_export_payload_size","invalid_export_indexes_patterns","invalid_export_index_filter","invalid_export_index_override_settings","unimplemented_external_function_calling","unimplemented_non_streaming_chat_completions","unimplemented_multi_choice_chat_completions","chat_not_found","invalid_chat_setting_document_template","invalid_chat_completion_org_id","invalid_chat_completion_project_id","invalid_chat_completion_api_version","invalid_chat_completion_deployment_id","invalid_chat_completion_source","invalid_chat_completion_base_api","invalid_chat_completion_api_key","invalid_chat_completion_prompts","invalid_chat_completion_system_prompt","invalid_chat_completion_search_description_prompt","invalid_chat_completion_search_query_param_prompt","invalid_chat_completion_search_filter_param_prompt","invalid_chat_completion_search_index_uid_param_prompt","invalid_chat_completion_pre_query_prompt","invalid_index_fields_filter","invalid_index_fields_filter_attribute_patterns","invalid_index_fields_filter_displayed","invalid_index_fields_filter_searchable","invalid_index_fields_filter_sortable","invalid_index_fields_filter_distinct","invalid_index_fields_filter_ranking_rule","invalid_index_fields_filter_filterable","requires_enterprise_edition","invalid_render_template","invalid_render_input","render_document_not_found","template_parsing_error","template_rendering_error","invalid_webhooks","invalid_webhook_url","invalid_webhook_headers","immutable_webhook","invalid_webhook_uuid","webhook_not_found","immutable_webhook_uuid","immutable_webhook_is_editable","invalid_dynamic_search_rule_uid","invalid_dynamic_search_rule_offset","invalid_dynamic_search_rule_limit","invalid_dynamic_search_rule_filter","invalid_dynamic_search_rule_description","invalid_dynamic_search_rule_priority","invalid_dynamic_search_rule_active","invalid_dynamic_search_rule_conditions","invalid_dynamic_search_rule_actions","invalid_dynamic_search_rule_filter_query","invalid_dynamic_search_rule_filter_active","dynamic_search_rule_not_found"],"description":"The error code.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"type":{"type":"string","enum":["internal","invalid_request","auth","system"],"description":"The error type.","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"link":{"type":"string","description":"A link to the documentation about this specific error.","isRequired":true,"uniqueKey":"link","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"The Authorization header is missing. It must use the bearer authorization method.","code":"missing_authorization_header","type":"auth","link":"https://docs.meilisearch.com/errors#missing_authorization_header"},"examples":{"Example":{"title":"Example","value":{"message":"The Authorization header is missing. It must use the bearer authorization method.","code":"missing_authorization_header","type":"auth","link":"https://docs.meilisearch.com/errors#missing_authorization_header"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"421a27cd-04f3-40ca-a70f-35d362031e31":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"Uuidv4, string or JWT","description":"An API key is a token that you provide when making API calls. Read more about [how to secure your project](https://www.meilisearch.com/docs/learn/security/basic_security).\n\nInclude the API key to the `Authorization` header, for instance:\n```bash\n-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'\n```\n\nIf you use a SDK, ensure you instantiate the client with the API key, for instance with [JS SDK](https://github.com/meilisearch/meilisearch-js):\n```js\nconst client = new MeiliSearch({\n host: 'MEILISEARCH_URL',\n apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1'\n});\n```","scopes":["search","*"],"schemeName":"Bearer"}}},"servers":{"bdde1061-cfb1-4636-a2c9-40d85a2fd614":{"url":"http://localhost:7700","description":"Local server."}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"Uuidv4, string or JWT","description":"An API key is a token that you provide when making API calls. Read more about [how to secure your project](https://www.meilisearch.com/docs/learn/security/basic_security).\n\nInclude the API key to the `Authorization` header, for instance:\n```bash\n-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'\n```\n\nIf you use a SDK, ensure you instantiate the client with the API key, for instance with [JS SDK](https://github.com/meilisearch/meilisearch-js):\n```js\nconst client = new MeiliSearch({\n host: 'MEILISEARCH_URL',\n apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1'\n});\n```","scopes":["search","*"],"schemeName":"Bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key is a token that you provide when making API calls. Read more about [how to secure your project](https://www.meilisearch.com/docs/learn/security/basic_security).\n\nInclude the API key to the `Authorization` header, for instance:\n```bash\n-H 'Authorization: Bearer 6436fc5237b0d6e0d64253fbaac21d135012ecf1'\n```\n\nIf you use a SDK, ensure you instantiate the client with the API key, for instance with [JS SDK](https://github.com/meilisearch/meilisearch-js):\n```js\nconst client = new MeiliSearch({\n host: 'MEILISEARCH_URL',\n apiKey: '6436fc5237b0d6e0d64253fbaac21d135012ecf1'\n});\n```","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"assets/release-assets/meilisearch-openapi-mintlify.json"},"subdomain":"meilisearch-6b28dec2","siteName":"Meilisearch Documentation","title":"Perform a multi-search - Meilisearch Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T23:02:47.025Z","originalFileLocation":"reference/api/multi-search/perform-a-multi-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=\"dark\"}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=\"Run multiple search queries in a single API request. Each query can target a different index, so you can search across several indexes at once and get one combined response. Warning: If Meilisearch encounters an error processing any query in the request, it immediately stops and returns an error message for the first error encountered. Partial results are not returned.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Meilisearch Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/meilisearch-6b28dec2/6t6RePI0bXwGcKSs/_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=\"/docs/mintlify-assets/_mintlify/favicons/meilisearch-6b28dec2/6t6RePI0bXwGcKSs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/meilisearch-6b28dec2/6t6RePI0bXwGcKSs/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/meilisearch-6b28dec2/6t6RePI0bXwGcKSs/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/meilisearch-6b28dec2/6t6RePI0bXwGcKSs/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/meilisearch-6b28dec2/6t6RePI0bXwGcKSs/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/meilisearch-6b28dec2/6t6RePI0bXwGcKSs/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/meilisearch-6b28dec2/6t6RePI0bXwGcKSs/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/meilisearch-6b28dec2/6t6RePI0bXwGcKSs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Perform a multi-search - Meilisearch Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Run multiple search queries in a single API request. Each query can target a different index, so you can search across several indexes at once and get one combined response. Warning: If Meilisearch encounters an error processing any query in the request, it immediately stops and returns an error message for the first error encountered. Partial results are not returned.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Meilisearch Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.meilisearch.com/docs/reference/api/multi-search/perform-a-multi-search\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://meilisearch-6b28dec2.mintlify.app/_mintlify/api/og/v2?division=Multi-search\u0026amp;title=Perform+a+multi-search\u0026amp;description=Run+multiple+search+queries+in+a+single+API+request.%0A%0AEach+query+can+target+a+different+index%2C+so+you+can+search+across+several+indexes+at+once+and+get+one+comb\u0026amp;theme=25515a5016844863e4538b41\u0026amp;signature=3741a4694ec65bfd562dacb8756bf4d88cb160f3d6a471e06288961681668ade\">\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=\"Perform a multi-search - Meilisearch Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Run multiple search queries in a single API request. Each query can target a different index, so you can search across several indexes at once and get one combined response. Warning: If Meilisearch encounters an error processing any query in the request, it immediately stops and returns an error message for the first error encountered. Partial results are not returned.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://meilisearch-6b28dec2.mintlify.app/_mintlify/api/og/v2?division=Multi-search\u0026amp;title=Perform+a+multi-search\u0026amp;description=Run+multiple+search+queries+in+a+single+API+request.%0A%0AEach+query+can+target+a+different+index%2C+so+you+can+search+across+several+indexes+at+once+and+get+one+comb\u0026amp;theme=25515a5016844863e4538b41\u0026amp;signature=3741a4694ec65bfd562dacb8756bf4d88cb160f3d6a471e06288961681668ade\">\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=\"/docs/mintlify-assets/_mintlify/favicons/meilisearch-6b28dec2/6t6RePI0bXwGcKSs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Meilisearch Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF5CB2\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.meilisearch.com/docs/reference/api/multi-search/perform-a-multi-search\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/reference/api/multi-search/perform-a-multi-search.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.meilisearch.com/#organization\",\"name\":\"Meilisearch Documentation\",\"url\":\"https://www.meilisearch.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/meilisearch-6b28dec2/YRn82YKcWv02OWrg/assets/repo/meilisearch-logo-light.svg?fit=max\u0026auto=format\u0026n=YRn82YKcWv02OWrg\u0026q=85\u0026s=331f9ce2d1f557db3b679795f4707aa5\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.meilisearch.com/docs#website\",\"name\":\"Meilisearch Documentation\",\"url\":\"https://www.meilisearch.com/docs\",\"publisher\":{\"@id\":\"https://www.meilisearch.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.meilisearch.com/docs/reference/api/multi-search/perform-a-multi-search#webpage\",\"url\":\"https://www.meilisearch.com/docs/reference/api/multi-search/perform-a-multi-search\",\"name\":\"Perform a multi-search\",\"description\":\"Run multiple search queries in a single API request. Each query can target a different index, so you can search across several indexes at once and get one combined response. Warning: If Meilisearch encounters an error processing any query in the request, it immediately stops and returns an error message for the first error encountered. Partial results are not returned.\",\"dateModified\":\"2026-10-27T23:02:47.025Z\",\"isPartOf\":{\"@id\":\"https://www.meilisearch.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.meilisearch.com/docs/reference/api/multi-search/perform-a-multi-search#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.meilisearch.com/docs/reference/api/multi-search/perform-a-multi-search#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Routes\",\"item\":\"https://www.meilisearch.com/docs/reference/api/indexes/list-all-indexes\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Perform a multi-search\",\"item\":\"https://www.meilisearch.com/docs/reference/api/multi-search/perform-a-multi-search\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.meilisearch.com/docs/reference/api/multi-search/perform-a-multi-search#apireference\",\"headline\":\"Perform a multi-search\",\"name\":\"Perform a multi-search\",\"description\":\"Run multiple search queries in a single API request. Each query can target a different index, so you can search across several indexes at once and get one combined response. Warning: If Meilisearch encounters an error processing any query in the request, it immediately stops and returns an error message for the first error encountered. Partial results are not returned.\",\"url\":\"https://www.meilisearch.com/docs/reference/api/multi-search/perform-a-multi-search\",\"mainEntityOfPage\":{\"@id\":\"https://www.meilisearch.com/docs/reference/api/multi-search/perform-a-multi-search#webpage\"},\"dateModified\":\"2026-10-27T23:02:47.025Z\",\"publisher\":{\"@id\":\"https://www.meilisearch.com/#organization\"},\"isPartOf\":{\"@id\":\"https://www.meilisearch.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Meilisearch Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Meilisearch Documentation","nav":{"global":null,"tabs":[{"tab":"Getting started","pages":[{"title":"Getting started","href":"/getting_started/overview"}]},{"tab":"Capabilities","pages":[{"title":"Capabilities","href":"/capabilities/overview"}]},{"tab":"Reference","groups":[{"group":"Overview","pages":[{"title":"Authorization","sidebarTitle":"Authorization","href":"/reference/api/authorization"},{"title":"Headers","sidebarTitle":"Headers","href":"/reference/api/headers"},{"title":"Requests","sidebarTitle":"Requests","href":"/reference/api/requests"},{"title":"Pagination","sidebarTitle":"Pagination","href":"/reference/api/pagination"},{"title":"OpenAPI specifications","sidebarTitle":"OpenAPI specifications","href":"/reference/api/openapi"}]},{"group":"API Routes","pages":[{"group":"Indexes","pages":[{"title":"List all indexes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes","href":"/reference/api/indexes/list-all-indexes"},{"title":"Create index","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes","href":"/reference/api/indexes/create-index"},{"title":"Get index","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}","href":"/reference/api/indexes/get-index"},{"title":"Update index","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /indexes/{index_uid}","href":"/reference/api/indexes/update-index"},{"title":"Delete index","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}","href":"/reference/api/indexes/delete-index"},{"title":"Swap indexes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /swap-indexes","href":"/reference/api/indexes/swap-indexes"},{"title":"List index fields","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes/{index_uid}/fields","href":"/reference/api/indexes/list-index-fields"}]},{"group":"Documents","pages":[{"title":"List documents with GET","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/documents","href":"/reference/api/documents/list-documents-with-get"},{"title":"List documents with POST","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes/{index_uid}/documents/fetch","href":"/reference/api/documents/list-documents-with-post"},{"title":"Get document","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/documents/{document_id}","href":"/reference/api/documents/get-document"},{"title":"Add or replace documents","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes/{index_uid}/documents","href":"/reference/api/documents/add-or-replace-documents"},{"title":"Add or update documents","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/documents","href":"/reference/api/documents/add-or-update-documents"},{"title":"Delete document","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/documents/{document_id}","href":"/reference/api/documents/delete-document"},{"title":"Delete all documents","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/documents","href":"/reference/api/documents/delete-all-documents"},{"title":"Delete documents by filter","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes/{index_uid}/documents/delete","href":"/reference/api/documents/delete-documents-by-filter"},{"title":"Delete documents by batch","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes/{index_uid}/documents/delete-batch","href":"/reference/api/documents/delete-documents-by-batch"},{"title":"Edit documents by function","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes/{index_uid}/documents/edit","href":"/reference/api/documents/edit-documents-by-function"}]},{"group":"Search","pages":[{"title":"Search with POST","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes/{index_uid}/search","href":"/reference/api/search/search-with-post"},{"title":"Search with GET","description":"Search for documents matching a query in the given index.\n\n> Equivalent to the [search with POST route](/docs/reference/api/search/search-with-post) in the Meilisearch API.\n\n**Note:** By default this endpoint returns at most 1000 results. Configure `pagination.maxTotalHits` in index settings to change this limit.\n\n**Note:** The GET route only accepts string filter expressions. Use the POST route if you need array-of-array filter syntax.","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/search","href":"/reference/api/search/search-with-get"}]},{"group":"Multi-search","pages":[{"title":"Perform a multi-search","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /multi-search","href":"/reference/api/multi-search/perform-a-multi-search"}]},{"group":"Facet search","pages":[{"title":"Search for facet values","description":"Search for facet values matching a query within a given facet attribute. Use this to build\nautocomplete or dropdown UIs for facet filters.\n\n**Prerequisite:** The `facetName` attribute must be in the index's `filterableAttributes` list.\nFacet search will not work without this configuration.\n\n**Note:** Facet search only considers the first word of `facetQuery`. Searching for `Jane`\nreturns `Jane Austen`, but searching for `Austen` does not.\n\n**Note:** Numeric facet values are not searchable. Convert numbers to strings if you need\nto search them as facets.","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes/{index_uid}/facet-search","href":"/reference/api/facet-search/search-for-facet-values"}]},{"group":"Similar documents","pages":[{"title":"Get similar documents with POST","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes/{index_uid}/similar","href":"/reference/api/similar-documents/get-similar-documents-with-post"},{"title":"Get similar documents with GET","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/similar","href":"/reference/api/similar-documents/get-similar-documents-with-get"}]},{"group":"MCP","pages":[{"title":"Model context protocol (MCP)","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /mcp","href":"/reference/api/mcp/model-context-protocol-mcp"}]},{"group":"Chats","pages":[{"title":"List chat workspaces","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /chats","href":"/reference/api/chats/list-chat-workspaces"},{"title":"Get a chat workspace","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /chats/{workspace_uid}","href":"/reference/api/chats/get-a-chat-workspace"},{"title":"Delete a chat workspace","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /chats/{workspace_uid}","href":"/reference/api/chats/delete-a-chat-workspace"},{"title":"Request a chat completion","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /chats/{workspace_uid}/chat/completions","href":"/reference/api/chats/request-a-chat-completion"},{"title":"Get settings of a chat workspace","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /chats/{workspace_uid}/settings","href":"/reference/api/chats/get-settings-of-a-chat-workspace"},{"title":"Update settings of a chat workspace","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /chats/{workspace_uid}/settings","href":"/reference/api/chats/update-settings-of-a-chat-workspace"},{"title":"Reset the settings of a chat workspace","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /chats/{workspace_uid}/settings","href":"/reference/api/chats/reset-the-settings-of-a-chat-workspace"}]},{"group":"Search Rules","pages":[{"title":"List search rules","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /dynamic-search-rules","href":"/reference/api/search-rules/list-search-rules"},{"title":"Delete all search rules.","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /dynamic-search-rules","href":"/reference/api/search-rules/delete-all-search-rules"},{"title":"Get a search rule","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /dynamic-search-rules/{uid}","href":"/reference/api/search-rules/get-a-search-rule"},{"title":"Create or update a search rule","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /dynamic-search-rules/{uid}","href":"/reference/api/search-rules/create-or-update-a-search-rule"},{"title":"Delete a search rule","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /dynamic-search-rules/{uid}","href":"/reference/api/search-rules/delete-a-search-rule"}]},{"group":"Tasks","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /tasks","href":"/reference/api/async-task-management/list-tasks"},{"title":"Get task","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /tasks/{task_id}","href":"/reference/api/async-task-management/get-task"},{"title":"Get task's document payload","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /tasks/{task_id}/documents","href":"/reference/api/async-task-management/get-tasks-document-payload"},{"title":"Cancel tasks","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /tasks/cancel","href":"/reference/api/async-task-management/cancel-tasks"},{"title":"Delete tasks","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /tasks","href":"/reference/api/async-task-management/delete-tasks"},{"title":"Stream tasks changes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /tasks/stream","href":"/reference/api/async-task-management/stream-tasks-changes"}]},{"group":"Batches","pages":[{"title":"List batches","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /batches","href":"/reference/api/async-task-management/list-batches"},{"title":"Get batch","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /batches/{batch_id}","href":"/reference/api/async-task-management/get-batch"},{"title":"Stream batches changes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /batches/stream","href":"/reference/api/async-task-management/stream-batches-changes"}]},{"group":"Keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /keys","href":"/reference/api/keys/list-api-keys"},{"title":"Create API key","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /keys","href":"/reference/api/keys/create-api-key"},{"title":"Get API key","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /keys/{key}","href":"/reference/api/keys/get-api-key"},{"title":"Update API key","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /keys/{key}","href":"/reference/api/keys/update-api-key"},{"title":"Delete API key","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /keys/{key}","href":"/reference/api/keys/delete-api-key"}]},{"group":"Settings","pages":[{"group":"All settings","pages":[{"title":"List all settings","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings","href":"/reference/api/settings/list-all-settings"},{"title":"Update all settings","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /indexes/{index_uid}/settings","href":"/reference/api/settings/update-all-settings"},{"title":"Reset all settings","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings","href":"/reference/api/settings/reset-all-settings"}]},{"group":"Chat","pages":[{"title":"Get chat","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/chat","href":"/reference/api/settings/get-chat"},{"title":"Update chat","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /indexes/{index_uid}/settings/chat","href":"/reference/api/settings/update-chat"},{"title":"Reset chat","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/chat","href":"/reference/api/settings/reset-chat"}]},{"group":"Dictionary","pages":[{"title":"Get dictionary","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/dictionary","href":"/reference/api/settings/get-dictionary"},{"title":"Update dictionary","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/dictionary","href":"/reference/api/settings/update-dictionary"},{"title":"Reset dictionary","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/dictionary","href":"/reference/api/settings/reset-dictionary"}]},{"group":"Displayed attributes","pages":[{"title":"Get displayedAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/displayed-attributes","href":"/reference/api/settings/get-displayedattributes"},{"title":"Update displayedAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/displayed-attributes","href":"/reference/api/settings/update-displayedattributes"},{"title":"Reset displayedAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/displayed-attributes","href":"/reference/api/settings/reset-displayedattributes"}]},{"group":"Distinct attribute","pages":[{"title":"Get distinctAttribute","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/distinct-attribute","href":"/reference/api/settings/get-distinctattribute"},{"title":"Update distinctAttribute","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/distinct-attribute","href":"/reference/api/settings/update-distinctattribute"},{"title":"Reset distinctAttribute","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/distinct-attribute","href":"/reference/api/settings/reset-distinctattribute"}]},{"group":"Embedders","pages":[{"title":"Get embedders","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/embedders","href":"/reference/api/settings/get-embedders"},{"title":"Update embedders","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /indexes/{index_uid}/settings/embedders","href":"/reference/api/settings/update-embedders"},{"title":"Reset embedders","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/embedders","href":"/reference/api/settings/reset-embedders"}]},{"group":"Facet search","pages":[{"title":"Get facetSearch","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/facet-search","href":"/reference/api/settings/get-facetsearch"},{"title":"Update facetSearch","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/facet-search","href":"/reference/api/settings/update-facetsearch"},{"title":"Reset facetSearch","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/facet-search","href":"/reference/api/settings/reset-facetsearch"}]},{"group":"Faceting","pages":[{"title":"Get faceting","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/faceting","href":"/reference/api/settings/get-faceting"},{"title":"Update faceting","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /indexes/{index_uid}/settings/faceting","href":"/reference/api/settings/update-faceting"},{"title":"Reset faceting","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/faceting","href":"/reference/api/settings/reset-faceting"}]},{"group":"Filterable attributes","pages":[{"title":"Get filterableAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/filterable-attributes","href":"/reference/api/settings/get-filterableattributes"},{"title":"Update filterableAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/filterable-attributes","href":"/reference/api/settings/update-filterableattributes"},{"title":"Reset filterableAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/filterable-attributes","href":"/reference/api/settings/reset-filterableattributes"}]},{"group":"Foreign keys","pages":[{"title":"Get foreignKeys","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/foreign-keys","href":"/reference/api/settings/get-foreignkeys"},{"title":"Update foreignKeys","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/foreign-keys","href":"/reference/api/settings/update-foreignkeys"},{"title":"Reset foreignKeys","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/foreign-keys","href":"/reference/api/settings/reset-foreignkeys"}]},{"group":"Localized attributes","pages":[{"title":"Get localizedAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/localized-attributes","href":"/reference/api/settings/get-localizedattributes"},{"title":"Update localizedAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/localized-attributes","href":"/reference/api/settings/update-localizedattributes"},{"title":"Reset localizedAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/localized-attributes","href":"/reference/api/settings/reset-localizedattributes"}]},{"group":"Non-separator tokens","pages":[{"title":"Get nonSeparatorTokens","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/non-separator-tokens","href":"/reference/api/settings/get-nonseparatortokens"},{"title":"Update nonSeparatorTokens","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/non-separator-tokens","href":"/reference/api/settings/update-nonseparatortokens"},{"title":"Reset nonSeparatorTokens","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/non-separator-tokens","href":"/reference/api/settings/reset-nonseparatortokens"}]},{"group":"Pagination","pages":[{"title":"Get pagination","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/pagination","href":"/reference/api/settings/get-pagination"},{"title":"Update pagination","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /indexes/{index_uid}/settings/pagination","href":"/reference/api/settings/update-pagination"},{"title":"Reset pagination","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/pagination","href":"/reference/api/settings/reset-pagination"}]},{"group":"Prefix search","pages":[{"title":"Get prefixSearch","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/prefix-search","href":"/reference/api/settings/get-prefixsearch"},{"title":"Update prefixSearch","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/prefix-search","href":"/reference/api/settings/update-prefixsearch"},{"title":"Reset prefixSearch","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/prefix-search","href":"/reference/api/settings/reset-prefixsearch"}]},{"group":"Proximity precision","pages":[{"title":"Get proximityPrecision","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/proximity-precision","href":"/reference/api/settings/get-proximityprecision"},{"title":"Update proximityPrecision","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/proximity-precision","href":"/reference/api/settings/update-proximityprecision"},{"title":"Reset proximityPrecision","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/proximity-precision","href":"/reference/api/settings/reset-proximityprecision"}]},{"group":"Ranking rules","pages":[{"title":"Get rankingRules","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/ranking-rules","href":"/reference/api/settings/get-rankingrules"},{"title":"Update rankingRules","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/ranking-rules","href":"/reference/api/settings/update-rankingrules"},{"title":"Reset rankingRules","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/ranking-rules","href":"/reference/api/settings/reset-rankingrules"}]},{"group":"Search cutoff","pages":[{"title":"Get searchCutoffMs","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/search-cutoff-ms","href":"/reference/api/settings/get-searchcutoffms"},{"title":"Update searchCutoffMs","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/search-cutoff-ms","href":"/reference/api/settings/update-searchcutoffms"},{"title":"Reset searchCutoffMs","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/search-cutoff-ms","href":"/reference/api/settings/reset-searchcutoffms"}]},{"group":"Searchable attributes","pages":[{"title":"Get searchableAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/searchable-attributes","href":"/reference/api/settings/get-searchableattributes"},{"title":"Update searchableAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/searchable-attributes","href":"/reference/api/settings/update-searchableattributes"},{"title":"Reset searchableAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/searchable-attributes","href":"/reference/api/settings/reset-searchableattributes"}]},{"group":"Separator tokens","pages":[{"title":"Get separatorTokens","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/separator-tokens","href":"/reference/api/settings/get-separatortokens"},{"title":"Update separatorTokens","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/separator-tokens","href":"/reference/api/settings/update-separatortokens"},{"title":"Reset separatorTokens","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/separator-tokens","href":"/reference/api/settings/reset-separatortokens"}]},{"group":"Sortable attributes","pages":[{"title":"Get sortableAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/sortable-attributes","href":"/reference/api/settings/get-sortableattributes"},{"title":"Update sortableAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/sortable-attributes","href":"/reference/api/settings/update-sortableattributes"},{"title":"Reset sortableAttributes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/sortable-attributes","href":"/reference/api/settings/reset-sortableattributes"}]},{"group":"Stop words","pages":[{"title":"Get stopWords","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/stop-words","href":"/reference/api/settings/get-stopwords"},{"title":"Update stopWords","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/stop-words","href":"/reference/api/settings/update-stopwords"},{"title":"Reset stopWords","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/stop-words","href":"/reference/api/settings/reset-stopwords"}]},{"group":"Synonyms","pages":[{"title":"Get synonyms","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/synonyms","href":"/reference/api/settings/get-synonyms"},{"title":"Update synonyms","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json put /indexes/{index_uid}/settings/synonyms","href":"/reference/api/settings/update-synonyms"},{"title":"Reset synonyms","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/synonyms","href":"/reference/api/settings/reset-synonyms"}]},{"group":"Typo tolerance","pages":[{"title":"Get typoTolerance","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/settings/typo-tolerance","href":"/reference/api/settings/get-typotolerance"},{"title":"Update typoTolerance","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /indexes/{index_uid}/settings/typo-tolerance","href":"/reference/api/settings/update-typotolerance"},{"title":"Reset typoTolerance","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /indexes/{index_uid}/settings/typo-tolerance","href":"/reference/api/settings/reset-typotolerance"}]}]},{"group":"Management","pages":[{"group":"Stats","pages":[{"title":"Get stats of index","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /indexes/{index_uid}/stats","href":"/reference/api/indexes/get-stats-of-index"},{"title":"Get stats of all indexes","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /stats","href":"/reference/api/stats/get-stats-of-all-indexes"}]},{"group":"Health","pages":[{"title":"Get health","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /health","href":"/reference/api/health/get-health"}]},{"group":"Version","pages":[{"title":"Get version","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /version","href":"/reference/api/version/get-version"}]},{"group":"Template","pages":[{"title":"Render template","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /render-template","href":"/reference/api/render-templates/render-template"}]},{"group":"Snapshots","pages":[{"title":"Create snapshot","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /snapshots","href":"/reference/api/backups/create-snapshot"}]},{"group":"Dumps","pages":[{"title":"Create dump","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /dumps","href":"/reference/api/backups/create-dump"}]},{"group":"Logs","pages":[{"title":"Retrieve logs","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /logs/stream","href":"/reference/api/logs/retrieve-logs"},{"title":"Stop retrieving logs","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /logs/stream","href":"/reference/api/logs/stop-retrieving-logs"},{"title":"Update target of the console logs","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /logs/stderr","href":"/reference/api/logs/update-target-of-the-console-logs"}]},{"group":"Metrics","pages":[{"title":"Get Prometheus metrics","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /metrics","href":"/reference/api/stats/get-prometheus-metrics"}]},{"group":"Experimental features","pages":[{"title":"List experimental features","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /experimental-features","href":"/reference/api/experimental-features/list-experimental-features"},{"title":"Configure experimental features","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /experimental-features","href":"/reference/api/experimental-features/configure-experimental-features"}]},{"group":"Network","pages":[{"title":"Get network topology","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /network","href":"/reference/api/experimental-features/get-network-topology"},{"title":"Configure network topology","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /network","href":"/reference/api/experimental-features/configure-network-topology"},{"title":"Network control","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /network/control","href":"/reference/api/experimental-features/network-control"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /webhooks","href":"/reference/api/webhooks/list-webhooks"},{"title":"Create webhook","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /webhooks","href":"/reference/api/webhooks/create-webhook"},{"title":"Get webhook","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json get /webhooks/{uuid}","href":"/reference/api/webhooks/get-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json patch /webhooks/{uuid}","href":"/reference/api/webhooks/update-webhook"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json delete /webhooks/{uuid}","href":"/reference/api/webhooks/delete-webhook"}]},{"group":"Compact","pages":[{"title":"Compact index","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /indexes/{index_uid}/compact","href":"/reference/api/indexes/compact-index"},{"title":"Compact task queue","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /tasks/compact","href":"/reference/api/async-task-management/compact-task-queue"}]},{"group":"Export","pages":[{"title":"Export to a remote Meilisearch","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /export","href":"/reference/api/export/export-to-a-remote-meilisearch"}]},{"group":"Render template","pages":[{"title":"Render template","deprecated":null,"version":null,"openapi":"/assets/release-assets/meilisearch-openapi-mintlify.json post /render-template","href":"/reference/api/render-templates/render-template"}]}]}]},{"group":"Errors","pages":[{"title":"Errors","sidebarTitle":"Overview","href":"/reference/errors/overview"},{"title":"Error codes","sidebarTitle":"Error codes","href":"/reference/errors/error_codes"}]}]},{"tab":"Resources","pages":[{"title":"Resources","href":"/resources/comparisons/alternatives"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/changelog"}]}]},"basePath":"","title":"Perform a multi-search - Meilisearch Documentation","buildId":"dpl_4RHMRqtvdHvKgaEfTTjFqjzja3B6","deploymentId":"dpl_4RHMRqtvdHvKgaEfTTjFqjzja3B6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-D_4Sesi0.js","utils-DRHeK26p.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C6d-DUc2.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dex7slho.js","snippetPresets-BcCEBp0Z.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CufowNTX.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-A4lJSCIe.js","shallow-DqoHP7zn.js","getApiPlaygroundDisplay-Cku8AmtL.js","CodeSnippet-CtHQbNqc.js","CodeSnippets-CGo5Cslf.js","Page-BoJxk0m8.js","getPastedJson-M-bKdue4.js","icon-DEqCU4st.js","MethodPill-DnfSSXiJ.js","DuplicateIcon-BHu2PE8M.js","createIcon-BPsE5X7c.js","DynamicMarkdown-Dnt6YhtR.js","SectionHeading-6CtFWqMQ.js","axios-vUo_bRtp.js","Markdown-BoKe_1fI.js","clsx-DM5-sUNJ.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CkIdkovK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-B3e6Nh_r.js"]}