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

    Interface AgentInfo

    interface AgentInfo {
        agentNickname: string;
        aiModel: string;
        aiService: string;
        allowSearch: boolean;
        attachedArtifactIds?: string[];
        beginInstruction: string;
        canModerate?: boolean;
        controlledByHuman?: boolean;
        description: string;
        id: string;
        isPublished: boolean;
        maxHistoryMessages?: number;
        maxOutputTokens: number;
        name: string;
        ownerRoomId?: string;
        pack?: string;
        privateContext?: string;
        promptCacheTTL?: number;
        promptFolder: string;
        reasoningEffort: "low" | "medium" | "high";
        smallModelName?: string;
        toolNames: string[];
        totalCost: number;
        totalInputTokens: number;
        totalOutputTokens: number;
        useModerator?: boolean;
    }
    Index
    agentNickname aiModel aiService allowSearch attachedArtifactIds? beginInstruction canModerate? controlledByHuman? description id isPublished maxHistoryMessages? maxOutputTokens name ownerRoomId? pack? privateContext? promptCacheTTL? promptFolder reasoningEffort smallModelName? toolNames totalCost totalInputTokens totalOutputTokens useModerator?
    agentNickname: string
    aiModel: string
    aiService: string
    allowSearch: boolean
    attachedArtifactIds?: string[]
    beginInstruction: string
    canModerate?: boolean

    Whether this agent could be its room's moderator: it is not human-controlled, and its prompt folder provides a moderate.prompt.

    Derived from the agent's prompt folder rather than stored, and by the same check that refuses a room whose moderator cannot moderate — so a moderator the UI offers is never one the server will reject. Populated where an agent is being looked at on its own or as part of a room's roster; the top-level agent list leaves it absent, because "could moderate" is a question about a room.

    controlledByHuman?: boolean
    description: string
    id: string
    isPublished: boolean
    maxHistoryMessages?: number
    maxOutputTokens: number
    name: string
    ownerRoomId?: string
    pack?: string

    The pack this agent is filed under, or absent when it is not filed.

    Drives grouping and filtering in the lists. An agent naming a pack that is not installed stays visible: deleting a pack must not hide the work it produced.

    privateContext?: string
    promptCacheTTL?: number
    promptFolder: string
    reasoningEffort: "low" | "medium" | "high"
    smallModelName?: string
    toolNames: string[]
    totalCost: number
    totalInputTokens: number
    totalOutputTokens: number
    useModerator?: boolean

    Settings
    Member Visibility

    On This Page
    Properties