Skip to main content

Usage guide

Setup, environment variables, and Python/JavaScript/Go usage examples.

​
SimliAvatar

Avatar integration for the Simli provider. Configures a Simli avatar session, resolving credentials and face settings from explicit arguments or environment variables.

​
Constructor

​
api_key
Optional[str]
Simli API key. Falls back to the SIMLI_API_KEY environment variable when not provided.
​
face_id
str
default:""
Identifier of the face to use. Falls back to the SIMLI_FACE_ID environment variable, then to a built-in default face when empty.
​
model
Optional[str]
Optional model identifier for the avatar.
​
is_trinity
bool
default:"False"
Whether to enable Trinity mode for the avatar.