Interface: AgentStream

Generated from the public TypeScript API.

A normalized Agent event stream with active-session controls.

interrupt() affects the current turn. close() disposes the iterator and transient Session and is idempotent. Session startup is lazy.

​

Example

const stream: AgentStream = agent.stream("Explain this change.")
console.log(await stream.sessionId())
for await (const message of stream) console.log(message.type)

​

Extends

• AsyncGenerator<AgentMessage, ResultMessage, void>

​

Methods

​

close()

close(): Promise<void>;

Dispose the stream and its transient session idempotently.

​

Returns

Promise<void>

A promise settled after owned resources are handled.

​

Throws

When one or more teardown stages fail.

​

Example

await stream.close()

---

​

interrupt()

interrupt(): Promise<void>;

Abort the active turn without disposing a multi-turn iterator.

​

Returns

Promise<void>

A promise settled after the abort request.

​

Throws

When startup or the abort request fails.

​

Example

await stream.interrupt()

---

​

sessionId()

sessionId(): Promise<string>;

Start lazily when needed and return the server session id.

​

Returns

Promise<string>

The transient server session id.

​

Throws

When session creation fails or the stream is already closed.

​

Example

console.log(await stream.sessionId())

---

​

setModel()

setModel(model): Promise<void>;

Change the active session’s model.

​

Parameters

model

ModelId

New provider/model id.

​

Returns

Promise<void>

A promise settled after the server applies the model.

​

Throws

When the stream is closed, the id is invalid, or the request fails.

​

Example

await stream.setModel("anthropic/claude-sonnet-4-5")

---

​

setPermissionMode()

setPermissionMode(mode): Promise<void>;

Change the active session’s permission mode.

​

Parameters

mode

PermissionMode

New runtime permission mode.

​

Returns

Promise<void>

A promise settled after the server applies the mode.

​

Throws

When the stream is closed or the request fails.

​

Example

await stream.setPermissionMode("dontAsk")