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

    Interface AgentCreationOptions

    Agent settings that AppService.createAgent takes as an object rather than a positional parameter.

    The positional list is public SDK surface and stops at ten, so everything since lives here. Each of these is also settable through AppService.updateAgent, which is the point: an agent that needs a tool grant should not have to be created and then edited.

    interface AgentCreationOptions {
        allowSearch?: boolean;
        maxHistoryMessages?: number;
        ownerRoomId?: string;
        privateContext?: string;
        promptCacheTTL?: number;
        smallModelName?: string;
        toolNames?: string[];
        useModerator?: boolean;
    }
    Index
    allowSearch? maxHistoryMessages? ownerRoomId? privateContext? promptCacheTTL? smallModelName? toolNames? useModerator?
    allowSearch?: boolean

    Enable the provider's web search, where it has one.

    maxHistoryMessages?: number

    Rolling history window: keep only the last N messages.

    ownerRoomId?: string

    The room this agent exists for. An owned agent is left out of AppService.listAgents and deleted with its room.

    privateContext?: string

    Notes only this agent sees.

    promptCacheTTL?: number

    Minutes to keep the prompt cache alive; above 5 selects the 1-hour cache.

    smallModelName?: string

    A cheaper same-service model for mechanical prompts.

    toolNames?: string[]

    Names of tools this agent may run with EXECUTE.

    useModerator?: boolean

    This agent sends MODERATE messages, so its room needs a moderator. For a human-controlled agent it also removes the action and target pickers from the room's composer. See Agent.useModerator.

    Settings
    Member Visibility

    On This Page
    Properties