Retrieves a preset.
Retrieve the details of a preset, given it's name.
Full-key operation
Retrieve the details of a preset, given it's name.
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 ID of the preset to retrieve.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/presets/listing_view"{ "value": { "q": "string", "query_rewrite": "layout,translit", "refinements": "off", "search_policy": "string", "x_user_id": "string", "x_anonymous_id": "string", "x_personalization_strength": 0, "x_surface": "search", "debug": true, "rerank": true, "rerank_top_k": 1, "rerank_model": "bge-reranker-base", "query_by": "string", "validate_field_names": true, "nl_query": true, "nl_model_id": "string", "nl_query_debug": true, "nl_query_prompt_cache_ttl": 0, "query_by_weights": "string", "text_match_type": "string", "prefix": "string", "infix": "string", "max_extra_prefix": 0, "max_extra_suffix": 0, "filter_by": "num_employees:>100 && country: [USA, UK]", "max_filter_by_candidates": 0, "sort_by": "num_employees:desc", "facet_by": "string", "max_facet_values": 0, "facet_query": "string", "facet_query_num_typos": 0, "num_typos": "string", "page": 0, "per_page": 0, "limit": 0, "offset": 0, "group_by": "string", "group_limit": 0, "group_missing_values": true, "include_fields": "string", "exclude_fields": "string", "highlight_full_fields": "string", "highlight_affix_num_tokens": 0, "highlight_start_tag": "string", "highlight_end_tag": "string", "enable_highlight_v1": true, "enable_analytics": true, "snippet_threshold": 0, "synonym_sets": "synonym_set_1,synonym_set_2", "drop_tokens_threshold": 0, "drop_tokens_mode": "right_to_left", "typo_tokens_threshold": 0, "enable_typos_for_alpha_numerical_tokens": true, "filter_curated_hits": true, "enable_synonyms": true, "synonym_prefix": true, "synonym_num_typos": 0, "pinned_hits": "string", "hidden_hits": "string", "curation_tags": "string", "highlight_fields": "string", "split_join_tokens": "string", "pre_segmented_query": true, "preset": "string", "profile": "string", "sort": "string", "enable_curations": false, "prioritize_exact_match": true, "max_candidates": 0, "prioritize_token_position": false, "prioritize_num_matching_fields": true, "enable_typos_for_numerical_tokens": true, "exhaustive_search": true, "search_cutoff_ms": 0, "use_cache": true, "cache_ttl": 0, "min_len_1typo": 0, "min_len_2typo": 0, "vector_query": "string", "remote_embedding_timeout_ms": 0, "remote_embedding_num_tries": 0, "facet_strategy": "string", "stopwords": "string", "facet_return_parent": "string", "voice_query": "string", "conversation": true, "conversation_model_id": "string", "conversation_id": "string", "conversation_stream": true }, "name": "string"}