Search Algolia indices and manage records, indices, settings, synonyms, rules and tasks.
Explore 31 workflow actions for Algolia, including account permissions and operation limits.
15 read actions16 write actions
WORKFLOW ACTIONS
What you can configure.
Choose an action in the workflow builder, connect an account, and map its inputs. These actions are available in the catalog; your account access and a successful test determine whether they work for your setup.
Add or replace record
Write
Create or fully replace the record with this objectID.
Permissions and limits
Account permissions
An Algolia API key with the addObject ACL
A repeated request may repeat the external action. Review the previous result before retrying a write.
Add record
Write
Add a record; Algolia assigns the objectID unless the record has one.
Permissions and limits
Account permissions
An Algolia API key with the addObject ACL
A repeated request may repeat the external action. Review the previous result before retrying a write.
Batch write records
Write
Add, update, partially update or delete many records in one call.
Permissions and limits
Account permissions
An Algolia API key with the addObject ACL
A repeated request may repeat the external action. Review the previous result before retrying a write.
Browse index
Read
Read every matching record a page at a time with a cursor.
Permissions and limits
Account permissions
An Algolia API key with the browse ACL
Clear records
Write
Delete every record but keep settings, synonyms and rules.
Permissions and limits
Account permissions
An Algolia API key with the deleteIndex ACL
A repeated request may repeat the external action. Review the previous result before retrying a write.
Clear rules
Write
Delete every rule in an index.
Permissions and limits
Account permissions
An Algolia API key with the editSettings ACL
A repeated request may repeat the external action. Review the previous result before retrying a write.
Clear synonyms
Write
Delete every synonym in an index.
Permissions and limits
Account permissions
An Algolia API key with the editSettings ACL
A repeated request may repeat the external action. Review the previous result before retrying a write.
Copy or move index
Write
Copy or move an index, or copy only its settings, synonyms or rules.
Permissions and limits
Account permissions
An Algolia API key with the addObject ACL
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete index
Write
Delete an index and everything in it.
Permissions and limits
Account permissions
An Algolia API key with the deleteIndex ACL
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete record
Write
Delete a record by objectID.
Permissions and limits
Account permissions
An Algolia API key with the deleteObject ACL
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete records by filter
Write
Delete every record matching a filter.
Permissions and limits
Account permissions
An Algolia API key with the deleteIndex ACL
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete rule
Write
Delete a rule.
Permissions and limits
Account permissions
An Algolia API key with the editSettings ACL
A repeated request may repeat the external action. Review the previous result before retrying a write.
Delete synonym
Write
Delete a synonym.
Permissions and limits
Account permissions
An Algolia API key with the editSettings ACL
A repeated request may repeat the external action. Review the previous result before retrying a write.
Get application task
Read
Read whether an application-level task, like a dictionary change, is done.
Permissions and limits
Account permissions
An Algolia API key with the editSettings ACL
Get logs
Read
Read recent API calls, queries, builds or errors.
Permissions and limits
Account permissions
An Algolia API key with the logs ACL
Get record
Read
Read a record by objectID.
Permissions and limits
Account permissions
An Algolia API key with the search ACL
Get records
Read
Read up to 1000 records from any indices by objectID.
Permissions and limits
Account permissions
An Algolia API key with the search ACL
Get rule
Read
Read a rule by objectID.
Permissions and limits
Account permissions
An Algolia API key with the settings ACL
Get settings
Read
Read an index's settings.
Permissions and limits
Account permissions
An Algolia API key with the settings ACL
Get synonym
Read
Read a synonym by objectID.
Permissions and limits
Account permissions
An Algolia API key with the settings ACL
Get task
Read
Read whether an index write has been applied (published or notPublished).
Permissions and limits
Account permissions
An Algolia API key with the addObject ACL
List indices
Read
List indices with their record counts and sizes.
Permissions and limits
Account permissions
An Algolia API key with the listIndexes ACL
Partially update record
Write
Change some attributes of a record, optionally creating it.
Permissions and limits
Account permissions
An Algolia API key with the addObject ACL
A repeated request may repeat the external action. Review the previous result before retrying a write.
Save rule
Write
Create or replace a rule with its conditions and consequence.
Permissions and limits
Account permissions
An Algolia API key with the editSettings ACL
A repeated request may repeat the external action. Review the previous result before retrying a write.
Save synonym
Write
Create or replace a synonym.
Permissions and limits
Account permissions
An Algolia API key with the editSettings ACL
A repeated request may repeat the external action. Review the previous result before retrying a write.
Search dictionary
Read
Search the plurals, stop words or compounds dictionary.
Permissions and limits
Account permissions
An Algolia API key with the settings ACL
Search facet values
Read
Find values of a searchable facet.
Permissions and limits
Account permissions
An Algolia API key with the search ACL
Search index
Read
Search an index with text, filters and facets.
Permissions and limits
Account permissions
An Algolia API key with the search ACL
Search rules
Read
Search an index's rules by text, anchoring, context or status.
Permissions and limits
Account permissions
An Algolia API key with the settings ACL
Search synonyms
Read
Search an index's synonyms by text and type.
Permissions and limits
Account permissions
An Algolia API key with the settings ACL
Update settings
Write
Change some of an index's settings.
Permissions and limits
Account permissions
An Algolia API key with the editSettings ACL
A repeated request may repeat the external action. Review the previous result before retrying a write.
SETUP
Start with a controlled test.
01Connect the intended account
Use the account and permissions required for your process. Review the connection check before configuring a workflow action.
02Review inputs and access
Select a listed operation and map its required inputs. Use test records and add a human approval before writes that need review.
03Confirm the result
Inspect step outputs and confirm the result in Algolia. A saved workflow is not a completed provider action.