Typesense API Reference for v{{ $page.typesenseVersion }}

This section of the documentation details all the API Endpoints available in Typesense and all the parameters you can use with them.

Use the links on the side navigation bar to get to the appropriate section you're looking for.

To learn how to install and run Typesense, see the Guide section instead.

What's new

This release contains new features, performance improvements and important bug fixes.

New Features

Phrase search: wrap keywords in a query with double quotes to search them as a phrase, e.g. "new york".
Schema changes: we now support fields to be added or dropped from a collection schema in-place.
Improved multi-field matching: much better performance and accuracy when query keywords have to be matched across multiple fields in a document.
Infix searching: find string within strings, which is useful for entities like model number or email address.
Allow string fields to be sorted: sorting on string fields can be enabled by setting sort: true parameter of the field.

Enhancements

Improved update and delete performance of numerical fields by 10x.
Emplace mode for imports: using the emplace action creates a document if it does not exist in a collection or updates it (partially or fully) if it already exists.
Treat space as typo: search for basket ball if basketball is not found or vice-versa. You can disable this behavior by setting split_join_tokens: false.
Improved Cyrillic support: better highlighting and fuzzy search for fields configured with: el, ru, sr, uk and be locales.
ARM compatibility: an ARM build is now published for every release.
Each multi-search query can have an independent x-typesense-api-key key. This is useful to specify different scoped search API keys for each search.
Control the number of words that Typesense considers for typo and prefix searching via the max_candidates parameter.
CORS can now be enabled for a specific set of domains using the --cors-domains flag.
Search results are now highlighted by prefix, rather than the full world. Previously, searching for "app" will highlight the full word "apple" in the results, but now it will only highlight the "app"le prefix within the word.
"Remove Matched Tokens" can be used by itself in Overrides. So you can now setup rules like, if query contains "word", remove "word" from the search query.
Ability to toggle if filters should by applied to overrides or not using the filter_curated_hits flag.
Ability to hide out_of and search_time_ms from the search API response, using the exclude_fields parameter.
Ability to control typo tolerance for facet queries using facet_query_num_typos.
Ability to specify which subnet to use for peering using --peering-subnet server parameter.

Bug Fixes

Fixed exact match of synonym query candidates not being ranked correctly.
Fix glibc incompatibility on recent Linux distros (Ubuntu 21.04+). #531
Fixed the snippet containing the full field value when highlight_full_fields is enabled.
Fixed --enable-cors=true flag format not working. Earlier, only the --enable-cors format worked.
Fixed exact match for repeated words (when searching for repeated words such as "Boom Boom"). #427
Fixed highlight_fields parameter not respecting include_fields. #556
Fixed document ids that are accepted with space char (%20) but cannot be deleted later. #574
Improved highlighting of text containing punctuations. #528
Fixed case sensitivity of facet fields. #504

Deprecations / behavior changes

In prefix queries, only the prefix part of a word in the result is highlighted now, instead of the whole word. For e.g. given a query like "new y", the result will be highlighted as <mark>New Y</mark>ork City.

Upgrading

Before upgrading your existing Typesense cluster to v{{ $page.typesenseVersion }}, please review the behavior changes above to prepare your application for the upgrade.

We'd recommend testing on your development / staging environments before upgrading.

Typesense Cloud

If you're on Typesense Cloud:

Go to https://cloud.typesense.org/clusters.
Click on your cluster
Click on "Modify Configuration" on the right side pane
Schedule a time for the upgrade.

Self Hosted

If you're self-hosting Typesense, here's how to upgrade:

Single node deployment

Trigger a snapshot to create a backup of your data.
Stop Typesense server.
Replace the binary via the tar package or via the DEB/RPM installer.
Start Typesense server back again.

Multi-node deployment

To upgrade a multi-node cluster, we will be proceeding node by node to ensure the cluster remains healthy during the rolling upgrade.

NOTE: During the upgrade, we have to ensure that the leader of the cluster is using the older Typesense version. So we will upgrade the leader last. You can determine whether a node is a leader or follower by the value of the state field in the /debug end-point response.

State	Role
1	LEADER
4	FOLLOWER

Trigger a snapshot to create a backup of your data on the leader node.
On any follower, stop Typesense and replace the binary via the tar package or via the DEB/RPM installer.
Start Typesense server back again and wait for node to rejoin the cluster as a follower and catch-up (/health should return healthy).
Repeat steps 2 and 3 for the other followers, leaving the leader node alone for now.
Once all the followers have been upgraded to v{{ $page.typesenseVersion }}, stop Typesense on the leader.
The other nodes will elect a new leader and keep working.
Replace the binary on the old leader and start the Typesense server back again.
This node will re-join the cluster as a follower, and we are done.

Downgrading

Once you upgrade to v0.24 of Typesense Server the internal structure of the data directory becomes incompatible with older versions of Typesense.

However, if you need to downgrade to v0.23, we've released a special version v0.23.2 that backports these data structure changes back to 0.23 while keeping other 0.23.1 features as is.

So v0.24 can only be downgraded to v0.23.2.

:::tip This documentation itself is open source. If you find any issues, click on the Edit page button at the bottom of the page and send us a Pull Request. :::