Graphorin API reference v0.15.1
Graphorin API reference / @graphorin/agent / / AgentCallOptions
Interface: AgentCallOptions<TDeps>
Defined in: packages/agent/src/types.ts:638
Stable
Per-call options accepted by agent.stream(...) / agent.run(...).
Type Parameters
| Type Parameter |
|---|
TDeps |
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
budget? | readonly | RunBudget | Run-level budget: 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:649 |
capability? | readonly | "read-only" | Per-run capability restriction - 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:679 |
deps? | readonly | TDeps | - | packages/agent/src/types.ts:639 |
directive? | readonly | ResumeDirective | HITL 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:672 |
inboundTaint? | readonly | InboundTaintSeed | 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:666 |
parentSpan? | readonly | AISpan<SpanType> | 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:688 |
pinnedProvider? | readonly | Provider | 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:660 |
sessionId? | readonly | string | - | packages/agent/src/types.ts:641 |
signal? | readonly | AbortSignal | - | packages/agent/src/types.ts:640 |
userId? | readonly | string | - | packages/agent/src/types.ts:642 |