Custom Indexes

Beyond the standard indexes, you can create custom indexes for information that needs its own home — a dataset for one project, a customer-specific collection, or a public index that external tools can search with an API key.

Custom indexes are managed from the Indexes & keys panel at the top of the Knowledge page. Expand it to see every index registered for your company, each with its scope badge, name, description, and how often agents used it in the last 30 days.

Index scopes

Every custom index has a scope that determines who can read and write it:

Scope	Who can access it
private	Only you and your companion agent
company	All agents in your company
public	The creator, plus anyone holding a read-only API key minted for the index

The full index name is derived from your company slug, the scope, and the name suffix you choose, so index names never collide between companies.

Creating an index

1. Open the Indexes & keys panel

   On the Knowledge page, expand Indexes & keys and click Create index.

2. Choose a scope

   Pick private, company, or public depending on who should be able to access the index.

3. Enter a name suffix

   The suffix must be slug-safe: lowercase letters, digits, and dashes, up to 64 characters (e.g. wayfarer-icp). The full index name is derived from it automatically.

4. Describe what the index stores

   The description is required. Agents discover indexes through sprigr_search with action: "list_indexes", and the description is what tells them whether an index is relevant — write it for an agent deciding where to look.

5. Click “Create”

   The index is registered and ready to use. For a public index, a default read-only API key is minted automatically and shown once in a copy-once dialog, together with the search URL — save it before closing.

Managing keys on public indexes

Public indexes carry their own API keys so external tools — dashboards, website embeds, customer lookups — can search them without a Sprigr Teams login. Click Keys next to a public index to open the keys drawer.

From the drawer you can:

• Mint a new key — Give it an optional label and choose a key type. Read keys are safe to distribute externally and to ship in client-side code. Write keys allow ingest and must stay server-side — treat them like database passwords and never ship them in a browser bundle.
• Rename — Update a key’s label for audit legibility.
• Rotate — Mint a new secret with the same access and revoke the old one in a single step. The new secret is shown once.
• Revoke — Permanently disable a key. Revocation takes effect immediately.

Secrets are shown once

A key’s secret value is only displayed at creation or rotation, in a copy-once dialog. Afterwards the drawer lists metadata only (key id, label, type, created, last used, expiry). If you lose a secret, rotate the key.

Deleting an index

Click Delete next to an index in the panel. Deleting removes the index and all of its content, and revokes any associated keys. This cannot be undone.

Only the creator of an index can delete it — if an agent created the index, the delete must come from that agent, and the portal will show a permission error otherwise.

Agents and custom indexes

Agents work with custom indexes through the same tools they use for standard knowledge:

• sprigr_search with action: "list_indexes" lists every index the agent can see, including custom ones, with their descriptions.
• sprigr_write with an index_name saves an entry into a specific custom index instead of the default shared or private index.

You can also ask an agent to create an index for you — for example, “Create a company index for supplier price lists and describe it so other agents can find it.”

MCP clients get the same capabilities through the sprigr_create_index, sprigr_list_my_indexes, sprigr_attach_index, sprigr_delete_index, sprigr_create_public_key, sprigr_list_keys, sprigr_rotate_key, sprigr_revoke_key, and sprigr_update_key_label tools — see the MCP Overview.

Next steps

• Knowledge Bases Overview — The standard indexes every organisation gets.
• Managing Indexes — Day-to-day entry management on the Knowledge page.
• Collections — Typed, deduplicated, faceted record sets for structured data, as an alternative to freeform knowledge entries.
• MCP Overview — Manage indexes and keys from external AI clients.