API Reference / API Methods

API Methods

Personalization

Add strategy setPersonalizationStrategy setPersonalizationStrategy setPersonalizationStrategy set_personalization_strategy set_personalization_strategy SetPersonalizationStrategy setPersonalizationStrategy SetPersonalizationStrategy set personalizationStrategy Add strategy Add strategy	Set a personalization strategy for your application
Get strategy getPersonalizationStrategy getPersonalizationStrategy getPersonalizationStrategy get_personalization_strategy get_personalization_strategy GetPersonalizationStrategy getPersonalizationStrategy GetPersonalizationStrategy Get strategy Get strategy get personalizationStrategy	Get the personalization strategy for your application

Search

Search index search search search search search Search Search searchAsync Search search search	Method used for querying an index.
Search for facet values searchForFacetValues searchForFacetValues searchForFacetValues search_for_facet_values search_for_facet_values SearchForFacetValues searchForFacetValues searchForFacetValues SearchForFacetValues searchForFacetValues search into facet values	Search for a set of values within a given facet attribute. Can be combined with a query.
Search multiple indices multipleQueries search multipleQueries multiple_queries multiple_queries MultipleQueries multipleQueries multipleQueriesAsync MultipleQueries multipleQueries multiQueries	Perform a search on several indices at the same time, with one method call.
Browse index browseObjects browse browseObjects browse_objects browse Browse browse browseAsync BrowseObjects browse browse index	Get all index content without any record limit. Can be used for backups.

Indexing

Add objects addObjects addObjects addObjects add_objects add_objects AddObjects addObjects addObjectsAsync AddObjects addObjects index into	Add new objects to an index.
Save objects replaceObject saveObjects saveObjects save_objects save_objects SaveObjects saveObjects saveObjectsAsync UpdateObjects saveObjects index into	Replace an existing object with an updated set of attributes.
Partial update objects partialUpdateObject partialUpdateObjects partialUpdateObjects partial_update_objects partial_update_objects PartialUpdateObjects PartialUpdateObjects partialUpdateObjectsAsync PartialUpdateObjects partialUpdateObjects partialUpdate objects	Update one or more attributes of an existing object.
Delete objects deleteObject deleteObjects deleteObjects delete_objects delete_objects DeleteObjects deleteObjects deleteObjectsAsync DeleteObjects deleteObjects delete objectIds	Remove objects from an index using their object ids.
Replace all objects replaceAllObjects Replace all objects replaceAllObjects replace_all_objects replace_all_objects ReplaceAllObjects replaceAllObjects Replace all objects ReplaceAllObjects Replace all objects Replace all objects	Clears all objects from your index and replaces them with a new set of objects.
Delete by deleteObjectBy deleteBy deleteBy delete_by delete_by DeleteBy deleteBy deleteByAsync DeleteBy deleteBy delete by	Remove all objects matching a filter (including geo filters).
Clear objects clearIndex clearIndex clearObjects clear_objects clear_index ClearObjects clear clearIndexAsync ClearObjects clearIndex clear index	Clear the records of an index without affecting its settings.
Get objects getObject getObjects getObjects get_objects get_objects GetObjects getObjects getObjectsAsync GetObjects getObjects get from "index"	Get one or more objects using their `objectID`s.
Custom batch multipleBatchObjects batch batch multiple_batch batch MultipleBatch batch batchAsync Batch batch batch	Perform several indexing operations in one API call.

Settings

Get settings getSettings getSettings getSettings get_settings get_settings GetSettings getSettings getSettingsAsync GetSettings getSettings settings	Get the settings of an index.
Set settings setSettings setSettings setSettings set_settings set_settings SetSettings setSettings setSettingsAsync SetSettings setSettings setSettings	Create or change an index’s settings.
Copy settings copySettings Copy settings copySettings copy_settings copy_settings CopySettings Copy settings Copy settings CopySettings Copy settings Copy settings	Copy the settings of an index to another index on the same app.

Manage indices

List indices listIndices listIndexes listIndices list_indices list_indexes ListIndices listIndexes listIndexesAsync ListIndices listIndexes list indexes	Get a list of indices with their associated metadata.
Delete index deleteIndex deleteIndex delete delete delete_index Delete deleteIndex deleteIndexAsync Delete deleteIndex delete index	Delete an index and all its settings, including links to its replicas.
Copy index copyIndex copyIndex copyIndex copy_index copy_index CopyIndex copyIndex copyIndexAsync CopyIndex copyIndex copy index	Make a copy of an index, including its objects, settings, synonyms, and query rules.
Move index moveIndex moveIndex moveIndex move_index move_index MoveIndex moveIndex moveIndexAsync MoveIndex moveIndex move index	Rename an index. Normally used to reindex your data atomically, without any down time.
Index exists Index exists Index exists exists Index exists Index exists Index exists Index exists Index exists Index exists Index exists Index exists	Returns whether an index exists or not.

API keys

Create secured API Key generateSecuredApiKey generateSecuredApiKey generateSecuredApiKey generate_secured_api_key generate_secured_api_key GenerateSecuredApiKey generateSecuredApiKey GenerateSecuredAPIKey Create secured API Key Create secured API Key generateSecuredApiKey	Generate a virtual API Key without any call to the server.
Add API Key addApiKey addApiKey addApiKey add_api_key add_api_key AddApiKey addApiKey AddAPIKey Add API Key Add API Key add key	Add a new API Key with specific permissions/restrictions.
Update API Key updateApiKey updateApiKey updateApiKey update_api_key update_api_key UpdateApiKey updateApiKey UpdateAPIKey Update API Key Update API Key update key	Update the permissions of an existing API Key.
Delete API Key deleteApiKey deleteApiKey deleteApiKey delete_api_key delete_api_key DeleteApiKey deleteApiKey DeleteAPIKey Delete API Key Delete API Key delete key	Delete an existing API Key.
Restore API Key restoreApiKey restoreApiKey restoreApiKey restore_api_key restore_api_key RestoreApiKey restoreApiKey RestoreAPIKey Restore API Key Restore API Key restore key	Restore a deleted API key, along with its associated rights.
Get API Key permissions getApiKey getApiKey getApiKey get_api_key get_api_key GetApiKey getApiKey GetAPIKey Get API Key permissions Get API Key permissions get key	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 listApiKeys listApiKeys listApiKeys list_api_keys list_api_keys ListApiKeys listApiKeys ListAPIKeys List API Keys List API Keys list keys	Get the full list of API Keys.

Synonyms

Save synonym saveSynonym saveSynonym saveSynonym save_synonym save_synonym saveSynonym saveSynonym SaveSynonym Save synonym Save synonym save synonym	Create or update a single synonym on an index.
Batch synonyms saveSynonyms batchSynonyms saveSynonyms save_synonyms batch_synonyms SaveSynonyms saveSyonyms SaveSynonyms Batch synonyms Batch synonyms save synonyms	Create or update multiple synonyms.
Delete synonym deleteSynonym deleteSynonym deleteSynonym delete_synonym delete_synonym DeleteSynonym deleteSynonym DeleteSynonym Delete synonym Delete synonym delete synonym	Remove a single synonym from an index using its object id.
Clear all synonyms clearSynonyms clearSynonyms clearSynonyms clear_synonyms clear_synonyms ClearSynonyms clearSynonyms ClearSynonyms Clear all synonyms Clear all synonyms clear synonyms	Remove all synonyms from an index.
Get synonym getSynonym getSynonym getSynonym get_synonym get_synonym GetSynonym getSynonym GetSynonym Get synonym Get synonym get synonym	Get a single synonym using its object id.
Search synonyms searchSynonyms searchSynonyms searchSynonyms search_synonyms search_synonyms SearchSynonyms searchSynonyms SearchSynonyms Search synonyms Search synonyms search synonyms	Get all synonyms that match a query.
Replace all synonyms replaceAllSynonyms Replace all synonyms replaceAllSynonyms replace_all_synonyms replace_all_synonyms ReplaceAllSynonyms replaceAllSynonyms Replace all synonyms ReplaceAllSynonyms Replace all synonyms Replace all synonyms	Push a new set of synonyms and erase all previous ones.
Copy synonyms copySynonyms Copy synonyms copySynonyms copy_synonyms copy_synonyms CopySynonyms Copy synonyms Copy synonyms CopySynonyms Copy synonyms Copy synonyms	Copy the synonyms of an index to another index on the same app.
Export Synonyms browseSynonyms exportSynonyms browseSynonyms index.browse_synonyms() export_synonyms BrowseSynonyms SynonymsIterable BrowseSynonyms Export Synonyms Export Synonyms exportSynonyms	Retrieve an index’s complete list of synonyms.

Query rules

Save rule saveRule saveRule saveRule save_rule save_rule SaveRule saveRule SaveRule Save rule Save rule save rule	Create or update a single rule.
Batch rules saveRules batchRules saveRules save_rules batch_rules SaveRules saveRules SaveRules Batch rules Batch rules save rules	Create or update a specified set of rules, or all rules.
Get rule getRule getRule getRule get_rule get_rule GetRule getRule GetRule Get rule Get rule get rule	Get the object/definition of a specific rule.
Delete rule deleteRule deleteRule deleteRule delete_rule delete_rule DeleteRule deleteRule DeleteRule Delete rule Delete rule delete rule	Delete a specific rule using its id.
Clear rules clearRules clearRules clearRules clear_rules clear_rules ClearRules clearRules ClearRules Clear rules Clear rules clear rules of index	Delete all rules in an index.
Search rules searchRules searchRules searchRules search_rules search_rules SearchRules searchRules SearchRules Search rules Search rules search rules	Search for rules matching various criteria.
Replace all rules replaceAllRules Replace all rules replaceAllRules replace_all_rules replace_all_rules ReplaceAllRules replaceAllRules Replace all rules ReplaceAllRules Replace all rules Replace all rules	Push a new set of rules and erase all previous ones.
Copy rules copyRules Copy rules copyRules copy_rules copy_rules CopyRules copyRules Copy rules CopyRules Copy rules Copy rules	Copy the rules of an index to another index on the same app.
Export rules browseRules exportRules browseRules index.browse_rules() export_rules BrowseRules RulesIterable BrowseRules Export rules Export rules exportRules	Retrieve an index’s full list of rules using an iterator.

A/B Test

Add A/B test addABTest addABTest addABTest add_ab_test add_ab_test AddABTest addABTest AddABTest Add A/B test Add A/B test add abTest	Create an A/B test.
Get A/B test getABTest getABTest getABTest get_ab_test get_ab_test GetABTest getABTest GetABTest Get A/B test Get A/B test get abTest	Get an A/B test information and results.
List A/B tests getABTests getABTests getABTests get_ab_tests get_ab_tests GetABTests getABTests GetABTests List A/B tests List A/B tests get all abTests	List A/B tests information and results.
Stop A/B test stopABTest stopABTest stopABTest stop_ab_test stop_ab_test StopABTest stopABTest StopABTest Stop A/B test Stop A/B test stop abTest	Stop an A/B test
Delete A/B test deleteABTest deleteABTest deleteABTest delete_ab_test delete_ab_test DeleteABTest deleteABTest DeleteABTest Delete A/B test Delete A/B test delete abTest	Delete an A/B test

Insights

Clicked Object IDs After Search clickedObjectIDsAfterSearch clickedObjectIDsAfterSearch clickedObjectIDsAfterSearch clicked_object_ids_after_search clicked_object_ids_after_search ClickedObjectIDsAfterSearch clickedObjectIDsAfterSearch ClickedObjectIDsAfterSearch clickedAfterSearch clickedAfterSearch send event ClickedObjectIDsAfterSearch	Send a click event to capture a query and its clicked items and positions.
Clicked Object IDs clickedObjectIDs clickedObjectIDs clickedObjectIDs clicked_object_ids clicked_object_ids ClickedObjectIDs clickedObjectIDs ClickedObjectIDs clicked clicked send event ClickedObjectIDs	Send a click event to capture clicked items.
Clicked Filters clickedFilters clickedFilters clickedFilters clicked_filters clicked_filters ClickedFilters clickedFilters ClickedFilters clicked clicked send event ClickedFilters	Send a click event to capture the filters a user clicks on.
Converted Objects IDs After Search convertedObjectIDsAfterSearch convertedObjectIDsAfterSearch convertedObjectIDs converted_object_ids_after_search converted_object_ids_after_search ConvertedObjectIDsAfterSearch convertedObjectIDsAfterSearch ConvertedObjectIDsAfterSearch convertedAfterSearch convertedAfterSearch send event ConvertedObjectIDsAfterSearch	Send a conversion event to capture a query and its clicked items.
Converted Object IDs convertedObjectIDs convertedObjectIDs convertedObjectIDs converted_object_ids converted_object_ids ConvertedObjectIDs convertedObjectIDs ConvertedObjectIDs converted converted send event ConvertedObjectIDs	Send a conversion event to capture clicked items.
Converted Filters convertedFilters convertedFilters convertedFilters converted_filters converted_filters ConvertedFilters convertedFilters ConvertedFilters converted converted send event ConvertedFilters	Send a conversion event to capture the filters a user uses when converting.
Viewed Object IDs viewedObjectIDs viewedObjectIDs viewedObjectIDs viewed_object_ids viewed_object_ids ViewedObjectIDs viewedObjectIDs ViewedObjectIDs viewed Viewed Object IDs send event ViewedObjectIDs	Send a view event to capture clicked items.
Viewed Filters viewedFilters viewedFilters viewedFilters viewed_filters viewed_filters ViewedFilters viewedFilters ViewedFilters viewed viewed send event ViewedFilters	Send a view event to capture the filters a user uses when viewing.

MultiClusters

Assign or Move userID assignUserID assignUserID assignUserId assign_user_ids assign_user_id AssignUserID assignUserId AssignUserID Assign or Move userID Assign or Move userID Assign or Move userID	Assign or Move a userID to a cluster.
Get top userID getTopUserID getTopUserID getTopUserId get_top_user_ids get_top_user_id GetTopUserID getTopUserId GetTopUserIDs Get top userID Get top userID Get top userID	Get the top 10 userIDs with the highest number of records per cluster.
Get userID getUserID getUserID getUserId get_user_id get_user_id GetUserID getUserId GetUserID Get userID Get userID Get userID	Returns the userID data stored in the mapping.
List clusters listClusters listClusters listClusters list_clusters list_clusters ListClusters listClusters ListClusters List clusters List clusters List clusters	List the clusters available in a multi-clusters setup for a single appID.
List userIDs listUserIDs listUserIDs listUserIDs list_user_ids list_user_ids ListUserIDs listUserIDs ListUserIDs List userIDs List userIDs List userIDs	List the userIDs assigned to a multi-clusters appID.
Remove userID removeUserID removeUserID removeUserId remove_user_id remove_user_id RemoveUserID removeUserID RemoveUserID Remove userID Remove userID Remove userID	Remove a userID and its associated data from the multi-clusters.
Search userID searchUserIDs searchUserIDs searchUserIds SearchUserIds search_user_ids search_user_ids Search userID SearchUserIds Search userID Search userID Search userID	Search for userIDs.

Advanced

Get logs getLogs getLogs getLogs get_logs get_logs GetLogs getLogs GetLogs Get logs Get logs logs	Get the logs of the latest search and indexing operations.
Configuring timeouts setTimeouts setTimeouts setTimeout timeout connect_timeout setTimeout setConnectTimeout setConnectTimeout timeout SetTimeout AlgoliaClientConfiguration	Override the pre-configured timeouts.
Set extra header setExtraHeader setExtraHeader setDefaultHeaders headers set_extra_header SetExtraHeader addExtraHeader setHeader setHeader SetExtraHeader customHeader	Sends an extra http header to Algolia, for all subsequent queries.
Wait for operations waitTask waitTask wait wait wait_task Wait waitTask WaitTask WaitTask waitTask waitFor task	Wait for a task to complete before executing the next line of code, to synchronize index updates.

Did you find this page helpful?