- Category: developer tools
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 133
- Triggers: 0
- Slug:
ALGOLIA - Version: 20261101_00
Tools
Add AB Test
Add AB Test
ALGOLIA_ADD_AB_TESTTool 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.Input Parameters
Output
Add or Replace Record
Add or Replace Record
ALGOLIA_ADD_OR_REPLACE_RECORDTool 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.Input Parameters
Output
Add Record to Index
Add Record to Index
ALGOLIA_ADD_RECORDTool 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.Input Parameters
Output
Browse Algolia Index
Browse Algolia Index
Clear Objects
Clear Objects
Clear Rules
Clear Rules
Clear Synonyms
Clear Synonyms
Clicked Object IDs
Clicked Object IDs
Clicked Object IDs After Search
Clicked Object IDs After Search
Compute Realtime User Profile
Compute Realtime User Profile
ALGOLIA_COMPUTE_REALTIME_USERTool 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.Input Parameters
Output
Converted Object IDs
Converted Object IDs
ALGOLIA_CONVERTED_OBJECT_IDSTool 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.Input Parameters
Output
Copy Index
Copy Index
ALGOLIA_COPY_INDEXInitiate an index copy and return an asynchronous task ID. Copy all parts including records, or specify settings, synonyms and rules as the scope; specifying a scope excludes records.Input Parameters
Output
Create API Key
Create API Key
ALGOLIA_CREATE_API_KEYTool 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.Input Parameters
Output
Create Authentication
Create Authentication
ALGOLIA_CREATE_AUTHENTICATIONCreate an authentication resource in the US region of Algolia’s ingestion API for connecting to sources or destinations.Input Parameters
Output
Create Destination
Create Destination
Create Ingestion Task
Create Ingestion Task
ALGOLIA_CREATE_INGESTION_TASKCreate an ingestion task connecting a source to a destination for data synchronization with an Algolia index. The request uses the US ingestion endpoint.Input Parameters
Output
Create or Update Recommend Rules
Create or Update Recommend Rules
ALGOLIA_CREATE_OR_UPDATE_RECOMMEND_RULESTool 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.Input Parameters
Output
Create Query Suggestions Config
Create Query Suggestions Config
ALGOLIA_CREATE_QS_CONFIGTool 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.Input Parameters
Output
Create Source
Create Source
ALGOLIA_CREATE_SOURCETool 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.Input Parameters
Output
Create Transformation
Create Transformation
ALGOLIA_CREATE_TRANSFORMATIONTool 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.Input Parameters
Output
Delete AB Test
Delete AB Test
Delete API Key
Delete API Key
Delete Authentication
Delete Authentication
Delete Query Suggestions Config
Delete Query Suggestions Config
Delete Destination
Delete Destination
Delete Index
Delete Index
Delete Multiple Records
Delete Multiple Records
Delete Recommend Rule
Delete Recommend Rule
Delete Records by Filter
Delete Records by Filter
ALGOLIA_DELETE_RECORDS_BY_FILTERTool 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.Input Parameters
Output
Delete Rule
Delete Rule
Delete Source
Delete Source
Delete Synonym
Delete Synonym
Delete Transformation
Delete Transformation
Delete User Profile
Delete User Profile
Delete User Token
Delete User Token
Disable Task V1
Disable Task V1
Enable Task V1
Enable Task V1
Batch Operations on Multiple Indices
Batch Operations on Multiple Indices
ALGOLIA_EXECUTE_BATCH_ON_MULTIPLE_INDICESTool 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.Input Parameters
Output
Export Rules
Export Rules
ALGOLIA_EXPORT_RULESExport a page of rules from an Algolia index for backup or migration. Use the returned cursor to retrieve subsequent pages.Input Parameters
Output
Find Object
Find Object
ALGOLIA_FIND_OBJECTTool to find the first object matching a query or filter in an index. Use when debugging relevance or filter logic after confirming index exists.Input Parameters
Output
Get A/B Test
Get A/B Test
Get Add to Cart Rate
Get Add to Cart Rate
ALGOLIA_GET_ADD_TO_CART_RATETool 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.Input Parameters
Output
Get API Key
Get API Key
Get App Task Status
Get App Task Status
Get Authentication
Get Authentication
Get Average Click Position
Get Average Click Position
ALGOLIA_GET_AVERAGE_CLICK_POSITIONTool to retrieve average click position metrics from Algolia Analytics. Use when analyzing user engagement and click behavior for search results.Input Parameters
Output
Get Click Positions
Get Click Positions
ALGOLIA_GET_CLICK_POSITIONSTool to retrieve the distribution of clicks by position from Algolia Analytics. Use when analyzing which search result positions receive the most user engagement.Input Parameters
Output
Get Click Through Rate
Get Click Through Rate
ALGOLIA_GET_CLICK_THROUGH_RATETool 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.Input Parameters
Output
Get Query Suggestions Config
Get Query Suggestions Config
ALGOLIA_GET_CONFIGTool to retrieve a Query Suggestions configuration by index name. Use when you need to inspect or verify Query Suggestions settings for a specific index.Input Parameters
Output
Get Personalization Config
Get Personalization Config
Get Conversion Rate
Get Conversion Rate
ALGOLIA_GET_CONVERSION_RATERetrieve conversion rate analytics for an index from the US analytics endpoint, including daily breakdowns.Input Parameters
Output
Get Destination
Get Destination
Get Dictionary Languages
Get Dictionary Languages
Get Dictionary Settings
Get Dictionary Settings
Get Logs
Get Logs
ALGOLIA_GET_LOGSTool 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.Input Parameters
Output
Get No Click Rate
Get No Click Rate
ALGOLIA_GET_NO_CLICK_RATERetrieve aggregate and daily no-click rates for tracked searches on an index, with optional date and tag filters. Use to analyze search engagement.Input Parameters
Output
Get No Results Rate
Get No Results Rate
ALGOLIA_GET_NO_RESULTS_RATERetrieve aggregate and daily no-results rates for an index using the US analytics endpoint. Use to analyze search effectiveness over a selected period.Input Parameters
Output
Get No Results Searches
Get No Results Searches
ALGOLIA_GET_NO_RESULTS_SEARCHESRetrieve frequent searches that produced zero results for an index using the US analytics endpoint. Use to analyze search gaps or identify content opportunities.Input Parameters
Output
Get Object Position
Get Object Position
Get multiple objects
Get multiple objects
Get Purchase Rate
Get Purchase Rate
ALGOLIA_GET_PURCHASE_RATERetrieve purchase rate metrics for an index, including daily breakdowns, from the US analytics region.Input Parameters
Output
Get Recommend Rule
Get Recommend Rule
ALGOLIA_GET_RECOMMEND_RULETool 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.Input Parameters
Output
Get Recommend Task Status
Get Recommend Task Status
ALGOLIA_GET_RECOMMEND_TASK_STATUSTool 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.Input Parameters
Output
Get Record from Index
Get Record from Index
ALGOLIA_GET_RECORDTool to retrieve a specific record from an index by its objectID. Use when you need to fetch a single object’s details.Input Parameters
objectID is always retrieved. Attributes included in unretrievableAttributes won’t be retrieved unless the request is authenticated with the admin API key.Output
Get Revenue
Get Revenue
ALGOLIA_GET_REVENUERetrieve search-related revenue data from Algolia Analytics using the US regional endpoint.Input Parameters
Output
Get Rule
Get Rule
Get Searches Count
Get Searches Count
ALGOLIA_GET_SEARCHES_COUNTRetrieve search counts for an index over a time range, including a daily breakdown, using the US regional Analytics endpoint.Input Parameters
Output
Get Searches No Clicks
Get Searches No Clicks
ALGOLIA_GET_SEARCHES_NO_CLICKSRetrieve top searches without clicks from Algolia Analytics using the US regional endpoint, to help identify queries that may need optimization.Input Parameters
Output
Get Index Settings
Get Index Settings
Get Source
Get Source
ALGOLIA_GET_SOURCETool to retrieve a source from the Algolia Ingestion API. Use when you need to get details about a specific data source by its ID.Input Parameters
Output
Get Synonym
Get Synonym
Get Task Status
Get Task Status
Get Task V1
Get Task V1
Get Top Countries
Get Top Countries
ALGOLIA_GET_TOP_COUNTRIESRetrieve top countries by search volume for a specified index using the US analytics endpoint, to analyze the geographic distribution of searches.Input Parameters
Output
Get Top Filter Attributes
Get Top Filter Attributes
ALGOLIA_GET_TOP_FILTER_ATTRIBUTESTool to retrieve top filter attributes from Algolia Analytics. Use when analyzing which filters are most commonly used by users in searches.Input Parameters
Output
Get Top Filter For Attribute
Get Top Filter For Attribute
ALGOLIA_GET_TOP_FILTER_FOR_ATTRIBUTETool 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.Input Parameters
Output
Get Top Filters No Results
Get Top Filters No Results
ALGOLIA_GET_TOP_FILTERS_NO_RESULTSTool 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 or filtering issues.Input Parameters
Output
Get Top Hits
Get Top Hits
ALGOLIA_GET_TOP_HITSTool 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 metrics. Use when analyzing which results appear most often in searches.Input Parameters
Output
Get Top Searches
Get Top Searches
ALGOLIA_GET_TOP_SEARCHESRetrieve popular search queries from Algolia Analytics, with optional click analytics and revenue metrics. Results can be ordered by search count or click-related metrics in ascending or descending order.Input Parameters
Output
Get Transformation
Get Transformation
Get Usage Statistics
Get Usage Statistics
ALGOLIA_GET_USAGETool 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 Premium plan or Enterprise add-on access.Input Parameters
Output
Get Usage for Index
Get Usage for Index
ALGOLIA_GET_USAGE_FOR_INDEXRetrieve usage statistics for a specific Algolia index over a time period, with hourly or daily aggregation, including metrics such as record counts, query volumes, and processing times. Usage API access requires a Premium plan or Enterprise add-on.Input Parameters
Output
Get Users
Get Users
ALGOLIA_GET_USERSRetrieve user profiles and affinities from Algolia advanced personalization using the EU endpoint. Filter by date ranges and paginate through user data.Input Parameters
Output
Get Users Count
Get Users Count
ALGOLIA_GET_USERS_COUNTRetrieve the number of unique users for an index over a time range, including a daily breakdown, using the US Algolia Analytics endpoint.Input Parameters
Output
Index Exists
Index Exists
Init Insights API Client
Init Insights API Client
List AB Tests
List AB Tests
ALGOLIA_LIST_AB_TESTSList a page of A/B tests for the application in the DE analytics region, with optional index prefix or suffix filters. Results include test IDs and status.Input Parameters
Output
List API Keys
List API Keys
List Authentications
List Authentications
ALGOLIA_LIST_AUTHENTICATIONSList a page of Algolia ingestion authentication resources in the US region, with optional type and platform filters.Input Parameters
Output
List Destinations
List Destinations
List Indices
List Indices
List Ingestion Tasks
List Ingestion Tasks
ALGOLIA_LIST_INGESTION_TASKSList ingestion tasks using the US ingestion endpoint. Supports filtering by source, destination, trigger type, action, and enabled status, with pagination and sorting.Input Parameters
Output
List Query Suggestions Configurations
List Query Suggestions Configurations
ALGOLIA_LIST_QS_CONFIGSTool to retrieve all Query Suggestions configurations for an Algolia application. Use when you need to view or audit existing Query Suggestions setups.Input Parameters
Output
List Task Runs
List Task Runs
ALGOLIA_LIST_RUNSList Algolia Ingestion task runs using the US regional endpoint. Filter by time range or status and paginate through run history.Input Parameters
Output
List Sources
List Sources
ALGOLIA_LIST_SOURCESTool 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.Input Parameters
Output
List Transformations
List Transformations
Partial Update Objects
Partial Update Objects
ALGOLIA_PARTIAL_UPDATE_OBJECTSPartially update multiple records in an index by objectID without replacing entire records. Each update can also be configured to create the record if it does not exist.Input Parameters
objectID and any additional fields you wish to change; you can also set createIfNotExists per object.Output
Push Records to Task
Push Records to Task
ALGOLIA_PUSH_TASKPush records and a selected indexing action to a configured ingestion task by task ID, including actions to delete records, clear an index, or delete an index. Tasks with source type ‘json’ cannot use this endpoint.Input Parameters
Output
Replace All Rules
Replace All Rules
Replace Task
Replace Task
ALGOLIA_REPLACE_TASKReplace an Algolia Ingestion task with new configuration using the US regional API endpoint.Input Parameters
Output
Restore API Key
Restore API Key
Run Task V1
Run Task V1
Save Rule
Save Rule
ALGOLIA_SAVE_RULETool to create or replace a rule in an index. Use when you need to add merchandising rules, query modifications, or conditional search behavior.Input Parameters
Output
Save Synonym
Save Synonym
Save Synonyms
Save Synonyms
ALGOLIA_SAVE_SYNONYMSBatch create or replace synonyms in an Algolia index. An optional setting replaces all existing synonyms with the supplied batch and can forward changes to replicas.Input Parameters
Output
Search Authentications
Search Authentications
Search Destinations
Search Destinations
Search Dictionary Entries
Search Dictionary Entries
ALGOLIA_SEARCH_DICTIONARY_ENTRIESTool to search dictionary entries in Algolia dictionaries. Use when you need to find stopwords, plurals, or compound words in specific dictionaries.Input Parameters
Output
Search Facet Values
Search Facet Values
ALGOLIA_SEARCH_FACET_VALUESTool 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.Input Parameters
Output
Search Algolia Index
Search Algolia Index
ALGOLIA_SEARCH_INDEXTool 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})Input Parameters
Output
Search Multiple Indices
Search Multiple Indices
Search Recommend Rules
Search Recommend Rules
ALGOLIA_SEARCH_RECOMMEND_RULESSearch Recommend rules in a specified index and model. An empty query can list rules for the recommendation scenario; results are paginated.Input Parameters
Output
Search Sources
Search Sources
Search Synonyms
Search Synonyms
ALGOLIA_SEARCH_SYNONYMSSearch synonyms in a specified Algolia index, optionally matching a query or filtering by synonym type. Choose a zero-based page and page size to browse matching synonym entries.Input Parameters
Output
Search Tasks V1
Search Tasks V1
Search Transformations
Search Transformations
Set Dictionary Settings
Set Dictionary Settings
ALGOLIA_SET_DICTIONARY_SETTINGSTool to update dictionary settings for Algolia. Use when you need to enable or disable built-in stop words, plurals, or compounds for specific languages.Input Parameters
Output
Set Personalization Strategy
Set Personalization Strategy
ALGOLIA_SET_PERSONALIZATION_STRATEGYTool 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.Input Parameters
Output
Set Index Settings
Set Index Settings
ALGOLIA_SET_SETTINGSTool 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.Input Parameters
Output
Stop AB Test
Stop AB Test
Try Transformation
Try Transformation
ALGOLIA_TRY_TRANSFORMATIONTool 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.Input Parameters
Output
Try Transformation Before Update
Try Transformation Before Update
ALGOLIA_TRY_TRANSFORMATION_BEFORE_UPDATETool 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.Input Parameters
Output
Update API Key
Update API Key
ALGOLIA_UPDATE_API_KEYTool 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.Input Parameters
Output
Update Authentication
Update Authentication
ALGOLIA_UPDATE_AUTHENTICATIONUpdate the name or credentials of an Algolia ingestion authentication resource in the US region.Input Parameters
Output
Update Query Suggestions Config
Update Query Suggestions Config
ALGOLIA_UPDATE_CONFIGTool to update an existing Query Suggestions configuration. Use when you need to modify settings for query suggestions on an existing index.Input Parameters
Output
Update Destination
Update Destination
Update Dictionary Entries
Update Dictionary Entries
ALGOLIA_UPDATE_DICTIONARY_ENTRIESBatch add or delete entries in an Algolia stopwords, plurals, or compounds dictionary. The request can also replace all existing custom entries in the selected dictionary.Input Parameters
Output
Update Record Partially
Update Record Partially
ALGOLIA_UPDATE_RECORD_PARTIALLYTool 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 true).Input Parameters
Output
Update Source
Update Source
ALGOLIA_UPDATE_SOURCETool 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.Input Parameters
Output
Update Task
Update Task
ALGOLIA_UPDATE_TASKPartially update an Algolia Ingestion API task using the US ingestion endpoint. Configure fields such as schedule, failure threshold, destination, or notifications.Input Parameters
Output
Update Transformation
Update Transformation
ALGOLIA_UPDATE_TRANSFORMATIONTool 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.Input Parameters
Output
Validate Source
Validate Source
ALGOLIA_VALIDATE_SOURCETool 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.Input Parameters
Output
Validate Source Before Update
Validate Source Before Update
ALGOLIA_VALIDATE_SOURCE_BEFORE_UPDATETool 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.