Algolia is a hosted search API that provides developers with tools to build fast and relevant search experiences for their applications.
Algolia is a hosted search API that provides developers with tools to build fast and relevant search experiences for their applications. On Nagent, Algolia is exposed as a fully-configurable developer tools integration that any agent can call — 133 actions, and API key authentication. No code is required to wire Algolia into your workflow — connect it once via the External Integrations panel and reuse it across every agent you build.
Agent builders use Algolia to automate the kinds of tasks developer tools teams previously handled manually. Concrete examples — each one is a single agent step in Nagent — include:
Every action and trigger is paired with a structured input/output schema (visible in the sections below), so when you wire Algolia into Helix — our agentic agent builder — the editor knows exactly what each step expects and produces. Configure once, deploy anywhere across your Nagent agents.
Every operation an agent can call against Algolia, with input parameters and output schema. Drop these into any step of an agent built in Helix.
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
Descriptive name for the A/B test to identify it in the dashboard.
End date and time of the A/B test in RFC 3339 format (e.g., '2026-02-18T23:59:59Z'). Test will automatically stop at this time.
Algolia analytics API region. Valid values: 'us', 'de'. Defaults to 'de' (EU region).
Exactly two variants to test. Traffic percentages must sum to 100.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Record data to add or replace in the index. Can include any attributes. The objectID field in the record body is optional but should match the objectID parameter if provided.
Unique record identifier. If a record with this objectID exists, it will be replaced; otherwise, a new record is created.
Name of the index on which to perform the operation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Record data to add to the index. Can include any attributes. If objectID is provided, it will be used; otherwise, one will be auto-generated. Records with matching IDs are replaced.
Name of the index on which to perform the operation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_BROWSE_INDEXTool to retrieve all records from an index. Use when you need to export or iterate through an entire index dataset.
Input parameters
Search query to filter records; empty or omitted returns all records.
Cursor to specify the starting point for the next batch of results.
Name of the Algolia index to browse.
Additional browse parameters as key-value pairs (e.g., filters, hitsPerPage).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_CLEAR_OBJECTSTool 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.
Input parameters
Name of the index from which to clear all records.
Optional mapping of request options (query parameters) as string values.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_CLEAR_RULESTool 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.
Input parameters
Name of the Algolia index from which to clear all rules.
If true, also clears rules on all replica indices.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_CLEAR_SYNONYMSTool to delete all synonyms from an index. Use when you need to remove all synonym definitions in one operation.
Input parameters
Name of the index from which to clear all synonyms.
Whether changes are applied to replica indices.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_CLICKED_OBJECT_IDSTool 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.
Input parameters
Name of the specific event (1-64 ASCII printable characters).
Name of the Algolia index where the event occurred.
List of clicked object IDs (1-20 items).
Anonymous user identifier. Allowed chars: alphanumeric, '_', '=', '+', '/', '-'; length 1-129.
Pseudonymous identifier for authenticated users; same pattern as userToken.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_CLICKED_OBJECT_IDS_AFTER_SEARCHTool to send a click event after a search response. Use when you want to report which items a user clicked in search results.
Input parameters
Name of the index where the click occurred.
queryID returned by Algolia Search API for the request.
Name for this click event, e.g. 'Product Clicked'.
List of objectIDs that were clicked.
Positions (1-based) of clicked objects in the search results. Must be strictly positive integers.
Event timestamp in milliseconds since epoch. If omitted, server timestamp is used.
Unique token identifying the user, consistent across events.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Unique pseudonymous or anonymous user identifier for which to compute the personalization profile.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Name of the Algolia index where conversion happened.
Name of the specific conversion event. 1–64 ASCII characters except control characters.
List of object IDs for items converted. Up to 20 IDs.
Event timestamp in milliseconds since epoch. If omitted, server timestamp is used.
Unique token identifying the user, e.g., 'user-123'.
Optional pseudonymous token for authenticated users. Never include PII.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_COPY_INDEXTool 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.
Input parameters
Parts of the index to copy. Allowed values: 'settings', 'synonyms', 'rules'. If omitted, all parts (including records) are copied. If specified, records are not copied.
Name of the source index to copy.
Name of the destination index to create.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint's reference. For more information, see access control list (ACL).
Index names or patterns that this API key can access. By default, an API key can access all indices in the same application. You can use leading and trailing wildcard characters (*): 'dev_*' matches all indices starting with 'dev_', '*_dev' matches all indices ending with '_dev', '*_products_*' matches all indices containing '_products_'.
Allowed HTTP referrers for this API key. By default, all referrers are allowed. You can use leading and trailing wildcard characters (*): 'https://algolia.com/*' allows all referrers starting with 'https://algolia.com/', '*.algolia.com' allows all referrers ending with '.algolia.com', '*algolia.com*' allows all referrers in the domain 'algolia.com'. Like all HTTP headers, referrers can be spoofed. Don't rely on them to secure your data.
Duration (in seconds) after which the API key expires. By default, API keys don't expire.
Description of an API key to help you identify this API key.
Maximum number of results this API key can retrieve in one query. By default, there's no limit.
Query parameters to add when making API requests with this API key. To restrict this API key to specific IP addresses, add the restrictSources parameter. You can only add a single source, but you can provide a range of IP addresses. Creating an API key fails if the request is made from an IP address outside the restricted range.
Maximum number of API requests allowed per IP address or user token per hour. If this limit is reached, the API returns an error with status code 429. By default, there's no limit.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_CREATE_AUTHENTICATIONTool 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.
Input parameters
Descriptive name for the resource.
Type of authentication. This determines the type of credentials required in the input object.
Authentication credentials object. The structure varies based on the authentication type. For 'basic' type: {username: str, password: str}. For 'googleServiceAccount' type: {clientEmail: str, privateKey: str}. For 'apiKey' type: {key: str}. For 'oauth' type: {url: str, client_id: str (optional), client_secret: str (optional), code: str (optional), scope: str (optional)}. For 'algolia' type: {appID: str, apiKey: str}. For 'algoliaInsights' type: {appID: str, apiKey: str}. For 'secrets' type: custom key-value pairs.
Platform associated with this authentication.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_CREATE_DESTINATIONTool to create a new destination in Algolia Ingestion API. Use when you need to set up a new destination for data ingestion.
Input parameters
Descriptive name for the resource.
Destination type. 'search' means data is stored in an Algolia index. 'insights' means data is recorded as user events in the Insights API.
Input configuration for the destination.
Universally unique identifier (UUID) of an authentication resource.
List of transformation IDs to associate with the destination.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_CREATE_INGESTION_TASKTool 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.
Input parameters
Cron expression for the task's schedule. Use standard cron syntax to define when the task should run automatically.
Configuration of the task input, depending on its type. Structure varies: for streaming input use 'mapping' object, for docker streams use 'streams' array, for Shopify use 'metafields' array and 'market' object.
Action to perform on the Algolia index. Defines how records are updated: 'replace' replaces all records, 'save' adds or updates records, 'partial' updates specific attributes, 'partialNoCreate' updates without creating, 'append' adds new records.
Date and time when the last cursor was created, in RFC 3339 format. Used for incremental data synchronization.
Whether the task is enabled. If false, the task will not run automatically even if scheduled.
Set of rules for a task.
Universally unique identifier (UUID) of a source resource.
Universally unique identifier (UUID) of a destination resource.
Notification settings for a task.
Maximum accepted percentage of failures for a task run to finish successfully. Task will fail if failure rate exceeds this threshold.
Action to perform on the Algolia index.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Recommend model (related-products, bought-together, trending-facets, or trending-items).
List of Recommend rules to create or update. Each rule is created or updated based on whether a rule with the same objectID already exists.
Name of the index on which to perform the operation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Analytics region for your Algolia application (us or eu). Must match your application's analytics region configured in the Algolia dashboard under Infrastructure > Analytics
List of words or regular expressions to exclude from query suggestions
Name of the Query Suggestions index to create. This will be the destination index for generated suggestions
Languages for deduplicating singular/plural suggestions. Set to true to enable for all languages, or provide an array of specific language codes (e.g., \['en', 'fr'\])
Array of source index configurations to use for generating query suggestions. At least one source index is required
Whether to enable personalized query suggestions based on user behavior. Default is false
Whether to include suggestions with special characters. Default is false
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Descriptive name for the source.
Type of data source to create. Options: bigcommerce, bigquery, commercetools, csv, docker, ga4BigqueryExport, json, shopify, push. The 'push' type is for sources where data is pushed directly via API.
Input configuration for the source. Structure varies by source type. Key required fields: commercetools requires url + projectKey; bigcommerce requires storeHash; json/csv require url; bigquery/ga4BigqueryExport require projectID + datasetID; docker requires image + configuration; push needs no input.
Region for the Algolia Ingestion API endpoint. The API will be called at https://data.{region}.algolia.com. Valid values: 'us', 'eu'.
Universally unique identifier (UUID) of an authentication resource. Required for most source types except 'push'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
The uniquely identified name of your transformation.
The type of transformation: 'code' for JavaScript code transformations, or 'noCode' for visual no-code transformations.
The input for the transformation. For 'code' type, provide a 'code' field with JavaScript. For 'noCode' type, provide a 'steps' field with the transformation steps.
A descriptive name for your transformation explaining what it does.
The authentications (UUIDs) associated with the transformation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_DELETE_AB_TESTTool to delete an A/B test by its unique identifier. Use when you need to permanently remove an A/B test configuration.
Input parameters
Unique A/B test identifier.
Algolia analytics API region. Valid values: 'us', 'de'. Defaults to 'de' (EU region).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_DELETE_API_KEYTool to delete an API key. Use when you need to revoke or remove an existing API key from your Algolia application.
Input parameters
API key to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_DELETE_AUTHENTICATIONTool to delete an authentication resource from Algolia. Use when you need to remove an existing authentication resource by its ID.
Input parameters
Unique identifier of an authentication resource.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_DELETE_CONFIGTool to delete a Query Suggestions configuration for the specified index. Use when you need to remove a Query Suggestions configuration permanently.
Input parameters
Query Suggestions index name to delete the configuration for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_DELETE_DESTINATIONTool to delete a destination in Algolia Ingestion API. Use when you need to permanently remove a destination by its ID.
Input parameters
Unique identifier of the destination to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_DELETE_INDEXTool 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.
Input parameters
The name of the index to be deleted
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_DELETE_OBJECTSTool to delete multiple records from an Algolia index. Use when you need to remove multiple objects by their IDs.
Input parameters
Name of the index from which to delete records.
List of objectIDs to delete.
Optional mapping of request options (query parameters) as string values.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_DELETE_RECOMMEND_RULETool to delete a Recommend rule from a recommendation scenario. Use when you need to remove a specific rule from an index's recommend model.
Input parameters
Recommend model for the recommendation scenario.
Unique record identifier of the rule to delete.
Name of the index on which to perform the operation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Filter expression to only include items that match the filter criteria. Supports numeric filters (<, <=, =, !=, >, >=), ranges (facet:lower TO upper), facet filters (facet:value), tag filters (_tags:value), and boolean filters (facet: true \\| false). Combine filters with AND, OR, and NOT operators. Example: '(category:Book OR category:Ebook) AND _tags:published'
Name of the index on which to perform the operation.
Filter by values of the special '_tags' attribute (deprecated, prefer using 'filters' parameter). Same combination rules apply as for facet_filters.
Maximum radius for a search around a central location. Works with around_lat_lng parameter. Can be an integer (meters) or 'all'.
Filter by facet values (deprecated, prefer using 'filters' parameter). Format: \[filter1, filter2\] is AND, \[\[filter1, filter2\], filter3\] is (filter1 OR filter2) AND filter3.
Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records within a circle around this location are included. Example: '40.71,-74.01'
Coordinates of a polygon in which to search. Each polygon is defined by 3 to 10,000 points (latitude, longitude pairs).
Filter by numeric facets (deprecated, prefer using 'filters' parameter). Supports comparison operators: <, <=, =, !=, >, >= and ranges (facet:lower TO upper).
Optional mapping of request options (query parameters) as string values.
Coordinates of a rectangle in which to search. Format: 'lat1,lng1,lat2,lng2' or nested arrays for multiple boxes.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_DELETE_RULETool to delete the specified rule from an index. Use when you need to permanently remove a rule after confirming its objectID.
Input parameters
Unique identifier of the rule to delete.
Name of the Algolia index from which to delete the rule.
Whether to forward this deletion to replica indices. If false (default), only the specified index is affected.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_DELETE_SOURCETool 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.
Input parameters
Unique identifier of the source to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_DELETE_SYNONYMTool to delete a synonym from a specified index. Use when you need to remove an existing synonym by its objectID.
Input parameters
ObjectID of the synonym to delete.
Name of the Algolia index from which to delete the synonym.
Whether to forward this deletion to all replica indices. If false (default), only the specified index is affected.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_DELETE_TRANSFORMATIONTool to delete a transformation in Algolia Ingestion API. Use when you need to permanently remove a transformation by its ID.
Input parameters
Unique identifier of the transformation to delete.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_DELETE_USER_PROFILETool to delete a user profile from personalization. Use when you need to remove a user's personalization data and reset their profile.
Input parameters
Unique identifier representing a user for which to fetch the personalization profile.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_DELETE_USER_TOKENTool to delete all events related to a user token from events metrics and analytics. Use when removing user data from Algolia Insights.
Input parameters
User token for which to delete all associated events.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_DISABLE_TASK_V1Tool 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.
Input parameters
Algolia ingestion API region. Valid values: 'us', 'eu'.
Unique identifier of a task.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_ENABLE_TASK_V1Tool 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.
Input parameters
Algolia ingestion API region. Valid values: 'us', 'eu', 'de'.
Unique identifier of a task.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Array of batch operations. Each operation specifies action, indexName, and body. All operations are executed in a single API call for efficiency. Must contain at least one operation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_EXPORT_RULESTool to export all rules defined on an index. Use when you need to backup or migrate index rules.
Input parameters
Page number to fetch (as a string); omit or set to '0' to start from the beginning. Use the cursor value from a previous response to fetch the next page.
Name of the Algolia index to export rules from
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Query string to search for. If omitted, only filters are applied. Values must match the form stored in the index; URLs or other transformed values (e.g., cleaned paths, derived IDs) may be stored in a normalized form that differs from the raw input.
Additional Algolia search parameters as key-value pairs. Supports 'filters' (string with syntax like 'category:Book AND price<100'), 'facetFilters', 'numericFilters', 'hitsPerPage', etc.
If True, searches across all pages until an object is found. If False, only searches the first page. Defaults to False.
Name of the Algolia index to search (e.g., 'products').
List of attributes to retrieve in the result. If omitted, all attributes are returned.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_AB_TESTTool 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.
Input parameters
Unique A/B test identifier.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia's segment documentation.
Index name to retrieve add-to-cart rate for.
End date of the period to analyze, in YYYY-MM-DD format.
Start date of the period to analyze, in YYYY-MM-DD format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_API_KEYTool 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.
Input parameters
The API key to retrieve. This is the key value (not the key ID).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_APP_TASKTool to check the status of an application task. Use when you need to verify if a task has completed.
Input parameters
Unique task identifier.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_AUTHENTICATIONTool 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.
Input parameters
Algolia ingestion API region. Valid values: 'us', 'eu'.
Unique identifier (UUID) of an authentication resource.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia documentation on segmenting analytics data.
Name of the Algolia index to retrieve click position metrics for.
End date of the period to analyze, in YYYY-MM-DD format.
Start date of the period to analyze, in YYYY-MM-DD format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia documentation on segmenting analytics data.
Name of the Algolia index to retrieve click position metrics for.
End date of the period to analyze, in YYYY-MM-DD format.
Start date of the period to analyze, in YYYY-MM-DD format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia's segment documentation.
Index name to retrieve click-through rate for.
End date of the period to analyze, in YYYY-MM-DD format.
Start date of the period to analyze, in YYYY-MM-DD format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Analytics region for your Algolia application (us or eu). Check your region in the Algolia dashboard at account/infrastructure/analytics
Query Suggestions index name to retrieve the configuration for
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_CONFIG2Tool 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.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_CONVERSION_RATETool 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.
Input parameters
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia's segment documentation.
Index name to retrieve conversion rate for.
End date of the period to analyze, in YYYY-MM-DD format.
Start date of the period to analyze, in YYYY-MM-DD format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_DESTINATIONTool to retrieve a destination by its ID. Use when you need to get details about a specific Algolia destination resource.
Input parameters
Unique identifier of the destination to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_DICTIONARY_LANGUAGESTool to list available languages for dictionary entries. Use when you need to check which languages support custom dictionary entries (plurals, stopwords, compounds).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_DICTIONARY_SETTINGSTool to retrieve dictionary settings for all dictionaries. Use when you need to check which standard dictionary entries are disabled across different languages.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Type of log entries to retrieve.
Maximum number of log entries to retrieve. Algolia limits the maximum length per request.
First log entry to retrieve. The most recent entries are listed first. Use this for pagination to skip earlier entries.
Index for which to retrieve log entries. By default, log entries are retrieved for all indices. Specify an index name to filter logs for a specific index.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_NO_CLICK_RATETool 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.
Input parameters
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia's segment documentation.
Index name to retrieve no-click rate for.
End date of the period to analyze, in YYYY-MM-DD format.
Start date of the period to analyze, in YYYY-MM-DD format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_NO_RESULTS_RATETool 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.
Input parameters
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia's segment documentation.
Index name to retrieve no results rate for.
End date of the period to analyze, in YYYY-MM-DD format.
Start date of the period to analyze, in YYYY-MM-DD format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_NO_RESULTS_SEARCHESTool to retrieve the most frequent searches that produced zero results. Use when analyzing search gaps or identifying content opportunities to improve search experience.
Input parameters
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia's segment documentation.
Index name to retrieve no-results searches for.
Number of items to return.
Position of the first item to return.
End date of the period to analyze, in YYYY-MM-DD format.
Start date of the period to analyze, in YYYY-MM-DD format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_OBJECT_POSITIONTool to retrieve an object’s position in a result set. Use when debugging relevance after performing a search query.
Input parameters
Full JSON response from a previous Algolia search, containing the 'hits' list.
The objectID of the record to locate in the results.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_OBJECTSTool to retrieve multiple records from an index. Use when you need to batch-fetch several objectIDs in one call.
Input parameters
Array of sub-requests, each with indexName and objectID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_PURCHASE_RATETool 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.
Input parameters
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia's segment documentation.
Index name to retrieve purchase rate for.
End date of the period to analyze, in YYYY-MM-DD format.
Start date of the period to analyze, in YYYY-MM-DD format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Recommend model type (related-products, bought-together, trending-facets, or trending-items).
Unique record identifier of the rule to retrieve.
Name of the index on which to perform the operation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Recommend model to check task status for. Must be one of: related-products, bought-together, trending-facets, or trending-items.
Unique task identifier returned from a previous Recommend operation (e.g., batch recommend rules).
Name of the index on which to perform the operation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Unique record identifier.
Name of the index on which to perform the operation.
Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_REVENUETool to retrieve revenue data from Algolia Analytics. Use when analyzing revenue metrics and conversion tracking for search results.
Input parameters
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia documentation on segmenting analytics data.
Index name to retrieve revenue data for.
End date of the period to analyze, in YYYY-MM-DD format.
Start date of the period to analyze, in YYYY-MM-DD format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_RULETool to retrieve a specific rule by its objectID from an index. Use when you need to inspect a rule's configuration, conditions, and consequences.
Input parameters
Unique identifier of the rule to retrieve.
Name of the Algolia index to retrieve the rule from.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_SEARCHES_COUNTTool 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.
Input parameters
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia's segment documentation.
Index name to retrieve searches count for.
End date of the period to analyze, in YYYY-MM-DD format.
Start date of the period to analyze, in YYYY-MM-DD format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_SEARCHES_NO_CLICKSTool 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.
Input parameters
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia's segment documentation.
Index name to retrieve no-click searches for.
Number of items to return.
Position of the first item to return.
End date of the period to analyze, in YYYY-MM-DD format.
Start date of the period to analyze, in YYYY-MM-DD format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_SETTINGSTool to retrieve the settings of a specified index. Use when you need to inspect index configurations after creation or update.
Input parameters
Name of the index whose settings are being retrieved
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Region for the Algolia Ingestion API endpoint (e.g., 'us', 'eu'). The API will be called at https://data.{region}.algolia.com
Unique identifier of the source to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_SYNONYMTool to retrieve a specific synonym by its objectID. Use when you need to fetch details of an existing synonym from an index.
Input parameters
Unique identifier of a synonym object.
Name of the index on which to perform the operation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_TASK_STATUSTool to check the status of an asynchronous task. Use when you need to verify completion of operations like adding or deleting records.
Input parameters
Unique task identifier.
Name of the index on which to perform the operation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_TASK_V1Tool to retrieve a task V1 from Algolia Ingestion API. Use when you need to fetch details about a specific task. Note: This API is deprecated but still functional.
Input parameters
Unique identifier of a task.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_TOP_COUNTRIESTool 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.
Input parameters
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia's segment documentation.
Index name to retrieve top countries for.
Number of items to return.
Position of the first item to return.
End date of the period to analyze, in YYYY-MM-DD format.
Start date of the period to analyze, in YYYY-MM-DD format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia documentation on segmenting analytics data.
Name of the Algolia index to retrieve filter attributes for.
Number of items to return.
Position of the first item to return.
Search query to filter results.
End date of the period to analyze, in YYYY-MM-DD format.
Start date of the period to analyze, in YYYY-MM-DD format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia documentation on segmenting analytics data.
Index name to retrieve filter values from.
Number of items to return. Default is 10.
Position of the first item to return. Default is 0.
Search query to filter results.
End date of the period to analyze, in YYYY-MM-DD format.
Attribute name to retrieve top filter values for.
Start date of the period to analyze, in YYYY-MM-DD format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia's segment documentation.
Index name to retrieve top filters for searches with no results.
Number of items to return.
Position of the first item to return.
Search query string to filter results.
End date of the period to analyze, in YYYY-MM-DD format.
Start date of the period to analyze, in YYYY-MM-DD format.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia's documentation on segmenting analytics data.
Index name to retrieve top hits for.
Number of items to return. Default is 10, maximum is 1000.
Position of the first item to return. Default is 0.
Search query to filter top hits.
End date of the period to analyze, in YYYY-MM-DD format.
Start date of the period to analyze, in YYYY-MM-DD format.
Whether to include metrics related to click and conversion events in the response. When true, adds click-through rate, conversion rate, and related metrics.
Whether to include metrics related to revenue events in the response. When true, adds add-to-cart rate, purchase rate, and revenue metrics.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_TOP_SEARCHESTool 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 behavior and identifying trending queries.
Input parameters
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia's documentation on segmenting analytics data.
Index name to retrieve top searches for.
Number of items to return. Default is 10.
Position of the first item to return. Default is 0.
End date of the period to analyze, in YYYY-MM-DD format.
Attribute by which to order the response items.
Sorting direction of the results.
Start date of the period to analyze, in YYYY-MM-DD format.
Whether to include metrics related to click and conversion events in the response. When true, adds click-through rate, conversion rate, and click position metrics.
Whether to include metrics related to revenue events in the response. When true, adds add-to-cart rate, purchase rate, and revenue metrics.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_TRANSFORMATIONTool 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.
Input parameters
Algolia ingestion API region. Valid values: 'us', 'eu'.
Unique identifier (UUID) of the transformation to retrieve.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
End date for the statistics period in ISO 8601 timestamp format. Must be in format: YYYY-MM-DDTHH:MM:SS.sssZ (e.g., '2026-02-12T23:59:59.999Z'). Required parameter for all usage queries.
Start date for the statistics period in ISO 8601 timestamp format. Must be in format: YYYY-MM-DDTHH:MM:SS.sssZ (e.g., '2026-02-05T00:00:00.000Z'). Required parameter for all usage queries.
Type of statistic to retrieve. Can be a single metric or comma-separated list of metrics. Common metrics include: 'search_operations', 'total_search_requests', 'queries_operations', 'multi_queries_operations', 'records', 'data_size', 'file_size', 'max_qps', 'used_search_capacity', 'avg_processing_time', '90p_processing_time', '99p_processing_time'. Use '*' to retrieve all available metrics grouped by category.
Time granularity for the statistics. Must be either 'hourly' (max 7 days range) or 'daily' (max 365 days range). Defaults to 'daily' if not specified.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_USAGE_FOR_INDEXTool 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 hourly and daily aggregation granularity.
Input parameters
Upper bound timestamp in ISO 8601 format (e.g., '2026-02-12T23:59:59Z'). Defines the end of the time period for which to retrieve statistics.
The name of the index for which to retrieve usage statistics.
Lower bound timestamp in ISO 8601 format (e.g., '2026-01-13T00:00:00Z'). Defines the start of the time period for which to retrieve statistics.
One or more comma-separated metric names to retrieve. Valid values include: queries_operations, records, data_size, avg_processing_time, 90p_processing_time, 99p_processing_time, multi_queries_operations, acl_operations, total_synonym_operations, total_rules_operations, max_qps, region_max_qps, degraded_queries_ssd_used_queries_impact, used_search_capacity, and more. Multiple statistics can be requested by separating them with commas (e.g., 'records,avg_processing_time').
Granularity of usage data aggregation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_USERSTool 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.
Input parameters
Limit the number of users in the response. The value of this parameter ranges from 1 to 1000.
Filter users by end date and time, in RFC 3339 format. Only users that were updated before this date will be returned.
Filter users by matching indices. If multiple indices are passed, returned users will match all indices.
Filter users by affinity name and value. If multiple values are passed, returned users will match all values.
Filter users by start date and time, in RFC 3339 format. Only users that were updated after this date will be returned.
Reference for the next page, when navigating forward using pagination. Can't be used in the same request as previousPageToken.
Reference for the previous page, when navigating backward using pagination. Can't be used in the same request as nextPageToken.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_GET_USERS_COUNTTool 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.
Input parameters
Tags by which to segment the analytics. You can combine multiple tags with OR and AND. Tags must be URL-encoded. For more information, see Algolia's documentation on segment analytics data.
Index name to retrieve user count for.
End date of the period to analyze, in YYYY-MM-DD format. If omitted, defaults to current date.
Start date of the period to analyze, in YYYY-MM-DD format. If omitted, defaults to 30 days before current date.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_INDEX_EXISTSTool 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: IndexExists(index_name='products').
Input parameters
Name of the Algolia index to check (e.g., 'products')
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_INIT_INSIGHTSTool to initialize the Algolia Insights API client. Use before sending any Insights events.
Input parameters
Insights API endpoint region: 'us' for insights.algolia.io or 'eu' for insights.eu.algolia.com.
Whether to store the userToken in a cookie for subsequent calls.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_LIST_AB_TESTSTool 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.
Input parameters
Number of items to return. Maximum is 1000.
Position of the first item to return. Use for pagination.
Index name prefix. Only A/B tests for indices starting with this string are included in the response.
Index name suffix. Only A/B tests for indices ending with this string are included in the response.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_LIST_API_KEYSTool 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.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_LIST_AUTHENTICATIONSTool to list authentication resources from Algolia. Use when you need to retrieve available authentication configurations for sources or destinations.
Input parameters
Page number of the paginated API response. Must be at least 1.
Sort field options for listing authentications.
Type of authentication resource to retrieve. Can include multiple types such as 'basic', 'oauth', etc.
Sort order options.
Ecommerce platform for which to retrieve authentications. Can include multiple platforms such as 'commercetools', 'none', etc.
Number of items per page. Must be between 1 and 100.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_LIST_DESTINATIONSTool to list destinations in Algolia. Use when you need to retrieve all destinations or filter them by type, authentication ID, or transformation ID.
Input parameters
Page number of the paginated API response.
Enum for sort properties.
Destination type to filter by. Can specify multiple types.
Enum for sort order.
Number of items per page.
Authentication ID used by destinations. Can specify multiple IDs.
Get the list of destinations used by a transformation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_LIST_INDICESTool 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.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_LIST_INGESTION_TASKSTool 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, and enabled status, with pagination and sorting.
Input parameters
Page number of the paginated API response (1-indexed).
Property by which to sort the list of tasks.
Sort order of the response.
Actions for filtering the list of tasks. Possible values: save, replace, partial, append.
Filter the list of tasks by the enabled status. Set to true for enabled tasks, false for disabled.
Source IDs for filtering the list of tasks. Provide a list of source UUIDs.
Filters the tasks with the specified source type. Example: json, commercetools.
Type of task trigger for filtering. Possible values: onDemand, schedule, subscription, streaming.
Number of items per page. Must be between 1 and 100. Default is 10.
Destination IDs for filtering the list of tasks. Provide a list of destination UUIDs.
Filter tasks by email notification settings. If specified, only returns tasks with notifications.email.enabled set to this value.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Analytics region for your Algolia application. Must be 'us' or 'eu'. Check your region in the Infrastructure > Analytics section of the Algolia dashboard.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_LIST_RUNSTool to list task runs. Use when you need to retrieve and monitor task execution status, filter by time range, or paginate through run history.
Input parameters
Page number of the paginated API response.
Property by which to sort the list of task runs.
Run type for filtering the list of task runs.
Sort order for the list of task runs.
Run status for filtering the list of task runs.
Task ID for filtering the list of task runs.
Date and time for the latest run to retrieve, in RFC 3339 format. By default, the current day is used.
Date and time for the earliest run to retrieve, in RFC 3339 format. By default, the current day minus seven days is used.
Number of items per page.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Page number of the paginated API response (1-indexed).
Property by which to sort the list of sources.
Source type filter. Some sources require authentication. Example: \['commercetools', 'bigcommerce'\]
Sort order of the response.
Algolia ingestion API region. Valid values: 'us', 'eu', 'de'.
Number of items per page. Must be between 1 and 100.
Authentication IDs of the sources to retrieve. Use 'none' to return sources without authentication.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_LIST_TRANSFORMATIONSTool to list all transformations in Algolia Ingestion API. Use when you need to retrieve transformation configurations, filter by type, or paginate through transformation lists.
Input parameters
Page number of the paginated API response. Must be at least 1.
Sort property for transformations list.
Type of transformation.
Sort order for transformations list.
Number of items per page. Must be between 1 and 100. Defaults to 10.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_PARTIAL_UPDATE_OBJECTSTool 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.
Input parameters
List of objects to update. Each entry must include `objectID` and any additional fields you wish to change; you can also set `createIfNotExists` per object.
Name of the Algolia index where the objects live.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_PUSH_TASKTool 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.
Input parameters
When true, the push operation will be synchronous and the API will wait for the ingestion to finish before responding.
Which indexing operation to perform: - addObject: adds records to an index (with auto-generated object ID) - updateObject: adds or replaces records in an index - partialUpdateObject: adds or updates attributes (creates if not exists) - partialUpdateObjectNoCreate: same as partialUpdateObject but doesn't create new records - deleteObject: delete records from an index - delete: delete an index - clear: delete all records from an index
Unique identifier of the task (UUID format).
Array of records to push. Each record must include an 'objectID' field. Additional fields depend on your index schema. Note: tasks with source type 'json' cannot use the push endpoint.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_REPLACE_ALL_RULESTool to push a new set of rules, erasing previous ones. Use when you need zero-downtime atomic replacement of all rules in an index.
Input parameters
Array of rule objects to replace all existing rules.
Name of the Algolia index to replace rules for.
Additional request options sent as query parameters.
Also apply the replacement to replica indices.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_REPLACE_TASKTool 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.
Input parameters
Cron expression for the task's schedule.
Configuration of the task, depending on its type. Can be streaming input (with mapping), docker streams (with streams array), or Shopify input (with metafields and market).
Action to perform on the Algolia index.
Date and time when the last cursor was created, in RFC 3339 format.
Unique identifier of a task.
Whether the task is enabled.
Set of rules for a task.
Universally unique identifier (UUID) of a destination resource.
Notification settings for a task.
Maximum accepted percentage of failures for a task run to finish successfully.
Action to perform on the Algolia index.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_RESTORE_API_KEYTool to restore a deleted API key within 72 hours of deletion. Use when you need to recover an accidentally deleted API key.
Input parameters
The API key to restore. Must have been deleted within the last 72 hours.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_RUN_TASK_V1Tool to run a task V1 from Algolia Ingestion API. Use when you need to manually trigger a task execution. Note: This API is deprecated but still functional.
Input parameters
Unique identifier of a task.
Additional information that will be passed to the created run.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Whether the rule is active. Defaults to true.
Time periods when the rule is active, specified as Unix timestamps.
Unique identifier for the rule. This will be used as the rule's objectID.
List of conditions that trigger the rule. Some consequences don't require conditions. Max 25 conditions.
Name of the index in which to save the rule.
Effect of the rule when conditions are met. Must include at least one consequence property.
Human-readable description of the rule's purpose.
Whether to apply changes to replica indices. Defaults to false.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_SAVE_SYNONYMTool to add or update a synonym in the specified index. Use when you need programmatic upsert of search synonyms after index creation.
Input parameters
Synonym object payload defining type and values.
Unique identifier for the synonym object. Must be specified and match the synonym objectID.
Name of the index in which to save the synonym.
Whether to forward the synonym update to all replicas.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_SAVE_SYNONYMSTool 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.
Input parameters
List of synonym objects to create or replace. Each must have an objectID and type.
Name of the index on which to perform the operation.
Whether changes are applied to replica indices. Default is false.
Whether to replace all synonyms in the index with the ones sent with this request. Default is false.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_SEARCH_AUTHENTICATIONSTool to search for authentication resources by IDs in Algolia. Use when you need to retrieve multiple specific authentication configurations by their IDs.
Input parameters
List of authentication IDs (UUIDs) to search for. Must contain at least one ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_SEARCH_DESTINATIONSTool to search for specific destinations by their IDs. Use when you need to retrieve multiple destinations at once by providing their unique identifiers.
Input parameters
List of destination IDs (UUIDs) to search for. At least one destination ID must be provided.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Page of search results to retrieve (zero-based).
Search query string to match dictionary entries. Empty string returns all entries.
Enum for ISO codes of supported languages.
Number of hits per page. Minimum 1, maximum 1000.
Dictionary type in which to search: 'plurals', 'stopwords', or 'compounds'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Search parameters as a URL-encoded query string.
Facet attribute in which to search for values. This attribute must be included in the 'attributesForFaceting' index setting with the 'searchable()' modifier.
Name of the index on which to perform the operation.
Text to search inside the facet's values.
Maximum number of facet values to return when searching for facet values.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Search query string. Empty string fetches all records. Max length is 512 characters. When searching by URL, strip query params and fragments to match stored paths; validate hits by comparing the URL field to the full target URL.
Name of the Algolia index to search (e.g., 'contacts')
Additional Algolia search parameters as key-value pairs, e.g., {'hitsPerPage': 10, 'filters': 'category:book'}.
Optional request-level options such as extra headers or query params.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_SEARCH_MULTIPLE_INDICESTool to perform searches across multiple indices in a single call. Use when you need to batch multiple index queries into one API request.
Input parameters
List of search queries to perform on multiple indices.
Search strategy to use: 'none' or 'stopIfEnoughMatches'.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_SEARCH_RECOMMEND_RULESTool 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.
Input parameters
Requested page of the API response. Page numbering starts at 0.
Recommend model type (related-products, bought-together, trending-facets, or trending-items).
Search query to filter rules. Use an empty string to list all rules for this recommendation scenario.
Include facets and facet values in the response. Use \['*'\] to include all facets.
Only search for rules with matching context.
Whether to only show rules where the value of their enabled property matches this parameter. If absent, show all rules, regardless of their enabled property.
Filter expression. This only searches for rules matching the filter expression.
Name of the index on which to perform the operation.
Maximum number of hits per page (1-1000). Algolia uses page and hitsPerPage to control how search results are displayed.
Maximum number of values to return for each facet (1-1000).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_SEARCH_SOURCESTool to search for sources by IDs in Algolia Ingestion API. Use when you need to retrieve multiple specific data sources by their IDs.
Input parameters
List of source IDs (UUIDs) to search for. Must contain at least one ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_SEARCH_SYNONYMSTool to search for synonyms in the specified index. Use when you need to retrieve synonyms matching a query or filter by type.
Input parameters
Zero-based page number to retrieve.
Filter by synonym type: 'oneWaySynonym', 'synonym', 'placeholder', 'altCorrection1', or 'altCorrection2'.
Keywords to match in synonyms.
Name of the Algolia index to search for synonyms.
Number of synonyms to return per page.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_SEARCH_TASKS_V1Tool to search for tasks V1 from Algolia Ingestion API. Use when you need to retrieve details about multiple specific tasks by their IDs. Note: This API is deprecated.
Input parameters
List of task UUIDs to search for.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_SEARCH_TRANSFORMATIONSTool to search for transformations by IDs in Algolia Ingestion API. Use when you need to retrieve multiple specific transformation configurations by their IDs.
Input parameters
List of transformation IDs (UUIDs) to search for. Must contain at least one ID.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Configuration for disabling or enabling built-in Algolia dictionary entries (stopwords, plurals, compounds) for specific languages.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Algolia personalization API region. Valid values: 'us', 'eu'.
Scores associated with each event. The higher the scores, the higher the impact of those events on the personalization of search results.
Scores associated with each facet. The higher the scores, the higher the impact of those facets on the personalization of search results.
Impact of personalization on the search results. If set to 0, personalization has no impact on the search results. Value must be between 0 and 100.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Key/value mapping of settings parameters. Only specified keys are overridden; unspecified keys remain unchanged. Use null to reset a setting to its default.
Name of the index to update.
Whether to forward these settings to all existing replica indices. Replicas must already exist; cannot create and forward in a single call.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_STOP_AB_TESTTool 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.
Input parameters
Unique A/B test identifier.
Algolia analytics API region. Valid values: 'us', 'de'. Defaults to 'de' (EU region).
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Deprecated field. The transformation code as a string. Use 'input' field with proper 'type' instead. If provided without 'type' or 'input', this will be used for backward compatibility.
Type of transformation.
The input for the transformation. Use TransformationCodeInput for code-based transformations or TransformationNoCodeInput for no-code transformations. Required if 'code' field is not provided.
The record to apply the transformation to. This is the sample data that will be transformed. Should be a JSON object representing your data structure.
Optional array of authentication resources to use with the transformation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
(Deprecated) Transformation code. Use the 'input' field with proper 'type' instead.
Type of transformation to test.
The transformation input, which can be either code or no-code configuration. If provided, this will be used to test the transformation.
The sample record object to apply the transformation to. Must be a valid JSON object.
Optional array of authentication configurations for the transformation.
Unique identifier (UUID) of the transformation to test.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Permissions that determine the type of API requests this key can make. The required ACL is listed in each endpoint's reference. For more information, see access control list (ACL).
The API key to update.
Index names or patterns that this API key can access. By default, an API key can access all indices in the same application. You can use leading and trailing wildcard characters (*): 'dev_*' matches all indices starting with 'dev_', '*_dev' matches all indices ending with '_dev', '*_products_*' matches all indices containing '_products_'.
Allowed HTTP referrers for this API key. By default, all referrers are allowed. You can use leading and trailing wildcard characters (*): 'https://algolia.com/*' allows all referrers starting with 'https://algolia.com/', '*.algolia.com' allows all referrers ending with '.algolia.com', '*algolia.com*' allows all referrers in the domain 'algolia.com'. Like all HTTP headers, referrers can be spoofed. Don't rely on them to secure your data.
Duration (in seconds) after which the API key expires. By default, API keys don't expire.
Description of an API key to help you identify this API key.
Maximum number of results this API key can retrieve in one query. By default, there's no limit.
Query parameters to add when making API requests with this API key. To restrict this API key to specific IP addresses, add the restrictSources parameter. You can only add a single source, but you can provide a range of IP addresses.
Maximum number of API requests allowed per IP address or user token per hour. If this limit is reached, the API returns an error with status code 429. By default, there's no limit.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_UPDATE_AUTHENTICATIONTool to update an authentication resource in Algolia. Use when you need to modify the name or credentials of an existing authentication configuration.
Input parameters
Descriptive name for the resource.
Authentication credentials object. The structure varies based on the authentication type. Can include fields like clientEmail/privateKey (googleServiceAccount), username/password (basic), key (apiKey), client_id/client_secret/code/scope/url (oauth), apiKey/appID (algolia), or custom key-value pairs.
Unique identifier of an authentication resource.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Analytics region for your Algolia application (us or eu). Must match your application's analytics region configured in the Algolia dashboard under Infrastructure > Analytics
List of words or regular expressions to exclude from query suggestions
Name of the Query Suggestions index to update
Languages for deduplicating singular/plural suggestions. Set to true to enable for all languages, or provide an array of specific language codes (e.g., \['en', 'fr'\])
Array of source index configurations to use for generating query suggestions. At least one source index is required
Whether to enable personalized query suggestions based on user behavior. Default is false
Whether to include suggestions with special characters. Default is false
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_UPDATE_DESTINATIONTool to update a destination in Algolia Ingestion API. Use when you need to modify an existing destination's configuration, name, type, or associated transformations.
Input parameters
Descriptive name for the resource.
Destination type enum.
Input configuration for updating a destination.
Unique identifier of a destination.
Universally unique identifier (UUID) of an authentication resource.
List of transformation IDs to associate with the destination.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_UPDATE_DICTIONARY_ENTRIESTool to add or delete dictionary entries in Algolia dictionaries. Use when you need to batch modify stopwords, plurals, or compound word entries.
Input parameters
List of add or delete operations to perform on the dictionary entries.
Type of dictionary to modify: 'plurals' for plural forms, 'stopwords' for common words to exclude, 'compounds' for compound word handling.
Whether to replace all existing custom entries in the dictionary with the ones in this request. Default is false.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Unique record identifier.
Attributes to add or update in the record. Existing attributes with the same keys will be overwritten, new attributes will be added, and unspecified attributes remain unchanged.
Name of the index on which to perform the operation.
Whether to create a new record if it doesn't exist. If true, creates the record when objectID is not found. If false, only updates existing records.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Descriptive name of the source.
Input configuration for the source. The structure varies based on source type. Common fields include: url (string), projectID (string), datasetID (string), tablePrefix (string), table (string), customSQLRequest (string), uniqueIDColumn (string), method (string), delimiter (string), mapping (object), customFields (object), fallbackIsInStockValue (boolean), locales (array), productQueryPredicate (string), storeKeys (array), useImagesObjects (boolean), configuration (object), featureFlags (object).
Region for the Algolia Ingestion API endpoint (e.g., 'us', 'eu'). The API will be called at https://data.{region}.algolia.com
Unique identifier of the source to update.
Universally unique identifier (UUID) of an authentication resource.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
ALGOLIA_UPDATE_TASKTool 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.
Input parameters
Cron expression for the task's schedule.
Configuration of the task, depending on its type. Can be streaming input (with mapping), docker streams (with streams array), or Shopify input (with metafields and market).
Unique identifier of a task.
Whether the task is enabled.
Set of rules for a task.
Universally unique identifier (UUID) of a destination resource.
Notification settings for a task.
Maximum accepted percentage of failures for a task run to finish successfully.
Action to perform on the Algolia index. Valid values: replace, save, partial, partialNoCreate, append.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Deprecated field. Use the 'input' field with proper 'type' instead to specify the transformation code.
The uniquely identified name of your transformation.
Type of transformation.
The input for the transformation, which can be either code or a no-code configuration.
A descriptive name for your transformation explaining what it does.
Unique identifier (UUID) of the transformation to update.
The authentications (UUIDs) associated with the transformation.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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
Descriptive name for the source.
Type of the data source to validate.
Input configuration for the source. The structure varies based on source type. Common fields include: url (string), projectID (string), datasetID (string), tablePrefix (string), table (string), customSQLRequest (string), uniqueIDColumn (string), method (string), delimiter (string), mapping (object), customFields (object/array), fallbackIsInStockValue (boolean), locales (array), productQueryPredicate (string), storeKeys (array), useImagesObjects (boolean), configuration (object), image (string), channel (object), productMetafields (array), variantMetafields (array), dataType (string), storeHash (string), projectKey (string).
Region for the Algolia Ingestion API endpoint. The API will be called at https://data.{region}.algolia.com
Universally unique identifier (UUID) of an authentication resource.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
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.
Input parameters
Descriptive name of the source to validate.
Input configuration for the source. The structure varies based on source type. Common fields include: url (string), projectID (string), datasetID (string), tablePrefix (string), table (string), customSQLRequest (string), uniqueIDColumn (string), method (string), delimiter (string), mapping (object), customFields (object), fallbackIsInStockValue (boolean), locales (array), productQueryPredicate (string), storeKeys (array), useImagesObjects (boolean), configuration (object), featureFlags (object).
Region for the Algolia Ingestion API endpoint (e.g., 'us', 'eu'). The API will be called at https://data.{region}.algolia.com
Unique identifier of the source to validate.
Universally unique identifier (UUID) of an authentication resource.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
No publicly available marketplace agent is found using this tool yet. There are 67 agents privately built on Nagent that already use Algolia.
Build on Nagent
Connect Algolia to any Nagent agent in minutes — no API key management, no boilerplate. Just configure and deploy.
The five questions agent builders ask before adopting a new integration.
Open the External Integrations panel inside Nagent (app.nagent.ai/externalIntegration), find Algolia, and click "Connect Now." You'll authenticate with an API key — Nagent handles credential storage and refresh automatically. Once connected, Algolia is available to any agent in your workspace.
No. Nagent provides no-code integration for every tool. Once Algolia is connected, you configure its 133 actions directly in the agent builder UI — no API calls, no boilerplate, no schema management.
Helix — Nagent's agentic agent builder — lets you drop Algolia steps into any workflow visually. Pick an action (e.g., one of those listed above), fill in the inputs (Helix knows the required vs. optional schema for each parameter), and connect it to upstream/downstream steps. Triggers run as the entry point of an agent, so when a Algolia event fires, the agent kicks off automatically.
Every Algolia action and trigger ships with a fully-typed schema — input parameters with name, type, required flag, and description, plus the output payload shape. The schemas are documented in the sections above. Helix uses these schemas to validate your configuration at build time and to type-check the data flowing between steps.
Yes. While Algolia ships with 133 pre-built developer tools actions, you can layer custom logic around them inside Helix — pre/post-processing steps, conditional branches, retries, or stitching Algolia together with other connected tools. For deeper customization, talk to our team about Nagent's Agentic AI Lab — forward-deployed engineers who build Algolia-based workflows tailored to your business.