Query Suggestions API

Name: Query Suggestions API API
Brand: Query Suggestions API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentAI/MLEmbeddings SearchapiKey12 EndpointsREST

For Agents

Configure and inspect Algolia query-suggestions indices that power autocomplete, including source index selection, facet eligibility, and rebuild status.

Quickstart

Get started with Query Suggestions API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"create an Algolia query suggestions configuration"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with Query Suggestions API API.

Create a query-suggestions configuration linking source indices and facets via POST /1/configs

List every query-suggestions configuration in the application via GET /1/configs

Update an existing configuration to add facets or change generation rules via PUT /1/configs/{indexName}

Delete a query-suggestions configuration when an index is decommissioned via DELETE /1/configs/{indexName}

GET STARTED

Start building with Query Suggestions API API

Explore with Jentic

View OpenAPI Document

Use for: I need to create a query-suggestions index for an autocomplete UI, List all query-suggestions configurations in the application, Check whether a query-suggestions index has finished rebuilding, Retrieve the log file for the latest suggestions build

Not supported: Does not execute search queries, manage records, or send analytics events - use the Algolia Search and Insights APIs for those. Use this API for query suggestions configuration only.

Jentic publishes the only available OpenAPI document for Query Suggestions API, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for the Algolia Query Suggestions API, keeping it validated and agent-ready. The Query Suggestions API manages the configuration of suggestion indices that Algolia generates from your search analytics, external suggestion lists, or facet values. You define which source indices contribute, which facets are eligible, and how often the suggestions index is rebuilt. The resulting suggestions index can then be queried like any other Algolia index to power autocomplete experiences.

Use Cases

Patterns agents use Query Suggestions API API for, with concrete tasks.

★ Storefront autocomplete from search analytics

Create a query-suggestions config that pulls popular searches from a primary product index and surfaces them as autocomplete entries. The Query Suggestions service rebuilds the index on a schedule, ranking suggestions by search volume and click-through. You can then query the resulting suggestions index from your autocomplete UI like any other Algolia index.

POST /1/configs with sourceIndices referencing 'products', generate=['brand','category'] facets, and minHits=5

Multi-source suggestions for content sites

Combine searches from a product index and an articles index into a single suggestions index. The configuration accepts multiple source indices and merges their popular queries, so a single autocomplete dropdown can surface both product and content suggestions ranked by relevance.

PUT /1/configs/storefront-suggestions adding 'articles' to sourceIndices alongside 'products' with weight 0.5

Diagnose missing suggestions

When a popular query does not appear in the suggestions dropdown, fetch the latest build log via GET /1/logs/{indexName} to see whether it was filtered by minHits, blocklist, or a generation rule. Combined with GET /1/configs/{indexName}/status this lets you confirm the index is up to date.

GET /1/logs/storefront-suggestions and GET /1/configs/storefront-suggestions/status, then report any errors or filtered queries

Agent-managed autocomplete tuning

An AI agent can audit current configurations, identify suggestions indices with stale builds, and apply updated rules through Jentic. Credentials are pulled from the Jentic vault so the agent never handles raw Algolia admin keys.

Search Jentic for 'update Algolia query suggestions configuration', load updateConfig, and execute with the new facet list

Key Endpoints

12 endpoints — jentic publishes the only available openapi specification for the algolia query suggestions api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/1/configs

List all query-suggestions configurations

POST

/1/configs

Create a new configuration

PUT

/1/configs/{indexName}

Update an existing configuration

DELETE

/1/configs/{indexName}

Delete a configuration

GET

/1/configs/{indexName}/status

Get build status of a suggestions index

GET

/1/logs/{indexName}

Get the latest build log

GET

/1/configs

List all query-suggestions configurations

POST

/1/configs

Create a new configuration

PUT

/1/configs/{indexName}

Update an existing configuration

DELETE

/1/configs/{indexName}

Delete a configuration

GET

/1/configs/{indexName}/status

Get build status of a suggestions index

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

x-algolia-application-id and x-algolia-api-key are stored encrypted in the Jentic vault. Agents receive scoped tokens at execution time; the raw Algolia admin key never enters agent context.

Intent-based discovery

Agents search Jentic by intent (e.g. 'create Algolia query suggestions config' or 'check suggestions build status') and Jentic returns the matching operation with its input schema.

Time to first call

Direct integration: half a day to wire config CRUD, status polling, and log inspection. Through Jentic: under 20 minutes - search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Algolia Search API

Read suggestions indices via the standard search endpoint

Always pair with Search - Query Suggestions only configures the index; reads happen through the Search API.

Complementary

Algolia Recommend API

Different surface area - product recommendations rather than autocomplete suggestions

Use Recommend for related-products carousels and Query Suggestions for autocomplete inputs.

Alternative

Meilisearch API

Open-source search with built-in typo-tolerant prefix matching

Choose Meilisearch when you need self-hosted autocomplete via prefix search rather than a curated suggestions index.

FAQs

Specific to using Query Suggestions API API through Jentic.

Why is there no official OpenAPI spec for the Query Suggestions API?

Algolia does not publish a standalone OpenAPI specification for the Query Suggestions API. Jentic generates and maintains this spec so that AI agents and developers can call the Query Suggestions API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the Algolia Query Suggestions API use?

Two API key headers: x-algolia-application-id and x-algolia-api-key with the editSettings ACL. Through Jentic, both are stored in the vault and injected at request time, so agents never see the raw admin key.

Can I combine multiple source indices into a single suggestions index?

Yes. POST or PUT /1/configs accepts a sourceIndices array, and each entry can carry its own facets, generate rules, and weight. Algolia merges and ranks the combined suggestions during the next rebuild.

What are the rate limits for the Algolia Query Suggestions API?

The spec does not declare numeric rate limits. Configuration changes trigger an asynchronous rebuild, so back-to-back PUTs on the same config can queue. Use GET /1/configs/{indexName}/status to confirm the previous build finished before issuing the next change.

How do I create a suggestions configuration through Jentic?

Search Jentic for 'create Algolia query suggestions config', load createConfig, and execute with sourceIndices and generate facets. Jentic injects the application ID and API key automatically.

Where do the suggestions actually live once configured?

Each configuration produces a regular Algolia index named in the config. Query that index via the Search API to populate your autocomplete dropdown - no special suggestions endpoint is needed for read traffic.