Typesense

Typo-tolerant search engine: index documents, run searches, and manage collections

Typesense documentationAPI checked August 18, 2026

Signs in with: Connection fields
Runs on: Cloud or On-Prem Worker
Operations: 111
Ready-made triggers: 0

Connect Typesense

In Neblex open Connect › Connections and click New Connection.
Search for Typesense and give the connection a clear name.
Fill in the fields. Secret values are encrypted and never shown again.
Click Test, then Create Connection.

If the system is only reachable inside your network, choose an On-Prem Worker under Test from and run the flow on that Worker. See On-Prem Workers.

Field	What to enter
ProtocolOptional	Typesense Server protocol.
HostOptional	Typesense Server host, including a non-default port when needed.
Server API keyOptionalSecret	X-TYPESENSE-API-KEY for server operations.
Cloud Management API keyOptionalSecret	Separate X-TYPESENSE-CLOUD-MANAGEMENT-API-KEY credential.

Use it in a flow

Open a flow, open the node library and search for Typesense.
Drag it onto the canvas and choose an Operation and your connection.
Map the operation's fields from earlier steps, or click Map with Matt.
Use Test this step to see what it returns, then save.

To start a flow from Typesense without a ready-made trigger: a Poll for changes trigger on Typesense with your own query passes on new or changed records.

Operations

111 operations in 16 groups. Each one is a step you can add to a flow.

Analytics10

Create an analytics event`createAnalyticsEvent`	POST	Submit a single analytics event.
Create analytics rule(s)`createAnalyticsRule`	POST	Create one or more analytics rules.
Create Analytics Rules Bulk`createAnalyticsRulesBulk`	POST	Create multiple analytics rules using the official array request alternative.
Delete an analytics rule`deleteAnalyticsRule`	DELETE	Permanently deletes an analytics rule, given it's name
Flush in-memory analytics to disk`flushAnalytics`	POST	Triggers a flush of analytics data to persistent storage.
Get analytics subsystem status`getAnalyticsStatus`	GET	Returns sizes of internal analytics buffers and queues.
Retrieve analytics events`getAnalyticsEvents`	GET	Retrieve the most recent events for a user and rule.
Retrieve analytics rules`retrieveAnalyticsRules`	GET	Retrieve all analytics rules.
Retrieves an analytics rule`retrieveAnalyticsRule`	GET	Retrieve the details of an analytics rule, given it's name
Upserts an analytics rule`upsertAnalyticsRule`	PUT	Upserts an analytics rule with the given name.

Cloud Management21

Cancel a pending cloning operation`cloudCancelCloningOperation`	PATCH	Cancel a pending cloning operation
Cancel a pending configuration change`cloudCancelConfigurationChange`	PATCH	Cancel a pending configuration change
Create a parameter`cloudCreateServerConfigurationParameter`	POST	Create a parameter
Create new cluster`cloudCreateCluster`	POST	Create new cluster
Delete a parameter`cloudDeleteServerConfigurationParameter`	DELETE	Delete a parameter
Generate API key`cloudGenerateClusterApiKeys`	POST	Generate API key
Get a single invoice`cloudGetInvoice`	GET	Get a single invoice
Get a single parameter`cloudGetServerConfigurationParameter`	GET	Get a single parameter
Get single cloning operation`cloudGetCloningOperation`	GET	Get single cloning operation
Get single cluster`cloudGetCluster`	GET	Get single cluster
Get single configuration change`cloudGetConfigurationChange`	GET	Get single configuration change
List all cloning operations`cloudListCloningOperations`	GET	List all cloning operations
List all clusters`cloudListClusters`	GET	List all clusters
List all configuration changes`cloudListConfigurationChanges`	GET	List all configuration changes
List all configuration parameters`cloudListServerConfigurationParameters`	GET	List all configuration parameters
List all invoices`cloudListInvoices`	GET	List all invoices
Schedule a Configuration Change`cloudScheduleConfigurationChange`	POST	Schedule a Configuration Change
Start a Cloning Operation`cloudStartCloningOperation`	POST	Start a Cloning Operation
Terminate cluster`cloudTerminateCluster`	POST	Terminate cluster
Update a parameter`cloudUpdateServerConfigurationParameter`	PATCH	Update a parameter
Update cluster attributes`cloudUpdateCluster`	PATCH	Update cluster attributes

Collections9

Create a new collection`createCollection`	POST	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.
Create or update a collection alias`upsertAlias`	PUT	Create or update a collection alias.
Delete a collection`deleteCollection`	DELETE	Permanently drops a collection.
Delete an alias`deleteAlias`	DELETE	Delete an alias
List all aliases`getAliases`	GET	List all aliases and the corresponding collections that they map to.
List all collections`getCollections`	GET	Returns a summary of all your collections.
Retrieve a single collection`getCollection`	GET	Retrieve the details of a collection, given its name.
Retrieve an alias`getAlias`	GET	Find out which collection an alias points to by fetching it
Update a collection`updateCollection`	PATCH	Update a collection's schema to modify the fields and their types.

Conversations5

Create a conversation model`createConversationModel`	POST	Create a Conversation Model
Delete a conversation model`deleteConversationModel`	DELETE	Delete a conversation model
List all conversation models`retrieveAllConversationModels`	GET	Retrieve all conversation models
Retrieve a conversation model`retrieveConversationModel`	GET	Retrieve a conversation model
Update a conversation model`updateConversationModel`	PUT	Update a conversation model

Curation Sets8

Create or update a curation set`upsertCurationSet`	PUT	Create or update a curation set with the given name
Create or update a curation set item`upsertCurationSetItem`	PUT	Create or update a curation set item with the given id
Delete a curation set`deleteCurationSet`	DELETE	Delete a specific curation set by its name
Delete a curation set item`deleteCurationSetItem`	DELETE	Delete a specific curation item by its id
List all curation sets`retrieveCurationSets`	GET	Retrieve all curation sets
List items in a curation set`retrieveCurationSetItems`	GET	Retrieve all curation items in a set
Retrieve a curation set`retrieveCurationSet`	GET	Retrieve a specific curation set by its name
Retrieve a curation set item`retrieveCurationSetItem`	GET	Retrieve a specific curation item by its id

Debug1

Print debugging informationdebug GET Print debugging information

Documents10

Delete a bunch of documents`deleteDocuments`	DELETE	Delete a bunch of documents that match a specific filter condition.
Delete a document`deleteDocument`	DELETE	Delete an individual document from a collection by using its ID.
Export all documents in a collection`exportDocuments`	GET	Export all documents in a collection in JSON lines format.
Import documents into a collection`importDocuments`	POST	The documents to be imported must be formatted in a newline delimited JSON structure.
Index a document`indexDocument`	POST	A document to be indexed in a given collection must conform to the schema of the collection.
Retrieve a document`getDocument`	GET	Fetch an individual document from a collection by using its ID.
Search for documents in a collection`searchCollection`	GET	Search for documents in a collection that match the search criteria.
send multiple search requests in a single HTTP request`multiSearch`	POST	This is especially useful to avoid round-trip network latencies incurred otherwise if each of these requests are sent in separate HTTP requests.
Update a document`updateDocument`	PATCH	Update an individual document from a collection by using its ID.
Update documents with conditional query`updateDocuments`	PATCH	The filter by query parameter is used to filter to specify a condition against which the documents are matched.

Health1

Checks if Typesense server is ready to accept requests.health GET Checks if Typesense server is ready to accept requests.

Keys4

Create an API Key`createKey`	POST	Create an API Key with fine-grain access control.
Delete an API key given its ID.`deleteKey`	DELETE	Delete an API key given its ID.
Retrieve (metadata about) a key`getKey`	GET	Retrieve (metadata about) a key.
Retrieve (metadata about) all keys.`getKeys`	GET	Retrieve (metadata about) all keys.

Legacy Server API10

Delete Collection Override`deleteCollectionOverride`	DELETE	Current first-party server source route retained by the v30.2 migration documentation.
Delete Collection Synonym`deleteCollectionSynonym`	DELETE	Current first-party server source route retained by the v30.2 migration documentation.
Get Collection Override`getCollectionOverride`	GET	Current first-party server source route retained by the v30.2 migration documentation.
Get Collection Overrides`getCollectionOverrides`	GET	Current first-party server source route retained by the v30.2 migration documentation.
Get Collection Synonym`getCollectionSynonym`	GET	Current first-party server source route retained by the v30.2 migration documentation.
Get Collection Synonyms`getCollectionSynonyms`	GET	Current first-party server source route retained by the v30.2 migration documentation.
Get Log Sequence`getLogSequence`	GET	Current first-party server source route retained by the v30.2 migration documentation.
Health Post`healthPost`	POST	Current first-party server source route retained by the v30.2 migration documentation.
Upsert Collection Override`upsertCollectionOverride`	PUT	Current first-party server source route retained by the v30.2 migration documentation.
Upsert Collection Synonym`upsertCollectionSynonym`	PUT	Current first-party server source route retained by the v30.2 migration documentation.

Nl Search Models5

Create a NL search model`createNLSearchModel`	POST	Create a new NL search model.
Delete a NL search model`deleteNLSearchModel`	DELETE	Delete a specific NL search model by its ID.
List all NL search models`retrieveAllNLSearchModels`	GET	Retrieve all NL search models.
Retrieve a NL search model`retrieveNLSearchModel`	GET	Retrieve a specific NL search model by its ID.
Update a NL search model`updateNLSearchModel`	PUT	Update an existing NL search model.

Operations8

Clear the cached responses of search requests in the LRU cache.`clearCache`	POST	Clear the cached responses of search requests that are sent with use cache parameter in the LRU cache.
Compacting the on-disk database`compactDb`	POST	Typesense uses RocksDB to store your documents on the disk.
Creates a point-in-time snapshot of a Typesense node's state and data in the specified directory.`takeSnapshot`	POST	Creates a point-in-time snapshot of a Typesense node's state and data in the specified directory.
Get current RAM, CPU, Disk & Network usage metrics.`retrieveMetrics`	GET	Retrieve the metrics.
Get stats about API endpoints.`retrieveAPIStats`	GET	Retrieve the stats about API endpoints.
Get the status of in-progress schema change operations`getSchemaChanges`	GET	Returns the status of any ongoing schema change operations.
Toggle Slow Request Log`toggleSlowRequestLog`	POST	Enable logging of requests that take over a defined threshold of time.
Triggers a follower node to initiate the raft voting process, which triggers leader re-election.`vote`	POST	Triggers a follower node to initiate the raft voting process, which triggers leader re-election.

Presets4

Delete a preset.`deletePreset`	DELETE	Permanently deletes a preset, given it's name.
Retrieves a preset.`retrievePreset`	GET	Retrieve the details of a preset, given it's name.
Retrieves all presets.`retrieveAllPresets`	GET	Retrieve the details of all presets
Upserts a preset.`upsertPreset`	PUT	Create or update an existing preset.

Stemming3

Import a stemming dictionary`importStemmingDictionary`	POST	Upload a JSONL file containing word mappings to create or update a stemming dictionary.
List all stemming dictionaries`listStemmingDictionaries`	GET	Retrieve a list of all available stemming dictionaries.
Retrieve a stemming dictionary`getStemmingDictionary`	GET	Fetch details of a specific stemming dictionary.

Stopwords4

Delete a stopwords set.`deleteStopwordsSet`	DELETE	Permanently deletes a stopwords set, given it's name.
Retrieves a stopwords set.`retrieveStopwordsSet`	GET	Retrieve the details of a stopwords set, given it's name.
Retrieves all stopwords sets.`retrieveStopwordsSets`	GET	Retrieve the details of all stopwords sets
Upserts a stopwords set.`upsertStopwordsSet`	PUT	When an analytics rule is created, we give it a name and describe the type, the source collections and the destination collection.

Synonyms8

Create or update a synonym set`upsertSynonymSet`	PUT	Create or update a synonym set with the given name
Create or update a synonym set item`upsertSynonymSetItem`	PUT	Create or update a synonym set item with the given id
Delete a synonym set`deleteSynonymSet`	DELETE	Delete a specific synonym set by its name
Delete a synonym set item`deleteSynonymSetItem`	DELETE	Delete a specific synonym item by its id
List all synonym sets`retrieveSynonymSets`	GET	Retrieve all synonym sets
List items in a synonym set`retrieveSynonymSetItems`	GET	Retrieve all synonym items in a set
Retrieve a synonym set`retrieveSynonymSet`	GET	Retrieve a specific synonym set by its name
Retrieve a synonym set item`retrieveSynonymSetItem`	GET	Retrieve a specific synonym item by its id