Sign in
Agents Streams

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.

post/agents/{agentId}/streams

Path parameters

agentIdstring required

Agent Id

Request body

fluentboolean

Whether to request a fluent stream.

session_timeoutnumber double

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

stream_warmupboolean

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.

compatibility_mode'on' | 'off' | 'auto'

Example request

{
  "session_timeout": 180
}

Response

Created stream

session_idstring
idstring required

Id of the stream - should be returned as path parameter in all streaming request to the same stream

Changes

No recorded changes to this endpoint across all 1 revision of this API.