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

TextMessageStartEvent

Interface: TextMessageStartEvent

Defined in: types.ts:805

Emitted when a text message starts.

Extends

Properties

messageId

ts
messageId: string;
messageId: string;

Defined in: types.ts:808

Unique identifier for this message


model?

ts
optional model: string;
optional model: string;

Defined in: types.ts:750

Model identifier for multi-model support

Inherited from

BaseAGUIEvent.model


rawEvent?

ts
optional rawEvent: unknown;
optional rawEvent: unknown;

Defined in: types.ts:752

Original provider event for debugging/advanced use cases

Inherited from

BaseAGUIEvent.rawEvent


role

ts
role: "assistant";
role: "assistant";

Defined in: types.ts:810

Role is always assistant for generated messages


timestamp

ts
timestamp: number;
timestamp: number;

Defined in: types.ts:748

Inherited from

BaseAGUIEvent.timestamp


type

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

Defined in: types.ts:806

Overrides

BaseAGUIEvent.type