How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Algolia

Algolia Query Suggestions API

Generates and maintains query-suggestion indices from popular searches to power as-you-type autocomplete.

Documentation Provider Profile APIs.io OpenAPI GitHub

This API exposes 12 operations across 6 paths, and defines 16 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://query-suggestions.{region}.algolia.com.

12 operations 6 paths 16 schemas 2 DELETE6 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://query-suggestions.{region}.algolia.com
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Algolia Query Suggestions API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-algolia-application-id (appId). An API key is passed in the header as x-algolia-api-key (apiKey). By default, every request must be authenticated.

  • appId — Your Algolia application ID.
  • apiKey — Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions.…

Paths & Operations 12

Across 6 paths, the API surfaces 12 operations — 2 DELETE, 6 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

query-suggestions 12
GET
/{path}
Send requests to the Algolia REST API
customGet 2 params → 200400402403404
POST
/{path}
Send requests to the Algolia REST API
customPost 2 params body → 200400402403404
PUT
/{path}
Send requests to the Algolia REST API
customPut 2 params body → 200400402403404
DELETE
/{path}
Send requests to the Algolia REST API
customDelete 2 params → 200400402403404
GET
/1/configs
List configurations
getAllConfigs → 200401
POST
/1/configs
Create a configuration
createConfig body → 200400401422500
GET
/1/configs/{indexName}
Retrieve a configuration
getConfig 1 param → 200400401404
PUT
/1/configs/{indexName}
Update a configuration
updateConfig 1 param body → 200401500
DELETE
/1/configs/{indexName}
Delete a configuration
deleteConfig 1 param → 200401500
GET
/1/configs/{indexName}/status
Retrieve configuration status
getConfigStatus 1 param → 200401404
GET
/1/logs/{indexName}
Retrieve logs
getLogFile 1 param → 200401404
GET
/setClientApiKey
Switch the API key used to authenticate requests
setClientApiKey 1 param → 204

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are SourceIndex (8 properties), Configuration (5 properties), Facet (2 properties), BaseResponse (2 properties). Each schema is shown below with its type and property counts.

AppID
object
1 property
IndexName
string
Name of the Query Suggestions index (case-sensitive).
Languages
Languages for deduplicating singular and plural suggestions. If specified, only the more popular form is included.
BaseResponse
object
2 properties
ConfigurationResponse
object
API response for retrieving Query Suggestions configurations.
6 required
Configuration
object
Query Suggestions configuration.
5 properties 1 required
Exclude
Words or regular expressions to exclude from the suggestions.
Facets
Facets to use as top categories with your suggestions. If provided, Query Suggestions adds the top facet values to each suggestion.
ConfigurationWithIndex
object
Query Suggestions configuration.
2 required
LogLevel
string
Type of log entry. - SKIP. A query is skipped because it doesn't match the conditions for successful inclusion. For example, when a query doesn't generate enou…
Generate
Facets used for generating query suggestions from facet values. For example, if you set generate: ["color", "brand"], combinations from the facet values are ad…
SourceIndex
object
Configuration of an Algolia index for Query Suggestions.
8 properties 1 required
External
Algolia indices with popular searches to use as query suggestions. Records of these indices must have these attributes: - query: search query which will be add…
AnalyticsTags
Analytics tags for filtering the popular searches. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/…
Facet
object
Facet to use as category.
2 properties
ErrorBase
object
Error.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

algolia-query-suggestions-api-openapi.yml Raw ↑
#Search#Autocomplete#REST
← Back to A APIs
API Details
ID
algolia:algolia-query-suggestions-api
Base URL
https://query-suggestions.{region}.algolia.com
Docs
https://www.algolia.com/doc/rest-api/query-suggestions/
Provider
Algolia
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=algolia-algolia-query-suggestions-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/algolia-algolia-query-suggestions-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Algolia Query Suggestions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.