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!

There are two methods you can use our postman collection. One is from the postman public API directory and other is just download the json from this Github repository and import it to your postman. We have shared the steps below for both the methods.

Navigate to this Postman collection, login into your postman click on typesense on to the left and select fork. Forking creates a copy of the collection in your account.

Give it a name and the workspace to which you want to import it.

We have provided the Postman Environment, you need to import that as well.

NOTE

To get a better understanding of what postman environments are take a look at this.

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

Downloaded the Postman collection, and import it into Postman.

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

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.

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:

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