Scoped Search API Keys

A scoped search API key is a search key with filters embedded in it, so the user holding it can only search the documents you allow. For example, in a multi-tenant app, you'd give each customer a key that's scoped to company_id:=124. Read more about how they work here.

You'd usually generate these in your backend with a client library. But to try one out, you can also generate a key in the dashboard:

1. Open your Cluster Dashboard and click on "API Keys" in the left pane.

2. Scroll down to "Generate Scoped Search Key".

3. Paste a "Parent search key". This needs to be a key whose only action is documents:search.

4. Enter a "Filter" (for example, company_id:=124), and optionally an "Expires at" time, "Max hits per search" or other search parameters.

5. Click on "Generate Scoped Search Key".

The key is generated in your browser, so neither key is sent anywhere or stored.