Skip to main content
GET
Autocomplete
Returns term suggestions from the pre-aggregated search suggestions index. Optimized for sub-50ms response times with Redis caching.

Authentication

All requests must include an API key via the x-api-key header or key query parameter.

Query Parameters

string
obrigatório
Search prefix (minimum 2 characters). Returns empty suggestions for single-character queries.
integer
padrão:"5"
Maximum number of suggestions returned. Capped at 10.
boolean
padrão:"false"
Include top 3 matching products when available from cache. Products are only returned on cache hit — never triggers a live search query.
string
API key as query parameter (alternative to x-api-key header).

Response

AutocompleteSuggestion[]
Array of suggestion objects ordered by document count descending.
integer
Server-side processing time in milliseconds.
SearchHit[]
Optional product previews. Only present when include_products=true and cache is warm.

AutocompleteSuggestion

Example

Rate Limits

1000 requests per minute per API key.

Error Codes

Última modificação em 12 de março de 2026