SuggestAPISuggestAPIDocumentation
Contact usOpen app
Reference

Search API

Reference for SuggestAPI autocomplete and typeahead endpoints, including query parameters and usage patterns.

Copy page
Open in ChatGPTOpen with page contextOpen in ClaudeOpen with page context

GET /v1/autocomplete

Primary ranked search endpoint.

When the tenant is in search proxy mode, this path forwards to the connected search API. Hosted mode, merchandising, synonyms, personalization, and graph ranking are not applied.

Important query params

  • query required, minimum 1 character
  • index logical index ID, defaults to default
  • limit from 1 to 50
  • mode one of fts_only, vector_only, hybrid, fts_rerank
  • bypass_cache or X-Bypass-Cache to skip cached responses
  • filters as a JSON string for exact and range filtering
  • user_id for personalization-aware ranking

Response shape

The response includes:

  • normalized and optionally corrected query values
  • the effective mode used
  • suggestions with titles, subtitles, descriptions, URLs, images, price, currency, score, and extra metadata

Example

curl "https://api.suggestapi.com/v1/autocomplete?index=products&query=diaphragm%20pump&limit=8&mode=hybrid" \
  -H "x-api-key: <public-key>"

GET /v1/typeahead

Fast prefix suggestion endpoint for search-as-you-type experiences.

Important query params

  • query required
  • index logical index ID
  • limit from 1 to 50
  • bypass_cache or X-Bypass-Cache

Notes

  • optimized for low-latency suggestion UIs
  • supports spell correction and typo-tolerant fuzzy matching on hosted search
  • returns simpler suggestion payloads than /autocomplete
  • in search proxy mode, suggestions come from the connected search API