Docs
Code Rabbit
Cloudflare
AG Grid
Netlify
Neon
WorkOS
Clerk
Convex
Electric
Sentry
Prisma
Strapi
Unkey
UI.dev
Code Rabbit
Cloudflare
AG Grid
Netlify
Neon
WorkOS
Clerk
Convex
Electric
Sentry
Prisma
Strapi
Unkey
UI.dev
Class References
Function References
Interface References
Type Alias References
Variable References
Interface References

RealtimeSessionConfig

Interface: RealtimeSessionConfig

Defined in: realtime/types.ts:30

Configuration for a realtime session

Properties

instructions?

ts
optional instructions: string;
optional instructions: string;

Defined in: realtime/types.ts:36

System instructions for the assistant


maxOutputTokens?

ts
optional maxOutputTokens: number | "inf";
optional maxOutputTokens: number | "inf";

Defined in: realtime/types.ts:48

Maximum number of tokens in a response


model?

ts
optional model: string;
optional model: string;

Defined in: realtime/types.ts:32

Model to use for the session


outputModalities?

ts
optional outputModalities: ("text" | "audio")[];
optional outputModalities: ("text" | "audio")[];

Defined in: realtime/types.ts:44

Output modalities for responses (e.g., ['audio', 'text'], ['text'])


providerOptions?

ts
optional providerOptions: Record<string, any>;
optional providerOptions: Record<string, any>;

Defined in: realtime/types.ts:52

Provider-specific options


semanticEagerness?

ts
optional semanticEagerness: "low" | "high" | "medium";
optional semanticEagerness: "low" | "high" | "medium";

Defined in: realtime/types.ts:50

Eagerness level for semantic VAD ('low', 'medium', 'high')


temperature?

ts
optional temperature: number;
optional temperature: number;

Defined in: realtime/types.ts:46

Temperature for generation (provider-specific range, e.g., 0.6-1.2 for OpenAI)


tools?

ts
optional tools: RealtimeToolConfig[];
optional tools: RealtimeToolConfig[];

Defined in: realtime/types.ts:38

Tools available in the session


vadConfig?

ts
optional vadConfig: VADConfig;
optional vadConfig: VADConfig;

Defined in: realtime/types.ts:42

VAD configuration


vadMode?

ts
optional vadMode: "server" | "manual" | "semantic";
optional vadMode: "server" | "manual" | "semantic";

Defined in: realtime/types.ts:40

VAD mode


voice?

ts
optional voice: string;
optional voice: string;

Defined in: realtime/types.ts:34

Voice to use for audio output