Create a new streaming session

curl --request POST \ --url https://api.vmonster.io/v1/streams \ --header 'Content-Type: multipart/form-data' \ --header 'x-api-key: <api-key>' \ --form 'aiavatar_id=<string>' \ --form max_duration_s=123 \ --form background='@example-file' \ --form position_x=123 \ --form position_y=123 \ --form scale=123

{ "session_id": "5761ae64-30fd-4d1d-bab1-a15f8475e95d", "stream_id": "46a09b1d-bc0d-4316-b929-874fa4787cfc", "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiI1ZDEyMzQtZTlmZi00Y2IyLTg3YWQtNGRlOGFhYmNkZWYxIiwibmFtZSI6IuuwlOyXkCIsImlhdCI6MTY4OTAyMzQ1NiwiZXhwIjoxNzE1NTg3NDU2fQ.dGhpcy1pc0EtcmFuZG9tLXNpZ25hdHVyZS1leGFtcGxlMTIz" }

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.