Docs
CodeRabbit
Cloudflare
AG Grid
Netlify
Neon
WorkOS
Clerk
Convex
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
CodeRabbit
Cloudflare
AG Grid
Netlify
Neon
WorkOS
Clerk
Convex
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
Class References
Function References
Interface References
Type Alias References
Variable References

ToolCallStartEvent

Interface: ToolCallStartEvent

Defined in: types.ts:778

Emitted when a tool call starts.

Extends

Properties

index?

ts
optional index: number;

Defined in: types.ts:785

Index for parallel tool calls


model?

ts
optional model: string;

Defined in: types.ts:690

Model identifier for multi-model support

Inherited from

BaseAGUIEvent.model


rawEvent?

ts
optional rawEvent: unknown;

Defined in: types.ts:692

Original provider event for debugging/advanced use cases

Inherited from

BaseAGUIEvent.rawEvent


timestamp

ts
timestamp: number;

Defined in: types.ts:688

Inherited from

BaseAGUIEvent.timestamp


toolCallId

ts
toolCallId: string;

Defined in: types.ts:781

Unique identifier for this tool call


toolName

ts
toolName: string;

Defined in: types.ts:783

Name of the tool being called


type

ts
type: "TOOL_CALL_START";

Defined in: types.ts:779

Overrides

BaseAGUIEvent.type