Algolia

Algolia Query Suggestions API

Query Suggestions add new indices to your Algolia application with popular search queries, external suggestions, or facet values. In your user interface, you…

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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

Base URLs for the Query Suggestions API:

  • https://query-suggestions.us.algolia.com
  • https://query-suggestions.eu.algolia.com

Use the URL that matches your analytics region.

All requests must use HTTPS.

Authentication

Add these headers to authenticate requests:

  • x-algolia-application-id. Your Algolia application ID.
  • x-algolia-api-key. An API key with the necessary permissions to make the request.

The required access control list (ACL) to make a request is listed in each endpoint's reference.

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 2xx statuses. Client errors return 4xx statuses. Server errors return 5xx statuses.
Error responses have a message property with more information.

Version

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

Endpoints 12

query-suggestions

  • GETSend requests to the Algolia REST API/:pathThis method lets you send requests to the Algolia REST API.
  • PUTSend requests to the Algolia REST API/:pathThis method lets you send requests to the Algolia REST API.
  • POSTSend requests to the Algolia REST API/:pathThis method lets you send requests to the Algolia REST API.
  • DELETESend requests to the Algolia REST API/:pathThis method lets you send requests to the Algolia REST API.
  • GETList configurations/1/configsRetrieves all Query Suggestions configurations of your Algolia application.
  • POSTCreate a configuration/1/configsCreates a new Query Suggestions configuration. You can have up to 100 configurations per Algolia application.
  • GETRetrieve a configuration/1/configs/:indexNameRetrieves a single Query Suggestions configuration by its index name.
  • PUTUpdate a configuration/1/configs/:indexNameUpdates a QuerySuggestions configuration.
  • DELETEDelete a configuration/1/configs/:indexNameDeletes a Query Suggestions configuration. Deleting only removes the configuration and stops updates to the Query Suggestions index. To delete the Query…
  • GETRetrieve configuration status/1/configs/:indexName/statusReports the status of a Query Suggestions index.
  • GETRetrieve logs/1/logs/:indexNameRetrieves the logs for a single Query Suggestions index.
  • GETSwitch the API key used to authenticate requests/setClientApiKey?apiKey=stringSwitch the API key used to authenticate requests.

API details

Base URL
https://query-suggestions.{region}.algolia.com
Authentication
An API key in the x-algolia-application-id header
An API key in the x-algolia-api-key header
Operations
12 operations on 6 pathsGET 6PUT 2POST 2DELETE 2
Main resources
query-suggestions 12
Response formats
application/json
Description format
OpenAPI 3.0.2, API version 1.0.0

How to test the Algolia Query Suggestions API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Algolia Query Suggestions API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the x-algolia-application-id header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Send requests to the Algolia REST API” (GET /:path), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Algolia Query Suggestions API?

Query Suggestions add new indices to your Algolia application with popular search queries, external suggestions, or facet values. In your user interface, you… It is listed under Developer tools and has 12 endpoints.

Who publishes the Algolia Query Suggestions API?

It is listed from Algolia's public API description (an OpenAPI document), not published by Algolia on Swastik Codes. Anyone who controls algolia.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Algolia Query Suggestions API?

Requests go to https://query-suggestions.{region}.algolia.com. Endpoint paths are added to this base URL.

How do I authenticate with the Algolia Query Suggestions API?

It accepts 2 methods: an API key in the x-algolia-application-id header; an API key in the x-algolia-api-key header.

How many endpoints does the Algolia Query Suggestions API have?

12 operations on 6 paths (6 GET, 2 PUT, 2 POST, 2 DELETE). The largest groups are query-suggestions.

Is forking the Algolia Query Suggestions API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.