TanStack

SessionIdEvent

Interface: SessionIdEvent

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

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

Properties

model?

ts
optional model?: string;

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

Model identifier for multi-model support

Inherited from

CustomEvent.model


name

ts
name: `${string}.session-id`;

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

Overrides

ts
CustomEvent.name

runId?

ts
optional runId?: string;

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

Inherited from

CustomEvent.runId


threadId?

ts
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).

Inherited from

CustomEvent.threadId


type

ts
type: "CUSTOM";

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

Inherited from

CustomEvent.type


value

ts
value: object;

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

sessionId

ts
sessionId: string;

Overrides

ts
CustomEvent.value