Algolia

Algolia is a powerful search-as-a-service platform that provides fast, relevant search experiences for applications. The Algolia connector enables you to interact with Algolia's Search API and Index operations, allowing you to retrieve search results, manage indices, and perform search queries programmatically.

Power end-to-end data operations for your Algolia API with Nexla. Our bi-directional Algolia connector is purpose-built for Algolia, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Algolia or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Algolia workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating an Algolia credential, you'll need to obtain API credentials from your Algolia dashboard. The Algolia API uses header-based authentication with an Application ID and API Key.

To obtain the required API credentials for Algolia:

1. Sign in to Algolia Dashboard: Navigate to https://www.algolia.com/ and sign in to your Algolia account. If you don't have an account, you can create one by clicking Sign up and following the registration process.

2. Access API Keys: Once signed in, navigate to your Algolia dashboard. Click on Settings in the left sidebar, then select API Keys from the settings menu. Your Application ID and API keys are displayed in this section.

3. Locate Application ID: Your Application ID is displayed at the top of the API Keys page. This is a unique identifier for your Algolia application and is required for all API requests. The Application ID is used in the X-Algolia-Application-Id header for API authentication.

4. Obtain API Key: Algolia provides different types of API keys for different purposes:

   • Search-Only API Key: Use this key for read-only operations such as searching indices. This key has limited permissions and is safer for client-side applications.
   • Admin API Key: Use this key for operations that require full access, including creating indices, updating settings, and managing data. This key has full permissions and should be kept secure.

For Nexla data sources, you'll typically need the Admin API Key to perform operations like listing indices and searching. The Admin API Key provides the necessary permissions for data ingestion operations. The API key is used in the X-Algolia-API-Key header for API authentication.

5. Copy Credentials: Copy both your Application ID and your Admin API Key. Store these securely, as you'll need them when creating the credential in Nexla.

For complete information about Algolia API authentication and managing API keys, see the Algolia Search API Documentation.

Algolia API access requires:

• Valid Algolia Account: You must have an active Algolia account with at least one application created
• Application ID: A unique identifier for your Algolia application (used in the X-Algolia-Application-Id header)
• Admin API Key: An API key with appropriate permissions for the operations you need to perform (used in the X-Algolia-API-Key header)

The Algolia API uses header-based authentication with these two headers on every request. The base URLs for API requests are https://{APPLICATION_ID}.algolia.net or https://{APPLICATION_ID}-dsn.algolia.net for high availability.

Authenticate

Credentials required

Use Algolia Application ID and API Key via headers.

Field	Required	Secret	Description
API Key	Yes	Yes	Your Algolia API Key
Application ID	Yes	No	Your Algolia Application ID

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Algolia

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your Algolia Application ID in the Application ID field. This unique identifier authenticates your application with the Algolia API. You can find this value in your Algolia dashboard under Settings > API Keys.

4. Enter your Algolia Admin API Key in the API Key field. This confidential key is used to securely authenticate your application during API requests. The Admin API Key provides full access to your Algolia application, including the ability to list indices and perform search operations.

   The API Key is sensitive information that should be kept secure. Nexla will store this credential securely and use it only for API authentication purposes. For production environments, consider using the Admin API Key only when necessary, and use Search-Only API Keys for read-only operations when possible.

5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Algolia connector tile, then select the credential that will be used to connect to the Algolia instance, and click Next; or, create a new Algolia credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Algolia endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

List Indices

This endpoint retrieves a list of all indices in your Algolia application. Use this endpoint when you need to discover available indices, monitor index metadata, or build dynamic workflows that operate on multiple indices.

• This endpoint automatically retrieves all indices in your Algolia application. No additional configuration is required beyond selecting this endpoint template.
• Enter a schedule in the Schedule field to specify when this data source should run. The schedule uses cron expression format (e.g., 0 6 * * * for daily at 6 AM). The default schedule is 0 6 * * * (daily at 6 AM).
• The endpoint returns index metadata including index names, creation dates, number of records, and other index configuration details.

This endpoint is useful for discovering available indices before configuring more specific search endpoints. The returned data includes index names that can be used as input for other Algolia endpoints. The endpoint uses the GET method to retrieve all indices in your application. For complete information about listing indices, see the Algolia List Indices API Documentation.

Search Records in Index

This endpoint performs a search query on a specific Algolia index and returns matching records. Use this endpoint when you need to retrieve search results, extract indexed data, or sync search results to other systems.

• Enter a schedule in the Schedule field to specify when this data source should run. The schedule uses cron expression format (e.g., 0 7 * * * for daily at 7 AM). The default schedule is 0 7 * * * (daily at 7 AM).
• Enter the name of the index to search in the Index Name field. This should match the exact name of an index in your Algolia application. You can find available index names by using the "List Indices" endpoint first.
• Optionally, enter a search query in the Search Query field to filter the results. If left empty, the endpoint will return all records in the index (up to the API limits). The search query uses Algolia's search syntax and supports features like filtering, faceting, and typo tolerance.

The search query parameter is optional. When left empty, the endpoint returns all records in the specified index (up to API limits). For complex search queries, you can use Algolia's advanced search syntax including filters, facets, and ranking parameters. The endpoint uses POST method to /1/indexes/{indexName}/query with the query in the request body. For complete information about Algolia search queries and parameters, see the Algolia Search API Documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Algolia data sources can also be manually configured to ingest data from any valid Algolia API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request headers and parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Algolia API URLs typically follow the format: https://{ApplicationID}-dsn.algolia.net/1/indexes/{IndexName}/query for search operations, or https://{ApplicationID}-dsn.algolia.net/1/indexes for listing indices. You can also use https://{ApplicationID}.algolia.net as the base URL. Replace {ApplicationID} with your Algolia Application ID from your credentials. Algolia provides multiple DNS endpoints for high availability.

You do not need to include authentication headers (X-Algolia-Application-Id and X-Algolia-API-Key) as these are automatically included from your credentials. The Content-Type header should be set to application/json for most Algolia API requests.

For Algolia search responses, the response data path is typically $.hits[*] to extract individual search results from the hits array; for list indices responses, use $.items[*] to extract individual index objects from the items array. For complete information about Algolia API endpoints, base URLs, and response formats, see the Algolia Search API Documentation.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Algolia data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.