SuggestAPISuggestAPIDocumentation
Contact usOpen app
Console

Search Serving

Choose SuggestAPI hosted search or your own search API for the tenant from Manage Settings.

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

Manage Settings (avatar menu) controls how autocomplete is served for the whole tenant, not a single index.

SuggestAPI hosted uses SuggestAPI retrieval and ranking. Your search API (plugin) is search proxy mode: the same /v1/autocomplete and /v1/typeahead URLs forward to your engine. Hosted ranking features do not apply. See Search capabilities and Search Proxy.

Prerequisites

Link a primary domain and index from Agent content before these controls activate. You cannot switch serving mode while a background import or reindex is running.

SuggestAPI hosted

Default. SuggestAPI ranks and returns autocomplete for the primary domain. No external search endpoint is required. Test Search uses this path.

Your search API (plugin)

Plugin mode sends live autocomplete to an HTTP API you operate. Configure:

  • Request URL template, method (GET or POST), optional headers and body template
  • Response mapping: items path, id, title/text, optional subtitle, image, URL, score, facets
  • Auth secrets stored in the console (not in the browser)

Save a draft, test with a sample query, then publish so live traffic uses the plugin. A deployment switch can stay in progress until pending imports finish; live traffic updates when the switch completes.

Use plugin mode when the storefront must keep an existing search backend and SuggestAPI should not serve hosted retrieval for that domain.

Hosted search behavior does not apply in this mode: hybrid/FTS/vector search mode, schema boosts and synonyms, merchandising pins, SuggestAPI spell correction, personalization, and knowledge-graph ranking. /v1/autocomplete and /v1/typeahead still work; they proxy to your API. Details: Search capabilities.