Interface: AgentSessionOptions

Generated from the public TypeScript API.

Options for a long-lived, caller-managed Session.

Turn cancellation is intentionally absent; pass a signal to each Session operation instead.

​

Example

const session = await agent.createSession({
  title: "Release review",
  parentId: "ses_parent",
})

​

Properties

​

cwd?

optional cwd?: string;

Working directory fixed for the new session.

---

​

maxBudgetUsd?

optional maxBudgetUsd?: number;

Maximum model cost per operation in USD.

---

​

maxTurns?

optional maxTurns?: number;

Maximum model turns per operation.

---

​

model?

optional model?: ModelId;

provider/model id for this session.

---

​

outputFormat?

optional outputFormat?: OutputFormatSpec<unknown>;

Structured-output contract for the session.

---

​

parentId?

optional parentId?: string;

Optional parent session id for server-side hierarchy.

---

​

permission?

optional permission?: PermissionRuleset;

Server permission rules, distinct from permissionMode.

---

​

permissionMode?

optional permissionMode?: PermissionMode;

Runtime permission behavior for the session.

---

​

title?

optional title?: string;

Explicit session title; defaults to "Agent session".