Skip to content
AACSearch

Replace a search profile

Replaces the whole profile (start from `getSearchProfile`); fields left out reset to their defaults. The name is fixed. Before the first publication, takes effect on the next search request. After publication, updates only the draft; publish it to affect searches.

Full-key operation

Requires a full key; a search key or a browser key gets a 403. See Keys and credits.
PUT
/collections/{collectionName}/search-profiles/{profileName}

Replaces the whole profile (start from getSearchProfile); fields left out reset to their defaults. The name is fixed. Before the first publication, takes effect on the next search request. After publication, updates only the draft; publish it to affect searches.

Authorization

api_key_header
X-NOVA-API-KEY<token>

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

collectionName*string

The name of the collection

profileName*string

The profile's stable name

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/collections/string/search-profiles/string" \  -H "Content-Type: application/json" \  -d '{    "searchable_fields": [      "name",      "brand",      "sku"    ]  }'
{  "label": "string",  "is_default": false,  "searchable_fields": [    "name",    "brand",    "sku"  ],  "facet_fields": [    {      "field": "brand",      "label": "Brand"    }  ],  "filterable_fields": [    "in_stock",    "price"  ],  "sorts": [    {      "id": "price_asc",      "label": "Cheapest first",      "sort_by": "price:asc"    }  ],  "default_sort_id": "string",  "fixed_filter_by": "visible:=true",  "highlight_fields": [    "string"  ],  "per_page_max": 1,  "search_policy": "string",  "revision": 1,  "active_release_id": "string",  "name": "storefront",  "collection": "string",  "created_at": 0,  "updated_at": 0}

Delete a search profile DELETE

Removes the profile. Requests that still name it get `404`; browser keys pinned to it stop working until re-minted.

Read what a storefront may show for a profile GET

The browser-safe projection of a profile: the sorts a visitor may pick (by id and label), the facets to render, the default sort and the page-size ceiling. It never carries engine expressions or field lists, so a browser key may read it. Widgets call it once at start-up.