Interface: ToolCallStartEvent#

Defined in: packages/typescript/ai/src/types.ts:885

Emitted when a tool call starts.

@ag-ui/core provides: toolCallId, toolCallName, parentMessageId? TanStack AI adds: model?, toolName (deprecated alias), index?, providerMetadata?

Extends#

• ToolCallStartEvent

Indexable#

[k: string]: unknown

[k: string]: unknown

Properties#

index?#

optional index: number;

optional index: number;

Defined in: packages/typescript/ai/src/types.ts:894

Index for parallel tool calls

model?#

optional model: string;

optional model: string;

Defined in: packages/typescript/ai/src/types.ts:887

Model identifier for multi-model support

providerMetadata?#

optional providerMetadata: Record<string, unknown>;

optional providerMetadata: Record<string, unknown>;

Defined in: packages/typescript/ai/src/types.ts:896

Provider-specific metadata to carry into the ToolCall

toolName#

toolName: string;

toolName: string;

Defined in: packages/typescript/ai/src/types.ts:892

Deprecated#

Use toolCallName instead (from @ag-ui/core spec). Kept for backward compatibility.