API Reference / API Methods


Add strategy

Set a personalization strategy.

Get strategy

Get the personalization strategy.


Get frequently bought together

Retrieve frequently bought together items for a set of objectIDs.

Get related products

Retrieve related products or related content for a set of objectIDs.

Get trending items

Retrieve global trending items. Retrieve trending items for a specific facet if ‘facetName’ and ‘facetValue’ are passed.

Get trending facets

Retrieve trending facet values for a specific facet attribute.

Get recommendations

Retrieve recommendations.

Search index

Method used for querying an index.

Search for facet values

Search for a set of values within a given facet attribute. Can be combined with a query.

Search multiple indices

Perform a search on several indices at the same time, with one method call.

Find Object

Find an object by the given condition. Can be used to debug relevance.

Get Object Position

Retrieve the given object’s position in the given results set. Can be used to debug relevance.


Save objects

Use this method to add new records (objects) to an index or replace existing records with an updated set of attributes.

Partial update objects

Update one or more attributes of an existing object.

Delete objects

Delete objects from an index using their objectID.

Replace all objects

Replaces all records from your index with a new set of records.

Delete by

Remove all objects matching a filter (including geo filters).

Clear objects

Clear the records of an index without affecting its settings.

Get objects

Get one or more objects using their objectIDs.

Custom batch

Perform several indexing operations in one API call.


Get settings

Get the settings of an index.

Set settings

Change an index’s settings.

Copy settings

Copy the settings of an index to another index on the same app.

Manage indices

List indices

Get a list of indices with their associated metadata.

Delete index

Delete an index and all its settings, including links to its replicas.

Copy index

Copy an index, including its records, Synonyms, Rules, and settings (except for enableReRanking).

Browse index

Get all records from an index.

Move index

Move or rename an index.

Index exists

Check if an index exists or not.

API keys

Create secured API key

Generate a secured API key without any call to Algolia’s servers.

Add API key

Add a new API Key with specific permissions and restrictions.

Update API key

Replace every permission of an existing API key.

Delete API key

Delete an API Key.

Restore API key

Restore a deleted API key, along with its associated rights.

Get API key permissions

Get the permissions of an API key. When initializing the client using the admin API key, you can request information for any of your application’s API keys. When using a non-admin API key, you can only retrieve information for this specific API key.

List API keys

Get a list of API keys.

Get secured API key remaining validity

Retrieve the remaining validity of a secured API key in seconds.


Save synonym

Create or update a single synonym on an index.

Save synonyms

Create or update multiple synonyms.

Delete synonym

Remove a single synonym from an index using its object id.

Clear all synonyms

Remove all synonyms from an index.

Get synonym

Get a single synonym object using its synonym ID (objectID).

Search synonyms

Get all synonyms that match a query.

Replace all synonyms

Push a new set of synonyms and erase all previous ones.

Copy synonyms

Copy the synonyms of an index to another index on the same app.

Export Synonyms

Retrieve an index’s complete list of synonyms.


Save rule

Create or update a single Rule.

Batch Rules

Create or update a specified set of Rules, or all Rules.

Get Rule

Get the object/definition of a specific Rule.

Delete Rule

Delete a specific Rule using its id.

Clear Rules

Delete all Rules in an index.

Search rules

Search for rules matching various criteria.

Replace all rules

Push a new set of rules and erase all previous ones.

Copy rules

Copy the rules of an index to another index on the same app.

Export Rules

Get a list of all Rules defined on an index.

A/B Test

Add A/B test

Create an A/B test.

Get A/B test

Get an A/B test information and results.

List A/B tests

List A/B tests information and results.

Stop A/B test

Stop an A/B test

Delete A/B test

Delete an A/B test



Initialize the Insights API client to communicate with the Algolia Insights API.

Clicked object IDs after search

Send a click event related to an Algolia request.

Clicked object IDs

Send a click event to capture clicked items.

Clicked filters

Send a click event to capture when users select filters.

Converted object IDs after search

Send a conversion event related to an Algolia request.

Converted object IDs

Send a conversion event to capture clicked items.

Converted filters

Send a conversion event to capture the filters a user selected when converting.

Viewed object IDs

Send a view event to capture viewed items.

Viewed filters

Send a view event to capture the active filters for items a user viewed.

Send events

Send a list of events in a single request.

Set User Token

Set the user token for all subsequent events sent to the Algolia Insights API.

Get User Token

Get the user token from the Insights API Client state.


Save dictionary entries

Send a batch of entries to a dictionary.

Replace dictionary entries

Replace a batch of dictionary entries.

Delete dictionary entries

Delete a batch of dictionary entries.

Clear dictionary entries

Remove all words from a custom dictionary.

Search dictionary entries

Search for entries in a dictionary.

Set dictionary settings

Enable or disable the use of standard dictionary entries

Get dictionary settings

Retrieve the dictionary override settings for plurals, stop words, and compound words.


Assign or Move userID

Assign or Move a userID to a cluster.

Get top userID

Get the top 10 userIDs with the highest number of records per cluster.

Get userID

Returns the userID data stored in the mapping.

List clusters

List the clusters available in a multi-clusters setup for a single appID.

List userIDs

List the userIDs assigned to a multi-clusters appID.

Remove userID

Remove a userID and its associated data from the multi-clusters.

Search userID

Search for userIDs.

Batch assign userIDs

Assign multiple userIDs to a cluster.

Has pending mappings

Get the status of your clusters’ migrations or user creations.


Get logs

Get the logs of the latest search and indexing operations.

Configuring timeouts

Change the pre-configured timeouts.

Set extra header

Send an extra HTTP header to Algolia for use with later queries.

Wait for operations

Wait for a task to complete to ensure synchronized index updates.

Custom request

Perform a custom request

Did you find this page helpful?