/algolia-search

name: algolia-search
description: |
  Algolia Search integration. Manage Indexs, Records, Rules, Tasks, Clusters, Users. Use when the user wants to interact with Algolia Search data.
compatibility: Requires network access and a valid Membrane account (Free tier supported).
license: MIT
homepage: https://getmembrane.com
repository: https://github.com/membranedev/application-skills
metadata:
  author: membrane
  version: "1.0"
  categories: ""

Algolia Search

Algolia Search is a hosted search engine that provides website and mobile app developers with the tools to build fast and relevant search experiences. It's used by companies of all sizes looking to improve their site search functionality.

Official docs: https://www.algolia.com/doc/

Algolia Search Overview

• **Index**
• **Record**
• **API Key**

Working with Algolia Search

This skill uses the Membrane CLI to interact with Algolia Search. Membrane handles authentication and credentials refresh automatically — so you can focus on the integration logic rather than auth plumbing.

Install the CLI

Install the Membrane CLI so you can run `membrane` from the terminal:

npm install -g @membranehq/cli@latest

Authentication

membrane login --tenant --clientName=<agentType>

This will either open a browser for authentication or print an authorization URL to the console, depending on whether interactive mode is available.

**Headless environments:** The command will print an authorization URL. Ask the user to open it in a browser. When they see a code after completing login, finish with:

membrane login complete <code>

Add `--json` to any command for machine-readable JSON output.

**Agent Types** : claude, openclaw, codex, warp, windsurf, etc. Those will be used to adjust tooling to be used best with your harness

Connecting to Algolia Search

Use `membrane connection ensure` to find or create a connection by app URL or domain:

membrane connection ensure "https://www.algolia.com/" --json

The user completes authentication in the browser. The output contains the new connection id.

This is the fastest way to get a connection. The URL is normalized to a domain and matched against known apps. If no app is found, one is created and a connector is built automatically.

If the returned connection has `state: "READY"`, skip to **Step 2**.

1b. Wait for the connection to be ready

If the connection is in `BUILDING` state, poll until it's ready:

npx @membranehq/cli connection get <id> --wait --json

The `--wait` flag long-polls (up to `--timeout` seconds, default 30) until the state changes. Keep polling until `state` is no longer `BUILDING`.

The resulting state tells you what to do next:

• **`READY`** — connection is fully set up. Skip to **Step 2**.
• **`CLIENT_ACTION_REQUIRED`** — the user or agent needs to do something. The `clientAction` object describes the required action:
• `clientAction.type` — the kind of action needed:
• `"connect"` — user needs to authenticate (OAuth, API key, etc.). This covers initial authentication and re-authentication for disconnected connections.
• `"provide-input"` — more information is needed (e.g. which app to connect to).
• `clientAction.description` — human-readable explanation of what's needed.
• `clientAction.uiUrl` (optional) — URL to a pre-built UI where the user can complete the action. Show this to the user when present.
• `clientAction.agentInstructions` (optional) — instructions for the AI agent on how to proceed programmatically.

After the user completes the action (e.g. authenticates in the browser), poll again with `membrane connection get <id> --json` to check if the state moved to `READY`.

• **`CONFIGURATION_ERROR`** or **`SETUP_FAILED`** — something went wrong. Check the `error` field for details.

Searching for actions

Search using a natural language description of what you want to do:

membrane action list --connectionId=CONNECTION_ID --intent "QUERY" --limit 10 --json

You should always search for actions in the context of a specific connection.

Each result includes `id`, `name`, `description`, `inputSchema` (what parameters the action accepts), and `outputSchema` (what it returns).

Popular actions

| Name | Key | Description | | --- | --- | --- | | Delete Index | delete-index | Delete an entire index and all its settings. | | Delete Record | delete-record | Delete a specific record from an index by its object ID | | Update Record Attributes | update-record-attributes | Partially update a record by adding new attributes or modifying existing ones without replacing the entire record | | Retrieve Record | retrieve-record | Retrieve a specific record from an index by its object ID | | Add or Replace Record | add-or-replace-record | Add a record with a specific object ID, or replace an existing record with the same ID | | Add Record | add-record | Add a new record to an index with an auto-generated object ID. | | List Indices | list-indices | List all indices in the Algolia application | | Search Index | search-index | Search for records in an Algolia index using a query string and optional filters |

Running actions

membrane action run <actionId> --connectionId=CONNECTION_ID --json

To pass JSON parameters:

membrane action run <actionId> --connectionId=CONNECTION_ID --input '{"key": "value"}' --json

The result is in the `output` field of the response.

Proxy requests

When the available actions don't cover your use case, you can send requests directly to the Algolia Search API through Membrane's proxy. Membrane automatically appends the base URL to the path you provide and injects the correct authentication headers — including transparent credential refresh if they expire.

membrane request CONNECTION_ID /path/to/endpoint

Common options:

| Flag | Description | |------|-------------| | `-X, --method` | HTTP me