Skip to content

Graphorin API reference v0.12.1


Graphorin API reference / @graphorin/agent / / AgentCallOptions

Interface: AgentCallOptions<TDeps>

Defined in: packages/agent/src/types.ts:616

Per-call options accepted by agent.stream(...) / agent.run(...).

Stable

Type Parameters

Type Parameter
TDeps

Properties

PropertyModifierTypeDescriptionDefined in
budget?readonlyRunBudgetRun-level budget (C5): between-step enforcement against the run's accumulated usage, sub-agents included. See RunBudget. Not persisted in RunState: re-supply it when resuming a suspended run.packages/agent/src/types.ts:627
capability?readonly"read-only"Per-run capability restriction (D2) - overrides AgentConfig.capability for this invocation. See that field for semantics. Not persisted in RunState: re-supply it when resuming a suspended run.packages/agent/src/types.ts:657
deps?readonlyTDeps-packages/agent/src/types.ts:617
directive?readonlyResumeDirectiveHITL resume directive. Supplied alongside a RunState to resolve any approvals that were pending when the previous agent.run(...) call suspended.packages/agent/src/types.ts:650
inboundTaint?readonlyInboundTaintSeedB1.5: stamp message-borne untrusted input into the run's taint ledger at init (see InboundTaintSeed). No-op when the agent has no dataFlowPolicy configured.packages/agent/src/types.ts:644
parentSpan?readonlyAISpan<SpanType>W-036: parent span for this run's agent.run root span - a multi-agent invocation forms ONE trace tree (the child's run span parents under the caller's step/tool span). The runtime supplies it automatically for handoffs and toTool sub-agents. Like capability, it is NOT persisted in RunState: re-supply on resume when stitching matters.packages/agent/src/types.ts:666
pinnedProvider?readonlyProviderC1/C2: fail-closed per-run model pin. When set, every step of this run resolves to exactly this provider: it wins over prepareStep provider overrides and the whole preference ladder (preferredModel / tool hints / tier map), and the agent-level fallback chain is never consulted. Built for proactive fires - a heartbeat beat or cron fire must not silently escalate to a more expensive model through fallback. Not persisted in RunState: re-supply it when resuming a suspended run.packages/agent/src/types.ts:638
sessionId?readonlystring-packages/agent/src/types.ts:619
signal?readonlyAbortSignal-packages/agent/src/types.ts:618
userId?readonlystring-packages/agent/src/types.ts:620