Docs
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
CodeRabbit
Cloudflare
AG Grid
SerpAPI
Netlify
OpenRouter
Neon
WorkOS
Clerk
Electric
PowerSync
Sentry
Railway
Prisma
Strapi
Unkey
Class References
Function References
Interface References
Type Alias References
Variable References

RealtimeEventPayloads

Interface: RealtimeEventPayloads

Defined in: packages/typescript/ai/src/realtime/types.ts:251

Event payloads for realtime events

Properties

audio_chunk

ts
audio_chunk: object;
audio_chunk: object;

Defined in: packages/typescript/ai/src/realtime/types.ts:259

data

ts
data: ArrayBuffer;
data: ArrayBuffer;

sampleRate

ts
sampleRate: number;
sampleRate: number;

error

ts
error: object;
error: object;

Defined in: packages/typescript/ai/src/realtime/types.ts:263

error

ts
error: Error;
error: Error;

interrupted

ts
interrupted: object;
interrupted: object;

Defined in: packages/typescript/ai/src/realtime/types.ts:262

messageId?

ts
optional messageId: string;
optional messageId: string;

message_complete

ts
message_complete: object;
message_complete: object;

Defined in: packages/typescript/ai/src/realtime/types.ts:261

message

ts
message: RealtimeMessage;
message: RealtimeMessage;

mode_change

ts
mode_change: object;
mode_change: object;

Defined in: packages/typescript/ai/src/realtime/types.ts:253

mode

ts
mode: RealtimeMode;
mode: RealtimeMode;

status_change

ts
status_change: object;
status_change: object;

Defined in: packages/typescript/ai/src/realtime/types.ts:252

status

ts
status: RealtimeStatus;
status: RealtimeStatus;

tool_call

ts
tool_call: object;
tool_call: object;

Defined in: packages/typescript/ai/src/realtime/types.ts:260

input

ts
input: unknown;
input: unknown;

toolCallId

ts
toolCallId: string;
toolCallId: string;

toolName

ts
toolName: string;
toolName: string;

transcript

ts
transcript: object;
transcript: object;

Defined in: packages/typescript/ai/src/realtime/types.ts:254

isFinal

ts
isFinal: boolean;
isFinal: boolean;

role

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

transcript

ts
transcript: string;
transcript: string;