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
Function References

realtimeToken

Function: realtimeToken()

ts
function realtimeToken(options): Promise<RealtimeToken>;

Defined in: realtime/index.ts:33

Generate a realtime token using the provided adapter.

This function is used on the server to generate ephemeral tokens that clients can use to establish realtime connections.

Parameters

options

RealtimeTokenOptions

Token generation options including the adapter

Returns

Promise<RealtimeToken>

Promise resolving to a RealtimeToken

Example

typescript
import { realtimeToken } from '@tanstack/ai'
import { openaiRealtimeToken } from '@tanstack/ai-openai'

// Server function (TanStack Start example)
export const getRealtimeToken = createServerFn()
  .handler(async () => {
    return realtimeToken({
      adapter: openaiRealtimeToken({
        model: 'gpt-4o-realtime-preview',
        voice: 'alloy',
        instructions: 'You are a helpful assistant...',
      }),
    })
  })