Postman collection for Typesense

Calling Typesense API via curl commands on your terminal can be a bit cumbersome.

Thankfully, we've put together a Postman collection that you can use and share with your team. We'll also be happy to accept any changes or improvements -- send us a PR!

Usage Instructions

In case you're not familiar with Postman, here's a quick walk-through on importing and using this collection.

Step 1️⃣: Import the collection

Downloaded the Postman collection, and import it into Postman.

You should now be able to see the collection on the left sidebar.

Step 2️⃣: Import the environment

We have also provided a Postman Environment -- you need to import that as well.

To get a better understanding of what Postman environments are, please look here.

Step 3️⃣: Edit the environment variables

Update the TYPESENSE_API_KEY variable match the API key that you use.

Update the url to point to your local or remote Typesense server:

✨ And that's it!

You can now use the Postman collection to hit the Typesense APIs.