Can I use Algolia as a CLI?

Yes. KosmoKrator exposes a Algolia CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Algolia through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Algolia tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Algolia credentials stored?

Algolia credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Algolia MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

data

Algolia CLI for AI Agents

Use the Algolia CLI from KosmoKrator to call Algolia tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

Algolia CLI Setup

Algolia can be configured headlessly with `kosmokrator integrations:configure algolia`.

Install, configure, and verify

# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure algolia --set app_id="$ALGOLIA_APP_ID" --set api_key="$ALGOLIA_API_KEY" --enable --read allow --write ask --json
kosmokrator integrations:doctor algolia --json
kosmokrator integrations:status --json

Credentials

Authentication type: API key api_key. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

Key	Env var	Type	Required	Label
`app_id`	`ALGOLIA_APP_ID`	Text `text`	yes	Application ID
`api_key`	`ALGOLIA_API_KEY`	Secret `secret`	yes	API Key

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call

kosmo integrations:call algolia.algolia_add_api_key '{"payload":"example_payload"}' --json

Provider shortcut

kosmo integrations:algolia algolia_add_api_key '{"payload":"example_payload"}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands

kosmo integrations:docs algolia --json
kosmo integrations:docs algolia.algolia_add_api_key --json
kosmo integrations:schema algolia.algolia_add_api_key --json
kosmo integrations:search "Algolia" --json
kosmo integrations:list --json

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CI Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status. Cron Jobs Schedule repeatable integration workflows from cron while keeping credentials in KosmoKrator config. Shell Scripts Call integration functions from shell scripts with stable JSON input and output. Headless Automation Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers. Coding Agents Let coding agents discover schemas and execute integration functions through CLI commands or MCP.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

`algolia.algolia_add_api_key`

Add a restricted Algolia API key with ACLs and optional restrictions.

Write write

Parameters: payload

Generic call

kosmo integrations:call algolia.algolia_add_api_key '{"payload":"example_payload"}' --json

Shortcut

kosmo integrations:algolia algolia_add_api_key '{"payload":"example_payload"}' --json

`algolia.algolia_api_delete`

Call a safe relative Algolia API path with DELETE for endpoints not covered by a dedicated tool.

Read read

Parameters: path, query

Generic call

kosmo integrations:call algolia.algolia_api_delete '{"path":"example_path","query":"example_query"}' --json

Shortcut

kosmo integrations:algolia algolia_api_delete '{"path":"example_path","query":"example_query"}' --json

`algolia.algolia_api_get`

Call a safe relative Algolia API path with GET for endpoints not covered by a dedicated tool.

Read read

Parameters: path, query, use_search_endpoint

Generic call

kosmo integrations:call algolia.algolia_api_get '{"path":"example_path","query":"example_query","use_search_endpoint":true}' --json

Shortcut

kosmo integrations:algolia algolia_api_get '{"path":"example_path","query":"example_query","use_search_endpoint":true}' --json

`algolia.algolia_api_post`

Call a safe relative Algolia API path with POST for endpoints not covered by a dedicated tool.

Read read

Parameters: path, payload, query, use_search_endpoint

Generic call

kosmo integrations:call algolia.algolia_api_post '{"path":"example_path","payload":"example_payload","query":"example_query","use_search_endpoint":true}' --json

Shortcut

kosmo integrations:algolia algolia_api_post '{"path":"example_path","payload":"example_payload","query":"example_query","use_search_endpoint":true}' --json

`algolia.algolia_api_put`

Call a safe relative Algolia API path with PUT for endpoints not covered by a dedicated tool.

Read read

Parameters: path, payload, query

Generic call

kosmo integrations:call algolia.algolia_api_put '{"path":"example_path","payload":"example_payload","query":"example_query"}' --json

Shortcut

kosmo integrations:algolia algolia_api_put '{"path":"example_path","payload":"example_payload","query":"example_query"}' --json

`algolia.algolia_batch`

Perform multiple write operations (addObject, updateObject, partialUpdateObject, deleteObject) in a single batch request for better performance.

Read read

Parameters: indexName, requests

Generic call

kosmo integrations:call algolia.algolia_batch '{"indexName":"example_indexName","requests":"example_requests"}' --json

Shortcut

kosmo integrations:algolia algolia_batch '{"indexName":"example_indexName","requests":"example_requests"}' --json

`algolia.algolia_batch_rules`

Create or update multiple Algolia query rules in one request.

Read read

Parameters: indexName, rules, query

Generic call

kosmo integrations:call algolia.algolia_batch_rules '{"indexName":"example_indexName","rules":"example_rules","query":"example_query"}' --json

Shortcut

kosmo integrations:algolia algolia_batch_rules '{"indexName":"example_indexName","rules":"example_rules","query":"example_query"}' --json

`algolia.algolia_batch_synonyms`

Create or update multiple Algolia synonyms in one request.

Read read

Parameters: indexName, synonyms, query

Generic call

kosmo integrations:call algolia.algolia_batch_synonyms '{"indexName":"example_indexName","synonyms":"example_synonyms","query":"example_query"}' --json

Shortcut

kosmo integrations:algolia algolia_batch_synonyms '{"indexName":"example_indexName","synonyms":"example_synonyms","query":"example_query"}' --json

`algolia.algolia_browse`

Browse records in an Algolia index for exports or complete scans.

Read read

Parameters: indexName, params

Generic call

kosmo integrations:call algolia.algolia_browse '{"indexName":"example_indexName","params":"example_params"}' --json

Shortcut

kosmo integrations:algolia algolia_browse '{"indexName":"example_indexName","params":"example_params"}' --json

`algolia.algolia_clear_index`

Remove all records from an Algolia index. The index itself is preserved with its settings. This action is irreversible.

Read read

Parameters: indexName

Generic call

kosmo integrations:call algolia.algolia_clear_index '{"indexName":"example_indexName"}' --json

Shortcut

kosmo integrations:algolia algolia_clear_index '{"indexName":"example_indexName"}' --json

`algolia.algolia_clear_rules`

Clear query rules from an Algolia index.

Read read

Parameters: indexName, query

Generic call

kosmo integrations:call algolia.algolia_clear_rules '{"indexName":"example_indexName","query":"example_query"}' --json

Shortcut

kosmo integrations:algolia algolia_clear_rules '{"indexName":"example_indexName","query":"example_query"}' --json

`algolia.algolia_clear_synonyms`

Clear synonyms from an Algolia index.

Read read

Parameters: indexName, query

Generic call

kosmo integrations:call algolia.algolia_clear_synonyms '{"indexName":"example_indexName","query":"example_query"}' --json

Shortcut

kosmo integrations:algolia algolia_clear_synonyms '{"indexName":"example_indexName","query":"example_query"}' --json

`algolia.algolia_delete_api_key`

Delete an Algolia API key.

Write write

Parameters: key

Generic call

kosmo integrations:call algolia.algolia_delete_api_key '{"key":"example_key"}' --json

Shortcut

kosmo integrations:algolia algolia_delete_api_key '{"key":"example_key"}' --json

`algolia.algolia_delete_index`

Delete an Algolia index and all its records.

Write write

Parameters: indexName

Generic call

kosmo integrations:call algolia.algolia_delete_index '{"indexName":"example_indexName"}' --json

Shortcut

kosmo integrations:algolia algolia_delete_index '{"indexName":"example_indexName"}' --json

`algolia.algolia_delete_object`

Delete a record from an Algolia index by its objectID. This action is irreversible.

Write write

Parameters: indexName, objectID

Generic call

kosmo integrations:call algolia.algolia_delete_object '{"indexName":"example_indexName","objectID":"example_objectID"}' --json

Shortcut

kosmo integrations:algolia algolia_delete_object '{"indexName":"example_indexName","objectID":"example_objectID"}' --json

`algolia.algolia_delete_rule`

Delete one Algolia query rule by objectID.

Write write

Parameters: indexName, objectID

Generic call

kosmo integrations:call algolia.algolia_delete_rule '{"indexName":"example_indexName","objectID":"example_objectID"}' --json

Shortcut

kosmo integrations:algolia algolia_delete_rule '{"indexName":"example_indexName","objectID":"example_objectID"}' --json

`algolia.algolia_delete_synonym`

Delete one Algolia synonym by objectID.

Write write

Parameters: indexName, objectID

Generic call

kosmo integrations:call algolia.algolia_delete_synonym '{"indexName":"example_indexName","objectID":"example_objectID"}' --json

Shortcut

kosmo integrations:algolia algolia_delete_synonym '{"indexName":"example_indexName","objectID":"example_objectID"}' --json

`algolia.algolia_get_api_key`

Get settings and ACLs for one Algolia API key.

Read read

Parameters: key

Generic call

kosmo integrations:call algolia.algolia_get_api_key '{"key":"example_key"}' --json

Shortcut

kosmo integrations:algolia algolia_get_api_key '{"key":"example_key"}' --json

`algolia.algolia_get_current_user`

List API keys for the Algolia application. Use this to verify that authentication is working and to see which API keys exist.

Read read

Parameters: none

Generic call

kosmo integrations:call algolia.algolia_get_current_user '{}' --json

Shortcut

kosmo integrations:algolia algolia_get_current_user '{}' --json

`algolia.algolia_get_object`

Retrieve a single record from an Algolia index by its objectID. Returns all attributes of the object.

Read read

Parameters: indexName, objectID, attributesToRetrieve

Generic call

kosmo integrations:call algolia.algolia_get_object '{"indexName":"example_indexName","objectID":"example_objectID","attributesToRetrieve":"example_attributesToRetrieve"}' --json

Shortcut

kosmo integrations:algolia algolia_get_object '{"indexName":"example_indexName","objectID":"example_objectID","attributesToRetrieve":"example_attributesToRetrieve"}' --json

`algolia.algolia_get_rule`

Get one Algolia query rule by objectID.

Read read

Parameters: indexName, objectID

Generic call

kosmo integrations:call algolia.algolia_get_rule '{"indexName":"example_indexName","objectID":"example_objectID"}' --json

Shortcut

kosmo integrations:algolia algolia_get_rule '{"indexName":"example_indexName","objectID":"example_objectID"}' --json

`algolia.algolia_get_settings`

Get the configuration settings of an Algolia index, including searchable attributes, ranking, facets, and more.

Read read

Parameters: indexName

Generic call

kosmo integrations:call algolia.algolia_get_settings '{"indexName":"example_indexName"}' --json

Shortcut

kosmo integrations:algolia algolia_get_settings '{"indexName":"example_indexName"}' --json

`algolia.algolia_get_synonym`

Get one Algolia synonym by objectID.

Read read

Parameters: indexName, objectID

Generic call

kosmo integrations:call algolia.algolia_get_synonym '{"indexName":"example_indexName","objectID":"example_objectID"}' --json

Shortcut

kosmo integrations:algolia algolia_get_synonym '{"indexName":"example_indexName","objectID":"example_objectID"}' --json

`algolia.algolia_get_task`

Get the status of an Algolia indexing task.

Read read

Parameters: indexName, taskID

Generic call

kosmo integrations:call algolia.algolia_get_task '{"indexName":"example_indexName","taskID":"example_taskID"}' --json

Shortcut

kosmo integrations:algolia algolia_get_task '{"indexName":"example_indexName","taskID":"example_taskID"}' --json

`algolia.algolia_index_operation`

Run an Algolia index operation such as copy or move to another index.

Read read

Parameters: indexName, operation, destination, extra

Generic call

kosmo integrations:call algolia.algolia_index_operation '{"indexName":"example_indexName","operation":"example_operation","destination":"example_destination","extra":"example_extra"}' --json

Shortcut

kosmo integrations:algolia algolia_index_operation '{"indexName":"example_indexName","operation":"example_operation","destination":"example_destination","extra":"example_extra"}' --json

`algolia.algolia_list_api_keys`

List Algolia API keys in the application.

Read read

Parameters: none

Generic call

kosmo integrations:call algolia.algolia_list_api_keys '{}' --json

Shortcut

kosmo integrations:algolia algolia_list_api_keys '{}' --json

`algolia.algolia_list_indices`

List all indices in the Algolia application. Returns index names, entry counts, and sizes information.

Read read

Parameters: page, hitsPerPage

Generic call

kosmo integrations:call algolia.algolia_list_indices '{"page":1,"hitsPerPage":1}' --json

Shortcut

kosmo integrations:algolia algolia_list_indices '{"page":1,"hitsPerPage":1}' --json

`algolia.algolia_list_logs`

List recent Algolia logs for API activity and troubleshooting.

Read read

Parameters: query

Generic call

kosmo integrations:call algolia.algolia_list_logs '{"query":"example_query"}' --json

Shortcut

kosmo integrations:algolia algolia_list_logs '{"query":"example_query"}' --json

`algolia.algolia_partial_update`

Update specific attributes of a record without replacing the entire object. Only the specified attributes will be changed; all other attributes remain unchanged.

Read read

Parameters: indexName, objectID, attributes

Generic call

kosmo integrations:call algolia.algolia_partial_update '{"indexName":"example_indexName","objectID":"example_objectID","attributes":"example_attributes"}' --json

Shortcut

kosmo integrations:algolia algolia_partial_update '{"indexName":"example_indexName","objectID":"example_objectID","attributes":"example_attributes"}' --json

`algolia.algolia_save_object`

Create or replace a record in an Algolia index. The object is identified by its objectID. If a record with this objectID exists, it will be fully replaced.

Read read

Parameters: indexName, objectID, body

Generic call

kosmo integrations:call algolia.algolia_save_object '{"indexName":"example_indexName","objectID":"example_objectID","body":"example_body"}' --json

Shortcut

kosmo integrations:algolia algolia_save_object '{"indexName":"example_indexName","objectID":"example_objectID","body":"example_body"}' --json

`algolia.algolia_save_rule`

Create or replace an Algolia query rule.

Read read

Parameters: indexName, objectID, payload

Generic call

kosmo integrations:call algolia.algolia_save_rule '{"indexName":"example_indexName","objectID":"example_objectID","payload":"example_payload"}' --json

Shortcut

kosmo integrations:algolia algolia_save_rule '{"indexName":"example_indexName","objectID":"example_objectID","payload":"example_payload"}' --json

`algolia.algolia_save_synonym`

Create or replace an Algolia synonym.

Read read

Parameters: indexName, objectID, payload

Generic call

kosmo integrations:call algolia.algolia_save_synonym '{"indexName":"example_indexName","objectID":"example_objectID","payload":"example_payload"}' --json

Shortcut

kosmo integrations:algolia algolia_save_synonym '{"indexName":"example_indexName","objectID":"example_objectID","payload":"example_payload"}' --json

`algolia.algolia_search`

Search an Algolia index. Supports full-text search with filters, faceting, and pagination. Use this to find records matching a query string or filter criteria.

Read read

Parameters: indexName, query, filters, hitsPerPage, page, attributesToRetrieve, facets, facetFilters, numericFilters

Generic call

kosmo integrations:call algolia.algolia_search '{"indexName":"example_indexName","query":"example_query","filters":"example_filters","hitsPerPage":1,"page":1,"attributesToRetrieve":"example_attributesToRetrieve","facets":"example_facets","facetFilters":"example_facetFilters"}' --json

Shortcut

kosmo integrations:algolia algolia_search '{"indexName":"example_indexName","query":"example_query","filters":"example_filters","hitsPerPage":1,"page":1,"attributesToRetrieve":"example_attributesToRetrieve","facets":"example_facets","facetFilters":"example_facetFilters"}' --json

`algolia.algolia_search_facet_values`

Search values for an Algolia facet attribute.

Read read

Parameters: indexName, facetName, params

Generic call

kosmo integrations:call algolia.algolia_search_facet_values '{"indexName":"example_indexName","facetName":"example_facetName","params":"example_params"}' --json

Shortcut

kosmo integrations:algolia algolia_search_facet_values '{"indexName":"example_indexName","facetName":"example_facetName","params":"example_params"}' --json

`algolia.algolia_search_multiple`

Search multiple Algolia indices in one request using the multiple queries endpoint.

Read read

Parameters: requests, strategy

Generic call

kosmo integrations:call algolia.algolia_search_multiple '{"requests":"example_requests","strategy":"example_strategy"}' --json

Shortcut

kosmo integrations:algolia algolia_search_multiple '{"requests":"example_requests","strategy":"example_strategy"}' --json

`algolia.algolia_search_rules`

Search query rules in an Algolia index.

Read read

Parameters: indexName, params

Generic call

kosmo integrations:call algolia.algolia_search_rules '{"indexName":"example_indexName","params":"example_params"}' --json

Shortcut

kosmo integrations:algolia algolia_search_rules '{"indexName":"example_indexName","params":"example_params"}' --json

`algolia.algolia_search_synonyms`

Search synonyms in an Algolia index.

Read read

Parameters: indexName, params

Generic call

kosmo integrations:call algolia.algolia_search_synonyms '{"indexName":"example_indexName","params":"example_params"}' --json

Shortcut

kosmo integrations:algolia algolia_search_synonyms '{"indexName":"example_indexName","params":"example_params"}' --json

`algolia.algolia_set_settings`

Update Algolia index settings such as searchableAttributes, ranking, facets, replicas, and typo tolerance.

Read read

Parameters: indexName, settings, query

Generic call

kosmo integrations:call algolia.algolia_set_settings '{"indexName":"example_indexName","settings":"example_settings","query":"example_query"}' --json

Shortcut

kosmo integrations:algolia algolia_set_settings '{"indexName":"example_indexName","settings":"example_settings","query":"example_query"}' --json

`algolia.algolia_update_api_key`

Update ACLs and restrictions for an Algolia API key.

Write write

Parameters: key, payload

Generic call

kosmo integrations:call algolia.algolia_update_api_key '{"key":"example_key","payload":"example_payload"}' --json

Shortcut

kosmo integrations:algolia algolia_update_api_key '{"key":"example_key","payload":"example_payload"}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

algolia.algolia_add_api_key 1 parameters

Schema command

kosmo integrations:schema algolia.algolia_add_api_key --json

Parameter	Type	Required	Description
`payload`	object	yes	API key payload including acl and optional restrictions.

algolia.algolia_api_delete 2 parameters

Schema command

kosmo integrations:schema algolia.algolia_api_delete --json

Parameter	Type	Required	Description
`path`	string	yes	Relative path below /1.
`query`	object	no	Optional query parameters.

algolia.algolia_api_get 3 parameters

Schema command

kosmo integrations:schema algolia.algolia_api_get --json

Parameter	Type	Required	Description
`path`	string	yes	Relative path below /1.
`query`	object	no	Optional query parameters.
`use_search_endpoint`	boolean	no	Use the DSN search endpoint.

algolia.algolia_api_post 4 parameters

Schema command

kosmo integrations:schema algolia.algolia_api_post --json

Parameter	Type	Required	Description
`path`	string	yes	Relative path below /1.
`payload`	object	no	JSON request body.
`query`	object	no	Optional query parameters.
`use_search_endpoint`	boolean	no	Use the DSN search endpoint.

algolia.algolia_api_put 3 parameters

Schema command

kosmo integrations:schema algolia.algolia_api_put --json

Parameter	Type	Required	Description
`path`	string	yes	Relative path below /1.
`payload`	object	no	JSON request body.
`query`	object	no	Optional query parameters.

algolia.algolia_batch 2 parameters

Schema command

kosmo integrations:schema algolia.algolia_batch --json

Parameter	Type	Required	Description
`indexName`	string	yes	The name of the index.
`requests`	array	yes	Array of batch operations. Each request must have "action" (addObject, updateObject, partialUpdateObject, deleteObject) and "body" (the record data). For update/delete, body must include "objectID".

algolia.algolia_batch_rules 3 parameters

Schema command

kosmo integrations:schema algolia.algolia_batch_rules --json

Parameter	Type	Required	Description
`indexName`	string	yes	The index name.
`rules`	array	yes	Array of rule objects.
`query`	object	no	Optional query parameters such as clearExistingRules or forwardToReplicas.

algolia.algolia_batch_synonyms 3 parameters

Schema command

kosmo integrations:schema algolia.algolia_batch_synonyms --json

Parameter	Type	Required	Description
`indexName`	string	yes	The index name.
`synonyms`	array	yes	Array of synonym objects.
`query`	object	no	Optional query parameters such as replaceExistingSynonyms or forwardToReplicas.

algolia.algolia_browse 2 parameters

Schema command

kosmo integrations:schema algolia.algolia_browse --json

Parameter	Type	Required	Description
`indexName`	string	yes	The index name.
`params`	object	no	Browse parameters such as query, cursor, filters, or hitsPerPage.

algolia.algolia_clear_index 1 parameters

Schema command

kosmo integrations:schema algolia.algolia_clear_index --json

Parameter	Type	Required	Description
`indexName`	string	yes	The name of the index to clear.

algolia.algolia_clear_rules 2 parameters

Schema command

kosmo integrations:schema algolia.algolia_clear_rules --json

Parameter	Type	Required	Description
`indexName`	string	yes	The index name.
`query`	object	no	Optional query parameters such as forwardToReplicas.

algolia.algolia_clear_synonyms 2 parameters

Schema command

kosmo integrations:schema algolia.algolia_clear_synonyms --json

Parameter	Type	Required	Description
`indexName`	string	yes	The index name.
`query`	object	no	Optional query parameters such as forwardToReplicas.

algolia.algolia_delete_api_key 1 parameters

Schema command

kosmo integrations:schema algolia.algolia_delete_api_key --json

Parameter	Type	Required	Description
`key`	string	yes	The API key value.

algolia.algolia_delete_index 1 parameters

Schema command

kosmo integrations:schema algolia.algolia_delete_index --json

Parameter	Type	Required	Description
`indexName`	string	yes	The index name.

algolia.algolia_delete_object 2 parameters

Schema command

kosmo integrations:schema algolia.algolia_delete_object --json

Parameter	Type	Required	Description
`indexName`	string	yes	The name of the index.
`objectID`	string	yes	The unique identifier of the record to delete.

algolia.algolia_delete_rule 2 parameters

Schema command

kosmo integrations:schema algolia.algolia_delete_rule --json

Parameter	Type	Required	Description
`indexName`	string	yes	The index name.
`objectID`	string	yes	The rule objectID.

algolia.algolia_delete_synonym 2 parameters

Schema command

kosmo integrations:schema algolia.algolia_delete_synonym --json

Parameter	Type	Required	Description
`indexName`	string	yes	The index name.
`objectID`	string	yes	The synonym objectID.

algolia.algolia_get_api_key 1 parameters

Schema command

kosmo integrations:schema algolia.algolia_get_api_key --json

Parameter	Type	Required	Description
`key`	string	yes	The API key value.

algolia.algolia_get_current_user 0 parameters

Schema command

kosmo integrations:schema algolia.algolia_get_current_user --json

Parameter	Type	Required	Description
No parameters.

algolia.algolia_get_object 3 parameters

Schema command

kosmo integrations:schema algolia.algolia_get_object --json

Parameter	Type	Required	Description
`indexName`	string	yes	The name of the index.
`objectID`	string	yes	The unique identifier of the record.
`attributesToRetrieve`	array	no	List of attributes to include in the response. Default: all attributes.

algolia.algolia_get_rule 2 parameters

Schema command

kosmo integrations:schema algolia.algolia_get_rule --json

Parameter	Type	Required	Description
`indexName`	string	yes	The index name.
`objectID`	string	yes	The rule objectID.

algolia.algolia_get_settings 1 parameters

Schema command

kosmo integrations:schema algolia.algolia_get_settings --json

Parameter	Type	Required	Description
`indexName`	string	yes	The name of the index.

algolia.algolia_get_synonym 2 parameters

Schema command

kosmo integrations:schema algolia.algolia_get_synonym --json

Parameter	Type	Required	Description
`indexName`	string	yes	The index name.
`objectID`	string	yes	The synonym objectID.

algolia.algolia_get_task 2 parameters

Schema command

kosmo integrations:schema algolia.algolia_get_task --json

Parameter	Type	Required	Description
`indexName`	string	yes	The index name.
`taskID`	string	yes	The Algolia task ID.

algolia.algolia_index_operation 4 parameters

Schema command

kosmo integrations:schema algolia.algolia_index_operation --json

Parameter	Type	Required	Description
`indexName`	string	yes	Source index name.
`operation`	string	yes	Operation name, such as copy or move.
`destination`	string	yes	Destination index name.
`extra`	object	no	Optional additional operation payload.

algolia.algolia_list_api_keys 0 parameters

Schema command

kosmo integrations:schema algolia.algolia_list_api_keys --json

Parameter	Type	Required	Description
No parameters.

algolia.algolia_list_indices 2 parameters

Schema command

kosmo integrations:schema algolia.algolia_list_indices --json

Parameter	Type	Required	Description
`page`	integer	no	Page number for pagination (0-based). Default: 0.
`hitsPerPage`	integer	no	Number of indices per page. Default: 100.

algolia.algolia_list_logs 1 parameters

Schema command

kosmo integrations:schema algolia.algolia_list_logs --json

Parameter	Type	Required	Description
`query`	object	no	Optional log query parameters such as offset, length, type, and indexName.

algolia.algolia_partial_update 3 parameters

Schema command

kosmo integrations:schema algolia.algolia_partial_update --json

Parameter	Type	Required	Description
`indexName`	string	yes	The name of the index.
`objectID`	string	yes	The unique identifier of the record to update.
`attributes`	object	yes	Key-value pairs of attributes to update. Only the specified attributes will be changed. Use special operations like {"_operation":"Increment","value":1} for atomic updates.

algolia.algolia_save_object 3 parameters

Schema command

kosmo integrations:schema algolia.algolia_save_object --json

Parameter	Type	Required	Description
`indexName`	string	yes	The name of the index.
`objectID`	string	yes	The unique identifier for the record.
`body`	object	yes	The complete record data. Must include all attributes you want stored. The objectID will be set automatically.

algolia.algolia_save_rule 3 parameters

Schema command

kosmo integrations:schema algolia.algolia_save_rule --json

Parameter	Type	Required	Description
`indexName`	string	yes	The index name.
`objectID`	string	yes	The rule objectID.
`payload`	object	yes	Rule payload.

algolia.algolia_save_synonym 3 parameters

Schema command

kosmo integrations:schema algolia.algolia_save_synonym --json

Parameter	Type	Required	Description
`indexName`	string	yes	The index name.
`objectID`	string	yes	The synonym objectID.
`payload`	object	yes	Synonym payload.

algolia.algolia_search 9 parameters

Schema command

kosmo integrations:schema algolia.algolia_search --json

Parameter	Type	Required	Description
`indexName`	string	yes	The name of the index to search.
`query`	string	yes	The search query string. Use an empty string "" to retrieve all records (with filters).
`filters`	string	no	Filter expression (e.g., "category:electronics AND price<100").
`hitsPerPage`	integer	no	Number of results per page (default: 20, max: 1000).
`page`	integer	no	Page number (0-based). Default: 0.
`attributesToRetrieve`	array	no	List of attributes to include in results. Default: ["*"] (all).
`facets`	array	no	List of facet attributes to compute.
`facetFilters`	array	no	Filter by facet values, e.g. [["category:electronics"], ["brand:Apple"]].
`numericFilters`	array	no	Numeric filters, e.g. ["price>50", "price<200"].

algolia.algolia_search_facet_values 3 parameters

Schema command

kosmo integrations:schema algolia.algolia_search_facet_values --json

Parameter	Type	Required	Description
`indexName`	string	yes	The index name.
`facetName`	string	yes	The facet attribute name.
`params`	object	no	Facet search parameters such as facetQuery and filters.

algolia.algolia_search_multiple 2 parameters

Schema command

kosmo integrations:schema algolia.algolia_search_multiple --json

Parameter	Type	Required	Description
`requests`	array	yes	Array of query objects with indexName and params.
`strategy`	string	no	Multiple query strategy. Defaults to none.

algolia.algolia_search_rules 2 parameters

Schema command

kosmo integrations:schema algolia.algolia_search_rules --json

Parameter	Type	Required	Description
`indexName`	string	yes	The index name.
`params`	object	no	Rule search parameters such as query, page, and hitsPerPage.

algolia.algolia_search_synonyms 2 parameters

Schema command

kosmo integrations:schema algolia.algolia_search_synonyms --json

Parameter	Type	Required	Description
`indexName`	string	yes	The index name.
`params`	object	no	Search parameters such as query, type, page, and hitsPerPage.

algolia.algolia_set_settings 3 parameters

Schema command

kosmo integrations:schema algolia.algolia_set_settings --json

Parameter	Type	Required	Description
`indexName`	string	yes	The index name.
`settings`	object	yes	Settings payload.
`query`	object	no	Optional query parameters such as forwardToReplicas.

algolia.algolia_update_api_key 2 parameters

Schema command

kosmo integrations:schema algolia.algolia_update_api_key --json

Parameter	Type	Required	Description
`key`	string	yes	The API key value.
`payload`	object	yes	Updated API key payload.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.