List all synonym sets
Retrieve all synonym sets
Full-key operation
Retrieve all synonym sets
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
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/synonym_sets"[ { "items": [ { "id": "string", "synonyms": [ "string" ], "root": "string", "locale": "string", "symbols_to_index": [ "string" ] } ], "name": "string" }]send multiple search requests in a single HTTP request POST
This is especially useful to avoid round-trip network latencies incurred otherwise if each of these requests are sent in separate HTTP requests. You can also use this feature to do a federated search across multiple collections in a single HTTP request. AACSearch extension: with `debug=true` (in the query string, on a search item, or the `X-NOVA-DEBUG: 1` header) the response includes `_trace` and every hit an `_explain` object, as for `searchCollection`. Every response carries an `X-Nova-Trace-Id` header identifying it in the query log.
Retrieve a synonym set GET
Retrieve a specific synonym set by its name