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

RealtimeAdapter

Interface: RealtimeAdapter

Defined in: realtime-types.ts

Adapter interface for connecting to realtime providers. Each provider (OpenAI, ElevenLabs, etc.) implements this interface.

Properties

provider

ts
provider: string;

Provider identifier (e.g., 'openai', 'elevenlabs').

Methods

connect()

ts
connect(token, clientTools?): Promise<RealtimeConnection>;

Create a connection using the provided token.

Parameters

token

RealtimeToken

The ephemeral token from the server.

clientTools?

ReadonlyArray<AnyClientTool>

Optional client-side tools to register with the provider.

Returns

Promise<RealtimeConnection>