New to Corsair? See API access, authentication, and error handling.
Ab Tests
addAbTest
abTests.addAbTest
Tool to create an A/B test comparing search performance between two index variants. Use when you need to test different search configurations, ranking strategies, or index settings and measure their impact on user behavior.
Risk: write
variants full type
variants full type
any
deleteAbTest
abTests.deleteAbTest
Tool to delete an A/B test by its unique identifier. Use when you need to permanently remove an A/B test configuration.
Risk: destructive · Irreversible
Output:
any
getAbTest
abTests.getAbTest
Tool to retrieve detailed information about an A/B test by its ID. Use when you need to check A/B test status, performance metrics, or configuration details.
Risk: read
Output:
any
listAbTests
abTests.listAbTests
Tool to list all A/B tests configured for this application. Use when you need to view existing A/B tests, check their status, or retrieve test IDs for further operations.
Risk: read
Output:
any
stopAbTest
abTests.stopAbTest
Tool to stop an A/B test by its unique identifier. Use when you need to halt an active A/B test. Note that stopped A/B tests cannot be restarted.
Risk: write
Output:
any
Analytics
getAddToCartRate
analytics.getAddToCartRate
Tool to retrieve add-to-cart rate metrics for e-commerce search analytics. Use when you need to analyze conversion effectiveness and user purchasing behavior for an index, including daily breakdowns.
Risk: read
Output:
any
getAverageClickPosition
analytics.getAverageClickPosition
Tool to retrieve average click position metrics from Algolia Analytics. Use when analyzing user engagement and click behavior for search results.
Risk: read
Output:
any
getClickPositions
analytics.getClickPositions
Tool to retrieve the distribution of clicks by position from Algolia Analytics. Use when analyzing which search result positions receive the most user engagement.
Risk: read
Output:
any
getClickThroughRate
analytics.getClickThroughRate
Tool to retrieve click-through rate (CTR) for searches with at least one click event. Use when you need to analyze search effectiveness and user engagement metrics for an index, including daily breakdowns.
Risk: read
Output:
any
getConversionRate
analytics.getConversionRate
Tool to retrieve conversion rate for searches with conversion events. Use when you need to analyze conversion effectiveness and user behavior metrics for an index, including daily breakdowns.
Risk: read
Output:
any
getNoClickRate
analytics.getNoClickRate
Tool to retrieve the rate of searches that received no clicks. Use when you need to analyze search effectiveness and identify queries where users didn’t engage with any results.
Risk: read
Output:
any
getNoResultsRate
analytics.getNoResultsRate
Tool to retrieve the fraction of searches that didn’t return any results. Use when you need to analyze search effectiveness and identify queries that fail to return results.
Risk: read
Output:
any
getNoResultsSearches
analytics.getNoResultsSearches
Tool to retrieve the most frequent searches that produced zero results. Use when analyzing search gaps or identifying content opportunities to improve search experience.
Risk: read
Output:
any
getPurchaseRate
analytics.getPurchaseRate
Tool to retrieve purchase rate metrics for searches that led to purchase events. Use when you need to analyze conversion effectiveness and purchase behavior for an index, including daily breakdowns.
Risk: read
Output:
any
getRevenue
analytics.getRevenue
Tool to retrieve revenue data from Algolia Analytics. Use when analyzing revenue metrics and conversion tracking for search results.
Risk: read
Output:
any
getSearchesCount
analytics.getSearchesCount
Tool to retrieve the number of searches within a time range, including a daily breakdown. Use when analyzing search volume and traffic patterns for an index.
Risk: read
Output:
any
getSearchesNoClicks
analytics.getSearchesNoClicks
Tool to retrieve top searches that did not receive any clicks. Use when analyzing search queries that may need optimization, such as queries with poor results or missing content.
Risk: read
Output:
any
getTopCountries
analytics.getTopCountries
Tool to retrieve top countries by search volume for a specified index. Use when you need to analyze geographic distribution of searches and understand where your users are searching from.
Risk: read
Output:
any
getTopFilterAttributes
analytics.getTopFilterAttributes
Tool to retrieve top filter attributes from Algolia Analytics. Use when analyzing which filters are most commonly used by users in searches.
Risk: read
Output:
any
getTopFilterForAttribute
analytics.getTopFilterForAttribute
Tool to retrieve top filter values for a specific attribute from Algolia Analytics. Use when analyzing which filter values are most commonly used for a given attribute in search queries.
Risk: read
Output:
any
getTopFiltersNoResults
analytics.getTopFiltersNoResults
Tool to retrieve top filters for searches that returned no results from Algolia Analytics. Use when analyzing which filters are commonly applied to searches that yield zero results, helping identify potential catalog or filtering issues.
Risk: read
Output:
any
getTopHits
analytics.getTopHits
Tool to retrieve the object IDs of the most frequent search results from Algolia Analytics. Returns up to 1,000 top hits ranked by frequency, optionally including click analytics (CTR, conversion rates) and revenue metrics. Use when analyzing which results appear most often in searches.
Risk: read
Output:
any
getTopSearches
analytics.getTopSearches
Tool to retrieve the most popular searches from Algolia Analytics. Returns search queries ranked by frequency, optionally including click analytics (CTR, conversion rates) and revenue metrics. Use when analyzing search behavior and identifying trending queries.
Risk: read
Output:
any
getUsersCount
analytics.getUsersCount
Tool to retrieve the number of unique users within a time range, including daily breakdown. Use when you need to analyze user engagement metrics for a specific index over a date range.
Risk: read
Output:
any
Api Keys
createApiKey
apiKeys.createApiKey
Tool to create a new API key with specific permissions and restrictions. Use when you need to generate API keys with custom ACL permissions, index restrictions, rate limits, or expiration times.
Risk: write
Output:
any
deleteApiKey
apiKeys.deleteApiKey
Tool to delete an API key. Use when you need to revoke or remove an existing API key from your Algolia application.
Risk: destructive · Irreversible
Output:
any
getApiKey
apiKeys.getApiKey
Tool to retrieve the permissions and details of a specific API key. Use when you need to inspect an API key’s ACL, restrictions, or other settings.
Risk: read
Output:
any
listApiKeys
apiKeys.listApiKeys
Tool to list all API keys associated with your Algolia application, including their permissions and restrictions. Use when you need to audit API key usage, check permissions, or manage access control. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | data | string | Yes | Data from the action execution | | error | string | No | Error if any occurred during the execution of the action | | successful | boolean | Yes | Whether or not the action execution was successful or not |
Risk: read
Output:
any
restoreApiKey
apiKeys.restoreApiKey
Tool to restore a deleted API key within 72 hours of deletion. Use when you need to recover an accidentally deleted API key.
Risk: write
Output:
any
updateApiKey
apiKeys.updateApiKey
Tool to update the permissions and settings of an existing API key. Use when you need to modify ACL permissions, index restrictions, rate limits, or other settings of an existing API key.
Risk: write
Output:
any
Authentications
createAuthentication
authentications.createAuthentication
Tool to create a new authentication resource in Algolia. Use when you need to set up authentication credentials for connecting to sources or destinations in the Algolia ingestion API.
Risk: write
Output:
any
deleteAuthentication
authentications.deleteAuthentication
Tool to delete an authentication resource from Algolia. Use when you need to remove an existing authentication resource by its ID.
Risk: destructive · Irreversible
Output:
any
getAuthentication
authentications.getAuthentication
Tool to retrieve an authentication resource by its ID. Use when you need to fetch details about a specific authentication configuration in Algolia’s ingestion API.
Risk: read
Output:
any
listAuthentications
authentications.listAuthentications
Tool to list authentication resources from Algolia. Use when you need to retrieve available authentication configurations for sources or destinations.
Risk: read
Output:
any
searchAuthentications
authentications.searchAuthentications
Tool to search for authentication resources by IDs in Algolia. Use when you need to retrieve multiple specific authentication configurations by their IDs.
Risk: write
Output:
any
updateAuthentication
authentications.updateAuthentication
Tool to update an authentication resource in Algolia. Use when you need to modify the name or credentials of an existing authentication configuration.
Risk: write
Output:
any
Destinations
createDestination
destinations.createDestination
Tool to create a new destination in Algolia Ingestion API. Use when you need to set up a new destination for data ingestion.
Risk: write
Output:
any
deleteDestination
destinations.deleteDestination
Tool to delete a destination in Algolia Ingestion API. Use when you need to permanently remove a destination by its ID.
Risk: destructive · Irreversible
Output:
any
getDestination
destinations.getDestination
Tool to retrieve a destination by its ID. Use when you need to get details about a specific Algolia destination resource.
Risk: read
Output:
any
listDestinations
destinations.listDestinations
Tool to list destinations in Algolia. Use when you need to retrieve all destinations or filter them by type, authentication ID, or transformation ID.
Risk: read
Output:
any
searchDestinations
destinations.searchDestinations
Tool to search for specific destinations by their IDs. Use when you need to retrieve multiple destinations at once by providing their unique identifiers.
Risk: write
Output:
any
updateDestination
destinations.updateDestination
Tool to update a destination in Algolia Ingestion API. Use when you need to modify an existing destination’s configuration, name, type, or associated transformations.
Risk: write
Output:
any
Dictionaries
getDictionaryLanguages
dictionaries.getDictionaryLanguages
Tool to list available languages for dictionary entries. Use when you need to check which languages support custom dictionary entries (plurals, stopwords, compounds). #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | data | string | Yes | Data from the action execution | | error | string | No | Error if any occurred during the execution of the action | | successful | boolean | Yes | Whether or not the action execution was successful or not |
Risk: read
Output:
any
getDictionarySettings
dictionaries.getDictionarySettings
Tool to retrieve dictionary settings for all dictionaries. Use when you need to check which standard dictionary entries are disabled across different languages. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | data | string | Yes | Data from the action execution | | error | string | No | Error if any occurred during the execution of the action | | successful | boolean | Yes | Whether or not the action execution was successful or not |
Risk: read
Output:
any
searchDictionaryEntries
dictionaries.searchDictionaryEntries
Tool to search dictionary entries in Algolia dictionaries. Use when you need to find stopwords, plurals, or compound words in specific dictionaries.
Risk: write
Output:
any
setDictionarySettings
dictionaries.setDictionarySettings
Tool to update dictionary settings for Algolia. Use when you need to enable or disable built-in stop words, plurals, or compounds for specific languages.
Risk: write
Output:
any
updateDictionaryEntries
dictionaries.updateDictionaryEntries
Tool to add or delete dictionary entries in Algolia dictionaries. Use when you need to batch modify stopwords, plurals, or compound word entries.
Risk: write
Output:
any
Indices
addOrReplaceRecord
indices.addOrReplaceRecord
Tool to add or replace a specific record in an index by objectID. If a record with the given objectID exists, it is replaced; otherwise, a new record is created. Use when you need to upsert an object with a known ID.
Risk: write
Output:
any
addRecord
indices.addRecord
Tool to add a record to an index with auto-generated objectID. Records with matching IDs are replaced. Use when you need to insert a new object into an index.
Risk: write
Output:
any
browseIndex
indices.browseIndex
Tool to retrieve all records from an index. Use when you need to export or iterate through an entire index dataset.
Risk: read
Output:
any
clearObjects
indices.clearObjects
Tool to clear records of an index without affecting settings. Use when you need to completely wipe all objects (e.g., after a bulk reindex) while preserving index configuration.
Risk: destructive · Irreversible
Output:
any
copyIndex
indices.copyIndex
Tool to copy the specified index to a new index. Use when you need to duplicate an existing index including records, settings, synonyms, and rules after confirming source and destination names.
Risk: write
Output:
any
deleteIndex
indices.deleteIndex
Tool to delete the specified index and all its records. Use when you need to permanently remove an index after confirming it’s no longer needed.
Risk: destructive · Irreversible
Output:
any
deleteObjects
indices.deleteObjects
Tool to delete multiple records from an Algolia index. Use when you need to remove multiple objects by their IDs.
Risk: destructive · Irreversible
Output:
any
deleteRecordsByFilter
indices.deleteRecordsByFilter
Tool to delete records matching a filter from an Algolia index. Use when you need to remove multiple records based on filter criteria (e.g., category, tags, numeric ranges). This is a resource-intensive operation.
Risk: destructive · Irreversible
Output:
any
executeBatchOnMultipleIndices
indices.executeBatchOnMultipleIndices
Tool to perform batch operations (add, update, delete) across multiple Algolia indices in a single request. Use when you need to modify records in different indices efficiently. Each operation specifies its target index and action type.
Risk: write
Output:
any
getRecommendTaskStatus
indices.getRecommendTaskStatus
Tool to check the status of a Recommend task. Use when you need to verify if an asynchronous Recommend operation (such as deleting a Recommend rule) has completed.
Risk: read
Output:
any
getRecord
indices.getRecord
Tool to retrieve a specific record from an index by its objectID. Use when you need to fetch a single object’s details.
Risk: read
Output:
any
getSettings
indices.getSettings
Tool to retrieve the settings of a specified index. Use when you need to inspect index configurations after creation or update.
Risk: read
Output:
any
getTaskStatus
indices.getTaskStatus
Tool to check the status of an asynchronous task. Use when you need to verify completion of operations like adding or deleting records.
Risk: read
Output:
any
listIndices
indices.listIndices
Tool to list all indices and their metadata. Use when you need to retrieve index names, sizes, and state before performing operations that depend on index properties. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | data | string | Yes | Data from the action execution | | error | string | No | Error if any occurred during the execution of the action | | successful | boolean | Yes | Whether or not the action execution was successful or not |
Risk: read
Output:
any
partialUpdateObjects
indices.partialUpdateObjects
Tool to partially update multiple records in the specified index. Use when you need to change only selected fields of many objects without replacing entire records. Use after confirming objectIDs and desired updates.
Risk: write
Output:
any
setSettings
indices.setSettings
Tool to update an Algolia index’s settings. Use when you need to configure index behavior before indexing records. Example: set searchableAttributes and customRanking for products index.
Risk: write
Output:
any
updateRecordPartially
indices.updateRecordPartially
Tool to add or update attributes in a single record. Use when you need to modify specific fields without replacing the entire record. Creates a new record if the objectID doesn’t exist (when create_if_not_exists is true).
Risk: write
Output:
any
Insights
clickedObjectIds
insights.clickedObjectIds
Tool to send a click event to Algolia to capture clicked items. Use immediately after a user click outside of search contexts to report click events.
Risk: write
Output:
any
clickedObjectIdsAfterSearch
insights.clickedObjectIdsAfterSearch
Tool to send a click event after a search response. Use when you want to report which items a user clicked in search results.
Risk: write
Output:
any
convertedObjectIds
insights.convertedObjectIds
Tool to send a conversion event for items outside of search context. Use when tracking conversions on category pages or external flows unrelated to Algolia search.
Risk: write
Output:
any
deleteUserToken
insights.deleteUserToken
Tool to delete all events related to a user token from events metrics and analytics. Use when removing user data from Algolia Insights.
Risk: destructive · Irreversible
Output:
any
initInsights
insights.initInsights
Tool to initialize the Algolia Insights API client. Use before sending any Insights events.
Risk: write
Output:
any
Logs
getLogs
logs.getLogs
Tool to retrieve log entries for API requests made to your Algolia application. Use when you need to debug issues, monitor API usage, or analyze search patterns.
Risk: read
Output:
any
Personalization
computeRealtimeUser
personalization.computeRealtimeUser
Tool to compute a user’s real-time personalization profile in Algolia. Use when you need to trigger calculation of personalization data for a specific user. Note: This endpoint is deprecated.
Risk: write
Output:
any
deleteUserProfile
personalization.deleteUserProfile
Tool to delete a user profile from personalization. Use when you need to remove a user’s personalization data and reset their profile.
Risk: destructive · Irreversible
Output:
any
getConfig2
personalization.getConfig2
Tool to retrieve the advanced personalization configuration. Use when you need to check personalization settings, re-ranking impact levels, or profile types for your Algolia application. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | data | string | Yes | Data from the action execution | | error | string | No | Error if any occurred during the execution of the action | | successful | boolean | Yes | Whether or not the action execution was successful or not |
Risk: read
Output:
any
getUsers
personalization.getUsers
Tool to retrieve a list of user profiles from Algolia advanced personalization. Use when you need to fetch user affinities, filter by date ranges, or paginate through user data.
Risk: read
Output:
any
setPersonalizationStrategy
personalization.setPersonalizationStrategy
Tool to define personalization strategy that controls how user behavior affects search results. Use when you need to configure which events and facets influence personalized search rankings.
Risk: write
Output:
any
Query Suggestions
createQsConfig
querySuggestions.createQsConfig
Tool to create a new Query Suggestions configuration for an Algolia index. Use when you need to set up query suggestions to help users discover popular searches. Up to 100 configurations per application are supported.
Risk: write
Output:
any
deleteConfig
querySuggestions.deleteConfig
Tool to delete a Query Suggestions configuration for the specified index. Use when you need to remove a Query Suggestions configuration permanently.
Risk: destructive · Irreversible
Output:
any
getConfig
querySuggestions.getConfig
Tool to retrieve a Query Suggestions configuration by index name. Use when you need to inspect or verify Query Suggestions settings for a specific index.
Risk: read
Output:
any
listQsConfigs
querySuggestions.listQsConfigs
Tool to retrieve all Query Suggestions configurations for an Algolia application. Use when you need to view or audit existing Query Suggestions setups.
Risk: read
Output:
any
updateConfig
querySuggestions.updateConfig
Tool to update an existing Query Suggestions configuration. Use when you need to modify settings for query suggestions on an existing index.
Risk: write
Output:
any
Rules
clearRules
rules.clearRules
Tool to delete all rules in an index. Use when you need to wipe all rules before re-creating them. Use after confirming no critical rules require retention.
Risk: destructive · Irreversible
Output:
any
createOrUpdateRecommendRules
rules.createOrUpdateRecommendRules
Tool to create or update a batch of Recommend Rules in an index. Use when you need to add or modify multiple rules at once for a recommendation model. Each rule is created or updated depending on whether a rule with the same objectID already exists.
Risk: write
rules full type
rules full type
any
deleteRecommendRule
rules.deleteRecommendRule
Tool to delete a Recommend rule from a recommendation scenario. Use when you need to remove a specific rule from an index’s recommend model.
Risk: destructive · Irreversible
Output:
any
deleteRule
rules.deleteRule
Tool to delete the specified rule from an index. Use when you need to permanently remove a rule after confirming its objectID.
Risk: destructive · Irreversible
Output:
any
exportRules
rules.exportRules
Tool to export all rules defined on an index. Use when you need to backup or migrate index rules.
Risk: write
Output:
any
getRecommendRule
rules.getRecommendRule
Tool to retrieve a Recommend rule that was previously created in the Algolia dashboard. Use when you need to inspect a specific rule’s configuration, conditions, or consequences by its objectID.
Risk: read
Output:
any
getRule
rules.getRule
Tool to retrieve a specific rule by its objectID from an index. Use when you need to inspect a rule’s configuration, conditions, and consequences.
Risk: read
Output:
any
replaceAllRules
rules.replaceAllRules
Tool to push a new set of rules, erasing previous ones. Use when you need zero-downtime atomic replacement of all rules in an index.
Risk: write
rules full type
rules full type
any
saveRule
rules.saveRule
Tool to create or replace a rule in an index. Use when you need to add merchandising rules, query modifications, or conditional search behavior.
Risk: write
Output:
any
searchRecommendRules
rules.searchRecommendRules
Tool to search for Recommend rules in the specified index and model. Use when you need to retrieve rules matching a query, or use an empty query to list all rules for this recommendation scenario.
Risk: write
Output:
any
Runs
listRuns
runs.listRuns
Tool to list task runs. Use when you need to retrieve and monitor task execution status, filter by time range, or paginate through run history.
Risk: read
Output:
any
Search
findObject
search.findObject
Tool to find the first object matching a query or filter in an index. Use when debugging relevance or filter logic after confirming index exists.
Risk: write
Output:
any
getObjectPosition
search.getObjectPosition
Tool to retrieve an object’s position in a result set. Use when debugging relevance after performing a search query.
Risk: write
Output:
any
getObjects
search.getObjects
Tool to retrieve multiple records from an index. Use when you need to batch-fetch several objectIDs in one call.
Risk: write
Output:
any
searchFacetValues
search.searchFacetValues
Tool to search for values of a specified facet attribute. Use when you need to find specific facet values that match a query string. Facet values are sorted by decreasing count by default.
Risk: write
Output:
any
searchIndex
search.searchIndex
Tool to perform a search on a specified Algolia index. Use after confirming the index name. Example: SearchIndex(index_name=‘contacts’, query=‘apple’, search_params={‘hitsPerPage’:10})
Risk: read
Output:
any
searchMultipleIndices
search.searchMultipleIndices
Tool to perform searches across multiple indices in a single call. Use when you need to batch multiple index queries into one API request.
Risk: write
Output:
any
Sources
createSource
sources.createSource
Tool to create a new data source in Algolia Ingestion API. Use when you need to set up a new source for data ingestion from external platforms or custom data feeds.
Risk: write
Output:
any
deleteSource
sources.deleteSource
Tool to delete a source from the Algolia Ingestion API. Use when you need to permanently remove a source after confirming it’s no longer needed.
Risk: destructive · Irreversible
Output:
any
getSource
sources.getSource
Tool to retrieve a source from the Algolia Ingestion API. Use when you need to get details about a specific data source by its ID.
Risk: read
Output:
any
listSources
sources.listSources
Tool to list sources from the Algolia Ingestion API. Use when you need to retrieve available data sources for ingestion pipelines. Supports filtering by type and authentication ID, with pagination and sorting options.
Risk: read
Output:
any
searchSources
sources.searchSources
Tool to search for sources by IDs in Algolia Ingestion API. Use when you need to retrieve multiple specific data sources by their IDs.
Risk: write
Output:
any
updateSource
sources.updateSource
Tool to update a source in the Algolia Ingestion API. Use when you need to modify the name, authentication, or input configuration of an existing data source.
Risk: write
Output:
any
validateSource
sources.validateSource
Tool to validate a source payload before creating it in Algolia. Use when you need to verify that a source configuration is valid before actually creating the source.
Risk: write
Output:
any
validateSourceBeforeUpdate
sources.validateSourceBeforeUpdate
Tool to validate a source update payload in the Algolia Ingestion API. Use when you need to verify that an update to a source configuration is valid before actually updating it.
Risk: write
Output:
any
Synonyms
clearSynonyms
synonyms.clearSynonyms
Tool to delete all synonyms from an index. Use when you need to remove all synonym definitions in one operation.
Risk: destructive · Irreversible
Output:
any
deleteSynonym
synonyms.deleteSynonym
Tool to delete a synonym from a specified index. Use when you need to remove an existing synonym by its objectID.
Risk: destructive · Irreversible
Output:
any
getSynonym
synonyms.getSynonym
Tool to retrieve a specific synonym by its objectID. Use when you need to fetch details of an existing synonym from an index.
Risk: read
Output:
any
saveSynonym
synonyms.saveSynonym
Tool to add or update a synonym in the specified index. Use when you need programmatic upsert of search synonyms after index creation.
Risk: write
Output:
any
saveSynonyms
synonyms.saveSynonyms
Tool to batch create or replace synonyms in an Algolia index. If a synonym with the objectID doesn’t exist, Algolia adds a new one. Use when you need to add or update multiple synonyms at once.
Risk: write
Output:
any
searchSynonyms
synonyms.searchSynonyms
Tool to search for synonyms in the specified index. Use when you need to retrieve synonyms matching a query or filter by type.
Risk: write
Output:
any
Tasks
createIngestionTask
tasks.createIngestionTask
Tool to create a new ingestion task connecting a source to a destination in Algolia. Use when you need to set up data synchronization between a source and an Algolia index.
Risk: write
Output:
any
disableTaskV1
tasks.disableTaskV1
Tool to disable a task V1 in Algolia Ingestion API. Use when you need to disable a specific task. Note: This API is deprecated but still functional.
Risk: write
Output:
any
enableTaskV1
tasks.enableTaskV1
Tool to enable a task V1 in Algolia Ingestion API. Use when you need to activate a previously disabled task. Note: This API is deprecated but still functional.
Risk: write
Output:
any
getAppTask
tasks.getAppTask
Tool to check the status of an application task. Use when you need to verify if a task has completed.
Risk: read
Output:
any
getTaskV1
tasks.getTaskV1
Tool 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.
Risk: read
Output:
any
listIngestionTasks
tasks.listIngestionTasks
Tool to retrieve a list of ingestion tasks from Algolia. Use when you need to fetch configured tasks for ingestion pipelines. Supports filtering by various criteria such as source, destination, trigger type, action, and enabled status, with pagination and sorting.
Risk: read
Output:
any
pushTask
tasks.pushTask
Tool to push records to an Algolia task by task ID. Use when you need to send data to a configured ingestion task. Note: tasks with source type ‘json’ cannot use this endpoint.
Risk: write
Output:
any
replaceTask
tasks.replaceTask
Tool to fully replace a task in Algolia Ingestion API. Use when you need to completely update a task with new configuration, replacing all existing settings.
Risk: write
Output:
any
runTaskV1
tasks.runTaskV1
Tool 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.
Risk: write
Output:
any
searchTasksV1
tasks.searchTasksV1
Tool 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.
Risk: write
Output:
any
updateTask
tasks.updateTask
Tool to partially update a task in Algolia Ingestion API. Use when you need to modify task configuration such as schedule, failure threshold, destination, or notification settings.
Risk: write
Output:
any
Transformations
createTransformation
transformations.createTransformation
Tool to create a new transformation in Algolia Ingestion API. Use when you need to set up data transformations for enriching or modifying records during ingestion.
Risk: write
Output:
any
deleteTransformation
transformations.deleteTransformation
Tool to delete a transformation in Algolia Ingestion API. Use when you need to permanently remove a transformation by its ID.
Risk: destructive · Irreversible
Output:
any
getTransformation
transformations.getTransformation
Tool to retrieve a transformation by its ID from Algolia’s Ingestion API. Use when you need to fetch details about a specific transformation including its code, configuration, and metadata.
Risk: read
Output:
any
listTransformations
transformations.listTransformations
Tool to list all transformations in Algolia Ingestion API. Use when you need to retrieve transformation configurations, filter by type, or paginate through transformation lists.
Risk: read
Output:
any
searchTransformations
transformations.searchTransformations
Tool to search for transformations by IDs in Algolia Ingestion API. Use when you need to retrieve multiple specific transformation configurations by their IDs.
Risk: write
Output:
any
tryTransformation
transformations.tryTransformation
Tool to try a transformation before creating it in Algolia. Use when you need to test transformation code or no-code configurations against sample data to verify they work correctly before deployment.
Risk: write
Output:
any
tryTransformationBeforeUpdate
transformations.tryTransformationBeforeUpdate
Tool to test a transformation before updating it in Algolia Ingestion API. Use when you need to validate transformation code or configuration against sample data before applying it to production.
Risk: write
Output:
any
updateTransformation
transformations.updateTransformation
Tool to update an existing transformation in Algolia Ingestion API. Use when you need to modify transformation settings, code, or configuration for data processing during ingestion.
Risk: write
Output:
any
Usage
getUsage
usage.getUsage
Tool to retrieve Algolia usage statistics over a specified time period. Use when you need to analyze search operations, indexing operations, capacity metrics, or other usage data for an Algolia application. Requires Premium plan or Enterprise add-on access.
Risk: read
Output:
any
getUsageForIndex
usage.getUsageForIndex
Tool to retrieve usage statistics for a specific Algolia index over a time period. Use when you need to analyze index metrics such as record counts, query volumes, processing times, or capacity usage. Supports both hourly and daily aggregation granularity.
Risk: read
Output:
any