This endpoint is used to initiate a new streaming session.
This endpoint is used to initiate a new streaming session with an Interactive Avatar. It sets up a fresh session, allowing for real-time interactions and communication.
Request Body
Field | Type | Description |
---|---|---|
| string | The quality of the data to be retrieved. Can be "high", "medium", or "low". |
| string (optional) | The ID of the Interactive Avatar to use. If not provided, a default avatar will be chosen. Default: |
| VoiceSetting(optional) | The settings for the Interactive Avatar's voice. |
| STTSetting(optional) | The speech-to-text settings control how audio is converted into text. |
| string (optional) | Specifies the encoding format for streaming video. Can be "H264", "VP8". Default: |
| string (optional) | Knowledge Base prompt used for chat task type. |
| string (optional) beta | Specifies the version to use. Currently, the only valid value is |
| string (optional) beta | The ID of the knowledge base to use for the avatar's responses. Only applicable when |
| boolean(optional) | By default session has a 2 minute idle timeout, setting to true disables it. |
| integer(optional) | Specifies the maximum idle time in seconds allowed after the last user activity before the session is considered inactive. Default value: 120 seconds. Min value: 30 seconds, Max value: 3600 seconds. |
| LiveKitSettings (optional) beta | Settings for connecting to your own LiveKit instance. |
VoiceSetting
Field | Type | Description |
---|---|---|
voice_id | string (optional) | Voice for your Interactive Avatar. See the available voices by calling the List Voices endpoint. Note: Not every voice is supported in the streaming API. |
rate | float(optional) | Voice speed rate. Default is 1. |
emotion | string (optional) | Emotion to use for Emotional voices. Available emotions are Excited , Serious , Friendly , Soothing , Broadcaster |
elevenlabs_settings | ElevenlabsSettings (optional) | Voice settings to pass over if the voice provider for the session is Elevenlabs. |
ElevenlabsSettings
Field | Type | Description |
---|---|---|
stability | float (optional) | Default is 0.75. |
model_id | string(optional) | Voice model id. For ElevenLabs available models is: eleven_flash_v2_5 , eleven_multilingual_v2 . Default: eleven_flash_v2_5 |
similarity_boost | float(optional) | Default is 0.75. |
style | float (optional) | Default is 0.0. |
use_speaker_boost | bool (optional) | Default is true. |
STTSettings
Field | Type | Description |
---|---|---|
| string (optional) | STT model. Allowed values: |
| float(optional) | Default is 0.55. |
LiveKitSettings
Field | Type | Description |
---|---|---|
room | string (optional) | The LiveKit room to join. Must match the token’s room claim. |
url | string (optional) | Your LiveKit server URL. Example: wss://mylivekit.example.com |
token | string (optional) | A valid LiveKit access token with the required permissions. |
Response
Field | Type | Description |
---|---|---|
| integer | The response status code. |
| string | A message providing more details about the request's result, typically explaining success or error. |
| object | Contains the main data for the response. |
| string | A unique identifier for the session. |
| string | The WebSocket URL for accessing the LiveKit room (e.g., |
| string | The access token required to authenticate and join the LiveKit room. |
| integer | The maximum allowed duration (in seconds) for the session, indicating any session time limits. |
| boolean | A flag indicating whether the session is part of a paid plan. |
| string | The real-time endpoint URL for alpha implementations, which could be used for experimental features (e.g., |
| string | Only returned when using HeyGen-managed LiveKit. |