{
"message": "The request could not be processed. Check the request body and required parameters."
}
{
"message": "unauthorized"
}
{
"status": "InternalServerError",
"code": 500,
"messages": [
"Error occur. Please contact support with error ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890"
]
}
Search
Autocomplete
Returns typeahead suggestions as the user types. Autocomplete can be configured to display document titles, but this is an account-wide setting — contact Cludo support to enable it.
GET
/
api
/
v4
/
{customerId}
/
{engineId}
/
autocomplete
Get Autocomplete Suggestions
curl --request GET \ --url https://api.cludo.com/api/v4/{customerId}/{engineId}/autocomplete \ --header 'Authorization: <api-key>'
Autocomplete can be configured to display document titles instead of plain suggestions. This is an account-wide setting — contact Cludo support to enable it.When title-based autocomplete is enabled, suggestions are backed by real indexed documents. You can narrow results using the filters query parameter with any indexed field:
SiteKey authentication. Pass the full value including the SiteKey prefix: SiteKey <base64(customerId:engineId:searchKey)>. Example: SiteKey dGVzdDoxMjM0NTY3Ojk4NzY1. See the Authentication guide for details.
JSON-encoded filter object restricting autocomplete results by field value. Only applies when title-based autocomplete is enabled — has no effect in plain suggestions mode. Any indexed field can be used. Example: {"Category":["Guides"]}.
Correlation id for analytics (optional depending on engine).
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Cludo API Documentation","colors":{"primary":"#5B4EFF","light":"#8B7FFF","dark":"#3D2ECC"},"logo":{"light":"https://mintcdn.com/cludo/VlW3XL1sCSBiIopK/images/cropped-cropped-Cludo_New_2021_Black-1.png?fit=max\u0026auto=format\u0026n=VlW3XL1sCSBiIopK\u0026q=85\u0026s=1da2012a65174d0e8987bbb2a3428a1f","dark":"https://mintcdn.com/cludo/QSqg9vB71E-uhtLM/images/Cludo_New_2021_White-01.png?fit=max\u0026auto=format\u0026n=QSqg9vB71E-uhtLM\u0026q=85\u0026s=96205b256cd0af679f7ed7cd6a7a9445"},"favicon":"https://mintcdn.com/cludo/PNai9WMfBGw4gQ9V/images/Cludo_Site_Icon.png?fit=max\u0026auto=format\u0026n=PNai9WMfBGw4gQ9V\u0026q=85\u0026s=2658cbf2e4ea92bc14f7210485c60b4c","api":{"playground":{"display":"interactive"},"examples":{"languages":["bash","python","javascript","typescript"],"prefill":true},"mdx":{"server":["https://api.cludo.com","https://api-us1.cludo.com"]}},"background":{"decoration":"gradient","color":{"light":"#f2f4f7"}},"navbar":{"links":[{"href":"https://cludo.com/resources/contact-support/","label":"Support"}],"primary":{"type":"button","label":"MyCludo","href":"https://my.cludo.com"}},"footer":{"links":[{"header":"Resources","items":[{"label":"Support","href":"https://cludo.com/resources/contact-support"},{"label":"Status","href":"https://status.cludo.com"}]}]},"search":{},"fonts":{"family":"Poppins"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cludo","hasAudioNarration":false,"actualSubdomain":"cludo","customDomains":["docs.cludo.com"],"gitSource":{"type":"github","owner":"cludo","repo":"cludo-api-documentation-2026","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad7582aee7653c65618e8c1","collectionId":"ee5697fb-ff48-4ada-9c32-bcbb28abed93","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad7582aee7653c65618e8c1"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ad7582aee7653c65618e8c1","clientVersion":"0.0.4074","searchFilterCounts":[{"language":"default","tag":"API Reference","count":39},{"language":"default","tag":"Search Tools","count":22},{"language":"default","tag":"Overview","count":16},{"language":"default","tag":"Quicklinks","count":7},{"language":"default","tag":"AI","count":6},{"language":"default","tag":"Guides","count":5},{"language":"default","tag":"Content \u0026 Indexing","count":5},{"language":"default","tag":"Banners","count":5},{"language":"default","tag":"Page Rankings","count":5},{"language":"default","tag":"Get Started","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":true,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"support@cludo.com","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":true},"customCss":[{"filePath":"styles/custom.css","content":"body{color:#000000}"}],"page":{"pagePath":"api-reference/v4/search/autocomplete","slug":"/api-reference/v4/search/autocomplete","pageMetadata":{"title":"Autocomplete","openapi":"GET /api/v4/{customerId}/{engineId}/autocomplete","description":"Returns typeahead suggestions as the user types. Autocomplete can be configured to display document titles, but this is an account-wide setting — contact Cludo support to enable it.","href":"/api-reference/v4/search/autocomplete"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns typeahead suggestions as the user types. Autocomplete can be configured to display document titles, but this is an account-wide setting — contact Cludo support to enable it.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={code:`code`,p:`p`,..._provideComponents(),...props.components},{Heading}=_components;if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`autocomplete-strategies`,children:`Autocomplete strategies`}),`\n`,_jsx(_components.p,{children:`Autocomplete can be configured to display document titles instead of plain suggestions. This is an account-wide setting — contact Cludo support to enable it.`}),`\n`,_jsxs(_components.p,{children:[`When title-based autocomplete is enabled, suggestions are backed by real indexed documents. You can narrow results using the `,_jsx(_components.code,{children:`filters`}),` query parameter with any indexed field:`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Autocomplete","openapi":"GET /api/v4/{customerId}/{engineId}/autocomplete","description":"Returns typeahead suggestions as the user types. Autocomplete can be configured to display document titles, but this is an account-wide setting — contact Cludo support to enable it.","href":"/api-reference/v4/search/autocomplete"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Autocomplete strategies","slug":"autocomplete-strategies","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getAutoComplete","summary":"Get Autocomplete Suggestions","description":"Returns typeahead suggestions as the user types. Autocomplete can be configured to display document titles, but this is an account-wide setting — contact Cludo support to enable it.","x-mint":{"metadata":{"title":"Autocomplete","description":"Get typeahead suggestions for search inputs."}},"security":["7feaf3b1-5c23-4945-bc5b-315d3699a1cf","044a15ee-fb1e-4ff6-92b4-33a4504d10ab"],"parameters":["61828061-3de4-43e4-980c-bd1effd2555f","b9768617-966f-45c1-9e17-87c0acb21007","3b2a3bc0-605c-4f0f-9781-d99f1bb51677","d0ab9470-13bb-4848-872c-05b30e80473c","31662f45-488a-4e89-a4b7-60985f014eea","79471039-ec88-47b3-9704-bbdb0ad8be8d"],"responses":{"200":"b07d42e6-e66d-4232-9535-8aed80233ba4","400":"fcafd2b2-a2c4-4968-b323-059a244a30bc","401":"c3bbcbbd-c7ea-4280-81f4-703051184074","500":"f4159573-29b7-48f0-90c0-4058d8f24067"},"method":"get","type":"path","servers":["8a0cffe9-5e0f-4f29-bd69-1ac091b7d5e7","50e50063-f7e6-4661-ba9e-6d1bb802cf50"],"path":"/api/v4/{customerId}/{engineId}/autocomplete","baseUrlOptions":["https://api.cludo.com","https://api-us1.cludo.com"],"title":"Get Autocomplete Suggestions","codeSamples":[],"requestExampleLanguages":["bash","python","javascript","typescript"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"61828061-3de4-43e4-980c-bd1effd2555f":{"name":"customerId","in":"path","required":true,"description":"Your Cludo account ID. Find it in [MyCludo](https://my.cludo.com/install/api).","schema":{"type":"integer","isRequired":true,"description":"Your Cludo account ID. Find it in [MyCludo](https://my.cludo.com/install/api).","uniqueKey":"","typeLabel":"integer"}},"b9768617-966f-45c1-9e17-87c0acb21007":{"name":"engineId","in":"path","required":true,"description":"The search engine to query. Must match the engine ID in your SiteKey.","schema":{"type":"integer","isRequired":true,"description":"The search engine to query. Must match the engine ID in your SiteKey.","uniqueKey":"","typeLabel":"integer"}},"3b2a3bc0-605c-4f0f-9781-d99f1bb51677":{"name":"query","in":"query","required":true,"description":"The partial text the user has typed so far.","schema":{"type":"string","isRequired":true,"description":"The partial text the user has typed so far.","uniqueKey":"","typeLabel":"string"}},"d0ab9470-13bb-4848-872c-05b30e80473c":{"name":"results","in":"query","required":false,"description":"Maximum number of suggestions to return.","schema":{"type":"integer","default":5,"isRequired":false,"description":"Maximum number of suggestions to return.","uniqueKey":"","typeLabel":"integer"}},"31662f45-488a-4e89-a4b7-60985f014eea":{"name":"responseType","in":"query","required":false,"description":"`JsonObject` — structured JSON (recommended). `JsonHtml` — HTML fragments.","schema":{"type":"string","enum":["JsonObject","JsonHtml"],"isRequired":false,"description":"`JsonObject` — structured JSON (recommended). `JsonHtml` — HTML fragments.","uniqueKey":"","typeLabel":"enum\u003cstring>"}},"79471039-ec88-47b3-9704-bbdb0ad8be8d":{"name":"filters","in":"query","required":false,"description":"JSON-encoded filter object restricting autocomplete results by field value. Only applies when title-based autocomplete is enabled — has no effect in plain suggestions mode. Any indexed field can be used. Example: `{\"Category\":[\"Guides\"]}`.","schema":{"type":"string","isRequired":false,"description":"JSON-encoded filter object restricting autocomplete results by field value. Only applies when title-based autocomplete is enabled — has no effect in plain suggestions mode. Any indexed field can be used. Example: `{\"Category\":[\"Guides\"]}`.","uniqueKey":"","typeLabel":"string"},"example":"{\"Category\":[\"Guides\"]}"}},"responses":{"b07d42e6-e66d-4232-9535-8aed80233ba4":{"description":"Autocomplete suggestions returned successfully.","content":{"application/json":{"schema":{"type":"object","properties":{"results":{"type":"array","description":"Top document hits that match the partial `query`, each with `fields` (e.g. Title, Url) and `id`.","items":{"type":"object","properties":{"fields":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"results.items.[INDEX].fields.additionalProperties","typeLabel":"string"},"description":"Displayed columns for the hit row (strings only in this schema).","uniqueKey":"results.items.[INDEX].fields","typeLabel":"object"},"id":{"type":"string","description":"Document id in the index (often URL or CMS id).","uniqueKey":"results.items.[INDEX].id","typeLabel":"string"}},"uniqueKey":"results.items.[INDEX]","typeLabel":"object"},"uniqueKey":"results","typeLabel":"object[]"},"suggestions":{"type":"array","description":"Plain-text completions to show in the dropdown (may differ from `results` titles).","items":{"type":"string","uniqueKey":"suggestions.items.[INDEX]","typeLabel":"string"},"uniqueKey":"suggestions","typeLabel":"string[]"},"topHits":{"type":"object","description":"Optional grouped counts per field value (e.g. top categories matching the prefix).","additionalProperties":{"type":"array","items":{"type":"object","properties":{"value":{"type":"string","description":"Facet value.","uniqueKey":"topHits.additionalProperties.items.[INDEX].value","typeLabel":"string"},"count":{"type":"integer","description":"Number of hits under this value.","uniqueKey":"topHits.additionalProperties.items.[INDEX].count","typeLabel":"integer"}},"uniqueKey":"topHits.additionalProperties.items.[INDEX]","typeLabel":"object"},"uniqueKey":"topHits.additionalProperties","typeLabel":"object[]"},"uniqueKey":"topHits","typeLabel":"object"},"totalResults":{"type":"integer","description":"Count of document hits returned or considered for this autocomplete call.","uniqueKey":"totalResults","typeLabel":"integer"},"totalSuggestions":{"type":"integer","description":"Count of string suggestions in `suggestions`.","uniqueKey":"totalSuggestions","typeLabel":"integer"},"facets":{"type":"object","description":"Lightweight facet map for the autocomplete context (shape similar to search `Facets` when present).","uniqueKey":"facets","typeLabel":"object"},"queryId":{"type":"string","description":"Correlation id for analytics (optional depending on engine).","uniqueKey":"queryId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"results":[{"fields":{"Title":"Search API reference","Url":"https://docs.example.com/search-api"},"id":"https://docs.example.com/search-api"}],"suggestions":["search api","search analytics"],"totalResults":6,"totalSuggestions":2,"queryId":"b7e4d2c1-8f3a-4e1b-9c6d-2a8f4e7b1c5d"},"examples":{"Example":{"title":"Example","value":{"results":[{"fields":{"Title":"Search API reference","Url":"https://docs.example.com/search-api"},"id":"https://docs.example.com/search-api"}],"suggestions":["search api","search analytics"],"totalResults":6,"totalSuggestions":2,"queryId":"b7e4d2c1-8f3a-4e1b-9c6d-2a8f4e7b1c5d"}}},"exampleType":"examples"}},"exampleType":"examples"},"fcafd2b2-a2c4-4968-b323-059a244a30bc":{"description":"The request is invalid. This typically occurs due to missing required fields, incorrect parameter values, or malformed request body.","content":{"application/json":{"schema":{"type":"object","description":"Error response returned when a request fails.","properties":{"message":{"type":"string","description":"A message describing what went wrong.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"The request could not be processed. Check the request body and required parameters."},"examples":{"Example":{"title":"Example","value":{"message":"The request could not be processed. Check the request body and required parameters."}}},"exampleType":"examples"}},"exampleType":"examples"},"c3bbcbbd-c7ea-4280-81f4-703051184074":{"description":"Authentication failed. The Authorization header is missing or contains invalid credentials.","content":{"application/json":{"schema":{"type":"object","description":"Returned when authentication fails.","properties":{"message":{"type":"string","description":"Authentication failure reason.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"unauthorized"},"examples":{"Example":{"title":"Example","value":{"message":"unauthorized"}}},"exampleType":"examples"}},"exampleType":"examples"},"f4159573-29b7-48f0-90c0-4058d8f24067":{"description":"An unexpected server error occurred. If this persists, contact support@cludo.com.","content":{"application/json":{"schema":{"type":"object","description":"Returned when an unexpected server error occurs.","properties":{"status":{"type":"string","description":"HTTP status name.","uniqueKey":"status","typeLabel":"string"},"code":{"type":"integer","description":"HTTP status code.","uniqueKey":"code","typeLabel":"integer"},"messages":{"type":"array","items":{"type":"string","uniqueKey":"messages.items.[INDEX]","typeLabel":"string"},"description":"Error details, usually including a support reference id.","uniqueKey":"messages","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"status":"InternalServerError","code":500,"messages":["Error occur. Please contact support with error ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890"]},"examples":{"Example":{"title":"Example","value":{"status":"InternalServerError","code":500,"messages":["Error occur. Please contact support with error ID: a1b2c3d4-e5f6-7890-abcd-ef1234567890"]}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"7feaf3b1-5c23-4945-bc5b-315d3699a1cf":{"SiteKey":{"type":"apiKey","in":"header","name":"Authorization","description":"SiteKey authentication. Pass the full value including the `SiteKey` prefix: `SiteKey \u003cbase64(customerId:engineId:searchKey)>`. Example: `SiteKey dGVzdDoxMjM0NTY3Ojk4NzY1`. See the [Authentication guide](/authentication) for details.","scopes":[]}},"044a15ee-fb1e-4ff6-92b4-33a4504d10ab":{"BasicAuth":{"type":"http","scheme":"basic","description":"Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: `Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5`. See the [Authentication guide](/authentication) for details.","scopes":[]}}},"servers":{"8a0cffe9-5e0f-4f29-bd69-1ac091b7d5e7":{"url":"https://api.cludo.com","description":"EU region (Customer IDs below 10,000,000)"},"50e50063-f7e6-4661-ba9e-6d1bb802cf50":{"url":"https://api-us1.cludo.com","description":"US region (Customer IDs 10,000,000 and above)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"SiteKey authentication. Pass the full value including the `SiteKey` prefix: `SiteKey \u003cbase64(customerId:engineId:searchKey)>`. Example: `SiteKey dGVzdDoxMjM0NTY3Ojk4NzY1`. See the [Authentication guide](/authentication) for details.","scopes":[]},"schema":{"title":"Authorization","type":"string","description":"SiteKey authentication. Pass the full value including the `SiteKey` prefix: `SiteKey \u003cbase64(customerId:engineId:searchKey)>`. Example: `SiteKey dGVzdDoxMjM0NTY3Ojk4NzY1`. See the [Authentication guide](/authentication) for details.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"SiteKey","name":"Authorization"}],"title":"SiteKey"},{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: `Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5`. See the [Authentication guide](/authentication) for details.","scopes":[]},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication. Use your Customer ID as the username and API Key as the password. Example header: `Authorization: Basic MTIzNDU2NzpteS1hcGkta2V5`. See the [Authentication guide](/authentication) for details.","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"BasicAuth","name":"Authorization"}],"title":"BasicAuth"}]},"originalFileLocation":"openapi/search.json"},"subdomain":"cludo","siteName":"Cludo API Documentation","title":"Autocomplete - Cludo API Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-06-11T09:29:35.217Z","originalFileLocation":"api-reference/v4/search/autocomplete.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns typeahead suggestions as the user types. Autocomplete can be configured to display document titles, but this is an account-wide setting — contact Cludo support to enable it.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Cludo API Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Autocomplete - Cludo API Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns typeahead suggestions as the user types. Autocomplete can be configured to display document titles, but this is an account-wide setting — contact Cludo support to enable it.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Cludo API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cludo.com/api-reference/v4/search/autocomplete\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cludo.mintlify.site/_mintlify/api/og/v2?division=Search\u0026amp;title=Autocomplete\u0026amp;description=Returns+typeahead+suggestions+as+the+user+types.+Autocomplete+can+be+configured+to+display+document+titles%2C+but+this+is+an+account-wide+setting+%E2%80%94+contact+Cludo+\u0026amp;theme=f4d788710e8d0750e07f0271\u0026amp;signature=105f58bd9026d1bd3a7cc216377fe48e6ce8d227dac2c437dfcd2f84b8d00149\">\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=\"Autocomplete - Cludo API Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns typeahead suggestions as the user types. Autocomplete can be configured to display document titles, but this is an account-wide setting — contact Cludo support to enable it.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cludo.mintlify.site/_mintlify/api/og/v2?division=Search\u0026amp;title=Autocomplete\u0026amp;description=Returns+typeahead+suggestions+as+the+user+types.+Autocomplete+can+be+configured+to+display+document+titles%2C+but+this+is+an+account-wide+setting+%E2%80%94+contact+Cludo+\u0026amp;theme=f4d788710e8d0750e07f0271\u0026amp;signature=105f58bd9026d1bd3a7cc216377fe48e6ce8d227dac2c437dfcd2f84b8d00149\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/cludo/jZhCi8DvpmlrCS0Y/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Cludo API Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5B4EFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cludo.com/api-reference/v4/search/autocomplete\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/v4/search/autocomplete.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cludo.com/#organization\",\"name\":\"Cludo API Documentation\",\"url\":\"https://docs.cludo.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cludo/VlW3XL1sCSBiIopK/images/cropped-cropped-Cludo_New_2021_Black-1.png?fit=max\u0026auto=format\u0026n=VlW3XL1sCSBiIopK\u0026q=85\u0026s=1da2012a65174d0e8987bbb2a3428a1f\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cludo.com#website\",\"name\":\"Cludo API Documentation\",\"url\":\"https://docs.cludo.com\",\"publisher\":{\"@id\":\"https://docs.cludo.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cludo.com/api-reference/v4/search/autocomplete#webpage\",\"url\":\"https://docs.cludo.com/api-reference/v4/search/autocomplete\",\"name\":\"Autocomplete\",\"description\":\"Returns typeahead suggestions as the user types. Autocomplete can be configured to display document titles, but this is an account-wide setting — contact Cludo support to enable it.\",\"dateModified\":\"2026-06-11T09:29:35.217Z\",\"isPartOf\":{\"@id\":\"https://docs.cludo.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cludo.com/api-reference/v4/search/autocomplete#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cludo.com/api-reference/v4/search/autocomplete#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Search\",\"item\":\"https://docs.cludo.com/api-reference/v4/search/search\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Autocomplete\",\"item\":\"https://docs.cludo.com/api-reference/v4/search/autocomplete\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cludo.com/api-reference/v4/search/autocomplete#apireference\",\"headline\":\"Autocomplete\",\"name\":\"Autocomplete\",\"description\":\"Returns typeahead suggestions as the user types. Autocomplete can be configured to display document titles, but this is an account-wide setting — contact Cludo support to enable it.\",\"url\":\"https://docs.cludo.com/api-reference/v4/search/autocomplete\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cludo.com/api-reference/v4/search/autocomplete#webpage\"},\"dateModified\":\"2026-06-11T09:29:35.217Z\",\"publisher\":{\"@id\":\"https://docs.cludo.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cludo.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Cludo API Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Cludo API Documentation","nav":{"global":null,"tabs":[{"tab":"Overview","pages":[{"title":"Overview","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"Overview","pages":[{"title":"API Reference Overview","href":"/api-reference/overview"}]},{"group":"Search","pages":[{"title":"Search","openapi":"POST /api/v4/{customerId}/{engineId}/search","description":"Execute a full-text search query with filters, facets, and sorting.","href":"/api-reference/v4/search/search"},{"title":"Autocomplete","openapi":"GET /api/v4/{customerId}/{engineId}/autocomplete","href":"/api-reference/v4/search/autocomplete"}]},{"group":"AI","pages":[{"title":"AI Search Overview","description":"Learn how Cludo AI Chat and AI Summary endpoints deliver generative answers and summaries grounded in your search index, and how to enable them.","href":"/api-reference/v4/ai/overview"},{"group":"AI Chat","pages":[{"title":"AI Chat","openapi":"POST /api/v4/{customerId}/{engineId}/search/answer","href":"/api-reference/v4/ai/chat"},{"title":"AI Chat Feedback","deprecated":null,"version":null,"openapi":"/openapi/ai.json post /api/v4/{customerId}/{engineId}/search/answer/feedback","href":"/api-reference/ai-chat-feedback"},{"title":"AI Chat Click","deprecated":null,"version":null,"openapi":"/openapi/ai.json post /api/v4/{customerId}/{engineId}/search/answer/click","href":"/api-reference/ai-chat-click"}]},{"group":"AI Summary","pages":[{"title":"AI Summary","openapi":"POST /api/v4/{customerId}/{engineId}/search/summarize","href":"/api-reference/v4/ai/summary"},{"title":"AI Summary Feedback","deprecated":null,"version":null,"openapi":"/openapi/ai.json post /api/v4/{customerId}/{engineId}/search/summarize/feedback","href":"/api-reference/ai-summary-feedback"}]}]},{"group":"Content \u0026 Indexing","pages":[{"group":"Documents","pages":[{"title":"Create or Replace","deprecated":null,"version":null,"openapi":"/openapi/index-management.json put /api/v4/{customerId}/index/{crawlerId}/documents","href":"/api-reference/create-or-replace"},{"title":"Partial Update","deprecated":null,"version":null,"openapi":"/openapi/index-management.json patch /api/v4/{customerId}/index/{crawlerId}/documents","href":"/api-reference/partial-update"},{"title":"Single Delete","deprecated":null,"version":null,"openapi":"/openapi/index-management.json delete /api/v4/{customerId}/index/{crawlerId}/documents","href":"/api-reference/single-delete"},{"title":"Bulk Delete","deprecated":null,"version":null,"openapi":"/openapi/index-management.json post /api/v4/{customerId}/index/{crawlerId}/documents/bulk-delete","href":"/api-reference/bulk-delete"}]},{"group":"Crawlers","pages":[{"title":"Queue URLs","deprecated":null,"version":null,"openapi":"/openapi/index-management.json post /api/v4/{customerId}/crawler/{crawlerId}/paths","href":"/api-reference/queue-urls"}]}]},{"group":"Tracking","pages":[{"title":"Track Search Query","deprecated":null,"version":null,"openapi":"/openapi/tracking.json post /api/v3/{customerId}/{engineId}/search/pushstat/querylog","href":"/api-reference/track-search-query"},{"title":"Track Result Click","deprecated":null,"version":null,"openapi":"/openapi/tracking.json post /api/v3/{customerId}/{engineId}/search/pushstat/clicklog","href":"/api-reference/track-result-click"}]},{"group":"Feedback","pages":[{"title":"Submit Feedback","deprecated":null,"version":null,"openapi":"/openapi/feedback.json post /api/v4/{customerId}/{engineId}/feedback","href":"/api-reference/submit-feedback"}]},{"group":"Search Tools","pages":[{"title":"Pre-search Suggestions","href":"/api-reference/v4/search-tools/pre-search-suggestions"},{"group":"Banners","pages":[{"title":"Create Banner","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json post /api/banners","href":"/api-reference/create-banner"},{"title":"List Banners by Engine","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/banners/site/{engineId}","href":"/api-reference/list-banners-by-engine"},{"title":"Get Single Banner","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/banners/{bannerId}","href":"/api-reference/get-single-banner"},{"title":"Update Banner","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json put /api/banners/{bannerId}","href":"/api-reference/update-banner"},{"title":"Delete Banner","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json delete /api/banners/{bannerId}","href":"/api-reference/delete-banner"}]},{"group":"Page Rankings","pages":[{"title":"Create Ranking","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json post /api/rankings","href":"/api-reference/create-ranking"},{"title":"List Rankings by Engine","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/rankings/site/{engineId}","href":"/api-reference/list-rankings-by-engine"},{"title":"Get Single Ranking","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/rankings/{rankingId}","href":"/api-reference/get-single-ranking"},{"title":"Update Ranking","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json put /api/rankings/{rankingId}","href":"/api-reference/update-ranking"},{"title":"Delete Ranking","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json delete /api/rankings/{rankingId}","href":"/api-reference/delete-ranking"}]},{"group":"Quicklinks","pages":[{"title":"Quicklinks","href":"/api-reference/v4/search-tools/quicklinks"},{"title":"Create Quicklink","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json post /api/quicklinks","href":"/api-reference/create-quicklink"},{"title":"List Quicklinks","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/engine/{engineId}/quicklinks","href":"/api-reference/list-quicklinks"},{"title":"Get Quicklink","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/quicklinks/{quicklinkId}","href":"/api-reference/get-quicklink"},{"title":"Get Quicklinks by Terms","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/engine/{engineId}/quicklinkterms","href":"/api-reference/get-quicklinks-by-terms"},{"title":"Update Quicklink","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json put /api/quicklinks/{quicklinkId}","href":"/api-reference/update-quicklink"},{"title":"Delete Quicklink","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json delete /api/quicklinks/{quicklinkId}","href":"/api-reference/delete-quicklink"}]},{"group":"Synonyms","pages":[{"title":"Create Synonym Group","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json post /api/synonymsgroup","href":"/api-reference/create-synonym-group"},{"title":"Get Synonyms by Language or Synonym Group","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json get /api/synonymsgroup/{identifier}","href":"/api-reference/get-synonyms-by-language-or-synonym-group"},{"title":"Update Synonym Group","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json put /api/synonymsgroup","href":"/api-reference/update-synonym-group"},{"title":"Delete Synonym Group","deprecated":null,"version":null,"openapi":"/openapi/search-tools.json delete /api/synonymsgroup","href":"/api-reference/delete-synonym-group"}]}]}]}]},"basePath":"","title":"Autocomplete - Cludo API Documentation","buildId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","deploymentId":"dpl_BLQvU86QFwq3AhPofSTw6q8dGWKm","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Myd8dsju.js","utils-C2HkQgW0.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-8rSppmTv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-B6MjiCFm.js","snippetPresets-DwrSAONL.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-1-a5UQKQ.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C541m7wZ.js","shallow-CWELCZ77.js","getApiPlaygroundDisplay-CTo5Zn03.js","CodeSnippet-D--dzvnl.js","CodeSnippets-DM3cXEDh.js","Page-CxAy5y67.js","getPastedJson-C-VECgcL.js","icon-BPq2-Mg3.js","MethodPill-D9J5cUHd.js","DuplicateIcon-BqHaxUnD.js","createIcon-CIbcZHp9.js","DynamicMarkdown-BKiHAm_d.js","SectionHeading-DstQXt3H.js","axios-vUo_bRtp.js","Markdown-CpxgzsKA.js","clsx-C5EfhVm0.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CJ9Oly2E.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Mk6P3qvh.js"]}