100ms Logo

100ms

Docs

Search docs
/
PLATFORM
introduction
BasicsRequest/ResponseAuthentication and tokensWebhookDomain and Port WhitelistingPostman Guide
Rooms
OverviewRoom objectCreate via APICreate via dashboardRetrieve a specific roomList roomsUpdate a roomDisable/Enable a room
active rooms
OverviewActive room objectRetrieve a specific active roomRetrieve a specific peerUpdate a peerSend messageRemove peersEnd an active room
Sessions
Session objectRetrieve a specific sessionList sessions
policy
Template objectCreate a template via APICreate a template via dashboardRetrieve a specific templateList all templatesUpdate a templateCreate/update a roleRetrieve a specific roleDelete a roleRetrieve settingsUpdate settings
Destinations
SFU RecordingRTMP Streaming & Browser RecordingInteractive Live Streaming via dashboard
changelog
Release Notes
legacy api (v1)
RoomSessionTemplates and Roles

Basics

100ms API collection

TL;DR - You can directly use our Postman collection to start exploring 100ms APIs.

Run in Postman

Refer to the Postman guide to get started with 100ms API collection.

Authentication

100ms uses management tokens to authenticate REST APIs. The service required to generate this token should be hosted on your server. You must use the app_access_key and app_secret from the developer section in your 100ms dashboard to create the management token. Refer to the authentication and tokens guide for more information on generating the management token.

Architecture

100ms is a cloud platform that allows developers to add video and audio conferencing to Web, Android and iOS applications.

The platform provides REST APIs, SDKs, and a dashboard that makes it simple to capture, distribute, record, and render live interactive audio, video.

Any application built using 100ms' SDK has 2 components.

  • Client: Use 100ms android, iOS, Web SDKs to manage connections, room states, render audio/video.

  • Server: Use 100ms' APIs or dashboard to create rooms, setup room templates, trigger recording or RTMP streaming, access events.

Architecture

Basic Concepts

  • Room A room is the basic object that 100ms SDKs return on successful connection. This contains references to peers, tracks and everything you need to render a live a/v app
  • Peer A peer is the object returned by 100ms SDKs that contains all information about a user - name, role, video track etc.
  • Track A track represents either the audio or video that a peer is publishing
  • Role A role defines who can a peer see/hear, the quality at which they publish their video, whether they have permissions to publish video/screenshare, mute someone, change someone's role.
  • Template A template is a collection of roles, room settings, recording and RTMP settings (if used), that are used by the SDK to decide which geography to connect to, which tracks to return to the client, whether to turn on recording when a room is created, etc. Each room is associated with a template.
  • Destinations Destinations is used to save audio/video calls for offline viewing. 100ms supports 2 kinds of recording - SFU recording and Browser recording. Also, HLS enabled configuration will allow you to live stream your room over HLS.
  • RTMP RTMP streaming is used to live stream your video conferencing apps to platforms like YouTube, Twitch, Facebook, MUX, etc.
  • Webhooks Webhook is an HTTP(S) endpoint used for pushing the notifications to your application. It will be invoked by 100ms servers to notify events of your room.

What are the steps to build a live app with 100ms?

  1. Sign up on 100ms using the Try For Free button in the top navbar.

Signup for 100ms account

  1. Once you're logged in to the dashboard, click on Create Your First App

Signup for 100ms account

  1. Hover on one of the Starter Kits. Deploy one of them. (We will use the Video Conference Starter Kit for this example)

Dashboard _ 100ms.png

  1. Select your account type and fill in the details

Dashboard _ 100ms.png

  1. Choose a deployment option. This could be 100ms or Vercel (based on the Starter Kit you are deploying)

Video Conferencing Starter Kit

  1. Enter a subdomain of your choice. Please avoid entering https/http/www or dots while entering the subdomain. Select a region closest to you and hit Continue.

choose subdomain

  1. Join or Invite someone to your deployed app with one of the roles:

join or invite

Where should I start?

Quickstart

If you want to see 100ms' SDKs in action in under 5 minutes, run one of our quickstart apps

API Overview

Create rooms, configure and maintain room policies and templates, start recording or RTMP streaming, and access events via 100ms' APIs. These APIs use standard HTTP verbs and HTTP status codes to make it simple to incorporate video into your code. We serve our API through HTTPS to secure your requests to our servers.

BaseURIhttps://api.100ms.live/{version}/

Note: our current version is v2.

Run in Postman

Refer to the Postman guide to get started with 100ms API collection.

Server Side API referenceRequest/Response
Edit this File