> ## Documentation Index
> Fetch the complete documentation index at: https://cognitio-agent.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Interface: AgentStreamOptions

> Generated from the public TypeScript API.

Per-stream overrides.

## Example

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

## Extends

* [`RunOptions`](RunOptions)

## Properties

### cwd?

```ts theme={null}
optional cwd?: string;
```

Working directory for this fresh session.

#### Inherited from

[`RunOptions`](RunOptions).[`cwd`](RunOptions#cwd)

***

### includePartialMessages?

```ts theme={null}
optional includePartialMessages?: boolean;
```

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

***

### maxBudgetUsd?

```ts theme={null}
optional maxBudgetUsd?: number;
```

Maximum run cost before an `error_max_budget` result.

#### Inherited from

[`RunOptions`](RunOptions).[`maxBudgetUsd`](RunOptions#maxbudgetusd)

***

### maxTurns?

```ts theme={null}
optional maxTurns?: number;
```

Maximum model turns before an `error_max_turns` result.

#### Inherited from

[`RunOptions`](RunOptions).[`maxTurns`](RunOptions#maxturns)

***

### model?

```ts theme={null}
optional model?: ModelId;
```

`provider/model` id for this session.

#### Inherited from

[`RunOptions`](RunOptions).[`model`](RunOptions#model)

***

### outputFormat?

```ts theme={null}
optional outputFormat?: OutputFormatSpec<unknown>;
```

Structured-output contract for this session.

#### Inherited from

[`RunOptions`](RunOptions).[`outputFormat`](RunOptions#outputformat)

***

### permission?

```ts theme={null}
optional permission?: PermissionRuleset;
```

Server permission rules, distinct from `permissionMode`.

#### Inherited from

[`RunOptions`](RunOptions).[`permission`](RunOptions#permission)

***

### permissionMode?

```ts theme={null}
optional permissionMode?: PermissionMode;
```

Runtime permission behavior for this session.

#### Inherited from

[`RunOptions`](RunOptions).[`permissionMode`](RunOptions#permissionmode)

***

### signal?

```ts theme={null}
optional signal?: AbortSignal;
```

Abort the active turn; terminal `error_aborted` still resolves normally.

#### Inherited from

[`RunOptions`](RunOptions).[`signal`](RunOptions#signal)

***

### title?

```ts theme={null}
optional title?: string;
```

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

#### Inherited from

[`RunOptions`](RunOptions).[`title`](RunOptions#title)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.