Algolia Search

Hosted site search. Search an index, add and update the records in it, and tune ranking with rules, synonyms, and settings.

Measured routing accuracy

74 golden cases replayed through the router over the whole index: measured over corpus ea4f12ad2948 (65 toolkits, 2283 tools indexed and 13 declared uncallable), 58 cases written by hand and 16 cases from the paraphrase pass. A case counts as top-1 when its gold tool ranked first and top-8 when it reached the slate at all.

The sweep is offline: the reranker is a deterministic identity fake that returns candidates in the order retrieval produced them, so top-1 measures retrieval order rather than a reranked slate. just eval-live measures the same cases through the live reranker.

Authentication

Connect an entity with ConnectionsService.InitiateConnection, naming this toolkit's slug. Credentials stay in the connections vault; callers hold connected-account ids only.

api_key

Submit the key with ConnectionsService rather than putting it in a request; it is sealed at rest and never returned.

Tools

58 action tools. The catalog-wide slug is algolia_search.<tool>, which is what search_tools returns and call_tool takes.

algolia_search.list_clusters

List the Algolia clusters of a multi-cluster application: the server groups records are spread across when each tenant's data lives on its own cluster. Calls GET /1/clusters.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/clusters.

Takes no arguments.

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "show the server groups used for multi-tenant setups", "what clusters does this account have", "list the machine groups holding records".

algolia_search.list_user_ids

List the user ids mapped to Algolia clusters: which tenants of a multi-cluster application sit on which server group. Calls GET /1/clusters/mapping.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/clusters/mapping.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "which tenants sit on which server group", "list the mapped tenant identifiers", "show the multi-tenant assignments".

algolia_search.assign_user_id

Assign or move a user id between Algolia clusters: put a tenant's records on a server group, or migrate them to another one. Calls POST /1/clusters/mapping.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/clusters/mapping.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "place a tenant on a server group", "migrate a tenant to another group", "assign multi-tenant storage".

algolia_search.batch_assign_user_ids

Assign multiple user ids to an Algolia cluster at once: place a batch of tenants on one server group. Calls POST /1/clusters/mapping/batch.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/clusters/mapping/batch.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "place many tenants on one server group", "bulk assign multi-tenant storage", "migrate a batch of tenants".

algolia_search.has_pending_mappings

Check whether an Algolia cluster mapping change is still running: whether a large batch of tenants is done being created or migrated. Calls GET /1/clusters/mapping/pending.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/clusters/mapping/pending.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "is the tenant migration still running", "did the bulk tenant change finish", "status of a multi-tenant migration".

algolia_search.search_user_ids

Search the user ids mapped to Algolia clusters: find tenants of a multi-cluster application by id or by the cluster they sit on. Results lag by a few seconds. Calls POST /1/clusters/mapping/search.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/clusters/mapping/search.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "find a tenant by identifier", "which tenants are on this server group", "look up multi-tenant assignments".

algolia_search.get_top_user_ids

List the busiest user ids per Algolia cluster: the ten tenants holding the most records on each server group. Calls GET /1/clusters/mapping/top.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/clusters/mapping/top.

Takes no arguments.

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "which tenants hold the most records", "busiest tenants per server group", "largest multi-tenant occupants".

algolia_search.get_user_id

Retrieve a user id from Algolia's cluster mapping: which server group a tenant's records live on, and how many they hold. Calls GET /1/clusters/mapping/{userID}.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/clusters/mapping/{{params.userID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "which server group holds this tenant", "read one tenant's assignment", "how many records does this tenant hold".

algolia_search.remove_user_id

Delete a user id from Algolia's cluster mapping: remove a tenant and their records from the multi-cluster application. Calls DELETE /1/clusters/mapping/{userID}.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /1/clusters/mapping/{{params.userID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "remove a tenant from the multi-tenant setup", "delete a tenant and their records", "unassign a tenant from its server group".

algolia_search.get_dictionary_languages

List the languages Algolia dictionaries support: which languages have stop word, plural, and segmentation entries, and how many custom ones you added. Calls GET /1/dictionaries/*/languages.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/dictionaries/*/languages.

Takes no arguments.

Also retrieved by: "which languages have stop word support", "list dictionary language coverage", "how many custom word entries per language".

algolia_search.get_dictionary_settings

Read the Algolia dictionary settings: which languages have the built-in stop word list turned off for this application. Calls GET /1/dictionaries/*/settings.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/dictionaries/*/settings.

Takes no arguments.

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "is the built-in stop word list on", "read the stop word configuration", "which languages have stop words disabled".

algolia_search.set_dictionary_settings

Change the Algolia dictionary settings: turn the built-in stop word list on or off for a language. Calls PUT /1/dictionaries/*/settings.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PUT /1/dictionaries/*/settings.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "turn the built-in stop word list on or off", "disable stop words for a language", "change the stop word configuration".

algolia_search.batch_dictionary_entries

Add or remove custom Algolia dictionary entries: edit your own stop word, plural, or segmentation words in one batch. Calls POST /1/dictionaries/{dictionaryName}/batch.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/dictionaries/{{params.dictionaryName}}/batch.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "add custom stop words or plurals", "remove my own dictionary words", "edit plural and segmentation entries".

algolia_search.search_dictionary_entries

Search Algolia dictionary entries: look through the built-in and custom stop word, plural, and segmentation words. Calls POST /1/dictionaries/{dictionaryName}/search.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/dictionaries/{{params.dictionaryName}}/search.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "look through stop words and plurals", "find a dictionary word entry", "search the segmentation words".

algolia_search.list_indices

List the Algolia indexes in this application: every collection of records you can search, with its record count and size. Calls GET /1/indexes.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/indexes.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "show every collection in this application", "what indexes exist here", "list the searchable collections".

algolia_search.multiple_batch

Write Algolia records across several indexes in a single request: add, update, or remove documents in more than one collection as one batch. Calls POST /1/indexes/*/batch.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/indexes/*/batch.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "bulk write across several collections", "one batch spanning multiple indexes", "update records in more than one index".

algolia_search.get_objects

Retrieve records from Algolia by object id: fetch several stored documents by their ids, from one collection or from different ones, in a single request. Calls POST /1/indexes/*/objects.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/indexes/*/objects.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "fetch several documents by their ids", "read specific records in one call", "batch lookup by primary key".

algolia_search.search

Run several Algolia queries in one request: look things up across one or more indexes at once (federated search over several collections) and get each query's hits back together. Calls POST /1/indexes/*/queries.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/indexes/*/queries.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "run several lookups in one request", "query more than one collection at once", "federated search across indexes".

algolia_search.delete_index

Delete an Algolia index entirely: wipe out a whole collection, every record in it, and its configuration. Calls DELETE /1/indexes/{indexName}.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /1/indexes/{{params.indexName}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "wipe out a whole collection", "drop an index and everything in it", "remove a collection permanently".

algolia_search.batch

Write many Algolia records to one index in a single request: add, update, or remove documents in a collection as one batch of operations. Calls POST /1/indexes/{indexName}/batch.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/indexes/{{params.indexName}}/batch.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "bulk write documents into one collection", "add update or remove records together", "send a batch of index operations".

algolia_search.browse

Page through every record in an Algolia index: walk a whole collection in batches of up to 1,000 for exports and bulk reads, rather than ranked search. Calls POST /1/indexes/{indexName}/browse.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/indexes/{{params.indexName}}/browse.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "page through every document in a collection", "export all records in bulk", "walk a whole index batch by batch".

algolia_search.clear_objects

Delete all records from an Algolia index but keep the index: empty a collection while its configuration, synonyms, and rules stay in place. Calls POST /1/indexes/{indexName}/clear.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls POST /1/indexes/{{params.indexName}}/clear.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "empty a collection but keep its configuration", "remove all documents and leave the setup", "truncate an index".

algolia_search.delete_by

Delete every Algolia record matching a filter: remove the documents a filter or facet condition selects instead of naming ids one at a time. Calls POST /1/indexes/{indexName}/deleteByQuery.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls POST /1/indexes/{{params.indexName}}/deleteByQuery.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "remove every document matching a filter", "bulk delete by facet condition", "drop records that match a query filter".

algolia_search.search_for_facet_values

Search the values of one Algolia facet attribute: type-ahead over a filter's possible values, such as brand or category names, so a UI can suggest them. Calls POST /1/indexes/{indexName}/facets/{facetName}/query.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/indexes/{{params.indexName}}/facets/{{params.facetName}}/query.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "suggest values for a filter attribute", "type-ahead over category or brand names", "which values does this facet have".

algolia_search.operation_index

Copy or rename an Algolia index: duplicate or move a collection, with its records, configuration, synonyms, and rules, inside the same application. Calls POST /1/indexes/{indexName}/operation.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/indexes/{{params.indexName}}/operation.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "copy a collection to a new name", "rename or duplicate an index", "move a collection within the application".

algolia_search.search_single_index

Search one Algolia index: run a full-text query against a single collection of records and get the matching hits back ranked, with highlighting, facets, and pagination. Calls POST /1/indexes/{indexName}/query.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/indexes/{{params.indexName}}/query.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "look up matching results in one collection", "full-text query against a single index", "find documents that match a keyword".

algolia_search.clear_rules

Delete every Algolia rule on an index: drop all merchandising overrides from a collection at once. Calls POST /1/indexes/{indexName}/rules/clear.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls POST /1/indexes/{{params.indexName}}/rules/clear.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "remove every merchandising override", "drop all query overrides at once", "wipe the rules on a collection".

algolia_search.search_rules

Search the Algolia rules on an index: find merchandising overrides by their query condition or context. Calls POST /1/indexes/{indexName}/rules/search.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/indexes/{{params.indexName}}/rules/search.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "find merchandising overrides by condition", "list the query overrides on a collection", "look through saved rules".

algolia_search.get_rule

Retrieve a rule from an Algolia index: read the merchandising override stored under an id, its condition and what it changes. Calls GET /1/indexes/{indexName}/rules/{objectID}.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/indexes/{{params.indexName}}/rules/{{params.objectID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "read one merchandising override", "show a stored rule by id", "what does this override change".

algolia_search.save_rule

Create or replace an Algolia rule: a merchandising override that reshapes results for a query, pinning, boosting, hiding, or filtering hits when a condition matches. Calls PUT /1/indexes/{indexName}/rules/{objectID}.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PUT /1/indexes/{{params.indexName}}/rules/{{params.objectID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "create a merchandising override for a query", "pin or boost hits when a condition matches", "reshape results for a specific search term".

algolia_search.delete_rule

Delete one Algolia rule by its id: drop a merchandising override from a collection. Calls DELETE /1/indexes/{indexName}/rules/{objectID}.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /1/indexes/{{params.indexName}}/rules/{{params.objectID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "remove one merchandising override", "drop a stored rule by id", "delete a query override".

algolia_search.get_settings

Read how one Algolia index is configured: the ranking, searchable attributes, faceting, typo tolerance, and pagination that decide how a collection's results come back. Calls GET /1/indexes/{indexName}/settings.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/indexes/{{params.indexName}}/settings.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "read how a collection is configured and ranked", "what are the searchable attributes here", "show the relevance configuration".

algolia_search.set_settings

Change how one Algolia index is configured and ranked: set its searchable attributes, ranking and custom ranking, faceting, and typo tolerance. Calls PUT /1/indexes/{indexName}/settings.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PUT /1/indexes/{{params.indexName}}/settings.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "change how a collection ranks results", "configure searchable attributes and faceting", "tune typo tolerance and ranking".

algolia_search.clear_synonyms

Delete every Algolia synonym on an index: drop all equivalent-word mappings from a collection at once. Calls POST /1/indexes/{indexName}/synonyms/clear.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls POST /1/indexes/{{params.indexName}}/synonyms/clear.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "remove every equivalent-word mapping", "drop all word equivalences at once", "wipe the synonyms on a collection".

algolia_search.search_synonyms

Search the Algolia synonyms on an index: find equivalent-word mappings by term or by type. Calls POST /1/indexes/{indexName}/synonyms/search.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/indexes/{{params.indexName}}/synonyms/search.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "find equivalent-word mappings by term", "list the word equivalences on a collection", "look through saved synonyms".

algolia_search.get_synonym

Read one Algolia synonym by its id: the equivalent-word mapping stored on a collection. Calls GET /1/indexes/{indexName}/synonyms/{objectID}.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/indexes/{{params.indexName}}/synonyms/{{params.objectID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "read one equivalent-word mapping", "look up a saved word equivalence", "show a stored synonym by id".

algolia_search.save_synonym

Create or replace an Algolia synonym: define equivalent words so two different terms return the same results in a collection. Calls PUT /1/indexes/{indexName}/synonyms/{objectID}.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PUT /1/indexes/{{params.indexName}}/synonyms/{{params.objectID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "define equivalent words for a collection", "make two terms return the same results", "add a word mapping for relevance".

algolia_search.delete_synonym

Delete one Algolia synonym by its id: drop an equivalent-word mapping from a collection. Calls DELETE /1/indexes/{indexName}/synonyms/{objectID}.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /1/indexes/{{params.indexName}}/synonyms/{{params.objectID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "remove one equivalent-word mapping", "drop a saved word equivalence", "delete a synonym by id".

algolia_search.get_task

Check whether an Algolia indexing task finished: the status of one write against a collection, so you know the change is searchable. Calls GET /1/indexes/{indexName}/task/{taskID}.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/indexes/{{params.indexName}}/task/{{params.taskID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "is my write searchable yet", "check the status of an index operation", "did that indexing job finish".

algolia_search.get_object

Retrieve a record from an Algolia index: fetch one stored document by its object id, with no query involved. Calls GET /1/indexes/{indexName}/{objectID}.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/indexes/{{params.indexName}}/{{params.objectID}}.

Arguments:

Also retrieved by: "fetch one document by its id", "read a single stored record", "pull up a record by primary key".

algolia_search.delete_object

Delete one stored Algolia record by its object id: remove a single document from a collection by its id. Calls DELETE /1/indexes/{indexName}/{objectID}.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /1/indexes/{{params.indexName}}/{{params.objectID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "remove one document by its id", "drop a single stored record", "delete a record by primary key".

algolia_search.list_api_keys

List the Algolia API keys of this application: every access token with the permissions and restrictions it carries. Calls GET /1/keys.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/keys.

Takes no arguments.

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "show the access tokens for this application", "what credentials exist here", "list keys and their permissions".

algolia_search.add_api_key

Create an Algolia API key: mint a new access token with scoped permissions, index restrictions, and an optional expiry. Calls POST /1/keys.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/keys.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "mint a new access token with scoped permissions", "issue a credential limited to one collection", "create a search-only token".

algolia_search.get_api_key

Read one Algolia API key: the permissions, index restrictions, and rate limits an access token carries. Calls GET /1/keys/{key}.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/keys/{{params.key}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "what permissions does this token have", "read an access token's restrictions", "inspect a credential".

algolia_search.update_api_key

Change an Algolia API key: replace the permissions and restrictions an existing access token carries. Calls PUT /1/keys/{key}.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls PUT /1/keys/{{params.key}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "change what a token is allowed to do", "replace an access token's permissions", "narrow a credential's scope".

algolia_search.delete_api_key

Delete an Algolia API key: revoke an access token so it stops working. Calls DELETE /1/keys/{key}.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /1/keys/{{params.key}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "revoke an access token", "remove a credential", "stop a token from working".

algolia_search.restore_api_key

Restore a deleted Algolia API key: bring a revoked access token back with the permissions it had. Calls POST /1/keys/{key}/restore.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/keys/{{params.key}}/restore.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "bring a revoked token back", "undo a credential deletion", "reinstate an access token".

algolia_search.get_logs

Retrieve log entries for this Algolia application: the recent request history of API calls it served, with their timing, status, and errors. Needs a key holding the logs permission. Calls GET /1/logs.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/logs.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "show the recent request history", "what calls did this application serve", "read the api activity log".

algolia_search.get_sources

List the IP addresses allowed to reach this Algolia application: the allow-list that decides which networks may call it. Calls GET /1/security/sources.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/security/sources.

Takes no arguments.

Also retrieved by: "which networks may reach this application", "read the ip allow-list", "show the permitted addresses".

algolia_search.append_source

Allow another IP address to reach this Algolia application: add a network to the allow-list. Calls POST /1/security/sources/append.

Class write (writes, no confirmation needed). No scopes beyond the connection's defaults. Calls POST /1/security/sources/append.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "allow another network to reach the application", "add an address to the allow-list", "permit a new ip range".

algolia_search.delete_source

Stop allowing an IP address to reach this Algolia application: remove a network from the allow-list. Calls DELETE /1/security/sources/{source}.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls DELETE /1/security/sources/{{params.source}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "stop allowing a network", "remove an address from the allow-list", "revoke an ip range".

algolia_search.get_app_task

Check whether an application-level Algolia task finished: the status of a change that spans the whole application rather than one collection. Calls GET /1/task/{taskID}.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /1/task/{{params.taskID}}.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "check an application-wide operation's status", "did the account-level change finish", "status of a task spanning the application".

algolia_search.chunked_batch

Replace all Algolia records in an index, chunked: push a large list of documents split into groups of 1,000 so one bulk load fits the API's request size. Calls GET /chunkedBatch.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /chunkedBatch.

Arguments:

Also retrieved by: "bulk load a large list of documents", "push records in groups of a thousand", "reload a collection from a big export".

algolia_search.index_exists

Check whether an Algolia index exists: report whether a named collection has been created and holds settings or records yet. Calls GET /indexExists.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /indexExists.

Arguments:

Also retrieved by: "does this collection exist yet", "check whether an index was created", "is there an index with that name".

algolia_search.replace_all_objects

Replace everything in an Algolia index: swap the whole collection for a new set of documents without interrupting live searches. Calls GET /replaceAllObjects.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls GET /replaceAllObjects.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "swap a collection for a fresh set of documents", "reindex without downtime", "overwrite everything in an index".

algolia_search.replace_all_objects_with_transformation

Replace everything in an Algolia index through the Push transformation pipeline: swap in a new set of documents and reshape each one as it lands. Calls GET /replaceAllObjectsWithTransformation.

Class destructive (held by the mutation gate until the call's own arguments carry "confirm": true). No scopes beyond the connection's defaults. Calls GET /replaceAllObjectsWithTransformation.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "reindex and reshape each document on the way in", "swap in new documents through the push pipeline", "transform records while reloading a collection".

algolia_search.wait_for_app_task

Wait until an application-level Algolia task finishes: block until a change spanning the whole application is applied. Calls GET /waitForAppTask.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /waitForAppTask.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "block until the application-wide change lands", "wait for an account-level operation", "hold until the whole-application task is done".

algolia_search.wait_for_task

Wait until an Algolia indexing task finishes: block until a write against a collection is applied, so the next read sees it. Calls GET /waitForTask.

Class read (reads only). No scopes beyond the connection's defaults. Calls GET /waitForTask.

Arguments:

Result fields (the payload is trimmed to these before it reaches the model):

Also retrieved by: "block until the write is applied", "wait for the index to catch up", "hold until the change is searchable".