Member Junction
    Preparing search index...

    Result shape returned by the StartRealtimeClientSession server mutation. The browser uses these values to open a client-direct realtime session.

    Exported because a host may mint the session ITSELF (its own mutation, carrying server-side context the stock mutation cannot express) and then hand the result to RealtimeSessionService.StartRealtimeSessionFromResult to run it — this is the contract that path is written against.

    interface StartRealtimeClientSessionResult {
        AgentSessionId: string;
        ConversationId: string | null;
        EphemeralToken: string;
        ExpiresAt: string;
        Model: string;
        ModelName: string | null;
        NarrationInstructionsTemplate: string | null;
        PriorChannelStatesJson: string | null;
        Provider: string;
        SessionConfigJson: string;
    }
    Index

    Properties

    AgentSessionId: string
    ConversationId: string | null
    EphemeralToken: string
    ExpiresAt: string
    Model: string
    ModelName: string | null

    Display name of the realtime model the session uses (e.g. "GPT Realtime 2"). Null when unknown.

    NarrationInstructionsTemplate: string | null

    DB-driven progress-narration instruction template (contains a {{ progressMessage }} placeholder). Null when the deployment hasn't synced the narration prompt — the client falls back to its built-in wording.

    PriorChannelStatesJson: string | null

    JSON map of the PRIOR session's saved channel states keyed by channel name (present only when the start carried lastSessionId and the prior session — owned by the same user — had saved states). Applied to the matching channel plugins via BaseRealtimeChannelClient.RestoreState so e.g. the whiteboard resumes where the last session left off.

    Provider: string
    SessionConfigJson: string

    JSON.stringify of the provider session config (instructions + tools) to apply at connect.