@agorio/sdk • Docs

Interface: AgentOptions

Properties

_subAgentDepth?

optional _subAgentDepth: number

Internal — current depth in a parent→child chain. Do not set manually.

Defined in

src/types/index.ts:705

acpOptions?

optional acpOptions: AcpClientOptions

ACP client options (enables ACP protocol support)

Defined in

src/types/index.ts:665

adapters?

optional adapters: MerchantAdapter[]

Merchant adapters for real e-commerce platform connectivity

Defined in

src/types/index.ts:667

ap2?

optional ap2: boolean

Enable AP2 (Agent Payments Protocol) mandate-based payment flow. Promoted to GA in v0.8 — kept as an opt-in because AP2 requires a signer and a payment endpoint that the SDK cannot infer from merchant discovery.

Defined in

src/types/index.ts:693

clientOptions?

optional clientOptions: UcpClientOptions

UCP client options

Defined in

src/types/index.ts:663

llm

llm: LlmAdapter

LLM adapter to use for reasoning

Defined in

src/types/index.ts:661

maxIterations?

optional maxIterations: number

Maximum agent loop iterations (default: 20)

Defined in

src/types/index.ts:675

onComplete()?

optional onComplete: (result) => void | Promise<void>

Called once after the agent finishes (success, max-iter, or error). Used by agorioCloud() to flush traces.

Parameters

• result: AgentResult

Returns

void | Promise<void>

Defined in

src/types/index.ts:685

onLog()?

optional onLog: (event) => void

Structured log callback for observability

Parameters

• event: AgentLogEvent

Returns

void

Defined in

src/types/index.ts:681

onStep()?

optional onStep: (step) => void

Callback for each agent step

Parameters

• step: AgentStep

Returns

void

Defined in

src/types/index.ts:679

pluginConfigs?

optional pluginConfigs: Record<string, Record<string, unknown>>

Per-plugin configuration, keyed by plugin name

Defined in

src/types/index.ts:687

plugins?

optional plugins: AgentPlugin[]

Custom plugins — additional tools beyond the built-in 12

Defined in

src/types/index.ts:673

sessionCustomerId?

optional sessionCustomerId: string

Owner / tenant id to attach to saved sessions.

Defined in

src/types/index.ts:699

sessionId?

optional sessionId: string

Session ID — if a snapshot exists for this ID, the agent resumes from it.

Defined in

src/types/index.ts:697

sessionStorage?

optional sessionStorage: SessionStorage

Persistent session storage — enables resume across process restarts.

Defined in

src/types/index.ts:695

subAgentMaxDepth?

optional subAgentMaxDepth: number

Maximum nested sub-agent depth. Default: 3.

Defined in

src/types/index.ts:703

subAgents?

optional subAgents: SubAgent[]

Sub-agents the LLM can invoke via the built-in invoke_sub_agent tool.

Defined in

src/types/index.ts:701

tracer?

optional tracer: AgentTracer

OpenTelemetry-compatible tracer (opt-in, no hard dependency)

Defined in

src/types/index.ts:683

verbose?

optional verbose: boolean

Enable verbose logging

Defined in

src/types/index.ts:677

webhookSecret?

optional webhookSecret: string

HMAC secret for webhook signature verification

Defined in

src/types/index.ts:671

webhookUrl?

optional webhookUrl: string

Webhook callback URL for order update notifications

Defined in

src/types/index.ts:669