Interface AvatarSessionOptions

Options for configuring an AvatarSession.

interface AvatarSessionOptions {
    agentId?: null | string;
    agentIdlePrompt?: null | string;
    agentImage?: null | string | Buffer<ArrayBufferLike>;
    agentImageMimeType?: string;
    agentImageUrl?: null | string;
    agentPrompt?: null | string;
    apiKey?: string;
    apiUrl?: string;
    avatarParticipantIdentity?: string;
    avatarParticipantName?: string;
    connOptions?: APIConnectOptions;
    extraPayload?: null | Record<string, unknown>;
    idleTimeout?: null | number;
}

Properties

agentId? agentIdlePrompt? agentImage? agentImageMimeType? agentImageUrl? agentPrompt? apiKey? apiUrl? avatarParticipantIdentity? avatarParticipantName? connOptions? extraPayload? idleTimeout?

Properties

Optional agentId

agentId?: null | string

The ID of the LemonSlice agent to add to the session. Exactly one of agentId, agentImageUrl, or agentImage must be provided.

Optional agentIdlePrompt

agentIdlePrompt?: null | string

A prompt that subtly influences the avatar's movements and expressions while idle.

Optional agentImage

agentImage?: null | string | Buffer<ArrayBufferLike>

A local image file path or Buffer to upload as the agent's avatar. Exactly one of agentId, agentImageUrl, or agentImage must be provided.

Optional agentImageMimeType

agentImageMimeType?: string

MIME type for the agentImage when provided as a Buffer (e.g. 'image/png'). Defaults to 'image/png'.

Optional agentImageUrl

agentImageUrl?: null | string

The URL of the image to use as the agent's avatar. Exactly one of agentId, agentImageUrl, or agentImage must be provided.

Optional agentPrompt

agentPrompt?: null | string

A prompt that subtly influences the avatar's movements and expressions while responding.

Optional apiKey

apiKey?: string

The LemonSlice API key. Can also be set via LEMONSLICE_API_KEY environment variable.

Optional apiUrl

apiUrl?: string

The LemonSlice API URL. Defaults to https://lemonslice.com/api/liveai/sessions or LEMONSLICE_API_URL environment variable.

Optional avatarParticipantIdentity

avatarParticipantIdentity?: string

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

Optional avatarParticipantName

avatarParticipantName?: string

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

Optional connOptions

connOptions?: APIConnectOptions

Connection options for API requests.

Optional extraPayload

extraPayload?: null | Record<string, unknown>

Additional payload fields to merge into the LemonSlice session creation request.

Optional idleTimeout

idleTimeout?: null | number

The idle timeout, in seconds. Defaults to 60 seconds.

Settings

Member Visibility

Theme

On This Page

agentIdagentIdlePromptagentImageagentImageMimeTypeagentImageUrlagentPromptapiKeyapiUrlavatarParticipantIdentityavatarParticipantNameconnOptionsextraPayloadidleTimeout