Briyah SDK - v2.0.18
    Preparing search index...

    Interface RoomDetails

    interface RoomDetails {
        agentIds: string[];
        agents?: AgentInfo[];
        baseRoomDir?: string;
        beginInstruction?: string;
        currentSpeaker?: string;
        goal: string;
        id: string;
        illustrationMode?: RoomIllustrationMode;
        imageAspect?: ImageAspect;
        imageModel?: string;
        isPaused?: boolean;
        isPublished?: boolean;
        moderator?: string;
        name: string;
        pack?: string;
        processingInProgress?: boolean;
        roomLeader?: string;
        templateRoomId?: string;
        timeZone?: string;
        turnMode?: RoomTurnMode;
    }
    Index
    agentIds agents? baseRoomDir? beginInstruction? currentSpeaker? goal id illustrationMode? imageAspect? imageModel? isPaused? isPublished? moderator? name pack? processingInProgress? roomLeader? templateRoomId? timeZone? turnMode?
    agentIds: string[]
    agents?: AgentInfo[]
    baseRoomDir?: string
    beginInstruction?: string

    What Begin sends to the room leader to open the conversation. Blank or absent means the room offers no Begin. See RoomConfig.beginInstruction.

    currentSpeaker?: string
    goal: string
    id: string
    illustrationMode?: RoomIllustrationMode

    Absent means 'on-request'. See RoomIllustrationMode.

    imageAspect?: ImageAspect

    The shape this room's pictures are drawn in unless the illustrate call asks for another. Absent means 'square'. See ImageAspect.

    imageModel?: string

    Entry in image_models.json. Absent uses DEFAULT_IMAGE_MODEL; NO_IMAGES disables.

    isPaused?: boolean

    Live turn state, the same fields RoomMessageUpdate carries over SSE. Without them a client that just loaded the page shows an idle room until the next update arrives, which for a turn-based room means it cannot tell whose turn it is until someone moves.

    isPublished?: boolean
    moderator?: string

    Nickname of the agent that places messages it cannot route mechanically. Only consulted in 'moderated' mode. Absent falls back to the first agent in the room, which is how story rooms have always chosen their moderator.

    name: string
    pack?: string

    The pack this room is filed under. Editable. See AgentInfo.pack.

    processingInProgress?: boolean
    roomLeader?: string
    templateRoomId?: string
    timeZone?: string

    The IANA time zone in which this room's agents are told today's date on every turn. Absent means they are not told — a story keeps its own clock.

    turnMode?: RoomTurnMode

    Settings
    Member Visibility

    On This Page
    Properties