Member Junction
    Preparing search index...

    Interface StartLiveKitAgentRoomSessionInput

    Input for GraphQLLiveKitClient.StartAgentRoomSession.

    interface StartLiveKitAgentRoomSessionInput {
        AgentID?: string;
        AgentName?: string;
        AgentSessionID?: string;
        EnableHandoff?: boolean;
        RealtimeModelID?: string;
        RealtimeVoice?: string;
        RoomName?: string;
        TargetAgentID?: string;
        TurnAddressing?: "Auto" | "ModelSide" | "Regex";
        TurnMode?: "Passive" | "Active" | "Hybrid";
    }
    Index

    Properties

    AgentID? AgentName? AgentSessionID? EnableHandoff? RealtimeModelID? RealtimeVoice? RoomName? TargetAgentID? TurnAddressing? TurnMode?

    Properties

    AgentID?: string

    The agent to voice in the room (the Realtime Co-Agent / voice front-end).

    AgentName?: string

    The agent's display name (bot name + addressing).

    AgentSessionID?: string

    The MJ agent-session id. When omitted, the server generates one.

    EnableHandoff?: boolean

    Start the agent able to bring someone into this room (a person who is offered the conversation, a phone number, or another agent). Opt-in; honoured only when the server is configured for handoffs, otherwise the agent starts as usual.

    RealtimeModelID?: string

    Optional per-session Realtime MODEL override (an MJ: AI Models Name or ID) — dev model picker.

    RealtimeVoice?: string

    Optional per-session VOICE override (provider-native voice id, e.g. OpenAI echo) — dev voice picker.

    RoomName?: string

    The room to use. When omitted, the server generates one.

    TargetAgentID?: string

    The TARGET agent the co-agent voices — the one being "called". Without it the agent stays idle.

    TurnAddressing?: "Auto" | "ModelSide" | "Regex"

    How the agent decides it was addressed: Auto (default — the model's own judgement when it is full-duplex, name matching otherwise), ModelSide, or Regex.

    TurnMode?: "Passive" | "Active" | "Hybrid"

    Turn-taking mode.

    Settings

    Member Visibility

    On This Page

    Properties