SuggestAPI Documentation
Contact us Open app
Getting Started

Authentication and API Keys

Learn how SuggestAPI uses scoped API keys for search and indexing access.

Copy page
Open in ChatGPT Open with page context Open in Claude Open with page context

SuggestAPI access for search and indexing setup is centered around API keys managed in the web app.

API keys

API keys should be created and managed in the SuggestAPI web app.

In the app, open the API Keys area for your tenant and create the key you need for the environment you are setting up.

Keys can be:

  • public for frontend-safe read use cases
  • private for write-capable or trusted backend integrations
  • restricted to specific indexes

Managing keys in the web app

Typical setup flow:

  1. Sign in to the SuggestAPI app.
  2. Switch to the correct tenant if you have access to more than one.
  3. Open API Keys.
  4. Create a public key for browser search or a private key for trusted server-side work.
  5. Limit the key to the indexes it should access when appropriate.
  6. Save the key somewhere secure and add it to your app or integration config.
  • Use public API keys for browser search requests.
  • Use private API keys or bearer auth for document writes, exports, and admin-safe automation.