Create Session Token
curl --request POST \
--url https://api.liveavatar.com/v1/sessions/token \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"avatar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mode": "FULL",
"is_sandbox": false,
"video_settings": {
"quality": "high",
"encoding": "H264"
},
"max_session_duration": 123,
"avatar_persona": {
"voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"context_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language": "en",
"voice_settings": {
"provider": "elevenLabs",
"speed": 1,
"stability": 0.75,
"similarity_boost": 0.75,
"style": 0,
"use_speaker_boost": true,
"model": "eleven_flash_v2_5",
"apply_language_text_normalization": false
},
"stt_config": {},
"llm_settings": {
"provider": "openai",
"model": "gpt-5.4-nano"
}
},
"voice_agent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language": "<string>",
"dynamic_variables": {}
},
"interactivity_type": "CONVERSATIONAL",
"llm_configuration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dynamic_variables": {},
"memory": {
"prev_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"session_memory_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
'import requests
url = "https://api.liveavatar.com/v1/sessions/token"
payload = {
"avatar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mode": "FULL",
"is_sandbox": False,
"video_settings": {
"quality": "high",
"encoding": "H264"
},
"max_session_duration": 123,
"avatar_persona": {
"voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"context_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language": "en",
"voice_settings": {
"provider": "elevenLabs",
"speed": 1,
"stability": 0.75,
"similarity_boost": 0.75,
"style": 0,
"use_speaker_boost": True,
"model": "eleven_flash_v2_5",
"apply_language_text_normalization": False
},
"stt_config": {},
"llm_settings": {
"provider": "openai",
"model": "gpt-5.4-nano"
}
},
"voice_agent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language": "<string>",
"dynamic_variables": {}
},
"interactivity_type": "CONVERSATIONAL",
"llm_configuration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dynamic_variables": {},
"memory": {
"prev_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"session_memory_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
avatar_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
mode: 'FULL',
is_sandbox: false,
video_settings: {quality: 'high', encoding: 'H264'},
max_session_duration: 123,
avatar_persona: {
voice_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
context_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
language: 'en',
voice_settings: {
provider: 'elevenLabs',
speed: 1,
stability: 0.75,
similarity_boost: 0.75,
style: 0,
use_speaker_boost: true,
model: 'eleven_flash_v2_5',
apply_language_text_normalization: false
},
stt_config: {},
llm_settings: {provider: 'openai', model: 'gpt-5.4-nano'}
},
voice_agent: {
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
language: '<string>',
dynamic_variables: {}
},
interactivity_type: 'CONVERSATIONAL',
llm_configuration_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
dynamic_variables: {},
memory: {
prev_session_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
session_memory_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
})
};
fetch('https://api.liveavatar.com/v1/sessions/token', 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.liveavatar.com/v1/sessions/token",
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([
'avatar_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'mode' => 'FULL',
'is_sandbox' => false,
'video_settings' => [
'quality' => 'high',
'encoding' => 'H264'
],
'max_session_duration' => 123,
'avatar_persona' => [
'voice_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'context_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'language' => 'en',
'voice_settings' => [
'provider' => 'elevenLabs',
'speed' => 1,
'stability' => 0.75,
'similarity_boost' => 0.75,
'style' => 0,
'use_speaker_boost' => true,
'model' => 'eleven_flash_v2_5',
'apply_language_text_normalization' => false
],
'stt_config' => [
],
'llm_settings' => [
'provider' => 'openai',
'model' => 'gpt-5.4-nano'
]
],
'voice_agent' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'language' => '<string>',
'dynamic_variables' => [
]
],
'interactivity_type' => 'CONVERSATIONAL',
'llm_configuration_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'dynamic_variables' => [
],
'memory' => [
'prev_session_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'session_memory_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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.liveavatar.com/v1/sessions/token"
payload := strings.NewReader("{\n \"avatar_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mode\": \"FULL\",\n \"is_sandbox\": false,\n \"video_settings\": {\n \"quality\": \"high\",\n \"encoding\": \"H264\"\n },\n \"max_session_duration\": 123,\n \"avatar_persona\": {\n \"voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"context_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"language\": \"en\",\n \"voice_settings\": {\n \"provider\": \"elevenLabs\",\n \"speed\": 1,\n \"stability\": 0.75,\n \"similarity_boost\": 0.75,\n \"style\": 0,\n \"use_speaker_boost\": true,\n \"model\": \"eleven_flash_v2_5\",\n \"apply_language_text_normalization\": false\n },\n \"stt_config\": {},\n \"llm_settings\": {\n \"provider\": \"openai\",\n \"model\": \"gpt-5.4-nano\"\n }\n },\n \"voice_agent\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"language\": \"<string>\",\n \"dynamic_variables\": {}\n },\n \"interactivity_type\": \"CONVERSATIONAL\",\n \"llm_configuration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dynamic_variables\": {},\n \"memory\": {\n \"prev_session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"session_memory_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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.liveavatar.com/v1/sessions/token")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"avatar_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mode\": \"FULL\",\n \"is_sandbox\": false,\n \"video_settings\": {\n \"quality\": \"high\",\n \"encoding\": \"H264\"\n },\n \"max_session_duration\": 123,\n \"avatar_persona\": {\n \"voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"context_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"language\": \"en\",\n \"voice_settings\": {\n \"provider\": \"elevenLabs\",\n \"speed\": 1,\n \"stability\": 0.75,\n \"similarity_boost\": 0.75,\n \"style\": 0,\n \"use_speaker_boost\": true,\n \"model\": \"eleven_flash_v2_5\",\n \"apply_language_text_normalization\": false\n },\n \"stt_config\": {},\n \"llm_settings\": {\n \"provider\": \"openai\",\n \"model\": \"gpt-5.4-nano\"\n }\n },\n \"voice_agent\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"language\": \"<string>\",\n \"dynamic_variables\": {}\n },\n \"interactivity_type\": \"CONVERSATIONAL\",\n \"llm_configuration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dynamic_variables\": {},\n \"memory\": {\n \"prev_session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"session_memory_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.liveavatar.com/v1/sessions/token")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"avatar_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mode\": \"FULL\",\n \"is_sandbox\": false,\n \"video_settings\": {\n \"quality\": \"high\",\n \"encoding\": \"H264\"\n },\n \"max_session_duration\": 123,\n \"avatar_persona\": {\n \"voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"context_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"language\": \"en\",\n \"voice_settings\": {\n \"provider\": \"elevenLabs\",\n \"speed\": 1,\n \"stability\": 0.75,\n \"similarity_boost\": 0.75,\n \"style\": 0,\n \"use_speaker_boost\": true,\n \"model\": \"eleven_flash_v2_5\",\n \"apply_language_text_normalization\": false\n },\n \"stt_config\": {},\n \"llm_settings\": {\n \"provider\": \"openai\",\n \"model\": \"gpt-5.4-nano\"\n }\n },\n \"voice_agent\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"language\": \"<string>\",\n \"dynamic_variables\": {}\n },\n \"interactivity_type\": \"CONVERSATIONAL\",\n \"llm_configuration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dynamic_variables\": {},\n \"memory\": {\n \"prev_session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"session_memory_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n}"
response = http.request(request)
puts response.read_body{
"code": 100,
"data": {
"session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"session_token": "<string>"
},
"message": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Sessions
Create Session Token
Create session token for an API-key-authenticated user.
Minting a session token is only doable via an API key (APIUserDep) — a
session JWT (SessionUser) cannot mint a token for another participant.
HeyGen gateway identities mint through /heygen_session_token.
This route only authenticates native API keys.
POST
/
v1
/
sessions
/
token
Create Session Token
curl --request POST \
--url https://api.liveavatar.com/v1/sessions/token \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"avatar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mode": "FULL",
"is_sandbox": false,
"video_settings": {
"quality": "high",
"encoding": "H264"
},
"max_session_duration": 123,
"avatar_persona": {
"voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"context_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language": "en",
"voice_settings": {
"provider": "elevenLabs",
"speed": 1,
"stability": 0.75,
"similarity_boost": 0.75,
"style": 0,
"use_speaker_boost": true,
"model": "eleven_flash_v2_5",
"apply_language_text_normalization": false
},
"stt_config": {},
"llm_settings": {
"provider": "openai",
"model": "gpt-5.4-nano"
}
},
"voice_agent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language": "<string>",
"dynamic_variables": {}
},
"interactivity_type": "CONVERSATIONAL",
"llm_configuration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dynamic_variables": {},
"memory": {
"prev_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"session_memory_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
'import requests
url = "https://api.liveavatar.com/v1/sessions/token"
payload = {
"avatar_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"mode": "FULL",
"is_sandbox": False,
"video_settings": {
"quality": "high",
"encoding": "H264"
},
"max_session_duration": 123,
"avatar_persona": {
"voice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"context_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language": "en",
"voice_settings": {
"provider": "elevenLabs",
"speed": 1,
"stability": 0.75,
"similarity_boost": 0.75,
"style": 0,
"use_speaker_boost": True,
"model": "eleven_flash_v2_5",
"apply_language_text_normalization": False
},
"stt_config": {},
"llm_settings": {
"provider": "openai",
"model": "gpt-5.4-nano"
}
},
"voice_agent": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"language": "<string>",
"dynamic_variables": {}
},
"interactivity_type": "CONVERSATIONAL",
"llm_configuration_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dynamic_variables": {},
"memory": {
"prev_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"session_memory_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
avatar_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
mode: 'FULL',
is_sandbox: false,
video_settings: {quality: 'high', encoding: 'H264'},
max_session_duration: 123,
avatar_persona: {
voice_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
context_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
language: 'en',
voice_settings: {
provider: 'elevenLabs',
speed: 1,
stability: 0.75,
similarity_boost: 0.75,
style: 0,
use_speaker_boost: true,
model: 'eleven_flash_v2_5',
apply_language_text_normalization: false
},
stt_config: {},
llm_settings: {provider: 'openai', model: 'gpt-5.4-nano'}
},
voice_agent: {
id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
language: '<string>',
dynamic_variables: {}
},
interactivity_type: 'CONVERSATIONAL',
llm_configuration_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
dynamic_variables: {},
memory: {
prev_session_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
session_memory_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
})
};
fetch('https://api.liveavatar.com/v1/sessions/token', 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.liveavatar.com/v1/sessions/token",
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([
'avatar_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'mode' => 'FULL',
'is_sandbox' => false,
'video_settings' => [
'quality' => 'high',
'encoding' => 'H264'
],
'max_session_duration' => 123,
'avatar_persona' => [
'voice_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'context_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'language' => 'en',
'voice_settings' => [
'provider' => 'elevenLabs',
'speed' => 1,
'stability' => 0.75,
'similarity_boost' => 0.75,
'style' => 0,
'use_speaker_boost' => true,
'model' => 'eleven_flash_v2_5',
'apply_language_text_normalization' => false
],
'stt_config' => [
],
'llm_settings' => [
'provider' => 'openai',
'model' => 'gpt-5.4-nano'
]
],
'voice_agent' => [
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'language' => '<string>',
'dynamic_variables' => [
]
],
'interactivity_type' => 'CONVERSATIONAL',
'llm_configuration_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'dynamic_variables' => [
],
'memory' => [
'prev_session_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'session_memory_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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.liveavatar.com/v1/sessions/token"
payload := strings.NewReader("{\n \"avatar_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mode\": \"FULL\",\n \"is_sandbox\": false,\n \"video_settings\": {\n \"quality\": \"high\",\n \"encoding\": \"H264\"\n },\n \"max_session_duration\": 123,\n \"avatar_persona\": {\n \"voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"context_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"language\": \"en\",\n \"voice_settings\": {\n \"provider\": \"elevenLabs\",\n \"speed\": 1,\n \"stability\": 0.75,\n \"similarity_boost\": 0.75,\n \"style\": 0,\n \"use_speaker_boost\": true,\n \"model\": \"eleven_flash_v2_5\",\n \"apply_language_text_normalization\": false\n },\n \"stt_config\": {},\n \"llm_settings\": {\n \"provider\": \"openai\",\n \"model\": \"gpt-5.4-nano\"\n }\n },\n \"voice_agent\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"language\": \"<string>\",\n \"dynamic_variables\": {}\n },\n \"interactivity_type\": \"CONVERSATIONAL\",\n \"llm_configuration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dynamic_variables\": {},\n \"memory\": {\n \"prev_session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"session_memory_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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.liveavatar.com/v1/sessions/token")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"avatar_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mode\": \"FULL\",\n \"is_sandbox\": false,\n \"video_settings\": {\n \"quality\": \"high\",\n \"encoding\": \"H264\"\n },\n \"max_session_duration\": 123,\n \"avatar_persona\": {\n \"voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"context_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"language\": \"en\",\n \"voice_settings\": {\n \"provider\": \"elevenLabs\",\n \"speed\": 1,\n \"stability\": 0.75,\n \"similarity_boost\": 0.75,\n \"style\": 0,\n \"use_speaker_boost\": true,\n \"model\": \"eleven_flash_v2_5\",\n \"apply_language_text_normalization\": false\n },\n \"stt_config\": {},\n \"llm_settings\": {\n \"provider\": \"openai\",\n \"model\": \"gpt-5.4-nano\"\n }\n },\n \"voice_agent\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"language\": \"<string>\",\n \"dynamic_variables\": {}\n },\n \"interactivity_type\": \"CONVERSATIONAL\",\n \"llm_configuration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dynamic_variables\": {},\n \"memory\": {\n \"prev_session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"session_memory_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.liveavatar.com/v1/sessions/token")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"avatar_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"mode\": \"FULL\",\n \"is_sandbox\": false,\n \"video_settings\": {\n \"quality\": \"high\",\n \"encoding\": \"H264\"\n },\n \"max_session_duration\": 123,\n \"avatar_persona\": {\n \"voice_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"context_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"language\": \"en\",\n \"voice_settings\": {\n \"provider\": \"elevenLabs\",\n \"speed\": 1,\n \"stability\": 0.75,\n \"similarity_boost\": 0.75,\n \"style\": 0,\n \"use_speaker_boost\": true,\n \"model\": \"eleven_flash_v2_5\",\n \"apply_language_text_normalization\": false\n },\n \"stt_config\": {},\n \"llm_settings\": {\n \"provider\": \"openai\",\n \"model\": \"gpt-5.4-nano\"\n }\n },\n \"voice_agent\": {\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"language\": \"<string>\",\n \"dynamic_variables\": {}\n },\n \"interactivity_type\": \"CONVERSATIONAL\",\n \"llm_configuration_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"dynamic_variables\": {},\n \"memory\": {\n \"prev_session_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"session_memory_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n}"
response = http.request(request)
puts response.read_body{
"code": 100,
"data": {
"session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"session_token": "<string>"
},
"message": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Body
application/json
- Full Mode
- Lite Mode
Allowed value:
"FULL"Video encoding settings
Show child attributes
Show child attributes
Maximum session duration in seconds. Must be <= the configured limit for your subscription tier.
Inline voice / context / voice_settings. Mutually exclusive with voice_agent.
Show child attributes
Show child attributes
Reference a stored voice_agent by id; the server resolves its agent_type and builds the session accordingly (which per-session overrides apply depends on the type — see VoiceAgentRef). An elevenlabs_agent produces a LITE session even on this FULL request. Mutually exclusive with avatar_persona.
Show child attributes
Show child attributes
Available options:
CONVERSATIONAL, PUSH_TO_TALK Optional custom LLM configuration ID
Values for ${var} placeholders in the context's opening_text and prompt. Required keys are derived from the context; extra keys are ignored. At most 50 entries; keys <= 64 chars; values <= 1000 chars.
Show child attributes
Show child attributes
Attach session memory. Provide prev_session_id to seed/reuse from a prior session, session_memory_id to attach an existing memory, or both (must resolve to the same memory_id).
Show child attributes
Show child attributes
Was this page helpful?