SessionIdEvent

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

Custom event for extensibility.

@ag-ui/core provides: name, value, subagentRunId?

Extends#

• CustomEvent

Properties#

metadata?#

optional metadata?: Record<string, any>;

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

Extra information attached to this event.

Inherited from#

CustomEvent.metadata

name#

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

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

What this custom event is. Required: without it a consumer cannot route the value.

Overrides#

CustomEvent.name

type#

type: "CUSTOM";

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

Inherited from#

CustomEvent.type

value#

value: object;

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

The payload. Any JSON value, and required.

sessionId#

sessionId: string;

Overrides#

CustomEvent.value