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

ToolCallPart

Interface: ToolCallPart<TMetadata>

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

Type Parameters

TMetadata

TMetadata = unknown

Properties

approval?

ts
optional approval: object;
optional approval: object;

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

Approval metadata if tool requires user approval

approved?

ts
optional approved: boolean;
optional approved: boolean;

id

ts
id: string;
id: string;

needsApproval

ts
needsApproval: boolean;
needsApproval: boolean;

arguments

ts
arguments: string;
arguments: string;

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


id

ts
id: string;
id: string;

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


metadata?

ts
optional metadata: TMetadata;
optional metadata: TMetadata;

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

Provider-specific metadata that round-trips with the tool call. Typed per-adapter via TToolCallMetadata.


name

ts
name: string;
name: string;

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


output?

ts
optional output: any;
optional output: any;

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

Tool execution output (for client tools or after approval)


state

ts
state: ToolCallState;
state: ToolCallState;

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


type

ts
type: "tool-call";
type: "tool-call";

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