Can I use Typesense as a CLI?

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

Can I expose Typesense through MCP?

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

Where are Typesense credentials stored?

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

Can I deny write access for Typesense MCP tools?

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

data

Typesense CLI for AI Agents

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

Typesense CLI Setup

Typesense can be configured headlessly with `kosmokrator integrations:configure typesense`.

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 typesense --enable --read allow --write ask --json
kosmokrator integrations:doctor typesense --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.

No credentials are required.

Command Patterns

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

Generic CLI call

kosmo integrations:call typesense.typesense_clear_cache '{}' --json

Provider shortcut

kosmo integrations:typesense typesense_clear_cache '{}' --json

Discovery

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

Discovery commands

kosmo integrations:docs typesense --json
kosmo integrations:docs typesense.typesense_clear_cache --json
kosmo integrations:schema typesense.typesense_clear_cache --json
kosmo integrations:search "Typesense" --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.

`typesense.typesense_clear_cache`

Clear the cached responses of search requests in the LRU cache. Clear the cached responses of search requests that are sent with `use_cache` parameter in the LRU cache.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_clear_cache '{}' --json

Shortcut

kosmo integrations:typesense typesense_clear_cache '{}' --json

`typesense.typesense_compact_db`

Compacting the on-disk database Typesense uses RocksDB to store your documents on the disk. If you do frequent writes or updates, you could benefit from running a compaction of the underlying RocksDB database. This could reduce the size of the database and decrease read latency. While the database will not block during this operation, we recommend running it during off-peak hours.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_compact_db '{}' --json

Shortcut

kosmo integrations:typesense typesense_compact_db '{}' --json

`typesense.typesense_create_analytics_event`

Create an analytics event Submit a single analytics event. The event must correspond to an existing analytics rule by name.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_create_analytics_event '{}' --json

Shortcut

kosmo integrations:typesense typesense_create_analytics_event '{}' --json

`typesense.typesense_create_analytics_rule`

Create analytics rule(s) Create one or more analytics rules. You can send a single rule object or an array of rule objects.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_create_analytics_rule '{}' --json

Shortcut

kosmo integrations:typesense typesense_create_analytics_rule '{}' --json

`typesense.typesense_create_collection`

Create a new collection When a collection is created, we give it a name and describe the fields that will be indexed from the documents added to the collection.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_create_collection '{}' --json

Shortcut

kosmo integrations:typesense typesense_create_collection '{}' --json

`typesense.typesense_create_conversation_model`

Create a conversation model Create a Conversation Model

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_create_conversation_model '{}' --json

Shortcut

kosmo integrations:typesense typesense_create_conversation_model '{}' --json

`typesense.typesense_create_key`

Create an API Key with fine-grain access control. You can restrict access on both a per-collection and per-action level. The generated key is returned only during creation. You want to store this key carefully in a secure place.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_create_key '{}' --json

Shortcut

kosmo integrations:typesense typesense_create_key '{}' --json

`typesense.typesense_create_n_l_search_model`

Create a NL search model Create a new NL search model.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_create_n_l_search_model '{}' --json

Shortcut

kosmo integrations:typesense typesense_create_n_l_search_model '{}' --json

`typesense.typesense_debug`

Print debugging information

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_debug '{}' --json

Shortcut

kosmo integrations:typesense typesense_debug '{}' --json

`typesense.typesense_delete_alias`

Delete an alias

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_delete_alias '{}' --json

Shortcut

kosmo integrations:typesense typesense_delete_alias '{}' --json

`typesense.typesense_delete_analytics_rule`

Delete an analytics rule Permanently deletes an analytics rule, given it's name

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_delete_analytics_rule '{}' --json

Shortcut

kosmo integrations:typesense typesense_delete_analytics_rule '{}' --json

`typesense.typesense_delete_collection`

Delete a collection Permanently drops a collection. This action cannot be undone. For large collections, this might have an impact on read latencies.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_delete_collection '{}' --json

Shortcut

kosmo integrations:typesense typesense_delete_collection '{}' --json

`typesense.typesense_delete_conversation_model`

Delete a conversation model

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_delete_conversation_model '{}' --json

Shortcut

kosmo integrations:typesense typesense_delete_conversation_model '{}' --json

`typesense.typesense_delete_curation_set`

Delete a curation set Delete a specific curation set by its name

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_delete_curation_set '{}' --json

Shortcut

kosmo integrations:typesense typesense_delete_curation_set '{}' --json

`typesense.typesense_delete_curation_set_item`

Delete a curation set item Delete a specific curation item by its id

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_delete_curation_set_item '{}' --json

Shortcut

kosmo integrations:typesense typesense_delete_curation_set_item '{}' --json

`typesense.typesense_delete_document`

Delete a document Delete an individual document from a collection by using its ID.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_delete_document '{}' --json

Shortcut

kosmo integrations:typesense typesense_delete_document '{}' --json

`typesense.typesense_delete_documents`

Delete a bunch of documents that match a specific filter condition. Use the `batch_size` parameter to control the number of documents that should deleted at a time. A larger value will speed up deletions, but will impact performance of other operations running on the server.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_delete_documents '{}' --json

Shortcut

kosmo integrations:typesense typesense_delete_documents '{}' --json

`typesense.typesense_delete_key`

Delete an API key given its ID.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_delete_key '{}' --json

Shortcut

kosmo integrations:typesense typesense_delete_key '{}' --json

`typesense.typesense_delete_n_l_search_model`

Delete a NL search model Delete a specific NL search model by its ID.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_delete_n_l_search_model '{}' --json

Shortcut

kosmo integrations:typesense typesense_delete_n_l_search_model '{}' --json

`typesense.typesense_delete_preset`

Delete a preset. Permanently deletes a preset, given it's name.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_delete_preset '{}' --json

Shortcut

kosmo integrations:typesense typesense_delete_preset '{}' --json

`typesense.typesense_delete_stopwords_set`

Delete a stopwords set. Permanently deletes a stopwords set, given it's name.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_delete_stopwords_set '{}' --json

Shortcut

kosmo integrations:typesense typesense_delete_stopwords_set '{}' --json

`typesense.typesense_delete_synonym_set`

Delete a synonym set Delete a specific synonym set by its name

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_delete_synonym_set '{}' --json

Shortcut

kosmo integrations:typesense typesense_delete_synonym_set '{}' --json

`typesense.typesense_delete_synonym_set_item`

Delete a synonym set item Delete a specific synonym item by its id

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_delete_synonym_set_item '{}' --json

Shortcut

kosmo integrations:typesense typesense_delete_synonym_set_item '{}' --json

`typesense.typesense_export_documents`

Export all documents in a collection in JSON lines format.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_export_documents '{}' --json

Shortcut

kosmo integrations:typesense typesense_export_documents '{}' --json

`typesense.typesense_flush_analytics`

Flush in-memory analytics to disk Triggers a flush of analytics data to persistent storage.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_flush_analytics '{}' --json

Shortcut

kosmo integrations:typesense typesense_flush_analytics '{}' --json

`typesense.typesense_get_alias`

Retrieve an alias Find out which collection an alias points to by fetching it

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_get_alias '{}' --json

Shortcut

kosmo integrations:typesense typesense_get_alias '{}' --json

`typesense.typesense_get_aliases`

List all aliases and the corresponding collections that they map to.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_get_aliases '{}' --json

Shortcut

kosmo integrations:typesense typesense_get_aliases '{}' --json

`typesense.typesense_get_analytics_events`

Retrieve analytics events Retrieve the most recent events for a user and rule.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_get_analytics_events '{}' --json

Shortcut

kosmo integrations:typesense typesense_get_analytics_events '{}' --json

`typesense.typesense_get_analytics_status`

Get analytics subsystem status Returns sizes of internal analytics buffers and queues.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_get_analytics_status '{}' --json

Shortcut

kosmo integrations:typesense typesense_get_analytics_status '{}' --json

`typesense.typesense_get_collection`

Retrieve a single collection Retrieve the details of a collection, given its name.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_get_collection '{}' --json

Shortcut

kosmo integrations:typesense typesense_get_collection '{}' --json

`typesense.typesense_get_document`

Retrieve a document Fetch an individual document from a collection by using its ID.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_get_document '{}' --json

Shortcut

kosmo integrations:typesense typesense_get_document '{}' --json

`typesense.typesense_get_health`

Checks if Typesense server is ready to accept requests.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_get_health '{}' --json

Shortcut

kosmo integrations:typesense typesense_get_health '{}' --json

`typesense.typesense_get_key`

Retrieve (metadata about) a key. Only the key prefix is returned when you retrieve a key. Due to security reasons, only the create endpoint returns the full API key.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_get_key '{}' --json

Shortcut

kosmo integrations:typesense typesense_get_key '{}' --json

`typesense.typesense_get_keys`

Retrieve (metadata about) all keys.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_get_keys '{}' --json

Shortcut

kosmo integrations:typesense typesense_get_keys '{}' --json

`typesense.typesense_get_schema_changes`

Get the status of in-progress schema change operations Returns the status of any ongoing schema change operations. If no schema changes are in progress, returns an empty response.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_get_schema_changes '{}' --json

Shortcut

kosmo integrations:typesense typesense_get_schema_changes '{}' --json

`typesense.typesense_get_stemming_dictionary`

Retrieve a stemming dictionary Fetch details of a specific stemming dictionary.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_get_stemming_dictionary '{}' --json

Shortcut

kosmo integrations:typesense typesense_get_stemming_dictionary '{}' --json

`typesense.typesense_import_documents`

Import documents into a collection The documents to be imported must be formatted in a newline delimited JSON structure. You can feed the output file from a Typesense export operation directly as import.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_import_documents '{}' --json

Shortcut

kosmo integrations:typesense typesense_import_documents '{}' --json

`typesense.typesense_import_stemming_dictionary`

Import a stemming dictionary Upload a JSONL file containing word mappings to create or update a stemming dictionary.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_import_stemming_dictionary '{}' --json

Shortcut

kosmo integrations:typesense typesense_import_stemming_dictionary '{}' --json

`typesense.typesense_index_document`

Index a document A document to be indexed in a given collection must conform to the schema of the collection.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_index_document '{}' --json

Shortcut

kosmo integrations:typesense typesense_index_document '{}' --json

`typesense.typesense_list_collections`

List all collections Returns a summary of all your collections. The collections are returned sorted by creation date, with the most recent collections appearing first.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_list_collections '{}' --json

Shortcut

kosmo integrations:typesense typesense_list_collections '{}' --json

`typesense.typesense_list_stemming_dictionaries`

List all stemming dictionaries Retrieve a list of all available stemming dictionaries.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_list_stemming_dictionaries '{}' --json

Shortcut

kosmo integrations:typesense typesense_list_stemming_dictionaries '{}' --json

`typesense.typesense_multi_search`

send multiple search requests in a single HTTP request This is especially useful to avoid round-trip network latencies incurred otherwise if each of these requests are sent in separate HTTP requests. You can also use this feature to do a federated search across multiple collections in a single HTTP request.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_multi_search '{}' --json

Shortcut

kosmo integrations:typesense typesense_multi_search '{}' --json

`typesense.typesense_retrieve_a_p_i_stats`

Get stats about API endpoints. Retrieve the stats about API endpoints.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_retrieve_a_p_i_stats '{}' --json

Shortcut

kosmo integrations:typesense typesense_retrieve_a_p_i_stats '{}' --json

`typesense.typesense_retrieve_all_conversation_models`

List all conversation models Retrieve all conversation models

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_retrieve_all_conversation_models '{}' --json

Shortcut

kosmo integrations:typesense typesense_retrieve_all_conversation_models '{}' --json

`typesense.typesense_retrieve_all_n_l_search_models`

List all NL search models Retrieve all NL search models.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_retrieve_all_n_l_search_models '{}' --json

Shortcut

kosmo integrations:typesense typesense_retrieve_all_n_l_search_models '{}' --json

`typesense.typesense_retrieve_all_presets`

Retrieves all presets. Retrieve the details of all presets

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_retrieve_all_presets '{}' --json

Shortcut

kosmo integrations:typesense typesense_retrieve_all_presets '{}' --json

`typesense.typesense_retrieve_analytics_rule`

Retrieves an analytics rule Retrieve the details of an analytics rule, given it's name

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_retrieve_analytics_rule '{}' --json

Shortcut

kosmo integrations:typesense typesense_retrieve_analytics_rule '{}' --json

`typesense.typesense_retrieve_analytics_rules`

Retrieve analytics rules Retrieve all analytics rules. Use the optional rule_tag filter to narrow down results.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_retrieve_analytics_rules '{}' --json

Shortcut

kosmo integrations:typesense typesense_retrieve_analytics_rules '{}' --json

`typesense.typesense_retrieve_conversation_model`

Retrieve a conversation model

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_retrieve_conversation_model '{}' --json

Shortcut

kosmo integrations:typesense typesense_retrieve_conversation_model '{}' --json

`typesense.typesense_retrieve_curation_set`

Retrieve a curation set Retrieve a specific curation set by its name

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_retrieve_curation_set '{}' --json

Shortcut

kosmo integrations:typesense typesense_retrieve_curation_set '{}' --json

`typesense.typesense_retrieve_curation_set_item`

Retrieve a curation set item Retrieve a specific curation item by its id

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_retrieve_curation_set_item '{}' --json

Shortcut

kosmo integrations:typesense typesense_retrieve_curation_set_item '{}' --json

`typesense.typesense_retrieve_curation_set_items`

List items in a curation set Retrieve all curation items in a set

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_retrieve_curation_set_items '{}' --json

Shortcut

kosmo integrations:typesense typesense_retrieve_curation_set_items '{}' --json

`typesense.typesense_retrieve_curation_sets`

List all curation sets Retrieve all curation sets

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_retrieve_curation_sets '{}' --json

Shortcut

kosmo integrations:typesense typesense_retrieve_curation_sets '{}' --json

`typesense.typesense_retrieve_metrics`

Get current RAM, CPU, Disk & Network usage metrics. Retrieve the metrics.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_retrieve_metrics '{}' --json

Shortcut

kosmo integrations:typesense typesense_retrieve_metrics '{}' --json

`typesense.typesense_retrieve_n_l_search_model`

Retrieve a NL search model Retrieve a specific NL search model by its ID.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_retrieve_n_l_search_model '{}' --json

Shortcut

kosmo integrations:typesense typesense_retrieve_n_l_search_model '{}' --json

`typesense.typesense_retrieve_preset`

Retrieves a preset. Retrieve the details of a preset, given it's name.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_retrieve_preset '{}' --json

Shortcut

kosmo integrations:typesense typesense_retrieve_preset '{}' --json

`typesense.typesense_retrieve_stopwords_set`

Retrieves a stopwords set. Retrieve the details of a stopwords set, given it's name.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_retrieve_stopwords_set '{}' --json

Shortcut

kosmo integrations:typesense typesense_retrieve_stopwords_set '{}' --json

`typesense.typesense_retrieve_stopwords_sets`

Retrieves all stopwords sets. Retrieve the details of all stopwords sets

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_retrieve_stopwords_sets '{}' --json

Shortcut

kosmo integrations:typesense typesense_retrieve_stopwords_sets '{}' --json

`typesense.typesense_retrieve_synonym_set`

Retrieve a synonym set Retrieve a specific synonym set by its name

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_retrieve_synonym_set '{}' --json

Shortcut

kosmo integrations:typesense typesense_retrieve_synonym_set '{}' --json

`typesense.typesense_retrieve_synonym_set_item`

Retrieve a synonym set item Retrieve a specific synonym item by its id

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_retrieve_synonym_set_item '{}' --json

Shortcut

kosmo integrations:typesense typesense_retrieve_synonym_set_item '{}' --json

`typesense.typesense_retrieve_synonym_set_items`

List items in a synonym set Retrieve all synonym items in a set

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_retrieve_synonym_set_items '{}' --json

Shortcut

kosmo integrations:typesense typesense_retrieve_synonym_set_items '{}' --json

`typesense.typesense_retrieve_synonym_sets`

List all synonym sets Retrieve all synonym sets

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_retrieve_synonym_sets '{}' --json

Shortcut

kosmo integrations:typesense typesense_retrieve_synonym_sets '{}' --json

`typesense.typesense_search_documents`

Search for documents in a collection that match the search criteria.

Read read

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_search_documents '{}' --json

Shortcut

kosmo integrations:typesense typesense_search_documents '{}' --json

`typesense.typesense_take_snapshot`

Creates a point-in-time snapshot of a Typesense node's state and data in the specified directory. You can then backup the snapshot directory that gets created and later restore it as a data directory, as needed.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_take_snapshot '{}' --json

Shortcut

kosmo integrations:typesense typesense_take_snapshot '{}' --json

`typesense.typesense_toggle_slow_request_log`

Toggle Slow Request Log Enable logging of requests that take over a defined threshold of time. Default is `-1` which disables slow request logging. Slow requests are logged to the primary log file, with the prefix SLOW REQUEST.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_toggle_slow_request_log '{}' --json

Shortcut

kosmo integrations:typesense typesense_toggle_slow_request_log '{}' --json

`typesense.typesense_update_collection`

Update a collection's schema to modify the fields and their types.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_update_collection '{}' --json

Shortcut

kosmo integrations:typesense typesense_update_collection '{}' --json

`typesense.typesense_update_conversation_model`

Update a conversation model

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_update_conversation_model '{}' --json

Shortcut

kosmo integrations:typesense typesense_update_conversation_model '{}' --json

`typesense.typesense_update_document`

Update a document Update an individual document from a collection by using its ID. The update can be partial.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_update_document '{}' --json

Shortcut

kosmo integrations:typesense typesense_update_document '{}' --json

`typesense.typesense_update_documents`

Update documents with conditional query The filter_by query parameter is used to filter to specify a condition against which the documents are matched. The request body contains the fields that should be updated for any documents that match the filter condition. This endpoint is only available if the Typesense server is version `0.25.0.rc12` or later.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_update_documents '{}' --json

Shortcut

kosmo integrations:typesense typesense_update_documents '{}' --json

`typesense.typesense_update_n_l_search_model`

Update a NL search model Update an existing NL search model.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_update_n_l_search_model '{}' --json

Shortcut

kosmo integrations:typesense typesense_update_n_l_search_model '{}' --json

`typesense.typesense_upsert_alias`

Create or update a collection alias. An alias is a virtual collection name that points to a real collection. If you're familiar with symbolic links on Linux, it's very similar to that. Aliases are useful when you want to reindex your data in the background on a new collection and switch your application to it without any changes to your code.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_upsert_alias '{}' --json

Shortcut

kosmo integrations:typesense typesense_upsert_alias '{}' --json

`typesense.typesense_upsert_analytics_rule`

Upserts an analytics rule with the given name.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_upsert_analytics_rule '{}' --json

Shortcut

kosmo integrations:typesense typesense_upsert_analytics_rule '{}' --json

`typesense.typesense_upsert_curation_set`

Create or update a curation set with the given name

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_upsert_curation_set '{}' --json

Shortcut

kosmo integrations:typesense typesense_upsert_curation_set '{}' --json

`typesense.typesense_upsert_curation_set_item`

Create or update a curation set item with the given id

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_upsert_curation_set_item '{}' --json

Shortcut

kosmo integrations:typesense typesense_upsert_curation_set_item '{}' --json

`typesense.typesense_upsert_preset`

Upserts a preset. Create or update an existing preset.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_upsert_preset '{}' --json

Shortcut

kosmo integrations:typesense typesense_upsert_preset '{}' --json

`typesense.typesense_upsert_stopwords_set`

Upserts a stopwords set. When an analytics rule is created, we give it a name and describe the type, the source collections and the destination collection.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_upsert_stopwords_set '{}' --json

Shortcut

kosmo integrations:typesense typesense_upsert_stopwords_set '{}' --json

`typesense.typesense_upsert_synonym_set`

Create or update a synonym set with the given name

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_upsert_synonym_set '{}' --json

Shortcut

kosmo integrations:typesense typesense_upsert_synonym_set '{}' --json

`typesense.typesense_upsert_synonym_set_item`

Create or update a synonym set item with the given id

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_upsert_synonym_set_item '{}' --json

Shortcut

kosmo integrations:typesense typesense_upsert_synonym_set_item '{}' --json

`typesense.typesense_vote`

Triggers a follower node to initiate the raft voting process, which triggers leader re-election. The follower node that you run this operation against will become the new leader, once this command succeeds.

Write write

Parameters: none

Generic call

kosmo integrations:call typesense.typesense_vote '{}' --json

Shortcut

kosmo integrations:typesense typesense_vote '{}' --json

Function Schemas

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

typesense.typesense_clear_cache 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_clear_cache --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_compact_db 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_compact_db --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_create_analytics_event 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_create_analytics_event --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_create_analytics_rule 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_create_analytics_rule --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_create_collection 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_create_collection --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_create_conversation_model 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_create_conversation_model --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_create_key 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_create_key --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_create_n_l_search_model 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_create_n_l_search_model --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_debug 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_debug --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_delete_alias 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_delete_alias --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_delete_analytics_rule 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_delete_analytics_rule --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_delete_collection 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_delete_collection --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_delete_conversation_model 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_delete_conversation_model --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_delete_curation_set 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_delete_curation_set --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_delete_curation_set_item 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_delete_curation_set_item --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_delete_document 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_delete_document --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_delete_documents 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_delete_documents --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_delete_key 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_delete_key --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_delete_n_l_search_model 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_delete_n_l_search_model --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_delete_preset 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_delete_preset --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_delete_stopwords_set 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_delete_stopwords_set --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_delete_synonym_set 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_delete_synonym_set --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_delete_synonym_set_item 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_delete_synonym_set_item --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_export_documents 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_export_documents --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_flush_analytics 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_flush_analytics --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_get_alias 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_get_alias --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_get_aliases 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_get_aliases --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_get_analytics_events 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_get_analytics_events --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_get_analytics_status 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_get_analytics_status --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_get_collection 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_get_collection --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_get_document 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_get_document --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_get_health 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_get_health --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_get_key 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_get_key --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_get_keys 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_get_keys --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_get_schema_changes 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_get_schema_changes --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_get_stemming_dictionary 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_get_stemming_dictionary --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_import_documents 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_import_documents --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_import_stemming_dictionary 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_import_stemming_dictionary --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_index_document 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_index_document --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_list_collections 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_list_collections --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_list_stemming_dictionaries 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_list_stemming_dictionaries --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_multi_search 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_multi_search --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_retrieve_a_p_i_stats 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_retrieve_a_p_i_stats --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_retrieve_all_conversation_models 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_retrieve_all_conversation_models --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_retrieve_all_n_l_search_models 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_retrieve_all_n_l_search_models --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_retrieve_all_presets 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_retrieve_all_presets --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_retrieve_analytics_rule 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_retrieve_analytics_rule --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_retrieve_analytics_rules 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_retrieve_analytics_rules --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_retrieve_conversation_model 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_retrieve_conversation_model --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_retrieve_curation_set 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_retrieve_curation_set --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_retrieve_curation_set_item 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_retrieve_curation_set_item --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_retrieve_curation_set_items 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_retrieve_curation_set_items --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_retrieve_curation_sets 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_retrieve_curation_sets --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_retrieve_metrics 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_retrieve_metrics --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_retrieve_n_l_search_model 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_retrieve_n_l_search_model --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_retrieve_preset 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_retrieve_preset --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_retrieve_stopwords_set 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_retrieve_stopwords_set --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_retrieve_stopwords_sets 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_retrieve_stopwords_sets --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_retrieve_synonym_set 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_retrieve_synonym_set --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_retrieve_synonym_set_item 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_retrieve_synonym_set_item --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_retrieve_synonym_set_items 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_retrieve_synonym_set_items --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_retrieve_synonym_sets 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_retrieve_synonym_sets --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_search_documents 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_search_documents --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_take_snapshot 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_take_snapshot --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_toggle_slow_request_log 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_toggle_slow_request_log --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_update_collection 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_update_collection --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_update_conversation_model 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_update_conversation_model --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_update_document 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_update_document --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_update_documents 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_update_documents --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_update_n_l_search_model 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_update_n_l_search_model --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_upsert_alias 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_upsert_alias --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_upsert_analytics_rule 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_upsert_analytics_rule --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_upsert_curation_set 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_upsert_curation_set --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_upsert_curation_set_item 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_upsert_curation_set_item --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_upsert_preset 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_upsert_preset --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_upsert_stopwords_set 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_upsert_stopwords_set --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_upsert_synonym_set 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_upsert_synonym_set --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_upsert_synonym_set_item 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_upsert_synonym_set_item --json

Parameter	Type	Required	Description
No parameters.

typesense.typesense_vote 0 parameters

Schema command

kosmo integrations:schema typesense.typesense_vote --json

Parameter	Type	Required	Description
No parameters.

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.