Algolia

Learn how to use Algolia with Composio

Overview

SLUG

ALGOLIA

Description

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

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
string
bearer_token
string
generic_api_key
stringRequired
generic_id
stringRequired

Tools

SLUG: ALGOLIA_ADD_AB_TEST

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.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_BROWSE_INDEX

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

Action Parameters

browse_parameters
object
cursor
string
index_name
stringRequired
query
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_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.

Action Parameters

index_name
stringRequired
request_options
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_CLEAR_RULES

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.

Action Parameters

forwardToReplicas
boolean
index_name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_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.

Action Parameters

authenticatedUserToken
string
eventName
stringRequired
indexName
stringRequired
objectIDs
arrayRequired
userToken
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_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.

Action Parameters

authenticatedUserToken
string
eventName
stringRequired
index
stringRequired
objectIDs
arrayRequired
timestamp
integer
userToken
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_COPY_INDEX

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.

Action Parameters

destination
stringRequired
index_name
stringRequired
scope
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_COPY_RULES

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.

Action Parameters

destIndex
stringRequired
index_name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_COPY_SETTINGS

Tool to copy the settings from one index to another. use when you need to replicate index configurations without records or other data.

Action Parameters

destination
stringRequired
index_name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_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.

Action Parameters

index_name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_DELETE_OBJECTS

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

Action Parameters

index_name
stringRequired
object_ids
arrayRequired
request_options
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_DELETE_RULE

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

Action Parameters

forward_to_replicas
boolean
index_name
stringRequired
object_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_DELETE_SYNONYM

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

Action Parameters

forward_to_replicas
boolean
index_name
stringRequired
object_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_EXPORT_RULES

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

Action Parameters

cursor
string
index_name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_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.

Action Parameters

attributesToRetrieve
array
filters
object
index_name
stringRequired
paginate
boolean
query
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_GET_OBJECTS

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

Action Parameters

requests
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_GET_OBJECT_POSITION

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

Action Parameters

object_id
stringRequired
results
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_GET_SETTINGS

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

Action Parameters

indexName
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_INDEX_EXISTS

Tool to check if an algolia index exists. use before performing index operations to prevent accidental index creation. example: indexexists(index name='products').

Action Parameters

index_name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_INIT_INSIGHTS

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

Action Parameters

region
stringDefaults to us
store_in_cookie
booleanDefaults to True

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_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.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_PARTIAL_UPDATE_OBJECTS

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.

Action Parameters

indexName
stringRequired
requests
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_REPLACE_ALL_RULES

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.

Action Parameters

forwardToReplicas
boolean
indexName
stringRequired
requestOptions
object
rules
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_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.

Action Parameters

forwardToReplicas
boolean
indexName
stringRequired
objectID
stringRequired
synonym
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_SEARCH_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})

Action Parameters

index_name
stringRequired
query
stringRequired
request_options
object
search_params
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_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.

Action Parameters

requests
arrayRequired
strategy
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_SEARCH_RULES

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.

Action Parameters

anchoring
string
context
string
enabled
boolean
hitsPerPage
integer
indexName
stringRequired
page
integer
query
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_SEARCH_SYNONYMS

Tool to search for synonyms in the specified index. use when you need to retrieve synonyms matching a query or filter by type.

Action Parameters

hitsPerPage
integer
index_name
stringRequired
page
integer
query
string
type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: ALGOLIA_SET_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.

Action Parameters

forward_to_replicas
boolean
index_name
stringRequired
settings
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired