Typeahead suggestions
Suggestions for a prefix while the visitor types (TYPEAHEAD surface). Candidates come from the collection's popular queries, its documents, linked catalogue entities (brands, categories), the query graph continuing the session's last query, search-rule suggestions and the session's recent searches; they are ranked by expected downstream usefulness (not just count or CTR), de-duplicated semantically and filtered of queries known to return nothing. Every returned suggestion is logged as an impression with its position; report the chosen one as a `suggestion_select` event with `query_id` = `suggest_id`. Never calls a language model.
Search-key operation
Suggestions for a prefix while the visitor types (TYPEAHEAD surface). Candidates come from the collection's popular queries, its documents, linked catalogue entities (brands, categories), the query graph continuing the session's last query, search-rule suggestions and the session's recent searches; they are ranked by expected downstream usefulness (not just count or CTR), de-duplicated semantically and filtered of queries known to return nothing. Every returned suggestion is logged as an impression with its position; report the chosen one as a suggestion_select event with query_id = suggest_id. Never calls a language model.
Authorization
api_key_header Every request carries an organization API key. A key has one of two scopes. A full key reaches every operation in this document and belongs on your server. A search key is the one to ship in a browser widget or a storefront page: it reaches only the operations marked x-nova-key-scope: search — searching, federated search, recommendations, event ingestion, and the visitor-facing AI operations (semantic and image search, voice transcription and voice search, assistant chat, and the visitor's own conversation). It cannot write documents or read or change configuration; any other operation answers 403. AI operations are paid in credits from the organization's wallet whichever key calls them (402 when the balance runs out), and a search key needs X-NOVA-SESSION-ID on them: the session is what a conversation belongs to, and what the per-session allowance (429) is counted against. A key of either scope may additionally carry restrictions set in the console: an allowlist of collections (403 elsewhere), a forced filter_by per collection that is ANDed into every search (document-level access control), an allowlist of fields (include_fields is limited to it and a request naming any other field in query_by, facet_by, sort_by, filter_by or highlight_fields answers 400), an IP/CIDR allowlist and an Origin/Referer allowlist (403), and a per-key rate limit (429 with Retry-After).
In: header
Path Parameters
The name of the collection
Query Parameters
The prefix typed so far. Empty returns pre-search prompts (same as presearch).
length <= 2001 <= value <= 208The session's previous search, for contextual continuations.
length <= 200The signed-in visitor's id, for recent searches.
Header Parameters
The caller's session, for recent searches and impression attribution.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/collections/string/suggest?q=string"{ "suggest_id": "string", "q": "string", "suggestions": [ { "id": "string", "text": "string", "display": "string", "source": "query", "position": 0, "score": 0, "filter_by": "string", "doc_id": "string", "found": 0 } ], "took_ms": 0}Get recommendations POST
Returns documents recommended by a model. Pass `object_id` for item-to-item models (`looking_similar`, `related_items`, `bought_together`), `session_id` or `user_id` for `session`, and nothing for `trending`. Hits use the same shape as search results so they can be rendered by the same code.
Pre-search prompts GET
What to show before the visitor types (PRESEARCH surface): the session's or user's recent searches, contextual continuations of the last query (from the query graph), and what is trending on the collection. Sections are omitted when empty. Report a chosen item as a `suggestion_select` event with `query_id` = `presearch_id`.