Docs
Code Rabbit
Cloudflare
AG Grid
Netlify
Neon
WorkOS
Clerk
Convex
Electric
Sentry
Prisma
Strapi
Unkey
UI.dev
Code Rabbit
Cloudflare
AG Grid
Netlify
Neon
WorkOS
Clerk
Convex
Electric
Sentry
Prisma
Strapi
Unkey
UI.dev
Class References
Function References
Interface References
Type Alias References
Variable References

ToolCallStartEvent

Interface: ToolCallStartEvent

Defined in: types.ts:844

Emitted when a tool call starts.

Extends

Properties

index?

ts
optional index: number;
optional index: number;

Defined in: types.ts:853

Index for parallel tool calls


model?

ts
optional model: string;
optional model: string;

Defined in: types.ts:756

Model identifier for multi-model support

Inherited from

BaseAGUIEvent.model


parentMessageId?

ts
optional parentMessageId: string;
optional parentMessageId: string;

Defined in: types.ts:851

ID of the parent message that initiated this tool call


providerMetadata?

ts
optional providerMetadata: Record<string, unknown>;
optional providerMetadata: Record<string, unknown>;

Defined in: types.ts:855

Provider-specific metadata to carry into the ToolCall


rawEvent?

ts
optional rawEvent: unknown;
optional rawEvent: unknown;

Defined in: types.ts:758

Original provider event for debugging/advanced use cases

Inherited from

BaseAGUIEvent.rawEvent


timestamp

ts
timestamp: number;
timestamp: number;

Defined in: types.ts:754

Inherited from

BaseAGUIEvent.timestamp


toolCallId

ts
toolCallId: string;
toolCallId: string;

Defined in: types.ts:847

Unique identifier for this tool call


toolName

ts
toolName: string;
toolName: string;

Defined in: types.ts:849

Name of the tool being called


type

ts
type: "TOOL_CALL_START";
type: "TOOL_CALL_START";

Defined in: types.ts:845

Overrides

BaseAGUIEvent.type