The generated API clients are a work in progress, you can also find our stable clients on the Algolia documentation.

Skip to main content
API docs by Redocly

Query Suggestions API (1.0.0)

Download OpenAPI specification:Download

API powering the Query Suggestions feature of Algolia.

Configurations

Manage Query Suggestions configurations.

List configurations

Get all the configurations of Query Suggestions. For each index, you get a block of JSON with a list of its configuration settings.

Authorizations:
(appIdapiKey)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a configuration

Create a configuration of a Query Suggestions index. There's a limit of 100 configurations per application.

Authorizations:
(appIdapiKey)
Request Body schema: application/json
required
Array of objects (SourceIndices)

List of source indices used to generate a Query Suggestions index.

languages
Array of strings

De-duplicate singular and plural suggestions. For example, let's say your index contains English content, and that two suggestions “shoe” and “shoes” end up in your Query Suggestions index. If the English language is configured, only the most popular of those two suggestions would remain.

exclude
Array of strings

List of words and patterns to exclude from the Query Suggestions index.

indexName
required
string

Index name to target.

Responses

Request samples

Content type
application/json
{
  • "sourceIndices": [
    ],
  • "languages": [
    ],
  • "exclude": [
    ],
  • "indexName": "string"
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Success"
}

Get a single configuration

Get the configuration of a single Query Suggestions index.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

Responses

Response samples

Content type
application/json
{
  • "indexName": "string",
  • "sourceIndices": [
    ],
  • "languages": [
    ],
  • "exclude": [
    ]
}

Update a configuration

Update the configuration of a Query Suggestions index.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

Request Body schema: application/json
required
Array of objects (SourceIndices)

List of source indices used to generate a Query Suggestions index.

languages
Array of strings

De-duplicate singular and plural suggestions. For example, let's say your index contains English content, and that two suggestions “shoe” and “shoes” end up in your Query Suggestions index. If the English language is configured, only the most popular of those two suggestions would remain.

exclude
Array of strings

List of words and patterns to exclude from the Query Suggestions index.

Responses

Request samples

Content type
application/json
{
  • "sourceIndices": [
    ],
  • "languages": [
    ],
  • "exclude": [
    ]
}

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Success"
}

Delete a configuration

Delete a configuration of a Query Suggestion's index. By deleting a configuration, you stop all updates to the underlying query suggestion index. Note that when doing this, the underlying index does not change - existing suggestions remain untouched.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

Responses

Response samples

Content type
application/json
{
  • "status": 200,
  • "message": "Success"
}

Get configuration status

Get the status of a Query Suggestion's index. The status includes whether the Query Suggestions index is currently in the process of being built, and the last build time.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

Responses

Response samples

Content type
application/json
{
  • "indexName": "string",
  • "isRunning": true,
  • "lastBuiltAt": "string"
}

Advanced

Advanced operations.

Get a log file

Get the log file of the last build of a single Query Suggestion index.

Authorizations:
(appIdapiKey)
path Parameters
indexName
required
string
Example: myIndexName

The index in which to perform the request.

Responses

Response samples

Content type
application/json
[
  • {
    }
]