> ## Documentation Index
> Fetch the complete documentation index at: https://nango.dev/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Algolia

## Overview

> [card] [Pre-built tooling](#pre-built-tooling)

> [card] [Pre-built integrations](#pre-built-integrations)

> [card] [Access requirements](#access-requirements)

> [card] [Setup guide](#setup-guide)

> [card] [Useful links](#useful-links)

> [card] [API gotchas](#api-gotchas)

## Pre-built tooling

> [accordion] ✅ Authorization
>
> | Tools | Status |
> | - | - |
> | Pre-built authorization (API Key) | ✅ |
> | Pre-built authorization UI | ✅ |
> | Custom authorization UI | ✅ |
> | End-user authorization guide | ✅ |
> | Expired credentials detection | ✅ |

> [accordion] ✅ Read & write data
>
> | Tools | Status |
> | - | - |
> | Pre-built integrations | ✅ |
> | API unification | ✅ |
> | 2-way sync | ✅ |
> | Webhooks from Nango on data modifications | ✅ |
> | Real-time webhooks from 3rd-party API | 🚫 (time to contribute: \<48h) |
> | Proxy requests | ✅ |

> [accordion] ✅ Observability & data quality
>
> | Tools | Status |
> | - | - |
> | HTTP request logging | ✅ |
> | End-to-end type safety | ✅ |
> | Data runtime validation | ✅ |
> | OpenTelemetry export | ✅ |
> | Slack alerts on errors | ✅ |
> | Integration status API | ✅ |

> [accordion] ✅ Customization
>
> | Tools | Status |
> | - | - |
> | Create or customize use-cases | ✅ |
> | Pre-configured pagination | 🚫 (time to contribute: \<48h) |
> | Pre-configured rate-limit handling | 🚫 (time to contribute: \<48h) |
> | Per-customer configurations | ✅ |

### Others

| Function name | Description | Type |
| - | - | - |
| `batch-objects` | Batch create, update, or delete Algolia objects. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `copy-index` | Copy an Algolia index to a new destination index. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-api-key` | Create an API key in Algolia. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-object` | Create an object in an Algolia index. Returns a generated objectID. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-rule` | Create a query rule in an Algolia index. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `create-synonym` | Create a synonym in an Algolia index. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-api-key` | Delete an API key in Algolia. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-index` | Delete an Algolia index and all its objects. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-object` | Delete an object from an Algolia index. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-rule` | Delete a query rule from an Algolia index. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `delete-synonym` | Delete a synonym from an Algolia index. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-api-key` | Retrieve a single API key from Algolia. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-index` | Retrieve metadata for a single Algolia index. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-logs` | Retrieve recent API operation logs from Algolia. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-object` | Retrieve a single object from an Algolia index. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-rule` | Retrieve a single query rule from an Algolia index. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-settings` | Retrieve Algolia index settings. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `get-synonym` | Retrieve a single synonym from an Algolia index. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-api-keys` | List API keys from Algolia. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-indices` | List indices from Algolia. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-objects` | List objects from an Algolia index using the browse endpoint. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-rules` | List query rules from an Algolia index. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `list-synonyms` | List synonyms from an Algolia index. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `move-index` | Rename an Algolia index by moving it to a new name (destructive — overwrites destination). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `partial-update-object` | Update specific attributes of an existing Algolia object without replacing the whole record. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `search-index` | Run an Algolia search query against an index. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `search-multiple-indices` | Run search queries across multiple Algolia indices in a single request. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `set-settings` | Update Algolia index settings. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-api-key` | Update an API key in Algolia. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-object` | Replace an Algolia object entirely (full overwrite by objectID). | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-rule` | Update a query rule in an Algolia index. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `update-synonym` | Update a synonym in an Algolia index. | [Tool](https://nango.dev/docs/guides/functions/tools.md) |
| `api-keys` | Sync API keys from Algolia. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `indices` | Sync indices from Algolia. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `objects` | Sync objects from an Algolia index | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `rules` | Sync query rules from an Algolia index | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |
| `synonyms` | Sync synonyms from an Algolia index. | [Sync](https://nango.dev/docs/guides/functions/syncs/sync-functions.md) |

## Access requirements

| Pre-Requisites | Status | Comment |
| - | - | - |
| Paid dev account | ❓ | |
| Paid test account | ❓ | |
| Partnership | ❓ | |
| App review | ❓ | |
| Security audit | ❓ | |

## Setup guide

*No setup guide yet.*

> [!TIP]
>
> Need help getting started? Get help in the [community](https://nango.dev/slack).

> [!NOTE]
>
> Contribute improvements to the setup guide by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/algolia.mdx)

## Useful links

* [Generate an API key in your Algolia account](https://www.algolia.com/doc/guides/security/api-keys/#create-and-manage-your-api-keys)
* [Algolia API docs](https://www.algolia.com/doc/rest-api/search)
* [Algolia Authentication](https://www.algolia.com/doc/rest-api/search/#authentication)

> [!NOTE]
>
> Contribute useful links by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/algolia.mdx)

## API gotchas

* Algolia uses API\_KEY auth mode with `X-Algolia-API-Key: API_KEY`and `X-Algolia-Application-Id: APP_ID` in the request header to access different endpoints.

> [!NOTE]
>
> Contribute API gotchas by [editing this page](https://github.com/nangohq/nango/tree/master/docs/integrations/all/algolia.mdx)

## Going further

> [card] [Connect to Algolia](https://nango.dev/docs/integrations/all/algolia/connect)
>
> Guide to connect to Algolia using Connect UI


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.