Interface CreateConversationOptions

interface CreateConversationOptions {
    extraPayload?: Record<string, unknown>;
    faceId?: string;
    palId?: string;
    personaId?: string;
    properties?: Record<string, unknown>;
    replicaId?: string;
}

Properties

extraPayload? faceId? palId? personaId? properties? replicaId?

Properties

Optional extraPayload

extraPayload?: Record<string, unknown>

Additional fields to merge into the Tavus conversation creation payload.

Optional faceId

faceId?: string

Tavus face id. Falls back to TAVUS_FACE_ID.

Optional palId

palId?: string

Tavus pal id. Falls back to TAVUS_PAL_ID; defaults to a stock pal when omitted.

Optional personaId

personaId?: string

Deprecated

Use palId instead.

Optional properties

properties?: Record<string, unknown>

Conversation properties passed through to Tavus.

Optional replicaId

replicaId?: string

Deprecated

Use faceId instead.

Settings

Member Visibility

Theme

On This Page

extraPayloadfaceIdpalIdpersonaIdpropertiesreplicaId