Interface AgentSession

A named conversation session returned by Agent.session(). Maintains its own message history independently of other sessions on the same agent.

interface AgentSession {
    id: string;
    send(text): Promise<GenerateTextResult>;
    stream(text): StreamTextResult;
    messages(): Message[];
    usage(): Promise<AgentOSUsageAggregate>;
    clear(): void;
}

Index

Methods

send stream messages usage clear

Properties

Methods

send

send(text): Promise<GenerateTextResult>
Sends a user message and returns the complete assistant reply. Appends both turns to the session history when memory is enabled.
Parameters
- text: string
  User message text.
Returns Promise<GenerateTextResult>
The full generation result including text, usage, and tool calls.
- Defined in src/api/agent.ts:106

stream

stream(text): StreamTextResult
Streams a user message and returns streaming iterables. The assistant reply is appended to session history once the text promise resolves.
Parameters
- text: string
  User message text.
Returns StreamTextResult
A StreamTextResult with async iterables and awaitable aggregates.
- Defined in src/api/agent.ts:114

messages

messages(): Message[]
Returns a snapshot of the current conversation history for this session.

Returns Message[]
- Defined in src/api/agent.ts:116

usage

usage(): Promise<AgentOSUsageAggregate>
Returns persisted usage totals for this session when the usage ledger is enabled.

Returns Promise<AgentOSUsageAggregate>
- Defined in src/api/agent.ts:118

clear

clear(): void
Clears all messages from this session's history.

Returns void
- Defined in src/api/agent.ts:120

Properties

`Readonly` id

id: string

Stable session identifier supplied to or auto-generated by Agent.session().