Skip to main content
POST
Create a new streaming session

Authorizations

x-api-key
string
header
required

Body

multipart/form-data
aiavatar_id
string
required

The ID of the AI Avatar registered on VMONSTER Studio.

language
enum<string>
required

The language of the AI Avatar registered on VMONSTER Studio.

Available options:
ko,
en,
ja,
zh
max_duration_s
integer

(Optional) Maximum session duration in seconds. Default is 3600 seconds (1 hour) if not specified.

background
file

(Optional) Background image file for the streaming screen. Note: This setting will be ignored if the AI Avatar already has a background.

position_x
integer

(Optional) X-coordinate (0-1920) for avatar position.

position_y
integer

(Optional) Y-coordinate (0-1080) for avatar position.

scale
number

(Optional) Scale factor (0.51.0) for avatar size.

Response

Streaming session created successfully.

session_id
string

Unique identifier for the current session.

stream_id
string

Specific stream identifier.

token
string

Access token for entering the created room.