Documentation Index
Fetch the complete documentation index at: https://docs.liveavatar.com/llms.txt
Use this file to discover all available pages before exploring further.
Delete Session Events endpoint
DELETE /v1/sessions/{session_id}/events— New endpoint to hard-delete all events for a given session. Acceptssession_idpath parameter; authenticated via API key or bearer token.
JavaScript SDK v0.0.18 — ElevenLabs Agent improvements
@heygen/liveavatar-web-sdkv0.0.18 — Includes a set of ElevenLabs Agent connector improvements, notably bidirectional passthrough of raw ElevenLabs Conversational AI events. Frontends can now both receive every ElevenLabs server event (viaelevenlabs_agent_event) and send raw ElevenLabs client events (viaelevenlabs_agent_command) without per-feature plumbing.
1080p avatars, ElevenLabs voice override & expanded Gemini voices
- 1080p avatars — Added support for 1080p avatars on the new payment plan.
AvatarSchemaexposes anis_1080pboolean to identify them. - Session token improvements — Hardened JWT payload to strip sensitive fields from the token, also reducing payload size. Sandbox mode keeps fields visible for testing.
- ElevenLabs voice override —
ElevenLabsAgentConfigSchemaaccepts an optionalvoice_idthat is forwarded asconversation_config_override.tts.voice_idto the ElevenLabs Agent WebSocket, overriding the agent’s default voice for the session. - Expanded Gemini Realtime voices —
GeminiVoiceEnumadds Achernar, Achird, Algenib, Algieba, Alnilam, Autonoe, Callirrhoe, Despina, Enceladus, Erinome, Gacrux, Iapetus, Laomedeia, Pulcherrima, Rasalgethi, Sadachbia, Sadaltager, Schedar, Sulafat, Umbriel, Vindemiatrix, and Zubenelgenubi.
Gemini Realtime, Vertical Embeds & Dynamic Variables
- Gemini Realtime agent — LITE sessions can now be configured with
gemini_realtime_config, running on Gemini Live API with configurable model, voice, and temperature. Supported voices include Aoede, Charon, Fenrir, Kore, Leda, Orus, Puck, and Zephyr. Requires a newGEMINI_API_KEYsecret type. - Embed orientation —
/v2/embeddingsnow accepts anorientationfield (horizontalfor 16:9 orverticalfor 9:16). The response also returns the newembed_idfield. - Session dynamic variables — Session creation now accepts a
dynamic_variablesobject for filling${var}placeholders in the context’s opening text and prompt (max 50 entries). - New session filters —
GET /v1/sessionsnow supportsembed_idandcontext_idquery parameters. - New
AGENT_HANG_UPsession end reason — Added toSessionEndReasonEnumto indicate the agent itself terminated the call. Currently only emitted by the ElevenLabs agent.
ElevenLabs Events, Embed Transcripts & SDK Update
- ElevenLabs agent events — underlying ElevenLabs server events are now forwarded via the
elevenlabs_agent_eventevent type, giving you access to raw ElevenLabs Conversational AI events - Transcript on embed — Transcripts are now available directly on embed sessions
- JavaScript SDK updated — Updated the
@heygen/liveavatar-web-sdkpackage with new event types and improvements
Auth Simplification & Session Filtering
- Authentication — Cleaned up documentation for which endpoints require which auth specifications
- New
avatar_idfilter on/v1/sessions— List sessions can now be filtered by an optional avatar_id query parameter
Embeds, Image Avatars & More
- New
/v2/embeddingsendpoint with sandbox support — Embeds can now be created with Sandbox Mode available - Built Image Avatar pipeline — Create a fully animated avatar from just a photo using the new validate and submit endpoints
Improvements
- Update avatar endpoint — You can now change an avatar’s default voice
- Avatar and voice deletion untangled — Deleting a voice no longer affects its associated avatar, and vice versa
- ElevenLabs agent dynamic variables — Configure dynamic variables for ElevenLabs-powered agents that get replaced at session start
- Source events fixed in FULL Mode —
avatar.sayandavatar.repeatevents now correctly returnsource_event_id
ElevenLabs Scribe, Embed Improvements
- Added support for ElevenLabs Scribe, expanding ASR capabilities
- Embed Improvements
- Default language selection, letting users set the language for their embed experience
- Time limits, giving creators control over session duration
Voice Settings & Fish Audio
- Added additional voice settings for more granular control over avatar speech
- Added access to Fish Audio as a TTS provider
- New
[GET] /v1/languagesendpoint to clarify which languages are currently supported
language parameter interacts with FULL Mode systems.ElevenLabs Integration
- The
v1/secretsendpoint now accepts ElevenLabs API keys - FULL Mode sessions can now start with your own ElevenLabs keys and voices
- Added integration with ElevenLabs Agent functionality
LLM Plugin & Session Controls
- Introduced LLM Plugin for custom LLM configurations
- Added customizable session duration controls
- Transcription chunk events are now emitted in real time
- New endpoint to track user credit balances
Session Configuration & LITE Mode
- New session configuration options for video codec selection (H.264 / VP8)
- Added video quality control settings
- Added voice customization options
- CUSTOM Mode has been renamed to LITE Mode (backward-compatible)
- Bug fix: resolved opening line speech issues
Push-to-Talk
- Released Push-to-Talk functionality for avatar sessions
- Added accompanying documentation and integration guides
Sandbox Mode & FULL Mode Improvements
- Introduced Sandbox Mode for testing without credit charges
- Made
contextoptional in FULL Mode configurations, reducing required setup
Custom Mode & Session List Updates
- Custom Mode now exposes LiveKit Agent token for developers to integrate their own agents
- Session List endpoint updated to use query parameters
Transcription Endpoint
- New
[GET] /v1/sessions/{session_id}/transcriptendpoint - Enables developers to retrieve transcriptions between users and avatars in FULL Mode sessions