API Reference / API Methods

API Methods


Add strategy

Set a personalization strategy.

Get strategy

Get the personalization strategy.

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.


Add objects

Add new objects to an index.

Save objects

Replace an existing object with an updated set of attributes.

Partial update objects

Update one or more attributes of an existing object.

Delete objects

Remove objects from an index using their object ids.

Replace all objects

Clears all objects from your index and replaces them with a new set of objects.

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

Create or 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

Make a copy of an index, including its records, settings, Synonyms, and Rules.

Browse index

Get all index content without any record limit. Can be used for backups.

Move index

Rename an index. Normally used to reindex your data atomically, without any down time.

Index exists

Returns whether an index exists or not.

API keys

Create secured API Key

Generate a secured API key without any call to our servers.

Add API Key

Add a new API Key with specific permissions/restrictions.

Update API Key

Replace the permissions of an existing API Key.

Delete API Key

Delete an existing 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 on any of your application’s API keys. When using a non-admin API key, you can only retrieve information on this specific API key.

List API Keys

Get the full 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.

Batch 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 using its object id.

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

Retrieve an index’s full list of Rules using an iterator.

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


Clicked Object IDs After Search

Send a click event to capture a query and its clicked items and positions.

Clicked Object IDs

Send a click event to capture clicked items.

Clicked Filters

Send a click event to capture the filters a user clicks on.

Converted Objects IDs After Search

Send a conversion event to capture a query and its clicked items.

Converted Object IDs

Send a conversion event to capture clicked items.

Converted Filters

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

Viewed Object IDs

Send a view event to capture clicked items.

Viewed Filters

Send a view event to capture the filters a user uses when viewing.


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

Override the pre-configured timeouts.

Set extra header

Sends an extra http header to Algolia, for all subsequent queries.

Wait for operations

Wait for a task to complete before executing the next line of code, to synchronize index updates.

Did you find this page helpful?