Member Junction
    Preparing search index...

    Interface ClientRealtimeSessionConfig

    The server-minted configuration a browser needs to open a client-direct realtime session.

    Returned by BaseRealtimeModel.CreateClientSession. The browser authenticates to the provider with ClientRealtimeSessionConfig.EphemeralToken and hands ClientRealtimeSessionConfig.SessionConfig to the matching client driver — so the server retains control of the prompt and tool set even though the browser owns the socket.

    SessionConfig is a private pact between same-keyed driver halves. The server driver that minted it (selected by ClientRealtimeSessionConfig.Provider) and the client driver registered under the same key are the ONLY parties that understand its shape. Hosts and any transport in between must treat it as an opaque, serializable blob — never inspect, edit, or depend on its fields.

    interface ClientRealtimeSessionConfig {
        EphemeralToken: string;
        ExpiresAt: string;
        Model: string;
        Provider: string;
        SessionConfig: JSONObject;
    }
    Index

    Properties

    EphemeralToken: string

    The short-lived client secret the browser presents to the provider to authenticate its direct session. Server-scoped and expiring (see ClientRealtimeSessionConfig.ExpiresAt).

    ExpiresAt: string

    ISO-8601 timestamp at which ClientRealtimeSessionConfig.EphemeralToken expires.

    Model: string

    The provider realtime model id the session is scoped to (e.g. gpt-realtime).

    Provider: string

    The provider that minted the credential (e.g. 'openai'). Lets the browser select the correct provider-direct client implementation.

    SessionConfig: JSONObject

    The provider-native session config the matching client driver applies when it opens its socket (instructions/system prompt, tools, audio formats, turn detection). Because the server builds this, prompt and tool authority stay server-side even in the client-direct topology. Typed as a JSON object so it stays serializable across the server→client boundary — but its SHAPE is a private pact between the same-keyed server and client drivers; hosts must treat it opaquely and never read or rewrite its fields.