Mint a short-lived search key for a browser
Derives a secured key (`nssk_…`) from the calling full key, narrowed to the `search` scope and to the given collections and origins. It reaches only the storefront operations — search, recommendations, events, voice, image and semantic search and the assistant — and expires by itself (at most seven days), so a copy taken out of a page has a bounded blast radius. Revoking or rotating the parent key invalidates every browser key derived from it. The parent must be a full key created after secured keys were introduced (it carries a signing secret); a browser key cannot mint another.
Full-key operation
Derives a secured key (nssk_…) from the calling full key, narrowed to the search scope and to the given collections and origins. It reaches only the storefront operations — search, recommendations, events, voice, image and semantic search and the assistant — and expires by itself (at most seven days), so a copy taken out of a page has a bounded blast radius. Revoking or rotating the parent key invalidates every browser key derived from it. The parent must be a full key created after secured keys were introduced (it carries a signing secret); a browser key cannot mint another.
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
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
curl -X POST "https://example.com/browser-keys" \ -H "Content-Type: application/json" \ -d '{}'{ "key": "string", "scope": "search", "expires_at": "2019-08-24T14:15:22Z", "parent_key_id": "string"}