Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

100ms Active Rooms API

In-session control of running rooms and connected peers.

100ms Active Rooms API is one of 12 APIs that 100ms publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Active Rooms. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 6 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version v2.

Requests are made against a single base URL, https://api.100ms.live/v2.

7 operations 6 paths 3 schemas 3 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v2
Base URL
https://api.100ms.live/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

100ms Active Rooms API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (ManagementToken). By default, every request must be authenticated.

  • ManagementToken — Short-lived HS256 JWT generated server-side from the app access key/secret downloaded from the 100ms dashboard. Include as Authorization: Bearer .

Paths & Operations 7

Across 6 paths, the API surfaces 7 operations — 3 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Active Rooms 7

In-session control of running rooms and connected peers.

GET
/active-rooms/{room_id}
Retrieve Active Room
retrieveActiveRoom 1 param → 200404
POST
/active-rooms/{room_id}/end-room
End Active Room
endActiveRoom 1 param body → 200
GET
/active-rooms/{room_id}/peers
List Peers
listPeers 1 param → 200
GET
/active-rooms/{room_id}/peers/{peer_id}
Retrieve A Peer
retrievePeer 2 params → 200
POST
/active-rooms/{room_id}/peers/{peer_id}
Update A Peer
updatePeer 2 params body → 200
POST
/active-rooms/{room_id}/remove-peers
Remove Peers
removePeers 1 param body → 200
POST
/active-rooms/{room_id}/send-message
Send Message
sendMessage 1 param body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Peer (7 properties), ActiveRoom (6 properties), Error (3 properties). Each schema is shown below with its type and property counts.

ActiveRoom
object
6 properties
Peer
object
7 properties
Error
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

100ms-live-active-rooms-api-openapi.yml Raw ↑

Other APIs 100ms publishes across the network.

100ms Analytics API
100ms External Streams API
100ms Live Streams API
100ms Policy API
100ms Polls API
100ms Recording Assets API
100ms Recordings API
100ms Room Codes API
100ms Rooms API
100ms Sessions API
100ms Stream Keys API