Interface: Agent
Defined in: packages/agentos/src/api/agent.ts:421
A stateful agent instance returned by agent.
Methods
close()
close():
Promise<void>
Defined in: packages/agentos/src/api/agent.ts:450
Releases all in-memory session state held by this agent.
Returns
Promise<void>
export()
export(
metadata?):AgentExportConfig
Defined in: packages/agentos/src/api/agent.ts:456
Exports the agent's configuration as a portable object.
Parameters
metadata?
Optional human-readable metadata to attach.
author?
string
description?
string
name?
string
tags?
string[]
Returns
A portable AgentExportConfig object.
exportJSON()
exportJSON(
metadata?):string
Defined in: packages/agentos/src/api/agent.ts:462
Exports the agent's configuration as a pretty-printed JSON string.
Parameters
metadata?
Optional human-readable metadata to attach.
author?
string
description?
string
name?
string
tags?
string[]
Returns
string
JSON string.
generate()
generate(
prompt,opts?):Promise<GenerateTextResult>
Defined in: packages/agentos/src/api/agent.ts:430
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.
opts?
Partial<GenerateTextOptions>
Optional overrides merged on top of the agent's base options.
Returns
Promise<GenerateTextResult>
The complete generation result.
getAvatarBindings()
getAvatarBindings():
AvatarBindingInputs&Record<string,unknown>
Defined in: packages/agentos/src/api/agent.ts:464
Read current avatar binding state (auto-populated from mood/voice/relationship).
Returns
AvatarBindingInputs & Record<string, unknown>
session()
session(
id?):AgentSession
Defined in: packages/agentos/src/api/agent.ts:446
Returns (or creates) a named AgentSession with its own conversation history.
Parameters
id?
string
Optional session ID. A unique ID is generated when omitted.
Returns
The session object for this ID.
setAvatarBindingOverrides()
setAvatarBindingOverrides(
overrides):void
Defined in: packages/agentos/src/api/agent.ts:466
Inject game-specific binding overrides (healthBand, combatMode, etc.).
Parameters
overrides
Record<string, unknown>
Returns
void
stream()
stream(
prompt,opts?):StreamTextResult
Defined in: packages/agentos/src/api/agent.ts:439
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.
opts?
Partial<GenerateTextOptions>
Optional overrides merged on top of the agent's base options.
Returns
usage()
usage(
sessionId?):Promise<AgentOSUsageAggregate>
Defined in: packages/agentos/src/api/agent.ts:448
Returns persisted usage totals for the whole agent or a single session.
Parameters
sessionId?
string
Returns
Promise<AgentOSUsageAggregate>