Team
Shared credential for production and unattended runs.
Connect Algolia with Hookshot™ and your stack
Algolia is a hosted search API that provides developers with tools to build fast and relevant search experiences for their applications.
Tools and triggers
What Agents can do in Algolia
Available tools and events after Algolia is connected.
-
Add AB Test
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…
-
Add or Replace Record
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.
-
Add Record to Index
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.
-
Batch Operations on Multiple Indices
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…
-
Browse Algolia Index
Tool to retrieve all records from an index. Use when you need to export or iterate through an entire index dataset.
-
Clear Objects
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.
-
Clear Rules
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.
-
Clear Synonyms
Tool to delete all synonyms from an index. Use when you need to remove all synonym definitions in one operation.
-
Clicked Object IDs
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.
-
Clicked Object IDs After Search
Tool to send a click event after a search response. Use when you want to report which items a user clicked in search results.
-
Converted Object IDs
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.
-
Copy Index
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.
-
Create API Key
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.
-
Create Authentication
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.
-
Create Destination
Tool to create a new destination in Algolia Ingestion API. Use when you need to set up a new destination for data ingestion.
-
Create Ingestion Task
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.
-
Create or Update Recommend Rules
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…
-
Create Query Suggestions Config
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.
-
Create Source
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.
-
Create Transformation
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.
-
Delete AB Test
Tool to delete an A/B test by its unique identifier. Use when you need to permanently remove an A/B test configuration.
-
Delete API Key
Tool to delete an API key. Use when you need to revoke or remove an existing API key from your Algolia application.
-
Delete Authentication
Tool to delete an authentication resource from Algolia. Use when you need to remove an existing authentication resource by its ID.
-
Delete Destination
Tool to delete a destination in Algolia Ingestion API. Use when you need to permanently remove a destination by its ID.
-
Delete Index
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.
-
Delete Multiple Records
Tool to delete multiple records from an Algolia index. Use when you need to remove multiple objects by their IDs.
-
Delete Query Suggestions Config
Tool to delete a Query Suggestions configuration for the specified index. Use when you need to remove a Query Suggestions configuration permanently.
-
Delete Recommend Rule
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.
-
Delete Records by Filter
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.
-
Delete Rule
Tool to delete the specified rule from an index. Use when you need to permanently remove a rule after confirming its objectID.
-
Delete Source
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.
-
Delete Synonym
Tool to delete a synonym from a specified index. Use when you need to remove an existing synonym by its objectID.
-
Delete Transformation
Tool to delete a transformation in Algolia Ingestion API. Use when you need to permanently remove a transformation by its ID.
-
Delete User Profile
Tool to delete a user profile from personalization. Use when you need to remove a user's personalization data and reset their profile.
-
Delete User Token
Tool to delete all events related to a user token from events metrics and analytics. Use when removing user data from Algolia Insights.
-
Export Rules
Tool to export all rules defined on an index. Use when you need to backup or migrate index rules.
-
Find Object
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.
-
Get A/B Test
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.
-
Get Add to Cart Rate
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.
-
Get API Key
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.
-
Get App Task Status
Tool to check the status of an application task. Use when you need to verify if a task has completed.
-
Get Authentication
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.
-
Get Average Click Position
Tool to retrieve average click position metrics from Algolia Analytics. Use when analyzing user engagement and click behavior for search results.
-
Get Click Positions
Tool to retrieve the distribution of clicks by position from Algolia Analytics. Use when analyzing which search result positions receive the most user engagement.
-
Get Click Through Rate
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.
-
Get Conversion Rate
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.
-
Get Destination
Tool to retrieve a destination by its ID. Use when you need to get details about a specific Algolia destination resource.
-
Get Dictionary Languages
Tool to list available languages for dictionary entries. Use when you need to check which languages support custom dictionary entries (plurals, stopwords, compounds).
-
Get Dictionary Settings
Tool to retrieve dictionary settings for all dictionaries. Use when you need to check which standard dictionary entries are disabled across different languages.
-
Get Index Settings
Tool to retrieve the settings of a specified index. Use when you need to inspect index configurations after creation or update.
-
Get Logs
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.
-
Get Multiple Objects
Tool to retrieve multiple records from an index. Use when you need to batch-fetch several objectIDs in one call.
-
Get No Click Rate
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.
-
Get No Results Rate
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.
-
Get No Results Searches
Tool to retrieve the most frequent searches that produced zero results. Use when analyzing search gaps or identifying content opportunities to improve search experience.
-
Get Object Position
Tool to retrieve an object’s position in a result set. Use when debugging relevance after performing a search query.
-
Get Personalization Config
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.
-
Get Purchase Rate
Tool to retrieve purchase rate metrics for searches that led to purchase events. Use when you need to analyze conversion effectiveness and purchase behavior for an index, including daily breakdowns.
-
Get Query Suggestions Config
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.
-
Get Recommend Rule
Tool to retrieve a Recommend rule that was previously created in the Algolia dashboard. Use when you need to inspect a specific rule's configuration, conditions, or consequences by its objectID.
-
Get Recommend Task Status
Tool to check the status of a Recommend task. Use when you need to verify if an asynchronous Recommend operation (such as deleting a Recommend rule) has completed.
-
Get Record From Index
Tool to retrieve a specific record from an index by its objectID. Use when you need to fetch a single object's details.
-
Get Revenue
Tool to retrieve revenue data from Algolia Analytics. Use when analyzing revenue metrics and conversion tracking for search results.
-
Get Rule
Tool to retrieve a specific rule by its objectID from an index. Use when you need to inspect a rule's configuration, conditions, and consequences.
-
Get Searches Count
Tool to retrieve the number of searches within a time range, including a daily breakdown. Use when analyzing search volume and traffic patterns for an index.
-
Get Searches No Clicks
Tool to retrieve top searches that did not receive any clicks. Use when analyzing search queries that may need optimization, such as queries with poor results or missing content.
-
Get Source
Tool to retrieve a source from the Algolia Ingestion API. Use when you need to get details about a specific data source by its ID.
-
Get Synonym
Tool to retrieve a specific synonym by its objectID. Use when you need to fetch details of an existing synonym from an index.
-
Get Task Status
Tool to check the status of an asynchronous task. Use when you need to verify completion of operations like adding or deleting records.
-
Get Top Countries
Tool to retrieve top countries by search volume for a specified index. Use when you need to analyze geographic distribution of searches and understand where your users are searching from.
-
Get Top Filter Attributes
Tool to retrieve top filter attributes from Algolia Analytics. Use when analyzing which filters are most commonly used by users in searches.
-
Get Top Filter for Attribute
Tool to retrieve top filter values for a specific attribute from Algolia Analytics. Use when analyzing which filter values are most commonly used for a given attribute in search queries.
-
Get Top Filters No Results
Tool to retrieve top filters for searches that returned no results from Algolia Analytics. Use when analyzing which filters are commonly applied to searches that yield zero results, helping identify potential catalog…
-
Get Top Hits
Tool to retrieve the object IDs of the most frequent search results from Algolia Analytics. Returns up to 1,000 top hits ranked by frequency, optionally including click analytics (CTR, conversion rates) and revenue…
-
Get Top Searches
Tool to retrieve the most popular searches from Algolia Analytics. Returns search queries ranked by frequency, optionally including click analytics (CTR, conversion rates) and revenue metrics. Use when analyzing search…
-
Get Transformation
Tool to retrieve a transformation by its ID from Algolia's Ingestion API. Use when you need to fetch details about a specific transformation including its code, configuration, and metadata.
-
Get Usage for Index
Tool to retrieve usage statistics for a specific Algolia index over a time period. Use when you need to analyze index metrics such as record counts, query volumes, processing times, or capacity usage. Supports both…
-
Get Usage Statistics
Tool to retrieve Algolia usage statistics over a specified time period. Use when you need to analyze search operations, indexing operations, capacity metrics, or other usage data for an Algolia application. Requires…
-
Get Users
Tool to retrieve a list of user profiles from Algolia advanced personalization. Use when you need to fetch user affinities, filter by date ranges, or paginate through user data.
-
Get Users Count
Tool to retrieve the number of unique users within a time range, including daily breakdown. Use when you need to analyze user engagement metrics for a specific index over a date range.
-
Index Exists
Tool to check if an Algolia index exists. Use before performing index operations to prevent accidental index creation. Results are scoped to the Algolia app ID configured in the Composio connection. Example…
-
Init Insights API Client
Tool to initialize the Algolia Insights API client. Use before sending any Insights events.
-
List AB Tests
Tool to list all A/B tests configured for this application. Use when you need to view existing A/B tests, check their status, or retrieve test IDs for further operations.
-
List API Keys
Tool to list all API keys associated with your Algolia application, including their permissions and restrictions. Use when you need to audit API key usage, check permissions, or manage access control.
-
List Authentications
Tool to list authentication resources from Algolia. Use when you need to retrieve available authentication configurations for sources or destinations.
-
List Destinations
Tool to list destinations in Algolia. Use when you need to retrieve all destinations or filter them by type, authentication ID, or transformation ID.
-
List Indices
Tool to list all indices and their metadata. Use when you need to retrieve index names, sizes, and state before performing operations that depend on index properties.
-
List Ingestion Tasks
Tool to retrieve a list of ingestion tasks from Algolia. Use when you need to fetch configured tasks for ingestion pipelines. Supports filtering by various criteria such as source, destination, trigger type, action…
-
List Query Suggestions Configurations
Tool to retrieve all Query Suggestions configurations for an Algolia application. Use when you need to view or audit existing Query Suggestions setups.
-
List Sources
Tool to list sources from the Algolia Ingestion API. Use when you need to retrieve available data sources for ingestion pipelines. Supports filtering by type and authentication ID, with pagination and sorting options.
-
List Task Runs
Tool to list task runs. Use when you need to retrieve and monitor task execution status, filter by time range, or paginate through run history.
-
List Transformations
Tool to list all transformations in Algolia Ingestion API. Use when you need to retrieve transformation configurations, filter by type, or paginate through transformation lists.
-
Partial Update Objects
Tool to partially update multiple records in the specified index. Use when you need to change only selected fields of many objects without replacing entire records. Use after confirming objectIDs and desired updates.
-
Push Records to Task
Tool to push records to an Algolia task by task ID. Use when you need to send data to a configured ingestion task. Note: tasks with source type 'json' cannot use this endpoint.
-
Replace All Rules
Tool to push a new set of rules, erasing previous ones. Use when you need zero-downtime atomic replacement of all rules in an index.
-
Replace Task
Tool to fully replace a task in Algolia Ingestion API. Use when you need to completely update a task with new configuration, replacing all existing settings.
-
Restore API Key
Tool to restore a deleted API key within 72 hours of deletion. Use when you need to recover an accidentally deleted API key.
-
Save Rule
Tool to create or replace a rule in an index. Use when you need to add merchandising rules, query modifications, or conditional search behavior.
-
Save Synonym
Tool to add or update a synonym in the specified index. Use when you need programmatic upsert of search synonyms after index creation.
-
Save Synonyms
Tool to batch create or replace synonyms in an Algolia index. If a synonym with the objectID doesn't exist, Algolia adds a new one. Use when you need to add or update multiple synonyms at once.
-
Search Algolia Index
Tool to perform a search on a specified Algolia index. Use after confirming the index name. Example: SearchIndex(index_name='contacts', query='apple', search_params={'hitsPerPage':10})
-
Search Authentications
Tool to search for authentication resources by IDs in Algolia. Use when you need to retrieve multiple specific authentication configurations by their IDs.
-
Search Destinations
Tool to search for specific destinations by their IDs. Use when you need to retrieve multiple destinations at once by providing their unique identifiers.
-
Search Dictionary Entries
Tool to search dictionary entries in Algolia dictionaries. Use when you need to find stopwords, plurals, or compound words in specific dictionaries.
-
Search Facet Values
Tool to search for values of a specified facet attribute. Use when you need to find specific facet values that match a query string. Facet values are sorted by decreasing count by default.
-
Search Multiple Indices
Tool to perform searches across multiple indices in a single call. Use when you need to batch multiple index queries into one API request.
-
Search Recommend Rules
Tool to search for Recommend rules in the specified index and model. Use when you need to retrieve rules matching a query, or use an empty query to list all rules for this recommendation scenario.
-
Search Sources
Tool to search for sources by IDs in Algolia Ingestion API. Use when you need to retrieve multiple specific data sources by their IDs.
-
Search Synonyms
Tool to search for synonyms in the specified index. Use when you need to retrieve synonyms matching a query or filter by type.
-
Search Transformations
Tool to search for transformations by IDs in Algolia Ingestion API. Use when you need to retrieve multiple specific transformation configurations by their IDs.
-
Set Dictionary Settings
Tool to update dictionary settings for Algolia. Use when you need to enable or disable built-in stop words, plurals, or compounds for specific languages.
-
Set Index Settings
Tool to update an Algolia index's settings. Use when you need to configure index behavior before indexing records. Example: set searchableAttributes and customRanking for products index.
-
Set Personalization Strategy
Tool to define personalization strategy that controls how user behavior affects search results. Use when you need to configure which events and facets influence personalized search rankings.
-
Stop AB Test
Tool to stop an A/B test by its unique identifier. Use when you need to halt an active A/B test. Note that stopped A/B tests cannot be restarted.
-
Try Transformation
Tool to try a transformation before creating it in Algolia. Use when you need to test transformation code or no-code configurations against sample data to verify they work correctly before deployment.
-
Try Transformation Before Update
Tool to test a transformation before updating it in Algolia Ingestion API. Use when you need to validate transformation code or configuration against sample data before applying it to production.
-
Update API Key
Tool to update the permissions and settings of an existing API key. Use when you need to modify ACL permissions, index restrictions, rate limits, or other settings of an existing API key.
-
Update Authentication
Tool to update an authentication resource in Algolia. Use when you need to modify the name or credentials of an existing authentication configuration.
-
Update Destination
Tool to update a destination in Algolia Ingestion API. Use when you need to modify an existing destination's configuration, name, type, or associated transformations.
-
Update Dictionary Entries
Tool to add or delete dictionary entries in Algolia dictionaries. Use when you need to batch modify stopwords, plurals, or compound word entries.
-
Update Query Suggestions Config
Tool to update an existing Query Suggestions configuration. Use when you need to modify settings for query suggestions on an existing index.
-
Update Record Partially
Tool to add or update attributes in a single record. Use when you need to modify specific fields without replacing the entire record. Creates a new record if the objectID doesn't exist (when create_if_not_exists is…
-
Update Source
Tool to update a source in the Algolia Ingestion API. Use when you need to modify the name, authentication, or input configuration of an existing data source.
-
Update Task
Tool to partially update a task in Algolia Ingestion API. Use when you need to modify task configuration such as schedule, failure threshold, destination, or notification settings.
-
Update Transformation
Tool to update an existing transformation in Algolia Ingestion API. Use when you need to modify transformation settings, code, or configuration for data processing during ingestion.
-
Validate Source
Tool to validate a source payload before creating it in Algolia. Use when you need to verify that a source configuration is valid before actually creating the source.
-
Validate Source Before Update
Tool to validate a source update payload in the Algolia Ingestion API. Use when you need to verify that an update to a source configuration is valid before actually updating it.
Setup
Connect Algolia in Hookshot™
Pick a scope, then confirm what can start a Protege and what it can do.
Trigger Access
What can start a Protege from this app.
Tool Access
What a Protege can do after it starts.
Connection scope
Prefer team for production.
Personal
Tied to one user—only when the workflow needs their account.
Chat
Team-scoped for supported chat surfaces.
Build with us
See Hookshot™ in your stack.
Request early access or book a live walkthrough with the team.
