Interface: AgentStreamOptions

Generated from the public TypeScript API.

Per-stream overrides.

​

Example

const stream = agent.stream("Explain the diff.", {
  includePartialMessages: true,
})

​

Extends

• RunOptions

​

Properties

​

cwd?

optional cwd?: string;

Working directory for this fresh session.

​

Inherited from

RunOptions.cwd

---

​

includePartialMessages?

optional includePartialMessages?: boolean;

Yield text/reasoning delta envelopes in addition to assembled messages.

---

​

maxBudgetUsd?

optional maxBudgetUsd?: number;

Maximum run cost before an error_max_budget result.

​

Inherited from

RunOptions.maxBudgetUsd

---

​

maxTurns?

optional maxTurns?: number;

Maximum model turns before an error_max_turns result.

​

Inherited from

RunOptions.maxTurns

---

​

model?

optional model?: ModelId;

provider/model id for this session.

​

Inherited from

RunOptions.model

---

​

outputFormat?

optional outputFormat?: OutputFormatSpec<unknown>;

Structured-output contract for this session.

​

Inherited from

RunOptions.outputFormat

---

​

permission?

optional permission?: PermissionRuleset;

Server permission rules, distinct from permissionMode.

​

Inherited from

RunOptions.permission

---

​

permissionMode?

optional permissionMode?: PermissionMode;

Runtime permission behavior for this session.

​

Inherited from

RunOptions.permissionMode

---

​

signal?

optional signal?: AbortSignal;

Abort the active turn; terminal error_aborted still resolves normally.

​

Inherited from

RunOptions.signal

---

​

title?

optional title?: string;

Explicit session title; otherwise the prompt’s first line is used.

​

Inherited from

RunOptions.title