RTSDK
    Preparing search index...

    Interface NpcVoiceConfigInterface

    interface NpcVoiceConfigInterface {
        ephemeralKey: string;
        instructions: string;
        model?: string;
        turnDetection?: {
            prefix_padding_ms?: number;
            silence_duration_ms?: number;
            threshold?: number;
            type: "server_vad";
        };
        voice: string;
    }
    Index

    Properties

    ephemeralKey instructions model? turnDetection? voice

    Properties

    ephemeralKey: string

    OpenAI ephemeral key (ek_*). Generated server-side, used once to establish WebRTC connection.

    instructions: string

    System prompt including curriculum context and behavioral instructions.

    model?: string

    OpenAI model ID. Defaults to "gpt-4o-realtime-preview".

    turnDetection?: {
        prefix_padding_ms?: number;
        silence_duration_ms?: number;
        threshold?: number;
        type: "server_vad";
    }

    Voice activity detection configuration.

    voice: string

    OpenAI voice ID (e.g., "alloy", "echo", "shimmer").

    Settings

    Member Visibility

    On This Page

    Properties