NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

Algolia

algolia

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

Developer ToolsWeb del proveedor
Acciones
30
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

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ón

Tool 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Browse Algolia IndexALGOLIA_BROWSE_INDEXAcción

Tool to retrieve all records from an index. use when you need to export or iterate through an entire index dataset.

Parámetros de entrada

  • querystring

    Search query to filter records; empty or omitted returns all records.

  • cursorstring

    Cursor to specify the starting point for the next batch of results.

  • index_namestringObligatorio

    Name of the Algolia index to browse.

  • browse_parametersobject

    Additional browse parameters as key-value pairs (e.g., filters, hitsPerPage).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Clear ObjectsALGOLIA_CLEAR_OBJECTSAcción

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.

Parámetros de entrada

  • index_namestringObligatorio

    Name of the index from which to clear all records.

  • request_optionsobject

    Optional mapping of request options (query parameters) as string values.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Clear RulesALGOLIA_CLEAR_RULESAcción

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.

Parámetros de entrada

  • index_namestringObligatorio

    Name of the Algolia index from which to clear all rules.

  • forwardToReplicasboolean

    If true, also clears rules on all replica indices.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Clicked Object IDsALGOLIA_CLICKED_OBJECT_IDSAcción

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.

Parámetros de entrada

  • eventNamestringObligatorio

    Name of the specific event (1-64 ASCII printable characters).

  • indexNamestringObligatorio

    Name of the Algolia index where the event occurred.

  • objectIDsstring[]Obligatorio

    List of clicked object IDs (1-20 items).

  • userTokenstringObligatorio

    Anonymous user identifier. Allowed chars: alphanumeric, '_', '=', '+', '/', '-'; length 1-129.

  • authenticatedUserTokenstring

    Pseudonymous identifier for authenticated users; same pattern as userToken.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Clicked Object IDs After SearchALGOLIA_CLICKED_OBJECT_IDS_AFTER_SEARCHAcción

Tool 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

  • indexstringObligatorio

    Name of the index where the click occurred.

  • queryIDstringObligatorio

    queryID returned by Algolia Search API for the request.

  • eventNamestringObligatorio

    Name for this click event, e.g. 'Product Clicked'.

  • objectIDsstring[]Obligatorio

    List of objectIDs that were clicked.

  • positionsinteger[]Obligatorio

    Positions (0-based) of clicked objects in the search results.

  • timestampinteger

    Event timestamp in milliseconds since epoch. If omitted, server timestamp is used.

  • userTokenstringObligatorio

    Unique token identifying the user, consistent across events.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Converted Object IDsALGOLIA_CONVERTED_OBJECT_IDSAcción

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.

Parámetros de entrada

  • indexstringObligatorio

    Name of the Algolia index where conversion happened.

  • eventNamestringObligatorio

    Name of the specific conversion event. 1–64 ASCII characters except control characters.

  • objectIDsstring[]Obligatorio

    List of object IDs for items converted. Up to 20 IDs.

  • timestampinteger

    Event timestamp in milliseconds since epoch. If omitted, server timestamp is used.

  • userTokenstringObligatorio

    Unique token identifying the user, e.g., 'user-123'.

  • authenticatedUserTokenstring

    Optional pseudonymous token for authenticated users. Never include PII.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Copy IndexALGOLIA_COPY_INDEXAcción

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.

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_namestringObligatorio

    Name of the source index to copy.

  • destinationstringObligatorio

    Name of the destination index to create.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Copy RulesALGOLIA_COPY_RULESAcción

Tool 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

  • destIndexstringObligatorio

    Name of the destination index to copy rules to.

  • index_namestringObligatorio

    Name of the source index to copy rules from.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Copy Index SettingsALGOLIA_COPY_SETTINGSAcción

Tool 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_namestringObligatorio

    Name of the source index whose settings will be copied.

  • destinationstringObligatorio

    Name of the destination index where settings will be applied.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete IndexALGOLIA_DELETE_INDEXAcción

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.

Parámetros de entrada

  • index_namestringObligatorio

    The name of the index to be deleted

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Multiple RecordsALGOLIA_DELETE_OBJECTSAcción

Tool to delete multiple records from an algolia index. use when you need to remove multiple objects by their ids.

Parámetros de entrada

  • index_namestringObligatorio

    Name of the index from which to delete records.

  • object_idsstring[]Obligatorio

    List of objectIDs to delete.

  • request_optionsobject

    Optional mapping of request options (query parameters) as string values.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete RuleALGOLIA_DELETE_RULEAcción

Tool 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_idstringObligatorio

    Unique identifier of the rule to delete.

  • index_namestringObligatorio

    Name of the Algolia index from which to delete the rule.

  • forward_to_replicasboolean

    Whether to forward this deletion to replica indices. If false (default), only the specified index is affected.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete SynonymALGOLIA_DELETE_SYNONYMAcción

Tool 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_idstringObligatorio

    ObjectID of the synonym to delete.

  • index_namestringObligatorio

    Name of the Algolia index from which to delete the synonym.

  • forward_to_replicasboolean

    Whether to forward this deletion to all replica indices. If false (default), only the specified index is affected.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Export RulesALGOLIA_EXPORT_RULESAcción

Tool to export all rules defined on an index. use when you need to backup or migrate index rules.

Parámetros de entrada

  • cursorstring

    Cursor to fetch the next batch of rules; omit to start from the beginning

  • index_namestringObligatorio

    Name of the Algolia index to export rules from

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Find ObjectALGOLIA_FIND_OBJECTAcción

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.

Parámetros de entrada

  • querystring

    Query string to search for. If omitted, only filters are applied.

  • filtersobject

    Additional search parameters and filters as a JSON object.

  • paginateboolean

    Whether to search all pages. Defaults to False.

  • index_namestringObligatorio

    Name 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Object PositionALGOLIA_GET_OBJECT_POSITIONAcción

Tool to retrieve an object’s position in a result set. use when debugging relevance after performing a search query.

Parámetros de entrada

  • resultsobjectObligatorio

    Full JSON response from a previous Algolia search, containing the 'hits' list.

  • object_idstringObligatorio

    The objectID of the record to locate in the results.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get multiple objectsALGOLIA_GET_OBJECTSAcción

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

Parámetros de entrada

  • requestsobject[]Obligatorio

    Array of sub-requests, each with indexName and objectID.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Index SettingsALGOLIA_GET_SETTINGSAcción

Tool to retrieve the settings of a specified index. use when you need to inspect index configurations after creation or update.

Parámetros de entrada

  • indexNamestringObligatorio

    Name of the index whose settings are being retrieved

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Index ExistsALGOLIA_INDEX_EXISTSAcción

Tool 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_namestringObligatorio

    Name of the Algolia index to check (e.g., 'products')

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Init Insights API ClientALGOLIA_INIT_INSIGHTSAcción

Tool to initialize the algolia insights api client. use before sending any insights events.

Parámetros de entrada

  • regionstringenum

    Insights API endpoint region: 'us' for insights.algolia.io or 'eu' for insights.eu.algolia.com.

    useu
  • store_in_cookieboolean

    Whether to store the userToken in a cookie for subsequent calls.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List IndicesALGOLIA_LIST_INDICESAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Partial Update ObjectsALGOLIA_PARTIAL_UPDATE_OBJECTSAcción

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.

Parámetros de entrada

  • requestsobject[]Obligatorio

    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.

  • indexNamestringObligatorio

    Name of the Algolia index where the objects live.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Replace All RulesALGOLIA_REPLACE_ALL_RULESAcción

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.

Parámetros de entrada

  • rulesobject[]Obligatorio

    Array of rule objects to replace all existing rules.

  • indexNamestringObligatorio

    Name of the Algolia index to replace rules for.

  • requestOptionsobject

    Additional request options sent as query parameters.

  • forwardToReplicasboolean

    Also apply the replacement to replica indices.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Save SynonymALGOLIA_SAVE_SYNONYMAcción

Tool 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

  • synonymobjectObligatorio

    Synonym object payload defining type and values.

  • objectIDstringObligatorio

    Unique identifier for the synonym object. Must be specified and match the synonym objectID.

  • indexNamestringObligatorio

    Name of the index in which to save the synonym.

  • forwardToReplicasboolean

    Whether to forward the synonym update to all replicas.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Search Algolia IndexALGOLIA_SEARCH_INDEXAcción

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})

Parámetros de entrada

  • querystringObligatorio

    Search query string. Empty string fetches all records. Max length is 512 characters.

  • index_namestringObligatorio

    Name of the Algolia index to search (e.g., 'contacts')

  • search_paramsobject

    Additional Algolia search parameters as key-value pairs, e.g., {'hitsPerPage': 10, 'filters': 'category:book'}.

  • request_optionsobject

    Optional request-level options such as extra headers or query params.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Search Multiple IndicesALGOLIA_SEARCH_MULTIPLE_INDICESAcción

Tool 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[]Obligatorio

    List of search queries to perform on multiple indices.

  • strategystringenum

    Search strategy to use: 'none' or 'stopIfEnoughMatches'.

    nonestopIfEnoughMatches

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Search RulesALGOLIA_SEARCH_RULESAcción

Tool 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

  • pageinteger

    Zero-based page number to retrieve

  • querystring

    Full-text query to filter rules by condition or consequence

  • contextstring

    Restricts matches to contextual rules with this exact context

  • enabledboolean

    When set, restricts matches to rules by enabled status

  • anchoringstringenum

    When specified, restricts matches to rules with this anchoring type. One of: 'is', 'startsWith', 'endsWith', 'contains'.

    isstartsWithendsWithcontains
  • indexNamestringObligatorio

    Name of the index to search for rules

  • hitsPerPageinteger

    Number of hits per page (1–1000)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Search SynonymsALGOLIA_SEARCH_SYNONYMSAcción

Tool 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

  • pageinteger

    Zero-based page number to retrieve.

  • typestringenum

    Filter by synonym type: 'oneWaySynonym', 'synonym', 'placeholder', 'altCorrection1', or 'altCorrection2'.

    oneWaySynonymsynonymplaceholderaltCorrection1altCorrection2
  • querystring

    Keywords to match in synonyms.

  • index_namestringObligatorio

    Name of the Algolia index to search for synonyms.

  • hitsPerPageinteger

    Number of synonyms to return per page.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Set Index SettingsALGOLIA_SET_SETTINGSAcción

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.

Parámetros de entrada

  • settingsobjectObligatorio

    Key/value mapping of settings parameters. Only specified keys are overridden; unspecified keys remain unchanged. Use null to reset a setting to its default.

  • index_namestringObligatorio

    Name of the index to update.

  • forward_to_replicasboolean

    Whether 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

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not