Open History to see the last commit
1---
2id: RealtimeEventPayloads
3title: RealtimeEventPayloads
4---
5
6# Interface: RealtimeEventPayloads
7
8Defined in: [packages/ai/src/realtime/types.ts:258](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L258)
9
10Event payloads for realtime events
11
12## Properties
13
14### audio\_chunk
15
16```ts
17audio_chunk: object;
18```
19
20Defined in: [packages/ai/src/realtime/types.ts:266](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L266)
21
22#### data
23
24```ts
25data: ArrayBuffer;
26```
27
28#### sampleRate
29
30```ts
31sampleRate: number;
32```
33
34***
35
36### error
37
38```ts
39error: object;
40```
41
42Defined in: [packages/ai/src/realtime/types.ts:270](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L270)
43
44#### error
45
46```ts
47error: Error;
48```
49
50***
51
52### go\_away
53
54```ts
55go_away: object;
56```
57
58Defined in: [packages/ai/src/realtime/types.ts:271](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L271)
59
60#### timeLeft?
61
62```ts
63optional timeLeft: string;
64```
65
66***
67
68### interrupted
69
70```ts
71interrupted: object;
72```
73
74Defined in: [packages/ai/src/realtime/types.ts:269](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L269)
75
76#### messageId?
77
78```ts
79optional messageId: string;
80```
81
82***
83
84### message\_complete
85
86```ts
87message_complete: object;
88```
89
90Defined in: [packages/ai/src/realtime/types.ts:268](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L268)
91
92#### message
93
94```ts
95message: RealtimeMessage;
96```
97
98***
99
100### mode\_change
101
102```ts
103mode_change: object;
104```
105
106Defined in: [packages/ai/src/realtime/types.ts:260](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L260)
107
108#### mode
109
110```ts
111mode: RealtimeMode;
112```
113
114***
115
116### status\_change
117
118```ts
119status_change: object;
120```
121
122Defined in: [packages/ai/src/realtime/types.ts:259](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L259)
123
124#### status
125
126```ts
127status: RealtimeStatus;
128```
129
130***
131
132### tool\_call
133
134```ts
135tool_call: object;
136```
137
138Defined in: [packages/ai/src/realtime/types.ts:267](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L267)
139
140#### input
141
142```ts
143input: unknown;
144```
145
146#### toolCallId
147
148```ts
149toolCallId: string;
150```
151
152#### toolName
153
154```ts
155toolName: string;
156```
157
158***
159
160### transcript
161
162```ts
163transcript: object;
164```
165
166Defined in: [packages/ai/src/realtime/types.ts:261](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L261)
167
168#### isFinal
169
170```ts
171isFinal: boolean;
172```
173
174#### role
175
176```ts
177role: "user" | "assistant";
178```
179
180#### transcript
181
182```ts
183transcript: string;
184```
185
186***
187
188### usage
189
190```ts
191usage: UsageInfo;
192```
193
194Defined in: [packages/ai/src/realtime/types.ts:272](https://github.com/TanStack/ai/blob/main/packages/ai/src/realtime/types.ts#L272)