Algolia

Use Algolia in Sim to search indices, add or update records, run batch operations, and manage index settings. The actions below also cover browsing records, deleting by filter, copying or moving indices, and checking task status.

Use the block

Search indices, manage records (add, update, delete, browse), configure index settings, and perform batch operations.

Actions

Algolia Search

Search an Algolia index

Inputs and outputs

Input

Parameter	Type	Required	Description
applicationId	string	Yes	Algolia Application ID
apiKey	string	Yes	Algolia API Key
indexName	string	Yes	Name of the Algolia index to search
query	string	Yes	Search query text
hitsPerPage	number	No	Number of hits per page (default: 20)
page	number	No	Page number to retrieve (default: 0)
filters	string	No	Filter string (e.g., "category:electronics AND price < 100")
attributesToRetrieve	string	No	Comma-separated list of attributes to retrieve
facets	string	No	Comma-separated list of facet attribute names to retrieve counts for (use "*" for all)
getRankingInfo	boolean	No	Whether to include detailed ranking information in each hit
aroundLatLng	string	No	Coordinates for geo-search (e.g., "40.71,-74.01")
aroundRadius	string	No	Maximum radius in meters for geo-search, or "all" for unlimited
insideBoundingBox	json	No	Bounding box coordinates as [[lat1, lng1, lat2, lng2]] for geo-search
insidePolygon	json	No	Polygon coordinates as [[lat1, lng1, lat2, lng2, lat3, lng3, ...]] for geo-search

Output

Parameter	Type	Description
hits	array	Array of matching records
↳ objectID	string	Unique identifier of the record
↳ _highlightResult	object	Highlighted attributes matching the query. Each attribute has value, matchLevel (none, partial, full), and matchedWords
↳ _snippetResult	object	Snippeted attributes matching the query. Each attribute has value and matchLevel
↳ _rankingInfo	object	Ranking information for the hit. Only present when getRankingInfo is enabled
↳ nbTypos	number	Number of typos in the query match
↳ firstMatchedWord	number	Position of the first matched word
↳ geoDistance	number	Distance in meters for geo-search results
↳ nbExactWords	number	Number of exactly matched words
↳ userScore	number	Custom ranking score
↳ words	number	Number of matched words
nbHits	number	Total number of matching hits
page	number	Current page number (zero-based)
nbPages	number	Total number of pages available
hitsPerPage	number	Number of hits per page (1-1000, default 20)
processingTimeMS	number	Server-side processing time in milliseconds
query	string	The search query that was executed
parsedQuery	string	The query string after normalization and stop word removal
facets	object	Facet counts keyed by facet name, each containing value-count pairs
facets_stats	object	Statistics (min, max, avg, sum) for numeric facets
exhaustive	object	Exhaustiveness flags for facetsCount, facetValues, nbHits, rulesMatch, and typo

Algolia Add Record

Add or replace a record in an Algolia index

Inputs and outputs

Input

Parameter	Type	Required	Description
applicationId	string	Yes	Algolia Application ID
apiKey	string	Yes	Algolia Admin API Key
indexName	string	Yes	Name of the Algolia index
objectID	string	No	Object ID for the record (auto-generated if not provided)
record	json	Yes	JSON object representing the record to add

Output

Parameter	Type	Description
taskID	number	Algolia task ID for tracking the indexing operation
objectID	string	The object ID of the added or replaced record
createdAt	string	Timestamp when the record was created (only present when objectID is auto-generated)
updatedAt	string	Timestamp when the record was updated (only present when replacing an existing record)

Algolia Get Record

Get a record by objectID from an Algolia index

Inputs and outputs

Input

Parameter	Type	Required	Description
applicationId	string	Yes	Algolia Application ID
apiKey	string	Yes	Algolia API Key
indexName	string	Yes	Name of the Algolia index
objectID	string	Yes	The objectID of the record to retrieve
attributesToRetrieve	string	No	Comma-separated list of attributes to retrieve

Output

Parameter	Type	Description
objectID	string	The objectID of the retrieved record
record	object	The record data (all attributes)

Algolia Get Records

Retrieve multiple records by objectID from one or more Algolia indices

Inputs and outputs

Input

Parameter	Type	Required	Description
applicationId	string	Yes	Algolia Application ID
apiKey	string	Yes	Algolia API Key
indexName	string	Yes	Default index name for all requests
requests	json	Yes	Array of objects specifying records to retrieve. Each must have "objectID" and optionally "indexName" and "attributesToRetrieve".

Output

Parameter	Type	Description
results	array	Array of retrieved records (null entries for records not found)
↳ objectID	string	Unique identifier of the record

Algolia Partial Update Record

Partially update a record in an Algolia index without replacing it entirely

Inputs and outputs

Input

Parameter	Type	Required	Description
applicationId	string	Yes	Algolia Application ID
apiKey	string	Yes	Algolia Admin API Key
indexName	string	Yes	Name of the Algolia index
objectID	string	Yes	The objectID of the record to update
attributes	json	Yes	JSON object with attributes to update. Supports built-in operations like {"stock": {"_operation": "Decrement", "value": 1}}
createIfNotExists	boolean	No	Whether to create the record if it does not exist (default: true)

Output

Parameter	Type	Description
taskID	number	Algolia task ID for tracking the update operation
objectID	string	The objectID of the updated record
updatedAt	string	Timestamp when the record was updated

Algolia Delete Record

Delete a record by objectID from an Algolia index

Inputs and outputs

Input

Parameter	Type	Required	Description
applicationId	string	Yes	Algolia Application ID
apiKey	string	Yes	Algolia Admin API Key
indexName	string	Yes	Name of the Algolia index
objectID	string	Yes	The objectID of the record to delete

Output

Parameter	Type	Description
taskID	number	Algolia task ID for tracking the deletion
deletedAt	string	Timestamp when the record was deleted

Algolia Browse Records

Browse and iterate over all records in an Algolia index using cursor pagination

Inputs and outputs

Input

Parameter	Type	Required	Description
applicationId	string	Yes	Algolia Application ID
apiKey	string	Yes	Algolia API Key (must have browse ACL)
indexName	string	Yes	Name of the Algolia index to browse
query	string	No	Search query to filter browsed records
filters	string	No	Filter string to narrow down results
attributesToRetrieve	string	No	Comma-separated list of attributes to retrieve
hitsPerPage	number	No	Number of hits per page (default: 1000, max: 1000)
cursor	string	No	Cursor from a previous browse response for pagination
aroundLatLng	string	No	Coordinates for geo-search (e.g., "40.71,-74.01")
aroundRadius	string	No	Maximum radius in meters for geo-search, or "all" for unlimited
insideBoundingBox	json	No	Bounding box coordinates as [[lat1, lng1, lat2, lng2]] for geo-search
insidePolygon	json	No	Polygon coordinates as [[lat1, lng1, lat2, lng2, lat3, lng3, ...]] for geo-search

Output

Parameter	Type	Description
hits	array	Array of records from the index (up to 1000 per request)
↳ objectID	string	Unique identifier of the record
cursor	string	Opaque cursor string for retrieving the next page of results. Absent when no more results exist.
nbHits	number	Total number of records matching the browse criteria
page	number	Current page number (zero-based)
nbPages	number	Total number of pages available
hitsPerPage	number	Number of hits per page (1-1000, default 1000 for browse)
processingTimeMS	number	Server-side processing time in milliseconds

Algolia Batch Operations

Perform batch add, update, partial update, or delete operations on records in an Algolia index

Inputs and outputs

Input

Parameter	Type	Required	Description
applicationId	string	Yes	Algolia Application ID
apiKey	string	Yes	Algolia Admin API Key
indexName	string	Yes	Name of the Algolia index
requests	json	Yes	Array of batch operations. Each item has "action" (addObject, updateObject, partialUpdateObject, partialUpdateObjectNoCreate, deleteObject, delete, clear) and "body" (the record data; must include objectID for update/delete; use an empty object {} for the index-level delete/clear actions)

Output

Parameter	Type	Description
taskID	number	Algolia task ID for tracking the batch operation
objectIDs	array	Array of object IDs affected by the batch operation

Algolia List Indices

List all indices in an Algolia application

Inputs and outputs

Input

Parameter	Type	Required	Description
applicationId	string	Yes	Algolia Application ID
apiKey	string	Yes	Algolia API Key
page	number	No	Page number for paginating indices (default: not paginated)
hitsPerPage	number	No	Number of indices per page (default: 100)

Output

Parameter	Type	Description
indices	array	List of indices in the application
↳ name	string	Name of the index
↳ entries	number	Number of records in the index
↳ dataSize	number	Size of the index data in bytes
↳ fileSize	number	Size of the index files in bytes
↳ lastBuildTimeS	number	Last build duration in seconds
↳ numberOfPendingTasks	number	Number of pending indexing tasks
↳ pendingTask	boolean	Whether the index has pending tasks
↳ createdAt	string	Timestamp when the index was created
↳ updatedAt	string	Timestamp when the index was last updated
↳ primary	string	Name of the primary index (if this is a replica)
↳ replicas	array	List of replica index names
↳ virtual	boolean	Whether the index is a virtual replica
nbPages	number	Total number of pages of indices

Algolia Get Settings

Retrieve the settings of an Algolia index

Inputs and outputs

Input

Parameter	Type	Required	Description
applicationId	string	Yes	Algolia Application ID
apiKey	string	Yes	Algolia API Key
indexName	string	Yes	Name of the Algolia index

Output

Parameter	Type	Description
searchableAttributes	array	List of searchable attributes
attributesForFaceting	array	Attributes used for faceting
ranking	array	Ranking criteria
customRanking	array	Custom ranking criteria
replicas	array	List of replica index names
hitsPerPage	number	Default number of hits per page
maxValuesPerFacet	number	Maximum number of facet values returned
highlightPreTag	string	HTML tag inserted before highlighted parts
highlightPostTag	string	HTML tag inserted after highlighted parts
paginationLimitedTo	number	Maximum number of hits accessible via pagination

Algolia Update Settings

Update the settings of an Algolia index

Inputs and outputs

Input

Parameter	Type	Required	Description
applicationId	string	Yes	Algolia Application ID
apiKey	string	Yes	Algolia Admin API Key (must have editSettings ACL)
indexName	string	Yes	Name of the Algolia index
settings	json	Yes	JSON object with settings to update (e.g., {"searchableAttributes": ["name", "description"], "customRanking": ["desc(popularity)"]})
forwardToReplicas	boolean	No	Whether to apply changes to replica indices (default: false)

Output

Parameter	Type	Description
taskID	number	Algolia task ID for tracking the settings update
updatedAt	string	Timestamp when the settings were updated

Algolia Delete Index

Delete an entire Algolia index and all its records

Inputs and outputs

Input

Parameter	Type	Required	Description
applicationId	string	Yes	Algolia Application ID
apiKey	string	Yes	Algolia Admin API Key (must have deleteIndex ACL)
indexName	string	Yes	Name of the Algolia index to delete

Output

Parameter	Type	Description
taskID	number	Algolia task ID for tracking the index deletion
deletedAt	string	Timestamp when the index was deleted

Algolia Copy/Move Index

Copy or move an Algolia index to a new destination

Inputs and outputs

Input

Parameter	Type	Required	Description
applicationId	string	Yes	Algolia Application ID
apiKey	string	Yes	Algolia Admin API Key
indexName	string	Yes	Name of the source index
operation	string	Yes	Operation to perform: "copy" or "move"
destination	string	Yes	Name of the destination index
scope	json	No	Array of scopes to copy (only for "copy" operation): ["settings", "synonyms", "rules"]. Omit to copy everything including records.

Output

Parameter	Type	Description
taskID	number	Algolia task ID for tracking the copy/move operation
updatedAt	string	Timestamp when the operation was performed

Algolia Clear Records

Clear all records from an Algolia index while keeping settings, synonyms, and rules

Inputs and outputs

Input

Parameter	Type	Required	Description
applicationId	string	Yes	Algolia Application ID
apiKey	string	Yes	Algolia Admin API Key (must have deleteIndex ACL)
indexName	string	Yes	Name of the Algolia index to clear

Output

Parameter	Type	Description
taskID	number	Algolia task ID for tracking the clear operation
updatedAt	string	Timestamp when the records were cleared

Algolia Delete By Filter

Delete all records matching a filter from an Algolia index

Inputs and outputs

Input

Parameter	Type	Required	Description
applicationId	string	Yes	Algolia Application ID
apiKey	string	Yes	Algolia Admin API Key (must have deleteIndex ACL)
indexName	string	Yes	Name of the Algolia index
filters	string	No	Filter expression to match records for deletion (e.g., "category:outdated")
facetFilters	json	No	Array of facet filters (e.g., ["brand:Acme"])
numericFilters	json	No	Array of numeric filters (e.g., ["price > 100"])
tagFilters	json	No	Array of tag filters using the _tags attribute (e.g., ["published"])
aroundLatLng	string	No	Coordinates for geo-search filter (e.g., "40.71,-74.01")
aroundRadius	string	No	Maximum radius in meters for geo-search, or "all" for unlimited
insideBoundingBox	json	No	Bounding box coordinates as [[lat1, lng1, lat2, lng2]] for geo-search filter
insidePolygon	json	No	Polygon coordinates as [[lat1, lng1, lat2, lng2, lat3, lng3, ...]] for geo-search filter

Output

Parameter	Type	Description
taskID	number	Algolia task ID for tracking the delete-by-filter operation
updatedAt	string	Timestamp when the operation was performed

Algolia Get Task Status

Check whether an Algolia indexing task has finished publishing

Inputs and outputs

Input

Parameter	Type	Required	Description
applicationId	string	Yes	Algolia Application ID
apiKey	string	Yes	Algolia API Key
indexName	string	Yes	Name of the Algolia index the task ran against
taskID	number	Yes	The taskID returned by a previous write operation

Output

Parameter	Type	Description
status	string	Task status: "published" once the operation has been applied, "notPublished" while still pending