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

TextMessageStartEvent

Interface: TextMessageStartEvent

Defined in: types.ts:806

Emitted when a text message starts.

Extends

Properties

messageId

ts
messageId: string;
messageId: string;

Defined in: types.ts:809

Unique identifier for this message


model?

ts
optional model: string;
optional model: string;

Defined in: types.ts:751

Model identifier for multi-model support

Inherited from

BaseAGUIEvent.model


rawEvent?

ts
optional rawEvent: unknown;
optional rawEvent: unknown;

Defined in: types.ts:753

Original provider event for debugging/advanced use cases

Inherited from

BaseAGUIEvent.rawEvent


role

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

Defined in: types.ts:811

Role of the message sender


timestamp

ts
timestamp: number;
timestamp: number;

Defined in: types.ts:749

Inherited from

BaseAGUIEvent.timestamp


type

ts
type: "TEXT_MESSAGE_START";
type: "TEXT_MESSAGE_START";

Defined in: types.ts:807

Overrides

BaseAGUIEvent.type