Create Session

curl --request POST \
  --url https://api.vivix.ai/v1/realtime-avatar/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "vivix-a1-stream",
  "output": {
    "aspect_ratio": "9:16",
    "resolution": "720p"
  },
  "avatars": [
    {
      "avatar_id": "companion",
      "persona": "You are a warm, curious conversation companion. Speak in relaxed English and keep everyday replies brief. Acknowledge corrections without making excuses. Use small smiles and gentle nods, then let your hands rest while listening.",
      "visual": {
        "source_images": [
          {
            "source_image_id": "front",
            "url": "https://static.vivi-x.ai/images/2026/07/20/b9b8e89651cd24ad.png",
            "media_type": "image/png",
            "description": "A young woman with curly black hair and a pink shirt, facing the camera in a softly lit room."
          }
        ]
      }
    }
  ],
  "pipeline_config": {
    "tts_config": {
      "tts_voice_id": "longanhuan_v3.6"
    }
  }
}
'

import requests

url = "https://api.vivix.ai/v1/realtime-avatar/sessions"

payload = {
    "model": "vivix-a1-stream",
    "output": {
        "aspect_ratio": "9:16",
        "resolution": "720p"
    },
    "avatars": [
        {
            "avatar_id": "companion",
            "persona": "You are a warm, curious conversation companion. Speak in relaxed English and keep everyday replies brief. Acknowledge corrections without making excuses. Use small smiles and gentle nods, then let your hands rest while listening.",
            "visual": { "source_images": [
                    {
                        "source_image_id": "front",
                        "url": "https://static.vivi-x.ai/images/2026/07/20/b9b8e89651cd24ad.png",
                        "media_type": "image/png",
                        "description": "A young woman with curly black hair and a pink shirt, facing the camera in a softly lit room."
                    }
                ] }
        }
    ],
    "pipeline_config": { "tts_config": { "tts_voice_id": "longanhuan_v3.6" } }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: 'vivix-a1-stream',
    output: {aspect_ratio: '9:16', resolution: '720p'},
    avatars: [
      {
        avatar_id: 'companion',
        persona: 'You are a warm, curious conversation companion. Speak in relaxed English and keep everyday replies brief. Acknowledge corrections without making excuses. Use small smiles and gentle nods, then let your hands rest while listening.',
        visual: {
          source_images: [
            {
              source_image_id: 'front',
              url: 'https://static.vivi-x.ai/images/2026/07/20/b9b8e89651cd24ad.png',
              media_type: 'image/png',
              description: 'A young woman with curly black hair and a pink shirt, facing the camera in a softly lit room.'
            }
          ]
        }
      }
    ],
    pipeline_config: {tts_config: {tts_voice_id: 'longanhuan_v3.6'}}
  })
};

fetch('https://api.vivix.ai/v1/realtime-avatar/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vivix.ai/v1/realtime-avatar/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'model' => 'vivix-a1-stream',
    'output' => [
        'aspect_ratio' => '9:16',
        'resolution' => '720p'
    ],
    'avatars' => [
        [
                'avatar_id' => 'companion',
                'persona' => 'You are a warm, curious conversation companion. Speak in relaxed English and keep everyday replies brief. Acknowledge corrections without making excuses. Use small smiles and gentle nods, then let your hands rest while listening.',
                'visual' => [
                                'source_images' => [
                                                                [
                                                                                                                                'source_image_id' => 'front',
                                                                                                                                'url' => 'https://static.vivi-x.ai/images/2026/07/20/b9b8e89651cd24ad.png',
                                                                                                                                'media_type' => 'image/png',
                                                                                                                                'description' => 'A young woman with curly black hair and a pink shirt, facing the camera in a softly lit room.'
                                                                ]
                                ]
                ]
        ]
    ],
    'pipeline_config' => [
        'tts_config' => [
                'tts_voice_id' => 'longanhuan_v3.6'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vivix.ai/v1/realtime-avatar/sessions"

	payload := strings.NewReader("{\n  \"model\": \"vivix-a1-stream\",\n  \"output\": {\n    \"aspect_ratio\": \"9:16\",\n    \"resolution\": \"720p\"\n  },\n  \"avatars\": [\n    {\n      \"avatar_id\": \"companion\",\n      \"persona\": \"You are a warm, curious conversation companion. Speak in relaxed English and keep everyday replies brief. Acknowledge corrections without making excuses. Use small smiles and gentle nods, then let your hands rest while listening.\",\n      \"visual\": {\n        \"source_images\": [\n          {\n            \"source_image_id\": \"front\",\n            \"url\": \"https://static.vivi-x.ai/images/2026/07/20/b9b8e89651cd24ad.png\",\n            \"media_type\": \"image/png\",\n            \"description\": \"A young woman with curly black hair and a pink shirt, facing the camera in a softly lit room.\"\n          }\n        ]\n      }\n    }\n  ],\n  \"pipeline_config\": {\n    \"tts_config\": {\n      \"tts_voice_id\": \"longanhuan_v3.6\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.vivix.ai/v1/realtime-avatar/sessions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"vivix-a1-stream\",\n  \"output\": {\n    \"aspect_ratio\": \"9:16\",\n    \"resolution\": \"720p\"\n  },\n  \"avatars\": [\n    {\n      \"avatar_id\": \"companion\",\n      \"persona\": \"You are a warm, curious conversation companion. Speak in relaxed English and keep everyday replies brief. Acknowledge corrections without making excuses. Use small smiles and gentle nods, then let your hands rest while listening.\",\n      \"visual\": {\n        \"source_images\": [\n          {\n            \"source_image_id\": \"front\",\n            \"url\": \"https://static.vivi-x.ai/images/2026/07/20/b9b8e89651cd24ad.png\",\n            \"media_type\": \"image/png\",\n            \"description\": \"A young woman with curly black hair and a pink shirt, facing the camera in a softly lit room.\"\n          }\n        ]\n      }\n    }\n  ],\n  \"pipeline_config\": {\n    \"tts_config\": {\n      \"tts_voice_id\": \"longanhuan_v3.6\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vivix.ai/v1/realtime-avatar/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"model\": \"vivix-a1-stream\",\n  \"output\": {\n    \"aspect_ratio\": \"9:16\",\n    \"resolution\": \"720p\"\n  },\n  \"avatars\": [\n    {\n      \"avatar_id\": \"companion\",\n      \"persona\": \"You are a warm, curious conversation companion. Speak in relaxed English and keep everyday replies brief. Acknowledge corrections without making excuses. Use small smiles and gentle nods, then let your hands rest while listening.\",\n      \"visual\": {\n        \"source_images\": [\n          {\n            \"source_image_id\": \"front\",\n            \"url\": \"https://static.vivi-x.ai/images/2026/07/20/b9b8e89651cd24ad.png\",\n            \"media_type\": \"image/png\",\n            \"description\": \"A young woman with curly black hair and a pink shirt, facing the camera in a softly lit room.\"\n          }\n        ]\n      }\n    }\n  ],\n  \"pipeline_config\": {\n    \"tts_config\": {\n      \"tts_voice_id\": \"longanhuan_v3.6\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "code": 0,
  "message": "success",
  "data": {
    "session_id": "avatar-session-123",
    "status": "active",
    "session": {
      "mode": "video_avatar",
      "active_avatar_id": "companion",
      "source_image_id": "front"
    },
    "control": {
      "url": "wss://api.vivix.ai/v1/realtime-avatar/control?session_id=avatar-session-123",
      "client_secret": "ctl_..."
    },
    "output": {
      "aspect_ratio": "9:16",
      "resolution": "720p"
    },
    "delivery": {
      "media": {
        "transport": "trtc",
        "trtc": {
          "sdk_app_id": "1400000000",
          "room_id": "avatar-session-123",
          "user_id": "viewer",
          "user_sig": "...",
          "publisher_user_id": "publisher_xxx"
        }
      }
    },
    "model": "vivix-a1-stream",
    "expires_at": "2026-07-16T10:05:00Z",
    "recording_mode": "off",
    "auto_close": {
      "disconnected_timeout_seconds": 0,
      "interaction_idle_timeout_seconds": 0
    },
    "conversation": {
      "tools": [],
      "turn_detection": {
        "type": "server_vad",
        "silence_duration_ms": 500
      }
    },
    "avatars": [
      {
        "avatar_id": "companion",
        "persona": "You are a warm, curious conversation companion. Speak in relaxed English and keep everyday replies brief. Acknowledge corrections without making excuses. Use small smiles and gentle nods, then let your hands rest while listening.",
        "visual": {
          "source_images": [
            {
              "source_image_id": "front",
              "url": "https://static.vivi-x.ai/images/2026/07/20/b9b8e89651cd24ad.png",
              "media_type": "image/png"
            }
          ]
        }
      }
    ]
  }
}

POST

realtime-avatar

sessions

Create Session

curl --request POST \
  --url https://api.vivix.ai/v1/realtime-avatar/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "vivix-a1-stream",
  "output": {
    "aspect_ratio": "9:16",
    "resolution": "720p"
  },
  "avatars": [
    {
      "avatar_id": "companion",
      "persona": "You are a warm, curious conversation companion. Speak in relaxed English and keep everyday replies brief. Acknowledge corrections without making excuses. Use small smiles and gentle nods, then let your hands rest while listening.",
      "visual": {
        "source_images": [
          {
            "source_image_id": "front",
            "url": "https://static.vivi-x.ai/images/2026/07/20/b9b8e89651cd24ad.png",
            "media_type": "image/png",
            "description": "A young woman with curly black hair and a pink shirt, facing the camera in a softly lit room."
          }
        ]
      }
    }
  ],
  "pipeline_config": {
    "tts_config": {
      "tts_voice_id": "longanhuan_v3.6"
    }
  }
}
'

import requests

url = "https://api.vivix.ai/v1/realtime-avatar/sessions"

payload = {
    "model": "vivix-a1-stream",
    "output": {
        "aspect_ratio": "9:16",
        "resolution": "720p"
    },
    "avatars": [
        {
            "avatar_id": "companion",
            "persona": "You are a warm, curious conversation companion. Speak in relaxed English and keep everyday replies brief. Acknowledge corrections without making excuses. Use small smiles and gentle nods, then let your hands rest while listening.",
            "visual": { "source_images": [
                    {
                        "source_image_id": "front",
                        "url": "https://static.vivi-x.ai/images/2026/07/20/b9b8e89651cd24ad.png",
                        "media_type": "image/png",
                        "description": "A young woman with curly black hair and a pink shirt, facing the camera in a softly lit room."
                    }
                ] }
        }
    ],
    "pipeline_config": { "tts_config": { "tts_voice_id": "longanhuan_v3.6" } }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: 'vivix-a1-stream',
    output: {aspect_ratio: '9:16', resolution: '720p'},
    avatars: [
      {
        avatar_id: 'companion',
        persona: 'You are a warm, curious conversation companion. Speak in relaxed English and keep everyday replies brief. Acknowledge corrections without making excuses. Use small smiles and gentle nods, then let your hands rest while listening.',
        visual: {
          source_images: [
            {
              source_image_id: 'front',
              url: 'https://static.vivi-x.ai/images/2026/07/20/b9b8e89651cd24ad.png',
              media_type: 'image/png',
              description: 'A young woman with curly black hair and a pink shirt, facing the camera in a softly lit room.'
            }
          ]
        }
      }
    ],
    pipeline_config: {tts_config: {tts_voice_id: 'longanhuan_v3.6'}}
  })
};

fetch('https://api.vivix.ai/v1/realtime-avatar/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.vivix.ai/v1/realtime-avatar/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'model' => 'vivix-a1-stream',
    'output' => [
        'aspect_ratio' => '9:16',
        'resolution' => '720p'
    ],
    'avatars' => [
        [
                'avatar_id' => 'companion',
                'persona' => 'You are a warm, curious conversation companion. Speak in relaxed English and keep everyday replies brief. Acknowledge corrections without making excuses. Use small smiles and gentle nods, then let your hands rest while listening.',
                'visual' => [
                                'source_images' => [
                                                                [
                                                                                                                                'source_image_id' => 'front',
                                                                                                                                'url' => 'https://static.vivi-x.ai/images/2026/07/20/b9b8e89651cd24ad.png',
                                                                                                                                'media_type' => 'image/png',
                                                                                                                                'description' => 'A young woman with curly black hair and a pink shirt, facing the camera in a softly lit room.'
                                                                ]
                                ]
                ]
        ]
    ],
    'pipeline_config' => [
        'tts_config' => [
                'tts_voice_id' => 'longanhuan_v3.6'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vivix.ai/v1/realtime-avatar/sessions"

	payload := strings.NewReader("{\n  \"model\": \"vivix-a1-stream\",\n  \"output\": {\n    \"aspect_ratio\": \"9:16\",\n    \"resolution\": \"720p\"\n  },\n  \"avatars\": [\n    {\n      \"avatar_id\": \"companion\",\n      \"persona\": \"You are a warm, curious conversation companion. Speak in relaxed English and keep everyday replies brief. Acknowledge corrections without making excuses. Use small smiles and gentle nods, then let your hands rest while listening.\",\n      \"visual\": {\n        \"source_images\": [\n          {\n            \"source_image_id\": \"front\",\n            \"url\": \"https://static.vivi-x.ai/images/2026/07/20/b9b8e89651cd24ad.png\",\n            \"media_type\": \"image/png\",\n            \"description\": \"A young woman with curly black hair and a pink shirt, facing the camera in a softly lit room.\"\n          }\n        ]\n      }\n    }\n  ],\n  \"pipeline_config\": {\n    \"tts_config\": {\n      \"tts_voice_id\": \"longanhuan_v3.6\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.vivix.ai/v1/realtime-avatar/sessions")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"vivix-a1-stream\",\n  \"output\": {\n    \"aspect_ratio\": \"9:16\",\n    \"resolution\": \"720p\"\n  },\n  \"avatars\": [\n    {\n      \"avatar_id\": \"companion\",\n      \"persona\": \"You are a warm, curious conversation companion. Speak in relaxed English and keep everyday replies brief. Acknowledge corrections without making excuses. Use small smiles and gentle nods, then let your hands rest while listening.\",\n      \"visual\": {\n        \"source_images\": [\n          {\n            \"source_image_id\": \"front\",\n            \"url\": \"https://static.vivi-x.ai/images/2026/07/20/b9b8e89651cd24ad.png\",\n            \"media_type\": \"image/png\",\n            \"description\": \"A young woman with curly black hair and a pink shirt, facing the camera in a softly lit room.\"\n          }\n        ]\n      }\n    }\n  ],\n  \"pipeline_config\": {\n    \"tts_config\": {\n      \"tts_voice_id\": \"longanhuan_v3.6\"\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.vivix.ai/v1/realtime-avatar/sessions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"model\": \"vivix-a1-stream\",\n  \"output\": {\n    \"aspect_ratio\": \"9:16\",\n    \"resolution\": \"720p\"\n  },\n  \"avatars\": [\n    {\n      \"avatar_id\": \"companion\",\n      \"persona\": \"You are a warm, curious conversation companion. Speak in relaxed English and keep everyday replies brief. Acknowledge corrections without making excuses. Use small smiles and gentle nods, then let your hands rest while listening.\",\n      \"visual\": {\n        \"source_images\": [\n          {\n            \"source_image_id\": \"front\",\n            \"url\": \"https://static.vivi-x.ai/images/2026/07/20/b9b8e89651cd24ad.png\",\n            \"media_type\": \"image/png\",\n            \"description\": \"A young woman with curly black hair and a pink shirt, facing the camera in a softly lit room.\"\n          }\n        ]\n      }\n    }\n  ],\n  \"pipeline_config\": {\n    \"tts_config\": {\n      \"tts_voice_id\": \"longanhuan_v3.6\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "code": 0,
  "message": "success",
  "data": {
    "session_id": "avatar-session-123",
    "status": "active",
    "session": {
      "mode": "video_avatar",
      "active_avatar_id": "companion",
      "source_image_id": "front"
    },
    "control": {
      "url": "wss://api.vivix.ai/v1/realtime-avatar/control?session_id=avatar-session-123",
      "client_secret": "ctl_..."
    },
    "output": {
      "aspect_ratio": "9:16",
      "resolution": "720p"
    },
    "delivery": {
      "media": {
        "transport": "trtc",
        "trtc": {
          "sdk_app_id": "1400000000",
          "room_id": "avatar-session-123",
          "user_id": "viewer",
          "user_sig": "...",
          "publisher_user_id": "publisher_xxx"
        }
      }
    },
    "model": "vivix-a1-stream",
    "expires_at": "2026-07-16T10:05:00Z",
    "recording_mode": "off",
    "auto_close": {
      "disconnected_timeout_seconds": 0,
      "interaction_idle_timeout_seconds": 0
    },
    "conversation": {
      "tools": [],
      "turn_detection": {
        "type": "server_vad",
        "silence_duration_ms": 500
      }
    },
    "avatars": [
      {
        "avatar_id": "companion",
        "persona": "You are a warm, curious conversation companion. Speak in relaxed English and keep everyday replies brief. Acknowledge corrections without making excuses. Use small smiles and gentle nods, then let your hands rest while listening.",
        "visual": {
          "source_images": [
            {
              "source_image_id": "front",
              "url": "https://static.vivi-x.ai/images/2026/07/20/b9b8e89651cd24ad.png",
              "media_type": "image/png"
            }
          ]
        }
      }
    ]
  }
}

For video avatar sessions, include output. Its aspect_ratio accepts 9:16 (portrait) or 16:9 (landscape). If omitted, it defaults to 9:16. An unsupported ratio returns error 20004 before the session starts.

Connection, duration, and errors

The response includes control and media credentials. See Sessions to connect, session management for automatic closure, and Errors for error codes.

Use output.resolution to select 480p or 720p. If omitted, the session starts at 720p and Vivix fits the images to that size. Vivix fits each starting image, including images the session can switch to later. A session-level image_fit overrides the saved Character setting. If neither supplies a setting, Vivix uses a centered crop. The same anchor applies to every image in the session. To keep more of the top when the image is too tall for the frame, send:

{"image_fit":{"mode":"auto","crop_anchor":{"x":0.5,"y":0}}}

To use images you already prepared, send {"image_fit":{"mode":"manual"}}. For JPEGs, Vivix applies EXIF orientation before checking dimensions. Manual mode preserves the framing and skips cropping and scaling. If an image has the wrong dimensions, the API returns 20013 with its field path, actual dimensions, and expected dimensions. See Prepare the first image. For a 720p portrait session, a manual image at 720 × 1280 produces this error.

{
  "code": 20013,
  "message": "invalid avatars: avatars[0].visual.source_images[0]: image is 720 × 1280, expected 672 × 1280; see https://docs.vivix.ai/streaming-avatar/character/first-image",
  "data": null
}

When opening-image checks are enabled, they run on the active avatar’s selected opening image after fitting, including when you create a session from a saved character. If the request returns HTTP 422 with 20021 or 20022, update the image before retrying. See Session errors and the first-image guide.

Authorizations

Authorization

string

header

required

Your Vivix API key. Keep it on your server.

Body

application/json

model

string

required

Use vivix-a1-stream.

output

object

required

Required video output settings. Set the aspect ratio and resolution when creating the session.

Show child attributes

avatars

object[]

required

Available characters. Supply at least one, with unique avatar_id values. Each avatar selected for video needs a source image. Configure the shared voice in pipeline_config.tts_config.

Minimum array length: 1

Show child attributes

image_fit

object

How Vivix fits each starting image to the video avatar session frame. A session value overrides the saved character setting.

Show child attributes

idempotency_key

string

Optional key for retrying session creation. Reuse the same key when retrying the same request; use a new key for a new session.

session

object

Opening avatar and source image. Omit this object for a single avatar with one image. Use session.update to change the selected avatar or image during the session.

Show child attributes

pipeline_config

object

Session-wide speech recognition, speech synthesis, dialogue model, and audio rendering settings. These settings are fixed at session creation.

Show child attributes

conversation

object

Initial conversational defaults for tools, turn handling, and response generation.

Show child attributes

assets

object

Reusable image references, audio, speech text, and motion prompts. Use images for props or products in object interaction; put the character’s starting images in avatars[].visual.source_images. Asset IDs must be unique across all asset types.

Show child attributes

delivery

object

Media transport and delivery settings. Defaults to TRTC when omitted.

Show child attributes

max_duration_seconds

integer

Session time limit in seconds; minimum 4. The standard default is 20 minutes (1200 seconds), subject to your workspace’s session-duration limit. Check expires_at in the response for the actual expiry.

Required range: x >= 4

auto_close

object

Automatic close policy fixed when the session is created. The response returns the effective values after platform defaults are applied.

Show child attributes

recording_mode

string

on or off. Send off to disable recording.

Response

Success

code

integer

required

0 on success; any other value is an error code.

message

string

required

success, or an English error description.

data

object

required

Show child attributes

Overview

A1: Streaming Avatar

W1: Streaming World

Blazing Fast Video Generation

Create Session

Authorizations

Body

Response