Usage guide
Setup, environment variables, and Python/JavaScript/Go usage examples.
SimliAvatar
Real-time talking-head video avatar from Simli, lip-synced to your agent’s speech, using your own Simli API key. Authenticates with SIMLI_API_KEY from your environment, or an explicitapi_key.
Fields
Any
required
Simli avatar settings, including the face ID of the avatar to show. Required.
str
default:"UNSET"
How the avatar video is streamed from Simli, e.g. “P2P” for a direct peer-to-peer connection. Defaults to ‘P2P’.
str
default:"UNSET"
Base URL of the Simli API. Defaults to ‘https://api.simli.ai’.
bool
default:"UNSET"
Set to True if the face ID in config is a Simli Trinity avatar, so audio and video stay in sync. Defaults to False.