Interface RealtimeSessionOptions

Options for RealtimeModel.session.

The framework passes the agent's instructions, chat context, and tools when it creates a session. A provider that fixes them at connect time (for example, Gemini Live sends tools in its setup message) applies them to the first connection. It then does not need to reconnect when the same values arrive through _updateSession.

The framework still applies all of these values with _updateSession after creation. A provider can ignore a value that it does not need before it connects.

interface RealtimeSessionOptions {
    chatCtx?: ChatContext;
    instructions?: string;
    tools?: ToolContext<unknown>;
    turnDetectionDisabled?: boolean;
}

Properties

chatCtx? instructions? tools? turnDetectionDisabled?

Properties

Optional chatCtx

chatCtx?: ChatContext

Initial chat context.

Optional instructions

instructions?: string

Initial system instructions.

Optional tools

tools?: ToolContext<unknown>

Initial tools.

Optional turnDetectionDisabled

turnDetectionDisabled?: boolean

Disable server-side turn detection for this session. Only providers that report canDisableTurnDetection honor it.

Settings

Member Visibility

Theme

On This Page

chatCtxinstructionstoolsturnDetectionDisabled