* Retrieve a source by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param get

* Retrieves all allowed IP addresses with access to your application. * * Required API Key ACLs: * - admin * @param requestOption

* Retrieves the time when the Analytics data for the specified index was last updated. If the index has been recently created or no search has been p

* Retrieves the status of all Algolia clusters and instances. * @param requestOptions - The requestOptions to send along with the query, they wil

* Retrieves a synonym by its ID. To find the object IDs for your synonyms, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/se

* Checks the status of a given task. Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is created on a queu

* Checks the status of a given task. * * Required API Key ACLs: * - editSettings * - settings * - addObject * - dele

* Retrieves a task by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param getT

* Retrieves a task by its ID using the v1 endpoint. Use `getTask` instead. * * Required API Key ACLs: * - addObject * - deleteIn

* Retrieves timeseries for an A/B test by its ID. * * Required API Key ACLs: * - analytics * @param getTimeseries - The getTimese

* Retrieves the countries with the most searches in your index. * * Required API Key ACLs: * - analytics * @param getTopCountries

* Retrieves the 1,000 most frequently used filter attributes. These are attributes of your records that you included in the `attributesForFaceting` s

* Retrieves the 1,000 most frequent filter (facet) values for a filter attribute. These are attributes of your records that you included in the `attr

* Retrieves the 1,000 most frequently used filters for a search that didn\'t return any results. To get the most frequent searches without results, u

* Retrieves the object IDs of the 1,000 most frequent search results. If you set the `clickAnalytics` query parameter to `true`, the response also in

* Returns the most popular searches. For each search, it also includes the average number of hits. If you set the `clickAnalytics` query parameter to

* Get the IDs of the 10 users with the highest number of records per cluster. Since it can take a few seconds to get the data from the different clus

* Retrieves a transformation by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @

* Retrieves a user profile. * * Required API Key ACLs: * - search * - browse * - recommendation * @param getUser - Th

* Retrieves all memories, conversations and their messages for the given user token. * * Required API Key ACLs: * - logs * @param

* Returns the user ID data stored in the mapping. Since it can take a few seconds to get the data from the different clusters, the response isn\'t re

* Retrieves a user profile and their affinities for different facets. * * Required API Key ACLs: * - recommendation * @param getU

* Retrieves a list of user profiles in [lexicographical order](https://www.educative.io/answers/what-is-a-lexicographic-order). * * Required

* Retrieves the number of unique users within a time range, including a daily breakdown. Since it returns the number of unique users, the sum of the

* To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this ope

* Invalidate cached completions for this agent. Filter with `before` (exclusive). * * Required API Key ACLs: * - editSettings * @

* Lists all A/B tests you configured for this application. * * Required API Key ACLs: * - analytics * @param listABTests - The li

* Lists all A/B tests you configured for this application. * * Required API Key ACLs: * - analytics * @param listABTests - The li

* List all allowed domain patterns for this agent. * * Required API Key ACLs: * - settings * @param listAgentAllowedDomains - The

* Retrieves the conversations for the given agent ID. * * Required API Key ACLs: * - logs * @param listAgentConversations - The l

* List all agents with pagination and filtering. * * Required API Key ACLs: * - settings * @param listAgents - The listAgents obj

* Lists all API keys associated with your Algolia application, including their permissions and restrictions. * * Required API Key ACLs:

* Retrieves a list of all authentication resources. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSetti

* Lists the available clusters in a multi-cluster setup. * * Required API Key ACLs: * - admin * * @deprecated * @param

* Lists all compositions in the current Algolia application. * * Required API Key ACLs: * - editSettings * - settings * @pa

* Retrieves a list of destinations. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @para

* Retrieves a list of events for a task run, identified by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex

* Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request. *

* Get Provider Models. * * Required API Key ACLs: * - settings * @param requestOptions - The requestOptions to send along with th

* Get available models for a specific provider. * * Required API Key ACLs: * - settings * @param listProviderModels - The listPro

* List Providers. * * Required API Key ACLs: * - settings * @param listProviders - The listProviders object. * @param listPr

* Retrieve a list of task runs. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param li

* List Secret Keys. * * Required API Key ACLs: * - settings * @param listSecretKeys - The listSecretKeys object. * @param li

* Retrieves a list of sources. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param lis

* Retrieves a list of tasks. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param listT

* Retrieves a list of tasks using the v1 endpoint. Use `getTasks` instead. * * Required API Key ACLs: * - addObject * - deleteIn

* Retrieves a list of transformations. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @p

* Lists the userIDs assigned to a multi-cluster application. Since it can take a few seconds to get the data from the different clusters, the respons

* Adds, updates, or deletes records in multiple indices with a single API request. - Actions are applied in the order they are specified. - Actions a

* Adds, updates, or deletes compositions with a single API request. * * Required API Key ACLs: * - editSettings * @param batchPar

* Copies or moves (renames) an index within the same Algolia application. Notes: - Existing destination indices are overwritten, except for their ana

* Adds new attributes to a record, or updates existing ones. - If a record with the specified object ID doesn\'t exist, a new record is added to th

* Helper: Replaces object content of all the given objects according to their respective `objectID` field. The `chunkedBatch` helper is used under the

* Publish the specified agent. * * Required API Key ACLs: * - editSettings * @param publishAgent - The publishAgent object.

* Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous ca

* Sends a list of events to the Insights API. You can include up to 1,000 events in a single request, but the request body must be smaller than 2&nbs

* Pushes records through the pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous ca

* Update and insert a composition in the current Algolia application. * * Required API Key ACLs: * - editSettings * @param putCom

* If a composition rule with the provided ID already exists, it\'s replaced. Otherwise, a new one is added. * * Required API Key ACLs:

* Updates the configuration. The configuration is a list of configuration objects for each index. To configure Advanced Personalization for an index,

* Deletes a user ID and its associated data from the clusters. * * Required API Key ACLs: * - admin * * @deprecated * @

* Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order