Algolia Query Suggestions

Algolia Query Suggestions

Query Suggestions add new indices to your Algolia application with popular search queries, external suggestions, or facet values. In your user interface, you can query the Query Suggestions indices like regular indices and add suggested searches to guide users and speed up their search.

Base URLs

The base URLs for requests to the Query Suggestions API are:

Use the URL that matches your analytics region.

All requests must use HTTPS.

Authentication

To authenticate your API requests, add these headers:

You can find your application ID and API key in the Algolia dashboard.

Request format

Request bodies must be JSON objects.

Response status and errors

Response bodies are JSON objects. Deleting a user token returns an empty response body with rate-limiting information as headers.

Successful responses return a 2xx status. Client errors return a 4xx status. Server errors are indicated by a 5xx status. Error responses have a message property with more information.

Version

The current version of the Query Suggestions API is version 1, as indicated by the /1/ in each endpoint's URL.

Operations

List configurations
Delete a configuration
Retrieve a configuration
Update a configuration
Retrieve configuration status
Create a configuration
Retrieve logs
Send requests to the Algolia REST API
Send requests to the Algolia REST API
Send requests to the Algolia REST API
Send requests to the Algolia REST API
Switch the API key used to authenticate requests