Member Junction
    Preparing search index...

    Interface LiveKitAgentRoomSessionResult

    Result of starting an agent room session (includes a client token so the caller can immediately join).

    interface LiveKitAgentRoomSessionResult {
        ClientToken: string;
        ErrorMessage?: string;
        Identity: string;
        RoomName: string;
        ServerUrl: string;
        SessionBridgeID: string;
        Success: boolean;
    }
    Index

    Properties

    ClientToken ErrorMessage? Identity RoomName ServerUrl SessionBridgeID Success

    Properties

    ClientToken: string

    A scoped client token for the requesting user to join the same room.

    ErrorMessage?: string

    Error detail when Success is false.

    Identity: string

    The requesting user's participant identity.

    RoomName: string

    The room the agent joined.

    ServerUrl: string

    The LiveKit server URL.

    SessionBridgeID: string

    The durable bridge-session row id.

    Success: boolean

    Whether the operation succeeded.

    Settings

    Member Visibility

    On This Page

    Properties