Interface Agent

A stateful agent instance returned by agent.

interface Agent {
    generate(prompt, opts?): Promise<GenerateTextResult>;
    stream(prompt, opts?): StreamTextResult;
    session(id?): AgentSession;
    usage(sessionId?): Promise<AgentOSUsageAggregate>;
    close(): Promise<void>;
    export(metadata?): AgentExportConfig;
    exportJSON(metadata?): string;
    getAvatarBindings(): AvatarBindingInputs & Record<string, unknown>;
    setAvatarBindingOverrides(overrides): void;
}

Methods

generate stream session usage close export exportJSON getAvatarBindings setAvatarBindingOverrides

Methods

generate

stream

session

usage

close

  • close(): Promise<void>

  • Releases all in-memory session state held by this agent.

    Returns Promise<void>

export

  • export(metadata?): AgentExportConfig

  • Exports the agent's configuration as a portable object.

    Parameters

    • Optional metadata: {
          name?: string;
          description?: string;
          author?: string;
          tags?: string[];
      }

      Optional human-readable metadata to attach.

      • Optional name?: string
      • Optional description?: string
      • Optional author?: string
      • Optional tags?: string[]

    Returns AgentExportConfig

    A portable AgentExportConfig object.

exportJSON

  • exportJSON(metadata?): string

  • Exports the agent's configuration as a pretty-printed JSON string.

    Parameters

    • Optional metadata: {
          name?: string;
          description?: string;
          author?: string;
          tags?: string[];
      }

      Optional human-readable metadata to attach.

      • Optional name?: string
      • Optional description?: string
      • Optional author?: string
      • Optional tags?: string[]

    Returns string

    JSON string.

getAvatarBindings

  • getAvatarBindings(): AvatarBindingInputs & Record<string, unknown>

  • Read current avatar binding state (auto-populated from mood/voice/relationship).

    Returns AvatarBindingInputs & Record<string, unknown>

setAvatarBindingOverrides

  • setAvatarBindingOverrides(overrides): void

  • Inject game-specific binding overrides (healthBand, combatMode, etc.).

    Parameters

    • overrides: Record<string, unknown>

    Returns void

Settings

Member Visibility

Theme

On This Page

generatestreamsessionusagecloseexportexportJSONgetAvatarBindingssetAvatarBindingOverrides