Skip to content
AACSearch

Create or update a curation set

Create or update a curation set with the given name

Full-key operation

Requires a full key; a search key or a browser key gets a 403. See Keys and credits.
PUT
/curation_sets/{curationSetName}

Create or update a curation set with the given name

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

curationSetName*string

The name of the curation set to create/update

Request Body

application/json

The curation set to be created/updated

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/curation_sets/string" \  -H "Content-Type: application/json" \  -d '{    "items": [      {        "rule": {}      }    ]  }'
{  "items": [    {      "rule": {        "tags": [          "string"        ],        "query": "string",        "match": "exact",        "filter_by": "string"      },      "includes": [        {          "id": "string",          "position": 0        }      ],      "excludes": [        {          "id": "string"        }      ],      "filter_by": "string",      "remove_matched_tokens": true,      "metadata": {},      "sort_by": "string",      "replace_query": "string",      "filter_curated_hits": true,      "effective_from_ts": 0,      "effective_to_ts": 0,      "stop_processing": true,      "id": "string"    }  ],  "description": "string",  "name": "string"}