Interface: SandboxFileCustomEvent

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

Custom event for extensibility.

@ag-ui/core provides: name, value TanStack AI adds: model?

Uses Pick (not extends) so the Zod passthrough index signature does not erase discriminant property access on KnownCustomEvent / TypedStreamChunk unions.

Extends

CustomEvent

Properties

model?

optional model?: string;

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

Model identifier for multi-model support

Inherited from

CustomEvent.model

name

name: "sandbox.file";

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

Overrides

CustomEvent.name

runId?

optional runId?: string;

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

Inherited from

CustomEvent.runId

threadId?

optional threadId?: string;

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

Routing metadata the TanStack engine attaches when emitting CUSTOM events that need to be correlated with a specific thread/run. Stripped by strip-to-spec-middleware before going on the wire so the AG-UI consumer never sees them (when that middleware is enabled).