The SuggestAPI console at app.suggestapi.com is the operator UI for catalogs, search tuning, agent publishing, keys, and billing. Use these pages when you want to complete a job in the app rather than call the API.

API keys are documented in Authentication and API keys. Feature overviews and endpoint lists stay under Features, Guides, and Reference.

Sign in and workspace

  1. Sign in at app.suggestapi.com.
  2. If you belong to more than one organization, use the workspace menu in the header to select the tenant whose indexes you want to manage. Indexes, keys, agent content, and billing are isolated per tenant.
  3. If the console asks you to choose a plan, your trial or subscription is inactive. Complete checkout under Billing & Usage before other tabs will load.

Profile (name, email, time zone, password) is under the avatar menu.

Area Where What it is for
Indexes /indexes Create indexes and open catalog, search, and task management.
Agent Content /agent-content Verify a storefront domain, link an index, and publish agent-facing policies.
API Keys /api-keys Public (read) and private (write) keys, optionally scoped to indexes.
Manage Settings Avatar → Manage Settings Tenant-wide search serving: SuggestAPI hosted or your own search API.
Billing & Usage Avatar → Billing & Usage Plan, Stripe portal, and usage charts.

Rate Limits appears only for platform superusers. Scheduled Integrations is not in the live nav.

Inside an index

Open an index from the list. Empty indexes land on Import; indexes with documents land on Documents. Tabs:

Tab Job
Documents Browse, find, edit, duplicate, or delete records.
Import File upload, Google Shopping CSV, paste JSON, 1-Click Catalog Import.
Tasks Watch, cancel, or download background jobs.
Configuration Searchable fields, boosts, synonyms, search mode, reindex, merchandising.
Test Search Live autocomplete against the production search path.
Details Description, freshness, schema summary. Export JSON, CSV, or JSONL from the header.

Deep-link with ?tab=import, documents, tasks, config, playground, or details.

Only one background import, export, catalog crawl, or reindex runs per index at a time. While a job is active, Import, Configuration saves, and Export are locked. Use Tasks to wait or cancel.

Typical first week

  1. Create an index.
  2. Import a catalog.
  3. Confirm records on Documents.
  4. Tune Configuration, then check Test Search.
  5. Create a public API key for the storefront.
  6. On Agent Content, verify the domain and publish policies if agents should discover the catalog.