Create a new stream

Initiates the creation of a new WebRTC connection to a browser peer. The endpoint returns the necessary information to set up and manage the connection.

Path Params
string
required

Agent Id

Body Params
boolean
Defaults to false

Whether to request a fluent stream.

double
≤ 300

Maximum duration (in seconds) between messages before session times out. Can only be used with proper permissions

boolean
Defaults to false

Whether to stream wamrup video on the connection. If set to true, will stream a warmup video when connection is established. At the end of the warmup video, a message containing "stream/ready" will be sent on the data channel.

string
enum

Defines the video codec to be used in the stream. When set to on: VP8 will be used. When set to off: H264 will be used When set to auto the codec will be selected according to the browser.

Allowed:
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json