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

ToolInputAvailableEvent

Interface: ToolInputAvailableEvent

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

Emitted when a client tool is invoked. The agent loop yields this and pauses to let the caller run the tool client-side — structured-output.complete will not fire for that run. Shape fixed by the agent-loop forwarding in runStreamingStructuredOutputImpl in activities/chat/index.ts.

Extends

Indexable

ts
[k: string]: unknown
[k: string]: unknown

Properties

model?

ts
optional model: string;
optional model: string;

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

Model identifier for multi-model support

Inherited from

CustomEvent.model


name

ts
name: "tool-input-available";
name: "tool-input-available";

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

Overrides

ts
CustomEvent.name
CustomEvent.name

value

ts
value: object;
value: object;

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

input

ts
input: unknown;
input: unknown;

toolCallId

ts
toolCallId: string;
toolCallId: string;

toolName

ts
toolName: string;
toolName: string;

Overrides

ts
CustomEvent.value
CustomEvent.value