Interface: ToolCallEndEvent<TToolName, TInput, TOutput>#

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

Emitted when a tool call completes.

@ag-ui/core provides: toolCallId TanStack AI adds: model?, toolCallName?, toolName? (deprecated), input?, output?, result?

Same Pick (not extends) rationale as ToolCallStartEvent.

Extends#

• Pick<AGUIToolCallEndEvent, "toolCallId" | "timestamp" | "rawEvent">

Type Parameters#

TToolName#

TToolName extends string = string

Constrained tool name type. Defaults to string (untyped).

TInput#

TInput = unknown

Constrained input arguments type. Defaults to unknown.

TOutput#

TOutput = unknown

Constrained output type from the tool's outputSchema. Defaults to unknown.

Properties#

input?#

optional input?: TInput;

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

Final parsed input arguments (TanStack AI internal)

model?#

optional model?: string;

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

Model identifier for multi-model support

output?#

optional output?: TOutput;

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

Tool execution output, validated against the tool's outputSchema when one is declared. Prefer this over parsing result when present. Undefined for tools without execute, client tools pending approval, or when execution throws.

result?#

optional result?: 
  | string
  | ContentPart<unknown, unknown, unknown, unknown, unknown>[];

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

Tool execution result (TanStack AI internal / wire form)

state?#

optional state?: ToolOutputState;

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

Tool execution output state (TanStack AI internal)

toolCallName?#

optional toolCallName?: TToolName;

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

Name of the tool that completed (AG-UI-compatible optional field)

toolName?#

optional toolName?: TToolName;

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

Deprecated#

Use toolCallName instead. Kept for backward compatibility.

type#

type: "TOOL_CALL_END";

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