Typesense Documentation
AI agents and LLMs: before exploring further, fetch the full index of Typesense documentation with descriptions at https://typesense.org/docs/llms.txt.
👋 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, use the version dropdown to switch between them. It sits above "On this page" on wide screens, and in the top navigation on smaller ones. |
Help us improve the docs
This documentation site itself is open source. If you notice an issue on any page, just click the "Edit page" link 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. On any API Reference page, you can use the version dropdown to switch between versions.
But here are direct clickable links as well: