Algolia
algoliaAlgolia is a hosted search API that provides developers with tools to build fast and relevant search experiences for their applications.
Acciones disponibles (30)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add AB TestALGOLIA_ADD_AB_TESTAcciónTool to create an ab test comparing search performance between two variants. use to test different index configurations or search parameters and measure impact on click-through and conversion rates.
ALGOLIA_ADD_AB_TESTAcciónTool to create an ab test comparing search performance between two variants. use to test different index configurations or search parameters and measure impact on click-through and conversion rates.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Browse Algolia IndexALGOLIA_BROWSE_INDEXAcciónTool to retrieve all records from an index. use when you need to export or iterate through an entire index dataset.
ALGOLIA_BROWSE_INDEXAcciónTool to retrieve all records from an index. use when you need to export or iterate through an entire index dataset.
Parámetros de entrada
querystringSearch query to filter records; empty or omitted returns all records.
cursorstringCursor to specify the starting point for the next batch of results.
index_namestringObligatorioName of the Algolia index to browse.
browse_parametersobjectAdditional browse parameters as key-value pairs (e.g., filters, hitsPerPage).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Clear ObjectsALGOLIA_CLEAR_OBJECTSAcciónTool 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.
ALGOLIA_CLEAR_OBJECTSAcciónTool 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.
Parámetros de entrada
index_namestringObligatorioName of the index from which to clear all records.
request_optionsobjectOptional mapping of request options (query parameters) as string values.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Clear RulesALGOLIA_CLEAR_RULESAcciónTool 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.
ALGOLIA_CLEAR_RULESAcciónTool 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.
Parámetros de entrada
index_namestringObligatorioName of the Algolia index from which to clear all rules.
forwardToReplicasbooleanIf true, also clears rules on all replica indices.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Clicked Object IDsALGOLIA_CLICKED_OBJECT_IDSAcciónTool 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.
ALGOLIA_CLICKED_OBJECT_IDSAcciónTool 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.
Parámetros de entrada
eventNamestringObligatorioName of the specific event (1-64 ASCII printable characters).
indexNamestringObligatorioName of the Algolia index where the event occurred.
objectIDsstring[]ObligatorioList of clicked object IDs (1-20 items).
userTokenstringObligatorioAnonymous user identifier. Allowed chars: alphanumeric, '_', '=', '+', '/', '-'; length 1-129.
authenticatedUserTokenstringPseudonymous identifier for authenticated users; same pattern as userToken.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Clicked Object IDs After SearchALGOLIA_CLICKED_OBJECT_IDS_AFTER_SEARCHAcciónTool to send a click event after a search response. use when you want to report which items a user clicked in search results.
ALGOLIA_CLICKED_OBJECT_IDS_AFTER_SEARCHAcciónTool to send a click event after a search response. use when you want to report which items a user clicked in search results.
Parámetros de entrada
indexstringObligatorioName of the index where the click occurred.
queryIDstringObligatorioqueryID returned by Algolia Search API for the request.
eventNamestringObligatorioName for this click event, e.g. 'Product Clicked'.
objectIDsstring[]ObligatorioList of objectIDs that were clicked.
positionsinteger[]ObligatorioPositions (0-based) of clicked objects in the search results.
timestampintegerEvent timestamp in milliseconds since epoch. If omitted, server timestamp is used.
userTokenstringObligatorioUnique token identifying the user, consistent across events.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Converted Object IDsALGOLIA_CONVERTED_OBJECT_IDSAcciónTool 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.
ALGOLIA_CONVERTED_OBJECT_IDSAcciónTool 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.
Parámetros de entrada
indexstringObligatorioName of the Algolia index where conversion happened.
eventNamestringObligatorioName of the specific conversion event. 1–64 ASCII characters except control characters.
objectIDsstring[]ObligatorioList of object IDs for items converted. Up to 20 IDs.
timestampintegerEvent timestamp in milliseconds since epoch. If omitted, server timestamp is used.
userTokenstringObligatorioUnique token identifying the user, e.g., 'user-123'.
authenticatedUserTokenstringOptional pseudonymous token for authenticated users. Never include PII.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Copy IndexALGOLIA_COPY_INDEXAcciónTool 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.
ALGOLIA_COPY_INDEXAcciónTool 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.
Parámetros de entrada
scopestring[]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.
index_namestringObligatorioName of the source index to copy.
destinationstringObligatorioName of the destination index to create.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Copy RulesALGOLIA_COPY_RULESAcciónTool to copy rules from one index to another. use when you need to duplicate all query rules from a source index to a target index after confirming both names.
ALGOLIA_COPY_RULESAcciónTool to copy rules from one index to another. use when you need to duplicate all query rules from a source index to a target index after confirming both names.
Parámetros de entrada
destIndexstringObligatorioName of the destination index to copy rules to.
index_namestringObligatorioName of the source index to copy rules from.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Copy Index SettingsALGOLIA_COPY_SETTINGSAcciónTool to copy the settings from one index to another. use when you need to replicate index configurations without records or other data.
ALGOLIA_COPY_SETTINGSAcciónTool to copy the settings from one index to another. use when you need to replicate index configurations without records or other data.
Parámetros de entrada
index_namestringObligatorioName of the source index whose settings will be copied.
destinationstringObligatorioName of the destination index where settings will be applied.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete IndexALGOLIA_DELETE_INDEXAcciónTool 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.
ALGOLIA_DELETE_INDEXAcciónTool 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.
Parámetros de entrada
index_namestringObligatorioThe name of the index to be deleted
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete Multiple RecordsALGOLIA_DELETE_OBJECTSAcciónTool to delete multiple records from an algolia index. use when you need to remove multiple objects by their ids.
ALGOLIA_DELETE_OBJECTSAcciónTool to delete multiple records from an algolia index. use when you need to remove multiple objects by their ids.
Parámetros de entrada
index_namestringObligatorioName of the index from which to delete records.
object_idsstring[]ObligatorioList of objectIDs to delete.
request_optionsobjectOptional mapping of request options (query parameters) as string values.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete RuleALGOLIA_DELETE_RULEAcciónTool to delete the specified rule from an index. use when you need to permanently remove a rule after confirming its objectid.
ALGOLIA_DELETE_RULEAcciónTool to delete the specified rule from an index. use when you need to permanently remove a rule after confirming its objectid.
Parámetros de entrada
object_idstringObligatorioUnique identifier of the rule to delete.
index_namestringObligatorioName of the Algolia index from which to delete the rule.
forward_to_replicasbooleanWhether to forward this deletion to replica indices. If false (default), only the specified index is affected.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete SynonymALGOLIA_DELETE_SYNONYMAcciónTool to delete a synonym from a specified index. use when you need to remove an existing synonym by its objectid.
ALGOLIA_DELETE_SYNONYMAcciónTool to delete a synonym from a specified index. use when you need to remove an existing synonym by its objectid.
Parámetros de entrada
object_idstringObligatorioObjectID of the synonym to delete.
index_namestringObligatorioName of the Algolia index from which to delete the synonym.
forward_to_replicasbooleanWhether to forward this deletion to all replica indices. If false (default), only the specified index is affected.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Export RulesALGOLIA_EXPORT_RULESAcciónTool to export all rules defined on an index. use when you need to backup or migrate index rules.
ALGOLIA_EXPORT_RULESAcciónTool to export all rules defined on an index. use when you need to backup or migrate index rules.
Parámetros de entrada
cursorstringCursor to fetch the next batch of rules; omit to start from the beginning
index_namestringObligatorioName of the Algolia index to export rules from
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Find ObjectALGOLIA_FIND_OBJECTAcciónTool to find the first object matching a query or filter in an index. use when debugging relevance or filter logic after confirming index exists.
ALGOLIA_FIND_OBJECTAcciónTool to find the first object matching a query or filter in an index. use when debugging relevance or filter logic after confirming index exists.
Parámetros de entrada
querystringQuery string to search for. If omitted, only filters are applied.
filtersobjectAdditional search parameters and filters as a JSON object.
paginatebooleanWhether to search all pages. Defaults to False.
index_namestringObligatorioName of the Algolia index to search (e.g., 'products').
attributesToRetrievestring[]List of attributes to retrieve in the result. If omitted, all attributes are returned.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Object PositionALGOLIA_GET_OBJECT_POSITIONAcciónTool to retrieve an object’s position in a result set. use when debugging relevance after performing a search query.
ALGOLIA_GET_OBJECT_POSITIONAcciónTool to retrieve an object’s position in a result set. use when debugging relevance after performing a search query.
Parámetros de entrada
resultsobjectObligatorioFull JSON response from a previous Algolia search, containing the 'hits' list.
object_idstringObligatorioThe objectID of the record to locate in the results.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get multiple objectsALGOLIA_GET_OBJECTSAcciónTool to retrieve multiple records from an index. use when you need to batch-fetch several objectids in one call.
ALGOLIA_GET_OBJECTSAcciónTool to retrieve multiple records from an index. use when you need to batch-fetch several objectids in one call.
Parámetros de entrada
requestsobject[]ObligatorioArray of sub-requests, each with indexName and objectID.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get Index SettingsALGOLIA_GET_SETTINGSAcciónTool to retrieve the settings of a specified index. use when you need to inspect index configurations after creation or update.
ALGOLIA_GET_SETTINGSAcciónTool to retrieve the settings of a specified index. use when you need to inspect index configurations after creation or update.
Parámetros de entrada
indexNamestringObligatorioName of the index whose settings are being retrieved
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Index ExistsALGOLIA_INDEX_EXISTSAcciónTool to check if an algolia index exists. use before performing index operations to prevent accidental index creation. example: indexexists(index name='products').
ALGOLIA_INDEX_EXISTSAcciónTool to check if an algolia index exists. use before performing index operations to prevent accidental index creation. example: indexexists(index name='products').
Parámetros de entrada
index_namestringObligatorioName of the Algolia index to check (e.g., 'products')
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Init Insights API ClientALGOLIA_INIT_INSIGHTSAcciónTool to initialize the algolia insights api client. use before sending any insights events.
ALGOLIA_INIT_INSIGHTSAcciónTool to initialize the algolia insights api client. use before sending any insights events.
Parámetros de entrada
regionstringenumInsights API endpoint region: 'us' for insights.algolia.io or 'eu' for insights.eu.algolia.com.
useustore_in_cookiebooleanWhether to store the userToken in a cookie for subsequent calls.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List IndicesALGOLIA_LIST_INDICESAcciónTool 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.
ALGOLIA_LIST_INDICESAcciónTool 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Partial Update ObjectsALGOLIA_PARTIAL_UPDATE_OBJECTSAcciónTool 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.
ALGOLIA_PARTIAL_UPDATE_OBJECTSAcciónTool 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.
Parámetros de entrada
requestsobject[]ObligatorioList of objects to update. Each entry must include `objectID` and any additional fields you wish to change; you can also set `createIfNotExists` per object.
indexNamestringObligatorioName of the Algolia index where the objects live.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Replace All RulesALGOLIA_REPLACE_ALL_RULESAcciónTool to push a new set of rules, erasing previous ones. use when you need zero-downtime atomic replacement of all rules in an index.
ALGOLIA_REPLACE_ALL_RULESAcciónTool to push a new set of rules, erasing previous ones. use when you need zero-downtime atomic replacement of all rules in an index.
Parámetros de entrada
rulesobject[]ObligatorioArray of rule objects to replace all existing rules.
indexNamestringObligatorioName of the Algolia index to replace rules for.
requestOptionsobjectAdditional request options sent as query parameters.
forwardToReplicasbooleanAlso apply the replacement to replica indices.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Save SynonymALGOLIA_SAVE_SYNONYMAcciónTool to add or update a synonym in the specified index. use when you need programmatic upsert of search synonyms after index creation.
ALGOLIA_SAVE_SYNONYMAcciónTool to add or update a synonym in the specified index. use when you need programmatic upsert of search synonyms after index creation.
Parámetros de entrada
synonymobjectObligatorioSynonym object payload defining type and values.
objectIDstringObligatorioUnique identifier for the synonym object. Must be specified and match the synonym objectID.
indexNamestringObligatorioName of the index in which to save the synonym.
forwardToReplicasbooleanWhether to forward the synonym update to all replicas.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search Algolia IndexALGOLIA_SEARCH_INDEXAcciónTool 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})
ALGOLIA_SEARCH_INDEXAcciónTool 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})
Parámetros de entrada
querystringObligatorioSearch query string. Empty string fetches all records. Max length is 512 characters.
index_namestringObligatorioName of the Algolia index to search (e.g., 'contacts')
search_paramsobjectAdditional Algolia search parameters as key-value pairs, e.g., {'hitsPerPage': 10, 'filters': 'category:book'}.
request_optionsobjectOptional request-level options such as extra headers or query params.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search Multiple IndicesALGOLIA_SEARCH_MULTIPLE_INDICESAcciónTool to perform searches across multiple indices in a single call. use when you need to batch multiple index queries into one api request.
ALGOLIA_SEARCH_MULTIPLE_INDICESAcciónTool to perform searches across multiple indices in a single call. use when you need to batch multiple index queries into one api request.
Parámetros de entrada
requestsobject[]ObligatorioList of search queries to perform on multiple indices.
strategystringenumSearch strategy to use: 'none' or 'stopIfEnoughMatches'.
nonestopIfEnoughMatches
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search RulesALGOLIA_SEARCH_RULESAcciónTool to search for rules in the specified index. use when you need to retrieve rules matching a query, filtering by anchoring, context, pagination, or enabled status.
ALGOLIA_SEARCH_RULESAcciónTool to search for rules in the specified index. use when you need to retrieve rules matching a query, filtering by anchoring, context, pagination, or enabled status.
Parámetros de entrada
pageintegerZero-based page number to retrieve
querystringFull-text query to filter rules by condition or consequence
contextstringRestricts matches to contextual rules with this exact context
enabledbooleanWhen set, restricts matches to rules by enabled status
anchoringstringenumWhen specified, restricts matches to rules with this anchoring type. One of: 'is', 'startsWith', 'endsWith', 'contains'.
isstartsWithendsWithcontainsindexNamestringObligatorioName of the index to search for rules
hitsPerPageintegerNumber of hits per page (1–1000)
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Search SynonymsALGOLIA_SEARCH_SYNONYMSAcciónTool to search for synonyms in the specified index. use when you need to retrieve synonyms matching a query or filter by type.
ALGOLIA_SEARCH_SYNONYMSAcciónTool to search for synonyms in the specified index. use when you need to retrieve synonyms matching a query or filter by type.
Parámetros de entrada
pageintegerZero-based page number to retrieve.
typestringenumFilter by synonym type: 'oneWaySynonym', 'synonym', 'placeholder', 'altCorrection1', or 'altCorrection2'.
oneWaySynonymsynonymplaceholderaltCorrection1altCorrection2querystringKeywords to match in synonyms.
index_namestringObligatorioName of the Algolia index to search for synonyms.
hitsPerPageintegerNumber of synonyms to return per page.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Set Index SettingsALGOLIA_SET_SETTINGSAcciónTool 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.
ALGOLIA_SET_SETTINGSAcciónTool 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.
Parámetros de entrada
settingsobjectObligatorioKey/value mapping of settings parameters. Only specified keys are overridden; unspecified keys remain unchanged. Use null to reset a setting to its default.
index_namestringObligatorioName of the index to update.
forward_to_replicasbooleanWhether to forward these settings to all existing replica indices. Replicas must already exist; cannot create and forward in a single call.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not