Skip to main content
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>'
{
  "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"
}

Documentation Index

Fetch the complete documentation index at: https://cludo.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Autocomplete Strategies

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:

Authorizations

​
Authorization
string
header
required

SiteKey authentication. Pass the full value including the SiteKey prefix: SiteKey <base64(customerId:engineId:searchKey)>. Example: SiteKey dGVzdDoxMjM0NTY3Ojk4NzY1. See the Authentication guide for details.

Path Parameters

​
customerId
integer
required

Your Cludo account ID. Find it in MyCludo.

​
engineId
integer
required

The search engine to query. Must match the engine ID in your SiteKey.

Query Parameters

​
query
string
required

The partial text the user has typed so far.

​
results
integer
default:5

Maximum number of suggestions to return.

​
responseType
enum<string>

JsonObject — structured JSON (recommended). JsonHtml — HTML fragments.

Available options:
JsonObject,
JsonHtml
​
filters
string

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"]}.

Response

Autocomplete suggestions returned successfully.

​
results
object[]

Top document hits that match the partial query, each with fields (e.g. Title, Url) and id.

​
suggestions
string[]

Plain-text completions to show in the dropdown (may differ from results titles).

​
topHits
object

Optional grouped counts per field value (e.g. top categories matching the prefix).

​
totalResults
integer

Count of document hits returned or considered for this autocomplete call.

​
totalSuggestions
integer

Count of string suggestions in suggestions.

​
facets
object

Lightweight facet map for the autocomplete context (shape similar to search Facets when present).

​
queryId
string

Correlation id for analytics (optional depending on engine).