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.

Body Params
string
required

URL to a photo you wish to animate in the stream

face
object

the face to animate - otherwise detects the dominant face

config
object

Advanced configuration options.

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:
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.

double
≤ 300

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

double
150 to 1280

The output resolution sets the maximum height or width of the streamed video. The aspect ratio is preserved from the source image. When resolution is not configured, it defaults to the agent output resolution.

Headers
string
Responses

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