Interface AvatarSessionOptions

interface AvatarSessionOptions {
    apiKey?: null | string;
    apiUrl?: null | string;
    avatarId?: string;
    avatarParticipantIdentity?: null | string;
    avatarParticipantName?: null | string;
    connOptions?: APIConnectOptions;
    maxDurationMs?: null | number;
}

Properties

apiKey? apiUrl? avatarId? avatarParticipantIdentity? avatarParticipantName? connOptions? maxDurationMs?

Properties

Optional apiKey

apiKey?: null | string

Protoface API key. Falls back to the PROTOFACE_API_KEY env var.

Optional apiUrl

apiUrl?: null | string

Override the Protoface API base URL.

Optional avatarId

avatarId?: string

Protoface avatar ID to render. Defaults to the stable stock avatar ID av_stock_001.

Optional avatarParticipantIdentity

avatarParticipantIdentity?: null | string

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

Optional avatarParticipantName

avatarParticipantName?: null | string

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

Optional connOptions

connOptions?: APIConnectOptions

API retry/timeout options.

Optional maxDurationMs

maxDurationMs?: null | number

Optional maximum session duration in milliseconds.

Settings

Member Visibility

Theme

On This Page

apiKeyapiUrlavatarIdavatarParticipantIdentityavatarParticipantNameconnOptionsmaxDurationMs