Interface AvatarSessionOptions

interface AvatarSessionOptions {
    apiKey?: string;
    apiSecret?: string;
    avatarParticipantIdentity?: string;
    avatarParticipantName?: string;
    baseURL?: string;
    connOptions?: APIConnectOptions;
    extraKwargs?: Record<string, unknown> | LemonSliceOptions;
    fetch?: {
        (input, init?): Promise<Response>;
        (input, init?): Promise<Response>;
    };
    model: AvatarModel;
}

Properties

apiKey? apiSecret? avatarParticipantIdentity? avatarParticipantName? baseURL? connOptions? extraKwargs? fetch? model

Properties

Optional apiKey

apiKey?: string

Gateway API key. Falls back to LIVEKIT_INFERENCE_API_KEY then LIVEKIT_API_KEY.

Optional apiSecret

apiSecret?: string

Gateway API secret. Falls back to LIVEKIT_INFERENCE_API_SECRET then LIVEKIT_API_SECRET.

Optional avatarParticipantIdentity

avatarParticipantIdentity?: string

Room identity for the avatar worker. Defaults to "<provider>-inference-avatar".

Optional avatarParticipantName

avatarParticipantName?: string

Display name for the avatar worker.

Optional baseURL

baseURL?: string

Inference gateway base URL. Defaults to the environment's gateway.

Optional connOptions

connOptions?: APIConnectOptions

Retry and whole-request timeout options for gateway calls.

Optional extraKwargs

extraKwargs?: Record<string, unknown> | LemonSliceOptions

Provider-specific options. For LemonSlice, use LemonSliceOptions.

Optional fetch

fetch?: {
    (input, init?): Promise<Response>;
    (input, init?): Promise<Response>;
}

Optional fetch implementation, primarily for tests.

Type declaration

    • (input, init?): Promise<Response>

    • Parameters

      • input: URL | RequestInfo
      • Optional init: RequestInit

      Returns Promise<Response>

    • (input, init?): Promise<Response>

    • Parameters

      • input: string | URL | Request
      • Optional init: RequestInit

      Returns Promise<Response>

model

model: AvatarModel

"<provider>" or "<provider>/<avatar_id>", e.g. "lemonslice/agent_abc".

Settings

Member Visibility

Theme

On This Page

apiKeyapiSecretavatarParticipantIdentityavatarParticipantNamebaseURLconnOptionsextraKwargsfetchmodel