Skip to content
Source
Sign inSign up
TanStack/ai
Open History to see the last commit

ApprovalRequestedEvent.md

108 lines1.6 KB

Interface: ApprovalRequestedEvent

Defined in: packages/ai/src/types.ts:1387

Emitted when a server tool requires approval before execution. The agent loop yields this and pauses — structured-output.complete will not fire for that run. The shape is fixed by the orchestrator's tool-approval flow (the agent-loop branch of runStreamingStructuredOutputImpl in activities/chat/index.ts forwards CUSTOM events from TextEngine.run()).

Extends

Indexable

[k: string]: unknown

Properties

model?

optional model: string;

Defined in: packages/ai/src/types.ts:1339

Model identifier for multi-model support

Inherited from

CustomEvent.model


name

name: "approval-requested";

Defined in: packages/ai/src/types.ts:1388

Overrides

CustomEvent.name

value

value: object;

Defined in: packages/ai/src/types.ts:1389

approval

approval: object;
approval.id
id: string;
approval.needsApproval
needsApproval: true;

input

input: unknown;

toolCallId

toolCallId: string;

toolName

toolName: string;

Overrides

CustomEvent.value