Interface RealtimeModelOptions

interface RealtimeModelOptions {
    additionalLanguages?: string[];
    additionalParams?: Record<string, unknown>;
    apiKey: string;
    assistantBackchannelAggressiveness?: number;
    audioSpeed?: number;
    baseUrl?: string;
    boostedKeywords?: string[];
    configsForTools?: PhonicToolConfig[];
    configurationEndpoint?: null | ConfigurationEndpoint;
    connOptions: APIConnectOptions;
    defaultLanguage?: string;
    enableAssistantBackchannel?: boolean;
    enableRedaction?: boolean;
    forbidSpeechAfterToolCall?: string[];
    generateNoInputPokeText?: boolean;
    generateWelcomeMessage?: boolean;
    instructions?: string;
    intelligenceLevel?: IntelligenceLevel;
    isWelcomeMessageInterruptible?: boolean;
    mcpServers?: string[];
    minWordsToInterrupt?: number;
    model: string;
    multilingualMode?: "auto" | "request";
    noInputEndConversationSec?: number;
    noInputPokeSec?: number;
    noInputPokeText?: string;
    observabilityIntegrations?: "braintrust"[];
    onConversationCreated?: ((conversationId) => void);
    phonicAgent?: string;
    phonicTools?: string[];
    project?: string;
    pronunciationDictionary?: Item[];
    templateVariables?: Record<string, string>;
    vadMinSilenceDurationMs?: number;
    vadMinSpeechDurationMs?: number;
    vadPrebufferDurationMs?: number;
    vadThreshold?: number;
    voice?: string;
    websocketTimeoutSec?: number;
    welcomeMessage?: string;
}

Properties

additionalLanguages? additionalParams? apiKey assistantBackchannelAggressiveness? audioSpeed? baseUrl? boostedKeywords? configsForTools? configurationEndpoint? connOptions defaultLanguage? enableAssistantBackchannel? enableRedaction? forbidSpeechAfterToolCall? generateNoInputPokeText? generateWelcomeMessage? instructions? intelligenceLevel? isWelcomeMessageInterruptible? mcpServers? minWordsToInterrupt? model multilingualMode? noInputEndConversationSec? noInputPokeSec? noInputPokeText? observabilityIntegrations? onConversationCreated? phonicAgent? phonicTools? project? pronunciationDictionary? templateVariables? vadMinSilenceDurationMs? vadMinSpeechDurationMs? vadPrebufferDurationMs? vadThreshold? voice? websocketTimeoutSec? welcomeMessage?

Properties

Optional additionalLanguages

additionalLanguages?: string[]

Optional additionalParams

additionalParams?: Record<string, unknown>

apiKey

apiKey: string

Optional assistantBackchannelAggressiveness

assistantBackchannelAggressiveness?: number

Optional audioSpeed

audioSpeed?: number

Optional baseUrl

baseUrl?: string

Optional boostedKeywords

boostedKeywords?: string[]

Optional configsForTools

configsForTools?: PhonicToolConfig[]

Optional configurationEndpoint

configurationEndpoint?: null | ConfigurationEndpoint

connOptions

connOptions: APIConnectOptions

Optional defaultLanguage

defaultLanguage?: string

Optional enableAssistantBackchannel

enableAssistantBackchannel?: boolean

Optional enableRedaction

enableRedaction?: boolean

Optional forbidSpeechAfterToolCall

forbidSpeechAfterToolCall?: string[]

Deprecated

Use configsForTools with forbid_speech_after_tool_call per tool instead.

Optional generateNoInputPokeText

generateNoInputPokeText?: boolean

Optional generateWelcomeMessage

generateWelcomeMessage?: boolean

Optional instructions

instructions?: string

Set by updateInstructions via voice.Agent rather than the RealtimeModel constructor

Optional intelligenceLevel

intelligenceLevel?: IntelligenceLevel

Optional isWelcomeMessageInterruptible

isWelcomeMessageInterruptible?: boolean

Optional mcpServers

mcpServers?: string[]

Optional minWordsToInterrupt

minWordsToInterrupt?: number

model

model: string

Optional multilingualMode

multilingualMode?: "auto" | "request"

Optional noInputEndConversationSec

noInputEndConversationSec?: number

Optional noInputPokeSec

noInputPokeSec?: number

Optional noInputPokeText

noInputPokeText?: string

Optional observabilityIntegrations

observabilityIntegrations?: "braintrust"[]

Optional onConversationCreated

onConversationCreated?: ((conversationId) => void)

Type declaration

    • (conversationId): void

    • Parameters

      • conversationId: string

      Returns void

Optional phonicAgent

phonicAgent?: string

Optional phonicTools

phonicTools?: string[]

Optional project

project?: string

Optional pronunciationDictionary

pronunciationDictionary?: Item[]

Optional templateVariables

templateVariables?: Record<string, string>

Optional vadMinSilenceDurationMs

vadMinSilenceDurationMs?: number

Optional vadMinSpeechDurationMs

vadMinSpeechDurationMs?: number

Optional vadPrebufferDurationMs

vadPrebufferDurationMs?: number

Optional vadThreshold

vadThreshold?: number

Optional voice

voice?: string

Optional websocketTimeoutSec

websocketTimeoutSec?: number

Optional welcomeMessage

welcomeMessage?: string

Settings

Member Visibility

Theme

On This Page

additionalLanguagesadditionalParamsapiKeyassistantBackchannelAggressivenessaudioSpeedbaseUrlboostedKeywordsconfigsForToolsconfigurationEndpointconnOptionsdefaultLanguageenableAssistantBackchannelenableRedactionforbidSpeechAfterToolCallgenerateNoInputPokeTextgenerateWelcomeMessageinstructionsintelligenceLevelisWelcomeMessageInterruptiblemcpServersminWordsToInterruptmodelmultilingualModenoInputEndConversationSecnoInputPokeSecnoInputPokeTextobservabilityIntegrationsonConversationCreatedphonicAgentphonicToolsprojectpronunciationDictionarytemplateVariablesvadMinSilenceDurationMsvadMinSpeechDurationMsvadPrebufferDurationMsvadThresholdvoicewebsocketTimeoutSecwelcomeMessage