Interface Agent

generate

• generate(prompt, opts?): Promise<GenerateTextResult>

• Generates a single reply without maintaining session history. Accepts plain text or multimodal content (text + image parts).

  Parameters

  • prompt: MessageContent

    User prompt as text string or MessageContent array.
  • Optional opts: Partial<GenerateTextOptions>

    Optional overrides merged on top of the agent's base options.

  Returns Promise<GenerateTextResult>

  The complete generation result.

stream

• stream(prompt, opts?): StreamTextResult

• Streams a single reply without maintaining session history. Accepts plain text or multimodal content (text + image parts).

  Parameters

  • prompt: MessageContent

    User prompt as text string or MessageContent array.
  • Optional opts: Partial<GenerateTextOptions>

    Optional overrides merged on top of the agent's base options.

  Returns StreamTextResult

  A StreamTextResult.

session

• session(id?, options?): AgentSession

• Returns (or creates) a named AgentSession with its own conversation history.

  Parameters

  • Optional id: string

    Optional session ID. A unique ID is generated when omitted.
  • Optional options: AgentSessionOptions

    The session's user; see AgentSessionOptions.

  Returns AgentSession

  The session object for this ID.

usage

• usage(sessionId?): Promise<AgentOSUsageAggregate>

• Returns persisted usage totals for the whole agent or a single session.

  Parameters

  • Optional sessionId: string

  Returns Promise<AgentOSUsageAggregate>

close

• close(): Promise<void>

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

  Returns Promise<void>

export

• export(metadata?, options?): AgentExportConfig

• Exports the agent's configuration as a portable object. Secrets are redacted unless options.redactSecrets is false.

  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[]

  • Optional options: ExportAgentConfigOptions

    Redaction options.

  Returns AgentExportConfig

  A portable AgentExportConfig object.

exportJSON

• exportJSON(metadata?, options?): string

• Exports the agent's configuration as a pretty-printed JSON string. Secrets are redacted unless options.redactSecrets is false.

  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[]

  • Optional options: ExportAgentConfigOptions

    Redaction options.

  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

Optional voiceSession

• voiceSession(request): Promise<ManagedVoiceSession>

• Prepares the configured scoped voice call; present only with voice.session.

  Parameters

  • request: Omit<StartVoiceSession, "agent">

  Returns Promise<ManagedVoiceSession>

Optional learning