Interface AvatarSessionOptions

Options for configuring an AvatarSession.

interface AvatarSessionOptions {
    apiKey?: string;
    apiUrl?: string;
    avatarParticipantIdentity?: string;
    avatarParticipantName?: string;
    connOptions?: APIConnectOptions;
    faceId?: string;
    palId?: string;
    personaId?: string;
    replicaId?: string;
}

Properties

apiKey? apiUrl? avatarParticipantIdentity? avatarParticipantName? connOptions? faceId? palId? personaId? replicaId?

Properties

Optional apiKey

apiKey?: string

Tavus API key. Falls back to TAVUS_API_KEY.

Optional apiUrl

apiUrl?: string

Override the Tavus API base URL.

Optional avatarParticipantIdentity

avatarParticipantIdentity?: string

Identity for the avatar participant. Defaults to tavus-avatar-agent.

Optional avatarParticipantName

avatarParticipantName?: string

Display name for the avatar participant. Defaults to tavus-avatar-agent.

Optional connOptions

connOptions?: APIConnectOptions

API retry/timeout options.

Optional faceId

faceId?: string

Tavus face id. Falls back to TAVUS_FACE_ID.

Optional palId

palId?: string

Tavus pal id. Falls back to TAVUS_PAL_ID; defaults to a stock pal when omitted.

Optional personaId

personaId?: string

Deprecated

Use palId instead.

Optional replicaId

replicaId?: string

Deprecated

Use faceId instead.

Settings

Member Visibility

Theme

On This Page

apiKeyapiUrlavatarParticipantIdentityavatarParticipantNameconnOptionsfaceIdpalIdpersonaIdreplicaId