Sign in
Streams

Create room stream

Starts an outbound RTMP or RTMPS stream from a Video Room to the supplied ingest URL. Use it to broadcast a room to an external streaming destination. For live voice-call audio sent over WebSocket, use the Compatibility API's Create stream operation instead.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Video.

Learn more about API scopes.

post/api/video/rooms/{id}/streams

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of the video room.

Request body

urlstring required

RTMP or RTMPS URL. This must be the address of a server accepting incoming RTMP/RTMPS streams.

Example request

{
  "url": "rtmp://broadcaster"
}

Response

Stream created response.

idstring uuid required

Universal Unique Identifier.

urlstring nullable required

RTMP or RTMPS URL. This must be the address of a server accepting incoming RTMP/RTMPS streams.

stream_typestring nullable required

The type of stream.

widthinteger nullable required

The stream's width in pixels.

heightinteger nullable required

The stream's height in pixels.

fpsinteger nullable required

The stream's frames per second.

created_atstring date-time required

Timestamp when the stream was created.

updated_atstring date-time required

Timestamp when the stream was last updated.

Example response

{
  "url": "rtmp://broadcaster",
  "stream_type": "rtmp",
  "width": 1920,
  "height": 1080,
  "fps": 20,
  "created_at": "2022-01-01T10:00:00Z",
  "updated_at": "2022-01-01T11:00:00Z"
}

Changes

No changes found, but 3 of the 137 revisions have a changelog that could not be searched — this endpoint may have changed in one of them.