Interface: RunOptions

Generated from the public TypeScript API.

Flat per-run overrides.

Raw runtimeConfig is intentionally not accepted; construct another Agent for runtime fields outside this curated set.

​

Example

const result = await agent.run("Review this change.", {
  model: "anthropic/claude-sonnet-4-5",
  maxTurns: 4,
})

​

Extended by

• AgentStreamOptions

​

Properties

​

cwd?

optional cwd?: string;

Working directory for this fresh session.

---

​

maxBudgetUsd?

optional maxBudgetUsd?: number;

Maximum run cost before an error_max_budget result.

---

​

maxTurns?

optional maxTurns?: number;

Maximum model turns before an error_max_turns result.

---

​

model?

optional model?: ModelId;

provider/model id for this session.

---

​

outputFormat?

optional outputFormat?: OutputFormatSpec<unknown>;

Structured-output contract for this session.

---

​

permission?

optional permission?: PermissionRuleset;

Server permission rules, distinct from permissionMode.

---

​

permissionMode?

optional permissionMode?: PermissionMode;

Runtime permission behavior for this session.

---

​

signal?

optional signal?: AbortSignal;

Abort the active turn; terminal error_aborted still resolves normally.

---

​

title?

optional title?: string;

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