Algolia

{/* Generated by scripts/generate-integration-catalog.mjs. Do not edit by hand. */}

At a glance

  • Availability: Experimental (how to enable).
  • Authentication: API key.
  • Connection: The key from ALGOLIA_API_KEY is sent as the X-Algolia-API-Key header.
  • Provider documentation: Authentication reference.

Credentials

Set these per environment. See Connect an integration.

VariableRequiredDescription
ALGOLIA_API_KEYYesAlgolia API key (use the Search API key for read-only access, or a scoped key with addObject for writes) Docs.
ALGOLIA_APP_IDYesAlgolia application ID (10-character uppercase ID shown next to your API keys); read requests go to <application-id>-dsn.algolia.net and writes go to <application-id>.algolia.net Docs.

Setup

  1. Create an Algolia application: Sign up at https://dashboard.algolia.com (the free Build plan works for testing) and create or select an application.
  2. Copy your credentials: In Settings > API Keys (https://dashboard.algolia.com/account/api-keys/all), copy the Application ID into ALGOLIA_APP_ID and an API key into ALGOLIA_API_KEY. Use the Search API key for read-only use, or create a scoped key with search, browse, and addObject ACLs for writes. Avoid the Admin API key.
  3. Note your host: Read tools query <ALGOLIA_APP_ID>-dsn.algolia.net and Save Objects writes to <ALGOLIA_APP_ID>.algolia.net. Both hosts derive from the ALGOLIA_APP_ID environment variable, so no host input is needed on tool calls.
  4. Verify access: Run the List Indices tool. A 403 usually means the API key lacks the required ACL or the host does not match your application ID.

Provider notes

  • Algolia authenticates with two headers: X-Algolia-API-Key and X-Algolia-Application-Id, so both env vars are required
  • Browse requires an API key with the 'browse' ACL; Save Objects requires 'addObject'
  • The Search API key is safe to expose in frontends, but scoped/write keys must stay server-side

Provider API reference.

Tools

ToolAccessDescription
List Indices<br /><code className="reference-identifier">algolia__list_indices</code>ReadList indices
Search Index<br /><code className="reference-identifier">algolia__search_index</code>ReadSearch index
Browse Index<br /><code className="reference-identifier">algolia__browse_index</code>ReadBrowse index
Get Object<br /><code className="reference-identifier">algolia__get_object</code>ReadGet object
Save Objects<br /><code className="reference-identifier">algolia__save_objects</code>WriteSave objects

Verify the connection

Call a read tool such as algolia__list_indices with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.