Algolia Search

The Algolia Search API lets you search, configure, and manage your indices and records.

Client libraries

Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps. The official API clients are covered by Algolia's Service Level Agreement.

See: Algolia's ecosystem

Base URLs

The base URLs for requests to the Search API are:

https://{APPLICATION_ID}.algolia.net
https://{APPLICATION_ID}-dsn.algolia.net. If your subscription includes a Distributed Search Network, this ensures that requests are sent to servers closest to users.

Both URLs provide high availability by distributing requests with load balancing.

All requests must use HTTPS.

Retry strategy

To guarantee high availability, implement a retry strategy for all API requests using the URLs of your servers as fallbacks:

https://{APPLICATION_ID}-1.algolianet.com
https://{APPLICATION_ID}-2.algolianet.com
https://{APPLICATION_ID}-3.algolianet.com

These URLs use a different DNS provider than the primary URLs. You should randomize this list to ensure an even load across the three servers.

All Algolia API clients implement this retry strategy.

Authentication

To authenticate your API requests, add these headers:

x-algolia-application-id. Your Algolia application ID.
x-algolia-api-key. An API key with the necessary permissions to make the request. The required access control list (ACL) to make a request is listed in each endpoint's reference.

You can find your application ID and API key in the Algolia dashboard.

Request format

Depending on the endpoint, request bodies are either JSON objects or arrays of JSON objects,

Parameters

Parameters are passed as query parameters for GET and DELETE requests, and in the request body for POST and PUT requests.

Query parameters must be URL-encoded. Non-ASCII characters must be UTF-8 encoded. Plus characters (+) are interpreted as spaces. Arrays as query parameters must be one of:

A comma-separated string: attributesToRetrieve=title,description
A URL-encoded JSON array: attributesToRetrieve=%5B%22title%22,%22description%22%D

Response status and errors

The Search API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response.

Successful responses return a 2xx status. Client errors return a 4xx status. Server errors are indicated by a 5xx status. Error responses have a message property with more information.

Version

The current version of the Search API is version 1, as indicated by the /1/ in each endpoint's URL.

Operations

Add or delete dictionary entries

Search dictionary entries

List available languages

Retrieve dictionary settings

Update dictionary settings

Batch indexing operations on multiple indices

List indices

Batch indexing operations on one index

Browse for records

Delete all records from an index

Delete an index

Delete records matching a filter

Search for facet values

Delete a record

Retrieve a record

Add or update attributes

Add or replace a record

Copy or move an index

Add a new record (with auto-generated object ID)

Search an index

Create or update rules

Delete all rules

Delete a rule

Retrieve a rule

Create or replace a rule

Search for rules

Retrieve index settings

Update index settings

Create or replace synonyms

Delete all synonyms

Delete a synonym

Retrieve a synonym

Create or replace a synonym

Search for synonyms

Check task status

Retrieve records

Search multiple indices

List API keys

Delete an API key

Retrieve API key permissions

Update an API key

Restore an API key

Create an API key

Retrieve log entries

Add a source

List allowed sources

Replace allowed sources

Delete a source

Check application task status

Copies the given sourceIndexName records, rules and synonyms to an other Algolia application for the given destinationIndexName

Get all records from an index

Replace all records in an index

Deletes every records for the given objectIDs

Create secured API keys

Check if an index exists or not

Replaces object content of all the given objects according to their respective objectID field

Save objects to an Algolia index by leveraging the Transformation pipeline setup using the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push)

Send requests to the Algolia REST API

Replace all records in an index

Saves the given array of objects in the given index

Switch the API key used to authenticate requests

Wait for an API key operation

Wait for application-level operation to complete

Wait for operation to complete