API_DOC API Documentation

100ms API Copy

Number of APIs: 67

Welcome to 100ms server APIs

100ms collection includes API for our video components like rooms, sessions, policies, etc that are packaged and ready to use with Qodex, 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.

Authentication

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.

Simplified token generation

We have simplified the process of management token generation for you within this collection:

All you have to do is update the collection variables APP_ACCESS_KEY and APP_SECRET;
We have added a pre-request script within the collection, which will generate the management token and set the same as a collection variable (TOKEN) in the forked Qodex collection.
Automatically, this will be used as authentication for all the APIs in the 100ms collection.

Note: Refer to the authentication and tokens guide for more generating the management token in your preferred programming language for your development/production environment.

API Reference

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

1. Room APIs - Get room by id

GET {{HOST}}/v2/rooms/<ROOM_ID>

2. Room APIs - Get rooms created in timerange

GET {{HOST}}/v2/rooms?after=2022-01-01T01:00:00.000Z&before=2022-03-31T01:00:00.000Z&limit=20&start=6284eb3f119d5dbdd03ac068

3. Room APIs - Create room

POST {{HOST}}/v2/rooms

4. Room APIs - Enable room

POST {{HOST}}/v2/rooms/<ROOM_ID>

5. Room code APIs - Get room codes

GET {{HOST}}/v2/room-codes/room/:room_id

6. Room code APIs - Create room codes for all roles

POST {{HOST}}/v2/room-codes/room/:room_id