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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary

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.

Untrusted display-only summary

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.

Untrusted display-only summary

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

Untrusted display-only summary