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

• Auto schema detection: you can now index documents without a pre-defined schema
• Data validation during indexing: configure Typesense to coerce, reject or drop bad values
• Concurrency improvements: utilize all CPU cores and scale to hundreds of thousands of collections

Enhancements

• Default sorting field is now optional: when not present, text match score and insertion order are used
• Allow custom key value to be provided during creation of API keys
• Faster parallel loading of collections on cold start
• Ensure that all queried fields are highlighted in search response
• Reduction in memory consumption of facet fields
• Validate SSL certificate and key before loading SSL certs from disk

Bug Fixes

• Fixed exact matches ranking below matches with typos
• Fixed a bug in filtering of string fields
• Fixed an edge case involving scoped API keys and embedded filters working with multi-search end-point
• Fixed an edge case involving filtering on negative integers
• Fixed an issue related to range filter
• Fixed a crash while parsing certain rare + long query string parameters
• Fixed collection with null value crashing Typesense
• Fixed a crash when a snapshot was taken on an empty DB but right after a key is created

Deprecations

• The catch-up-min-sequence-diff and catch-up-threshold-percentage flags that are used for determining the catch up status of a follower, are replaced with healthy-read-lag and healthy-write-lag flags.

:::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. :::

<RedirectOldLinks />