Interface AvatarSessionOptions

interface AvatarSessionOptions {
    apiKey?: string;
    apiUrl?: string;
    avatarId?: string;
    avatarParticipantIdentity?: string;
    avatarParticipantName?: string;
    connOptions?: APIConnectOptions;
    maxDuration?: number;
    presetId?: string;
}

Properties

apiKey? apiUrl? avatarId? avatarParticipantIdentity? avatarParticipantName? connOptions? maxDuration? presetId?

Properties

Optional apiKey

apiKey?: string

Runway API secret. Falls back to RUNWAYML_API_SECRET environment variable.

Optional apiUrl

apiUrl?: string

Runway API URL. Defaults to https://api.dev.runwayml.com or RUNWAYML_BASE_URL environment variable.

Optional avatarId

avatarId?: string

ID of a user-created avatar. Provide either avatarId or presetId, not both.

Optional avatarParticipantIdentity

avatarParticipantIdentity?: string

Optional avatarParticipantName

avatarParticipantName?: string

Optional connOptions

connOptions?: APIConnectOptions

Optional maxDuration

maxDuration?: number

Maximum session duration in seconds.

Optional presetId

presetId?: string

ID of a Runway preset avatar. Provide either avatarId or presetId, not both.

Settings

Member Visibility

Theme

On This Page

apiKeyapiUrlavatarIdavatarParticipantIdentityavatarParticipantNameconnOptionsmaxDurationpresetId