An index is a named catalog SuggestAPI searches. Create and open indexes from Indexes (/indexes).
Blue-green physical promotion for API-driven cutovers is covered in Index lifecycle. This page is the console list.
Create an index
- Open Indexes.
- Choose Create Index.
- Set Display Name (what the team sees) and Index ID (Slug) (what API calls use). The slug accepts alphanumeric characters, dashes, and underscores only. It cannot change later.
- Confirm creation.
Plan rules can block additional indexes. See Service limits and Billing and usage.
Find and open an index
The list shows slug, name, status, document count, and timestamps. Filter by ID or name, and by ready vs pending (empty) status. Sort any column.
Click a row to open index management. If the workspace looks empty but you expected data, switch organization from the header workspace menu. Indexes belong to one tenant.
Status
- Pending — no documents yet. The index opens on Import.
- Ready — at least one document. The index opens on Documents.
Delete
Delete from the row actions. Deletion cannot be undone.
The index linked as the account primary domain index is protected. Unlink or change that assignment from Agent content before you can remove it.
After you create an index
- Import a catalog
- Manage documents
- Search index settings
- API keys if the storefront will query this index