Documentation
Framework
Version
Class References
Function References
Interface References
Type Alias References
Variable References

UIMessage

Interface: UIMessage

Defined in: types.ts:219

UIMessage - Domain-specific message format optimized for building chat UIs Contains parts that can be text, tool calls, or tool results

Properties

createdAt?

ts
optional createdAt: Date;
optional createdAt: Date;

Defined in: types.ts:223


id

ts
id: string;
id: string;

Defined in: types.ts:220


parts

ts
parts: MessagePart[];
parts: MessagePart[];

Defined in: types.ts:222


role

ts
role: "user" | "assistant" | "system";
role: "user" | "assistant" | "system";

Defined in: types.ts:221