Skip to content
Kuralle

RunOptions

Properties

Section titled “Properties”

abortSignal?

Section titled “abortSignal?”
optional abortSignal?: AbortSignal;

agentId?

Section titled “agentId?”
optional agentId?: string;

callerInstructions?

Section titled “callerInstructions?”
optional callerInstructions?: string;

Caller-supplied instructions merged into the system prompt via a run-lifetime system note — never pushed into the model message array.

deployment?

Section titled “deployment?”
optional deployment?: DeploymentTraceContext;

Immutable release identity already authorized and pinned by the deployment host.

driver?

Section titled “driver?”
optional driver?: ChannelDriver;

flowName?

Section titled “flowName?”
optional flowName?: string;

Creation-only with kind: 'flow'. Sets activeFlow on the minted run. Ignored on resume.

historyDelta?

Section titled “historyDelta?”
optional historyDelta?: ModelMessage[];

idempotencyKey?

Section titled “idempotencyKey?”
optional idempotencyKey?: string;

Stable key for this inbound user message; duplicate webhook retries are ignored (H2).

input?

Section titled “input?”
optional input?: UserContent;

The user turn: plain text, or AI SDK multimodal content (text + file/image/audio parts).

kind?

Section titled “kind?”
optional kind?: RunKind;

When omitted, opens the session’s conversation run. 'flow' mints a new headless flow run (server-side id). Caller-supplied runId is resume-only and wins over this field.

runId?

Section titled “runId?”
optional runId?: string;

Address an existing run in this session. Unknown and cross-session values fail closed. Omit to open the session’s conversation run.

seedMessages?

Section titled “seedMessages?”
optional seedMessages?: ModelMessage[];

selection?

Section titled “selection?”
optional selection?: ResolvedSelection;

sessionId?

Section titled “sessionId?”
optional sessionId?: string;

signalDelivery?

Section titled “signalDelivery?”
optional signalDelivery?: SignalDelivery;

userId?

Section titled “userId?”
optional userId?: string;

wake?

Section titled “wake?”
optional wake?: WakeOptions;

Agent-initiated (proactive) turn — mutually exclusive with input. The runtime appends a wake note instead of a user message and runs the normal loop: free-conversation agents proactively re-engage; an active flow re-prompts its current step. Schedule wakes with createWakeJobRunner.