> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/algolia.md).

# Algolia

Connect to Algolia to run fast full-text search queries against your search indexes from your AI workflows.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Algolia   | API Key        |

#### Algolia

Connect to Algolia search engine to provide fast and relevant search functionality. Supports indexing, searching, and relevance tuning.

**Set up in Algolia**

1. Sign in to the Algolia dashboard and open **Settings → API keys** (Team and Access section).
2. Copy your **Application ID** and an **API key** with search permissions (the Admin API key grants full access; a Search-only key is safer if you only need to query).
3. Keep the Admin API key confidential; never expose it in client-side code.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Algolia**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field  | Required | What to enter                                                                                                                             |
| -------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Application ID | Yes      | Your Algolia Application ID from your Algolia dashboard. [Provider instructions](https://dashboard.algolia.com/account/api-keys).         |
| API Key        | Yes      | Your Algolia API Key. Use a Search API Key for read-only access. [Provider instructions](https://dashboard.algolia.com/account/api-keys). |
| Index          | Yes      | The name of the Algolia index to search.                                                                                                  |

**Provider documentation:** [Setup reference](https://www.algolia.com/doc/guides/security/api-keys/).

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Algolia** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Query Algolia

Search an Algolia index with a query string

**Inputs**

| Field | Type   | Required | Description                                                       |
| ----- | ------ | -------- | ----------------------------------------------------------------- |
| Query | string | Yes      | The search query to execute against the Algolia index. Default: . |

**Outputs**

| Field   | Type   | Description                      |
| ------- | ------ | -------------------------------- |
| Results | string | The search results from Algolia. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/algolia.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
