100ms Logo

100ms

Docs

Search docs
/

Postman Guide

100ms collection includes API for our video components like rooms, sessions, policies, etc that are packaged and ready to use with Postman, along with documentation for each API to help you learn about them. You can import/fork these APIs and start using them instantly. The API collection comes with predefined environment variables to help you get started immediately.

Fork the collection

Run in Postman

You can click on this button to fork the 100ms API collection.

Add management token

100ms uses management tokens to authenticate REST APIs. To create the management token, you must use the app_access_key and app_secret from the developer section in your 100ms dashboard. Refer to the authentication and tokens guide for more information on generating the management token. Once you have generated the management token you can use the same as an collection variable in the forked Postman collection.

To use collection variables -- Go to Collections > 100ms API and replace the placeholder <YOUR_MANAGEMENT_TOKEN> with the management token generated as instructed above and save the changes.

Add-token

Once you have done that, you can access your Token by writing {{TOKEN}} within your Postman collection. We have already done that for you for all the APIs in the 100ms collection.

Note: If you prefer, you can configure these as Environment variables.

Example: Create a room

Let's try to create a room to see how the 100ms collection works. From the forked REST API collection, select the folder named Room APIs and select the request to create room. Replace the placeholders like name, description, template_id, etc with the desired values. Click the Send button once done.

Example-request

API Reference

You can refer to the detailed API reference to understand the request/response structure better, request arguments, response variables, webhooks, etc.

Stay up to date

Similar to how the forked repository on GitHub works, you can stay up to date with the 100ms master collection by pulling the changes.