ToolCallStartEvent

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

Emitted when a tool call starts.

@ag-ui/core provides: toolCallId, toolCallName, parentMessageId?, subagentRunId?

Extends

• Omit<AGUIToolCallStartEvent, "type">

Properties

metadata?

optional metadata?: Record<string, any>;

optional metadata?: Record<string, any>;

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

Provider-specific metadata to carry into the ToolCall.

Overrides

Omit.metadata

Omit.metadata

toolName?

optional toolName?: string;

optional toolName?: string;

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

Alias of toolCallName. Kept so existing stream readers still compile.

type

type: "TOOL_CALL_START";

type: "TOOL_CALL_START";

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