Example
Extends
Properties
agents?
Inherited from
AgentOptions.agents
allowedTools?
Inherited from
AgentOptions.allowedTools
appendSystemPrompt?
Inherited from
AgentOptions.appendSystemPrompt
autoPermissionClassifierModel?
Inherited from
AgentOptions.autoPermissionClassifierModel
backgroundTaskPolicy?
mode
Inherited from
AgentOptions.backgroundTaskPolicy
baseUrl?
spawn and client.
Inherited from
AgentOptions.baseUrl
canUseTool?
Inherited from
AgentOptions.canUseTool
checkpointing?
Inherited from
AgentOptions.checkpointing
client?
shutdown() never close it.
Inherited from
AgentOptions.client
commands?
Inherited from
AgentOptions.commands
compaction?
auto?
includeFiles?
Inherited from
AgentOptions.compaction
control?
Inherited from
AgentOptions.control
cwd?
Inherited from
AgentOptions.cwd
deleteSessionsOnClose?
Inherited from
AgentOptions.deleteSessionsOnClose
directory?
cwd; the two must match when both are supplied.
Inherited from
AgentOptions.directory
disallowedTools?
Inherited from
AgentOptions.disallowedTools
effort?
Inherited from
AgentOptions.effort
enableFileCheckpointing?
Inherited from
AgentOptions.enableFileCheckpointing
enableToolSearch?
Inherited from
AgentOptions.enableToolSearch
forkMessageId?
forkSession: true.
forkSession?
resume instead of attaching to it. Requires resume.
headers?
Inherited from
AgentOptions.headers
hooks?
Inherited from
AgentOptions.hooks
includeEnvironment?
Inherited from
AgentOptions.includeEnvironment
includePartialMessages?
instructions?
Inherited from
AgentOptions.instructions
maxBudgetUsd?
Inherited from
AgentOptions.maxBudgetUsd
maxTurns?
Inherited from
AgentOptions.maxTurns
model?
Inherited from
AgentOptions.model
outputFormat?
Inherited from
AgentOptions.outputFormat
permission?
permissionMode.
Inherited from
AgentOptions.permission
permissionMode?
Inherited from
AgentOptions.permissionMode
plugins?
Inherited from
AgentOptions.plugins
resume?
sdkMcpServers?
Inherited from
AgentOptions.sdkMcpServers
settingSources?
Inherited from
AgentOptions.settingSources
signal?
skills?
Inherited from
AgentOptions.skills
spawn?
config is merged by
top-level key and, under agent, by agent name; a named agent’s own
object replaces wholesale, so agent: { title: {…} } drops the facade’s
title.disable and restores the per-session title model call. Explicit
false, "", and [] values are preserved.
Inherited from
AgentOptions.spawn
systemPrompt?
Inherited from
AgentOptions.systemPrompt
thinkingConfig?
Inherited from
AgentOptions.thinkingConfig
title?
Inherited from
AgentOptions.title
tools?
sdk_<sanitized-name>.
They execute in the caller process rather than the isolated server.
Inherited from
AgentOptions.tools
workspaceId?
Inherited from
AgentOptions.workspaceId