Interface AvatarSessionOptions

Options for configuring an AvatarSession.

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

Properties

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

Properties

Optional apiKey

apiKey?: string

The Beyond Presence API key. Can also be set via BEY_API_KEY environment variable.

Optional apiUrl

apiUrl?: string

The Beyond Presence API URL. Defaults to https://api.bey.dev or BEY_API_URL environment variable.

Optional avatarId

avatarId?: null | string

The avatar ID to use. If not provided, defaults to a stock avatar.

Optional avatarParticipantIdentity

avatarParticipantIdentity?: string

The identity of the avatar participant in the room. Defaults to 'bey-avatar-agent'.

Optional avatarParticipantName

avatarParticipantName?: string

The name of the avatar participant in the room. Defaults to 'bey-avatar-agent'.

Optional connOptions

connOptions?: APIConnectOptions

Connection options for API requests.

Settings

Member Visibility

Theme

On This Page

apiKeyapiUrlavatarIdavatarParticipantIdentityavatarParticipantNameconnOptions