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 Recordings API

Composite and track-level recordings of sessions.

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

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

This API exposes 7 operations across 7 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 7 paths 3 schemas 2 GET5 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 Recordings 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 7 paths, the API surfaces 7 operations — 2 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Recordings 7

Composite and track-level recordings of sessions.

GET
/recordings
List All Recordings
listRecordings 5 params → 200
GET
/recordings/{recording_id}
Get Recording
getRecording 1 param → 200
POST
/recordings/room/{room_id}/start
Start Recording For Room
startRecordingForRoom 1 param body → 200
POST
/recordings/room/{room_id}/stop
Stop Recording For Room
stopRecordingForRoom 1 param → 200
POST
/recordings/{recording_id}/stop
Stop Recording By Id
stopRecordingById 1 param → 200
POST
/recordings/room/{room_id}/pause
Pause Recording For Room
pauseRecording 1 param → 200
POST
/recordings/room/{room_id}/resume
Resume Recording For Room
resumeRecording 1 param → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Recording (11 properties), RecordingAsset (10 properties), RecordingStart (3 properties). Each schema is shown below with its type and property counts.

RecordingStart
object
3 properties
Recording
object
11 properties
RecordingAsset
object
10 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

100ms-live-recordings-api-openapi.yml Raw ↑

Other APIs 100ms publishes across the network.

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