Interface AvatarSessionOptions

Options for configuring an AvatarSession.

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

Properties

apiKey? apiUrl? avatarParticipantIdentity? avatarParticipantName? connOptions? 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 personaId

personaId?: string

Tavus persona id. Falls back to TAVUS_PERSONA_ID; created automatically when omitted.

Optional replicaId

replicaId?: string

Tavus replica id. Falls back to TAVUS_REPLICA_ID.

Settings

Member Visibility

Theme

On This Page

apiKeyapiUrlavatarParticipantIdentityavatarParticipantNameconnOptionspersonaIdreplicaId