Algolia

Tool to create an A/B test comparing search performance between two index variants. Use when you need to test different search configurations, ranking strategies, or index settings and measure their impact on user behavior.

Tool to add or replace a specific record in an index by objectID. If a record with the given objectID exists, it is replaced; otherwise, a new record is created. Use when you need to upsert an object with a known ID.

Tool to add a record to an index with auto-generated objectID. Records with matching IDs are replaced. Use when you need to insert a new object into an index.

Tool to retrieve all records from an index. Use when you need to export or iterate through an entire index dataset.

Tool to clear records of an index without affecting settings. Use when you need to completely wipe all objects (e.g., after a bulk reindex) while preserving index configuration.

Tool to delete all rules in an index. Use when you need to wipe all rules before re-creating them. Use after confirming no critical rules require retention.

Tool to delete all synonyms from an index. Use when you need to remove all synonym definitions in one operation.

Tool to send a click event to Algolia to capture clicked items. Use immediately after a user click outside of search contexts to report click events.

Tool to send a click event after a search response. Use when you want to report which items a user clicked in search results.

Tool to compute a user's real-time personalization profile in Algolia. Use when you need to trigger calculation of personalization data for a specific user. Note: This endpoint is deprecated.

Tool to send a conversion event for items outside of search context. Use when tracking conversions on category pages or external flows unrelated to Algolia search.

Tool to copy the specified index to a new index. Use when you need to duplicate an existing index including records, settings, synonyms, and rules after confirming source and destination names.

Tool to create a new API key with specific permissions and restrictions. Use when you need to generate API keys with custom ACL permissions, index restrictions, rate limits, or expiration times.

Tool to create a new authentication resource in Algolia. Use when you need to set up authentication credentials for connecting to sources or destinations in the Algolia ingestion API.

Tool to create a new destination in Algolia Ingestion API. Use when you need to set up a new destination for data ingestion.

Tool to create a new ingestion task connecting a source to a destination in Algolia. Use when you need to set up data synchronization between a source and an Algolia index.

Tool to create or update a batch of Recommend Rules in an index. Use when you need to add or modify multiple rules at once for a recommendation model. Each rule is created or updated depending on whether a rule with the same objectID already exists.

Tool to create a new Query Suggestions configuration for an Algolia index. Use when you need to set up query suggestions to help users discover popular searches. Up to 100 configurations per application are supported.

Tool to create a new data source in Algolia Ingestion API. Use when you need to set up a new source for data ingestion from external platforms or custom data feeds.

Tool to create a new transformation in Algolia Ingestion API. Use when you need to set up data transformations for enriching or modifying records during ingestion.

Tool to delete an A/B test by its unique identifier. Use when you need to permanently remove an A/B test configuration.

Tool to delete an API key. Use when you need to revoke or remove an existing API key from your Algolia application.

Tool to delete an authentication resource from Algolia. Use when you need to remove an existing authentication resource by its ID.

Tool to delete a Query Suggestions configuration for the specified index. Use when you need to remove a Query Suggestions configuration permanently.

Tool to delete a destination in Algolia Ingestion API. Use when you need to permanently remove a destination by its ID.

Tool to delete the specified index and all its records. Use when you need to permanently remove an index after confirming it's no longer needed.

Tool to delete multiple records from an Algolia index. Use when you need to remove multiple objects by their IDs.

Tool to delete a Recommend rule from a recommendation scenario. Use when you need to remove a specific rule from an index's recommend model.

Tool to delete records matching a filter from an Algolia index. Use when you need to remove multiple records based on filter criteria (e.g., category, tags, numeric ranges). This is a resource-intensive operation.

Tool to delete the specified rule from an index. Use when you need to permanently remove a rule after confirming its objectID.

Tool to delete a source from the Algolia Ingestion API. Use when you need to permanently remove a source after confirming it's no longer needed.

Tool to delete a synonym from a specified index. Use when you need to remove an existing synonym by its objectID.

Tool to delete a transformation in Algolia Ingestion API. Use when you need to permanently remove a transformation by its ID.

Tool to delete a user profile from personalization. Use when you need to remove a user's personalization data and reset their profile.

Tool to delete all events related to a user token from events metrics and analytics. Use when removing user data from Algolia Insights.

Tool to disable a task V1 in Algolia Ingestion API. Use when you need to disable a specific task. Note: This API is deprecated but still functional.

Tool to enable a task V1 in Algolia Ingestion API. Use when you need to activate a previously disabled task. Note: This API is deprecated but still functional.

Tool to perform batch operations (add, update, delete) across multiple Algolia indices in a single request. Use when you need to modify records in different indices efficiently. Each operation specifies its target index and action type.

Tool to export all rules defined on an index. Use when you need to backup or migrate index rules.

Tool to find the first object matching a query or filter in an index. Use when debugging relevance or filter logic after confirming index exists.

Tool to retrieve detailed information about an A/B test by its ID. Use when you need to check A/B test status, performance metrics, or configuration details.

Tool to retrieve add-to-cart rate metrics for e-commerce search analytics. Use when you need to analyze conversion effectiveness and user purchasing behavior for an index, including daily breakdowns.

Tool to retrieve the permissions and details of a specific API key. Use when you need to inspect an API key's ACL, restrictions, or other settings.

Tool to check the status of an application task. Use when you need to verify if a task has completed.

Tool to retrieve an authentication resource by its ID. Use when you need to fetch details about a specific authentication configuration in Algolia's ingestion API.

Tool to retrieve average click position metrics from Algolia Analytics. Use when analyzing user engagement and click behavior for search results.

Tool to retrieve the distribution of clicks by position from Algolia Analytics. Use when analyzing which search result positions receive the most user engagement.

Tool to retrieve click-through rate (CTR) for searches with at least one click event. Use when you need to analyze search effectiveness and user engagement metrics for an index, including daily breakdowns.

Tool to retrieve a Query Suggestions configuration by index name. Use when you need to inspect or verify Query Suggestions settings for a specific index.

Tool to retrieve the advanced personalization configuration. Use when you need to check personalization settings, re-ranking impact levels, or profile types for your Algolia application.

Tool to retrieve conversion rate for searches with conversion events. Use when you need to analyze conversion effectiveness and user behavior metrics for an index, including daily breakdowns.

Tool to retrieve a destination by its ID. Use when you need to get details about a specific Algolia destination resource.

Tool to list available languages for dictionary entries. Use when you need to check which languages support custom dictionary entries (plurals, stopwords, compounds).

Tool to retrieve dictionary settings for all dictionaries. Use when you need to check which standard dictionary entries are disabled across different languages.

Tool to retrieve log entries for API requests made to your Algolia application. Use when you need to debug issues, monitor API usage, or analyze search patterns.

Tool to retrieve the rate of searches that received no clicks. Use when you need to analyze search effectiveness and identify queries where users didn't engage with any results.

Tool to retrieve the fraction of searches that didn't return any results. Use when you need to analyze search effectiveness and identify queries that fail to return results.

Tool to retrieve the most frequent searches that produced zero results. Use when analyzing search gaps or identifying content opportunities to improve search experience.

Tool to retrieve an object’s position in a result set. Use when debugging relevance after performing a search query.

Tool to retrieve multiple records from an index. Use when you need to batch-fetch several objectIDs in one call.