Typesense Documentation

👋 Welcome! Let's get you up and searching.

The documentation is divided into the following sections, that you'll find links for on the top navigation bar as well.

Section	Purpose
Overview	This section gives you a birds-eye view of Typesense, why you'd want to use it and comparison with alternatives.
Guide	This section walks you step-by-step through how you can use Typesense in different scenarios.
API Reference	This section gives you detailed information about all the API endpoints and parameters in each version of Typesense. When you're viewing any of the versions, you can click on the version dropdown in the Navbar to switch between versions.

Help us improve the docs

This documentation site itself is open source (opens new window). If you notice an issue on any page, just click on the Edit button at the bottom of the page, make changes and submit it as a PR.

We also welcome contributions to the documentation, especially to the Guide section. If you've integrated Typesense with a framework that's not covered, we'd love to have you share your work with the world. Please reach out to us to collaborate on this.

TIP

Use the "Edit page" link at the bottom of any page to edit it and submit a PR. We appreciate your contributions.

Typesense Versions

Typesense is versioned software and each version has API documentation specifically tied to it. You can use the dropdown on the top navigation bar to switch between versions.

But here are direct clickable links as well:

• 29.0
• 28.0
• 27.1
• 27.0
• 26.0
• 0.25.2
• 0.25.1
• 0.25.0
• 0.24.1
• 0.24.0
• 0.23.1
• 0.23.0
• 0.22.2
• 0.22.1
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.1
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.2