Skip to main content
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": {}
  },
  "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"
  }
}
'
{
  "code": 100,
  "data": {
    "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "session_token": "<string>"
  },
  "message": "<string>"
}

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
avatar_id
string<uuid>
required
​
mode
string
default:FULL
Allowed value: "FULL"
​
is_sandbox
boolean
default:false
​
video_settings
VideoSettings · object

Video encoding settings

​
max_session_duration
integer

Maximum session duration in seconds. Must be <= the configured limit for your subscription tier.

​
avatar_persona
AvatarPersonaSchema · object
deprecated

Inline voice / context / voice_settings. Mutually exclusive with voice_agent.

​
voice_agent
VoiceAgentRef · object

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.

​
interactivity_type
enum<string>
default:CONVERSATIONAL
Available options:
CONVERSATIONAL,
PUSH_TO_TALK
​
llm_configuration_id
string<uuid>

Optional custom LLM configuration ID

​
dynamic_variables
Dynamic Variables · object

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.

​
memory
MemoryRef · object

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).

Response

Successful Response

​
code
integer
default:100
​
data
SDKSessionTokenSchema · object
​
message
string