← Back to toolkits
Algolia logo

Algolia

Algolia is a hosted search API that provides developers with tools to build fast and relevant search experiences for their applications.

developer tools

Tools (133)

  • Add AB Test

    Tool to create an A/B test comparing search performance between two index variants. Use when you need to test different search configurations, ranking strategies, or index settings and measure their impact on user behavior.

    Inputs: name, endAt, region, variants

  • Add or Replace Record

    Tool to add or replace a specific record in an index by objectID. If a record with the given objectID exists, it is replaced; otherwise, a new record is created. Use when you need to upsert an object with a known ID.

    Inputs: record, object_id, index_name

  • Add Record to Index

    Tool to add a record to an index with auto-generated objectID. Records with matching IDs are replaced. Use when you need to insert a new object into an index.

    Inputs: record, index_name

  • Browse Algolia Index

    Browse a batch of records in an Algolia index, optionally filtering them by query or browse parameters. Use the returned cursor to request subsequent batches when exporting or iterating through an index.

    Inputs: query, cursor, index_name, browse_parameters

  • Clear Objects

    Tool to clear records of an index without affecting settings. Use when you need to completely wipe all objects (e.g., after a bulk reindex) while preserving index configuration.

    Inputs: index_name, request_options

  • Clear Rules

    Clear all rules from an Algolia index, optionally forwarding the operation to replica indices. A 404 response is returned as a no-op with task ID 0.

    Inputs: index_name, forwardToReplicas

  • Clear Synonyms

    Clear all synonyms from an Algolia index, optionally forwarding the operation to replica indices.

    Inputs: index_name, forwardToReplicas

  • Clicked Object IDs

    Tool to send a click event to Algolia to capture clicked items. Use immediately after a user click outside of search contexts to report click events.

    Inputs: eventName, indexName, objectIDs, userToken, authenticatedUserToken

  • Clicked Object IDs After Search

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

    Inputs: index, queryID, eventName, objectIDs, positions, timestamp, userToken

  • Compute Realtime User Profile

    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.

    Inputs: user_token

  • Converted Object IDs

    Tool to send a conversion event for items outside of search context. Use when tracking conversions on category pages or external flows unrelated to Algolia search.

    Inputs: index, eventName, objectIDs, timestamp, userToken, authenticatedUserToken

  • Copy Index

    Initiate an index copy and return an asynchronous task ID. Copy all parts including records, or specify settings, synonyms and rules as the scope; specifying a scope excludes records.

    Inputs: scope, index_name, destination

  • Create API Key

    Tool to create a new API key with specific permissions and restrictions. Use when you need to generate API keys with custom ACL permissions, index restrictions, rate limits, or expiration times.

    Inputs: acl, indexes, referers, validity, description, maxHitsPerQuery, queryParameters, maxQueriesPerIPPerHour

  • Create Authentication

    Create an authentication resource in the US region of Algolia's ingestion API for connecting to sources or destinations.

    Inputs: name, type, input, platform

  • Create Destination

    Create a destination for data ingestion using the US Algolia Ingestion API endpoint.

    Inputs: name, type, input, authenticationID, transformationIDs

  • Create Ingestion Task

    Create an ingestion task connecting a source to a destination for data synchronization with an Algolia index. The request uses the US ingestion endpoint.

    Inputs: cron, input, action, cursor, enabled, policies, sourceID, destinationID, notifications, failureThreshold, subscriptionAction

  • Create or Update Recommend Rules

    Tool to create or update a batch of Recommend Rules in an index. Use when you need to add or modify multiple rules at once for a recommendation model. Each rule is created or updated depending on whether a rule with the same objectID already exists.

    Inputs: model, rules, index_name

  • Create Query Suggestions Config

    Tool to create a new Query Suggestions configuration for an Algolia index. Use when you need to set up query suggestions to help users discover popular searches. Up to 100 configurations per application are supported.

    Inputs: region, exclude, indexName, languages, sourceIndices, enablePersonalization, allowSpecialCharacters

  • Create Source

    Tool to create a new data source in Algolia Ingestion API. Use when you need to set up a new source for data ingestion from external platforms or custom data feeds.

    Inputs: name, type, input, region, authenticationID

  • Create Transformation

    Tool to create a new transformation in Algolia Ingestion API. Use when you need to set up data transformations for enriching or modifying records during ingestion.

    Inputs: name, type, input, description, authenticationIDs

  • Delete AB Test

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

    Inputs: id, region

  • Delete API Key

    Delete an Algolia API key to revoke access. Deleting a main API key also deletes all secured API keys derived from it.

    Inputs: key

  • Delete Authentication

    Delete an Algolia ingestion authentication resource by ID in the US region.

    Inputs: authenticationID

  • Delete Query Suggestions Config

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

    Inputs: index_name

  • Delete Destination

    Delete a destination by ID using the US Algolia Ingestion API endpoint.

    Inputs: destination_id

  • Delete Index

    Tool to delete the specified index and all its records. Use when you need to permanently remove an index after confirming it's no longer needed.

    Inputs: index_name

  • Delete Multiple Records

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

    Inputs: index_name, object_ids, request_options

  • Delete Recommend Rule

    Tool to delete a Recommend rule from a recommendation scenario. Use when you need to remove a specific rule from an index's recommend model.

    Inputs: model, object_id, index_name

  • Delete Records by Filter

    Tool to delete records matching a filter from an Algolia index. Use when you need to remove multiple records based on filter criteria (e.g., category, tags, numeric ranges). This is a resource-intensive operation.

    Inputs: filters, index_name, tag_filters, around_radius, facet_filters, around_lat_lng, inside_polygon, numeric_filters, request_options, inside_bounding_box

  • Delete Rule

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

    Inputs: object_id, index_name, forward_to_replicas

  • Delete Source

    Delete an Algolia Ingestion API source by ID. The tool uses a data API endpoint supplied in connection metadata, or otherwise the US ingestion endpoint.

    Inputs: sourceID

  • Delete Synonym

    Tool to delete a synonym from a specified index. Use when you need to remove an existing synonym by its objectID.

    Inputs: object_id, index_name, forward_to_replicas

  • Delete Transformation

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

    Inputs: transformation_id

  • Delete User Profile

    Tool to delete a user profile from personalization. Use when you need to remove a user's personalization data and reset their profile.

    Inputs: user_token

  • Delete User Token

    Delete events related to a user token from Algolia Insights event metrics and analytics using the US Insights endpoint.

    Inputs: user_token

  • Disable Task V1

    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.

    Inputs: region, taskID

  • Enable Task V1

    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.

    Inputs: region, taskID

  • Batch Operations on Multiple Indices

    Tool to perform batch operations (add, update, delete) across multiple Algolia indices in a single request. Use when you need to modify records in different indices efficiently. Each operation specifies its target index and action type.

    Inputs: requests

  • Export Rules

    Export a page of rules from an Algolia index for backup or migration. Use the returned cursor to retrieve subsequent pages.

    Inputs: cursor, index_name

  • Find Object

    Tool to find the first object matching a query or filter in an index. Use when debugging relevance or filter logic after confirming index exists.

    Inputs: query, filters, paginate, index_name, attributesToRetrieve

  • Get A/B Test

    Retrieve an A/B test by ID from the DE analytics region, including its status, performance metrics, and configuration details.

    Inputs: id

  • Get Add to Cart Rate

    Tool to retrieve add-to-cart rate metrics for e-commerce search analytics. Use when you need to analyze conversion effectiveness and user purchasing behavior for an index, including daily breakdowns.

    Inputs: tags, index, endDate, startDate

  • Get API Key

    Tool to retrieve the permissions and details of a specific API key. Use when you need to inspect an API key's ACL, restrictions, or other settings.

    Inputs: key

  • Get App Task Status

    Tool to check the status of an application task. Use when you need to verify if a task has completed.

    Inputs: taskID

  • Get Authentication

    Tool to retrieve an authentication resource by its ID. Use when you need to fetch details about a specific authentication configuration in Algolia's ingestion API.

    Inputs: region, authentication_id

  • Get Average Click Position

    Tool to retrieve average click position metrics from Algolia Analytics. Use when analyzing user engagement and click behavior for search results.

    Inputs: tags, index, endDate, startDate

  • Get Click Positions

    Tool to retrieve the distribution of clicks by position from Algolia Analytics. Use when analyzing which search result positions receive the most user engagement.

    Inputs: tags, index, endDate, startDate

  • Get Click Through Rate

    Tool to retrieve click-through rate (CTR) for searches with at least one click event. Use when you need to analyze search effectiveness and user engagement metrics for an index, including daily breakdowns.

    Inputs: tags, index, endDate, startDate

  • Get Query Suggestions Config

    Tool to retrieve a Query Suggestions configuration by index name. Use when you need to inspect or verify Query Suggestions settings for a specific index.

    Inputs: region, indexName

  • Get Personalization Config

    Retrieve the advanced personalization configuration from the EU endpoint, including personalization settings, re-ranking impact and profile type.

  • Get Conversion Rate

    Retrieve conversion rate analytics for an index from the US analytics endpoint, including daily breakdowns.

    Inputs: tags, index, endDate, startDate

  • Get Destination

    Retrieve an Algolia ingestion destination by ID using the US endpoint.

    Inputs: destinationID

  • Get Dictionary Languages

    Tool to list available languages for dictionary entries. Use when you need to check which languages support custom dictionary entries (plurals, stopwords, compounds).

  • Get Dictionary Settings

    Tool to retrieve dictionary settings for all dictionaries. Use when you need to check which standard dictionary entries are disabled across different languages.

  • Get Logs

    Tool to retrieve log entries for API requests made to your Algolia application. Use when you need to debug issues, monitor API usage, or analyze search patterns.

    Inputs: type, length, offset, indexName

  • Get No Click Rate

    Retrieve aggregate and daily no-click rates for tracked searches on an index, with optional date and tag filters. Use to analyze search engagement.

    Inputs: tags, index, endDate, startDate

  • Get No Results Rate

    Retrieve aggregate and daily no-results rates for an index using the US analytics endpoint. Use to analyze search effectiveness over a selected period.

    Inputs: tags, index, endDate, startDate

  • Get No Results Searches

    Retrieve frequent searches that produced zero results for an index using the US analytics endpoint. Use to analyze search gaps or identify content opportunities.

    Inputs: tags, index, limit, offset, endDate, startDate

  • Get Object Position

    Find an object’s zero-based position by objectID in the hits of a supplied search response. Returns null if it is not present in those hits.

    Inputs: results, object_id

  • Get multiple objects

    Tool to retrieve multiple records from an index. Use when you need to batch-fetch several objectIDs in one call.

    Inputs: requests

  • Get Purchase Rate

    Retrieve purchase rate metrics for an index, including daily breakdowns, from the US analytics region.

    Inputs: tags, index, endDate, startDate

  • Get Recommend Rule

    Tool to retrieve a Recommend rule that was previously created in the Algolia dashboard. Use when you need to inspect a specific rule's configuration, conditions, or consequences by its objectID.

    Inputs: model, object_id, index_name

  • Get Recommend Task Status

    Tool to check the status of a Recommend task. Use when you need to verify if an asynchronous Recommend operation (such as deleting a Recommend rule) has completed.

    Inputs: model, task_id, index_name

  • Get Record from Index

    Tool to retrieve a specific record from an index by its objectID. Use when you need to fetch a single object's details.

    Inputs: object_id, index_name, attributes_to_retrieve

  • Get Revenue

    Retrieve search-related revenue data from Algolia Analytics using the US regional endpoint.

    Inputs: tags, index, endDate, startDate

  • Get Rule

    Tool to retrieve a specific rule by its objectID from an index. Use when you need to inspect a rule's configuration, conditions, and consequences.

    Inputs: object_id, index_name

  • Get Searches Count

    Retrieve search counts for an index over a time range, including a daily breakdown, using the US regional Analytics endpoint.

    Inputs: tags, index, endDate, startDate

  • Get Searches No Clicks

    Retrieve top searches without clicks from Algolia Analytics using the US regional endpoint, to help identify queries that may need optimization.

    Inputs: tags, index, limit, offset, endDate, startDate

  • Get Index Settings

    Retrieve selected settings for a specified Algolia index to inspect its configuration.

    Inputs: indexName

  • Get Source

    Tool to retrieve a source from the Algolia Ingestion API. Use when you need to get details about a specific data source by its ID.

    Inputs: region, sourceID

  • Get Synonym

    Tool to retrieve a specific synonym by its objectID. Use when you need to fetch details of an existing synonym from an index.

    Inputs: object_id, index_name

  • Get Task Status

    Tool to check the status of an asynchronous task. Use when you need to verify completion of operations like adding or deleting records.

    Inputs: task_id, index_name

  • Get Task V1

    Retrieve details of a specific V1 task from the Algolia Ingestion API by task ID. With the standard dashboard connection, requests use the US ingestion endpoint. DEPRECATED: This legacy action is deprecated.

    Inputs: taskID

  • Get Top Countries

    Retrieve top countries by search volume for a specified index using the US analytics endpoint, to analyze the geographic distribution of searches.

    Inputs: tags, index, limit, offset, endDate, startDate

  • Get Top Filter Attributes

    Tool to retrieve top filter attributes from Algolia Analytics. Use when analyzing which filters are most commonly used by users in searches.

    Inputs: tags, index, limit, offset, search, endDate, startDate

  • Get Top Filter For Attribute

    Tool to retrieve top filter values for a specific attribute from Algolia Analytics. Use when analyzing which filter values are most commonly used for a given attribute in search queries.

    Inputs: tags, index, limit, offset, search, endDate, attribute, startDate

  • Get Top Filters No Results

    Tool to retrieve top filters for searches that returned no results from Algolia Analytics. Use when analyzing which filters are commonly applied to searches that yield zero results, helping identify potential catalog or filtering issues.

    Inputs: tags, index, limit, offset, search, endDate, startDate

  • Get Top Hits

    Tool to retrieve the object IDs of the most frequent search results from Algolia Analytics. Returns up to 1,000 top hits ranked by frequency, optionally including click analytics (CTR, conversion rates) and revenue metrics. Use when analyzing which results appear most often in searches.

    Inputs: tags, index, limit, offset, search, endDate, startDate, clickAnalytics, revenueAnalytics

  • Get Top Searches

    Retrieve popular search queries from Algolia Analytics, with optional click analytics and revenue metrics. Results can be ordered by search count or click-related metrics in ascending or descending order.

    Inputs: tags, index, limit, offset, endDate, orderBy, direction, startDate, clickAnalytics, revenueAnalytics

  • Get Transformation

    Tool to retrieve a transformation by its ID from Algolia's Ingestion API. Use when you need to fetch details about a specific transformation including its code, configuration, and metadata.

    Inputs: region, transformationID

  • Get Usage Statistics

    Tool to retrieve Algolia usage statistics over a specified time period. Use when you need to analyze search operations, indexing operations, capacity metrics, or other usage data for an Algolia application. Requires Premium plan or Enterprise add-on access.

    Inputs: endDate, startDate, statistic, granularity

  • Get Usage for Index

    Retrieve usage statistics for a specific Algolia index over a time period, with hourly or daily aggregation, including metrics such as record counts, query volumes, and processing times. Usage API access requires a Premium plan or Enterprise add-on.

    Inputs: endDate, indexName, startDate, statistic, granularity

  • Get Users

    Retrieve user profiles and affinities from Algolia advanced personalization using the EU endpoint. Filter by date ranges and paginate through user data.

    Inputs: limit, endDate, indices, affinity, startDate, nextPageToken, previousPageToken

  • Get Users Count

    Retrieve the number of unique users for an index over a time range, including a daily breakdown, using the US Algolia Analytics endpoint.

    Inputs: tags, index, endDate, startDate

  • Index Exists

    Tool to check if an Algolia index exists. Use before performing index operations to prevent accidental index creation. Results are scoped to the Algolia app ID configured in the Ittes AI connection. Example: IndexExists(index_name='products').

    Inputs: index_name

  • Init Insights API Client

    Return Insights client configuration for a selected region, including the application ID, API key, host, and cookie-setting metadata.

    Inputs: region, store_in_cookie

  • List AB Tests

    List a page of A/B tests for the application in the DE analytics region, with optional index prefix or suffix filters. Results include test IDs and status.

    Inputs: limit, offset, indexPrefix, indexSuffix

  • List API Keys

    List the application's main API keys with their permissions and restrictions for access-control review.

  • List Authentications

    List a page of Algolia ingestion authentication resources in the US region, with optional type and platform filters.

    Inputs: page, sort, type, order, platform, itemsPerPage

  • List Destinations

    List a page of Algolia ingestion destinations using the US endpoint, optionally filtering by type, authentication ID or transformation ID.

    Inputs: page, sort, type, order, itemsPerPage, authenticationID, transformationID

  • List Indices

    Tool to list all indices and their metadata. Use when you need to retrieve index names, sizes, and state before performing operations that depend on index properties.

  • List Ingestion Tasks

    List ingestion tasks using the US ingestion endpoint. Supports filtering by source, destination, trigger type, action, and enabled status, with pagination and sorting.

    Inputs: page, sort, order, action, enabled, sourceID, sourceType, triggerType, itemsPerPage, destinationID, withEmailNotifications

  • List Query Suggestions Configurations

    Tool to retrieve all Query Suggestions configurations for an Algolia application. Use when you need to view or audit existing Query Suggestions setups.

    Inputs: region

  • List Task Runs

    List Algolia Ingestion task runs using the US regional endpoint. Filter by time range or status and paginate through run history.

    Inputs: page, sort, type, order, status, taskID, endDate, startDate, itemsPerPage

  • List Sources

    Tool to list sources from the Algolia Ingestion API. Use when you need to retrieve available data sources for ingestion pipelines. Supports filtering by type and authentication ID, with pagination and sorting options.

    Inputs: page, sort, type, order, region, itemsPerPage, authenticationID

  • List Transformations

    Tool to list all transformations in Algolia Ingestion API. Use when you need to retrieve transformation configurations, filter by type, or paginate through transformation lists.

    Inputs: page, sort, type, order, itemsPerPage

  • Partial Update Objects

    Partially update multiple records in an index by objectID without replacing entire records. Each update can also be configured to create the record if it does not exist.

    Inputs: requests, indexName

  • Push Records to Task

    Push records and a selected indexing action to a configured ingestion task by task ID, including actions to delete records, clear an index, or delete an index. Tasks with source type 'json' cannot use this endpoint.

    Inputs: watch, action, taskID, records

  • Replace All Rules

    Batch save rules in an index, replacing existing rules by default. The replacement can also be forwarded to replica indices, and additional request options can override the replacement setting.

    Inputs: rules, indexName, requestOptions, forwardToReplicas

  • Replace Task

    Replace an Algolia Ingestion task with new configuration using the US regional API endpoint.

    Inputs: cron, input, action, cursor, taskID, enabled, policies, destinationID, notifications, failureThreshold, subscriptionAction

  • Restore API Key

    Tool to restore a deleted API key within 72 hours of deletion. Use when you need to recover an accidentally deleted API key.

    Inputs: key

  • Run Task V1

    Manually trigger a V1 Algolia Ingestion task using the US regional endpoint. This action is deprecated.

    Inputs: taskID, runMetadata

  • Save Rule

    Tool to create or replace a rule in an index. Use when you need to add merchandising rules, query modifications, or conditional search behavior.

    Inputs: enabled, validity, object_id, conditions, index_name, consequence, description, forward_to_replicas

  • Save Synonym

    Tool to add or update a synonym in the specified index. Use when you need programmatic upsert of search synonyms after index creation.

    Inputs: synonym, objectID, indexName, forwardToReplicas

  • Save Synonyms

    Batch create or replace synonyms in an Algolia index. An optional setting replaces all existing synonyms with the supplied batch and can forward changes to replicas.

    Inputs: synonyms, indexName, forwardToReplicas, replaceExistingSynonyms

  • Search Authentications

    Tool to search for authentication resources by IDs in Algolia. Use when you need to retrieve multiple specific authentication configurations by their IDs.

    Inputs: authenticationIDs

  • Search Destinations

    Search for multiple Algolia ingestion destinations by their IDs using the US endpoint.

    Inputs: destinationIDs

  • Search Dictionary Entries

    Tool to search dictionary entries in Algolia dictionaries. Use when you need to find stopwords, plurals, or compound words in specific dictionaries.

    Inputs: page, query, language, hitsPerPage, dictionary_name

  • Search Facet Values

    Tool to search for values of a specified facet attribute. Use when you need to find specific facet values that match a query string. Facet values are sorted by decreasing count by default.

    Inputs: params, facet_name, index_name, facet_query, max_facet_hits

  • Search Algolia Index

    Tool to perform a search on a specified Algolia index. Use after confirming the index name. Example: SearchIndex(index_name='contacts', query='apple', search_params={'hitsPerPage':10})

    Inputs: query, index_name, search_params, request_options

  • Search Multiple Indices

    Tool to perform searches across multiple indices in a single call. Use when you need to batch multiple index queries into one API request.

    Inputs: requests, strategy

  • Search Recommend Rules

    Search Recommend rules in a specified index and model. An empty query can list rules for the recommendation scenario; results are paginated.

    Inputs: page, model, query, facets, context, enabled, filters, index_name, hitsPerPage, maxValuesPerFacet

  • Search Sources

    Search for multiple Algolia Ingestion API sources by their IDs using the US ingestion endpoint.

    Inputs: sourceIDs

  • Search Synonyms

    Search synonyms in a specified Algolia index, optionally matching a query or filtering by synonym type. Choose a zero-based page and page size to browse matching synonym entries.

    Inputs: page, type, query, index_name, hitsPerPage

  • Search Tasks V1

    Search for V1 Algolia Ingestion API tasks by their IDs using the US ingestion endpoint. This tool is deprecated.

    Inputs: taskIDs

  • Search Transformations

    Tool to search for transformations by IDs in Algolia Ingestion API. Use when you need to retrieve multiple specific transformation configurations by their IDs.

    Inputs: transformationIDs

  • Set Dictionary Settings

    Tool to update dictionary settings for Algolia. Use when you need to enable or disable built-in stop words, plurals, or compounds for specific languages.

    Inputs: disableStandardEntries

  • Set Personalization Strategy

    Tool to define personalization strategy that controls how user behavior affects search results. Use when you need to configure which events and facets influence personalized search rankings.

    Inputs: region, eventsScoring, facetsScoring, personalizationImpact

  • Set Index Settings

    Tool to update an Algolia index's settings. Use when you need to configure index behavior before indexing records. Example: set searchableAttributes and customRanking for products index.

    Inputs: settings, index_name, forward_to_replicas

  • Stop AB Test

    Tool to stop an A/B test by its unique identifier. Use when you need to halt an active A/B test. Note that stopped A/B tests cannot be restarted.

    Inputs: id, region

  • Try Transformation

    Tool to try a transformation before creating it in Algolia. Use when you need to test transformation code or no-code configurations against sample data to verify they work correctly before deployment.

    Inputs: code, type, input, sampleRecord, authentications

  • Try Transformation Before Update

    Tool to test a transformation before updating it in Algolia Ingestion API. Use when you need to validate transformation code or configuration against sample data before applying it to production.

    Inputs: code, type, input, sample_record, authentications, transformation_id

  • Update API Key

    Tool to update the permissions and settings of an existing API key. Use when you need to modify ACL permissions, index restrictions, rate limits, or other settings of an existing API key.

    Inputs: acl, key, indexes, referers, validity, description, maxHitsPerQuery, queryParameters, maxQueriesPerIPPerHour

  • Update Authentication

    Update the name or credentials of an Algolia ingestion authentication resource in the US region.

    Inputs: name, input, authenticationID

  • Update Query Suggestions Config

    Tool to update an existing Query Suggestions configuration. Use when you need to modify settings for query suggestions on an existing index.

    Inputs: region, exclude, indexName, languages, sourceIndices, enablePersonalization, allowSpecialCharacters

  • Update Destination

    Update an Algolia ingestion destination using the US endpoint, including its configuration, name, type or associated transformations.

    Inputs: name, type, input, destinationID, authenticationID, transformationIDs

  • Update Dictionary Entries

    Batch add or delete entries in an Algolia stopwords, plurals, or compounds dictionary. The request can also replace all existing custom entries in the selected dictionary.

    Inputs: requests, dictionary_name, clearExistingDictionaryEntries

  • Update Record Partially

    Tool to add or update attributes in a single record. Use when you need to modify specific fields without replacing the entire record. Creates a new record if the objectID doesn't exist (when create_if_not_exists is true).

    Inputs: object_id, attributes, index_name, create_if_not_exists

  • Update Source

    Tool to update a source in the Algolia Ingestion API. Use when you need to modify the name, authentication, or input configuration of an existing data source.

    Inputs: name, input, region, sourceID, authenticationID

  • Update Task

    Partially update an Algolia Ingestion API task using the US ingestion endpoint. Configure fields such as schedule, failure threshold, destination, or notifications.

    Inputs: cron, input, taskID, enabled, policies, destinationID, notifications, failureThreshold, subscriptionAction

  • Update Transformation

    Tool to update an existing transformation in Algolia Ingestion API. Use when you need to modify transformation settings, code, or configuration for data processing during ingestion.

    Inputs: code, name, type, input, description, transformationID, authenticationIDs

  • Validate Source

    Tool to validate a source payload before creating it in Algolia. Use when you need to verify that a source configuration is valid before actually creating the source.

    Inputs: name, type, input, region, authenticationID

  • Validate Source Before Update

    Tool to validate a source update payload in the Algolia Ingestion API. Use when you need to verify that an update to a source configuration is valid before actually updating it.

    Inputs: name, input, region, sourceID, authenticationID