Realtime WebSocket

AperçuCopy Anchor Link

Utilisez ce point de terminaison pour les sessions en temps réel telles que la reconnaissance vocale en streaming, la synthèse vocale, la traduction vocale ou les modèles multimodaux en temps réel. Une requête GET standard renvoie les métadonnées du point de terminaison, tandis qu'une requête de mise à niveau WebSocket ouvre une session en temps réel pour le modèle sélectionné.

Surface prise en chargeCopy Anchor Link

TokenLab expose un endpoint WebSocket temps réel sur GET /v1/realtime pour les contrôles de métadonnées et les upgrades WebSocket. Considérez-le comme un WebSocket subset : il relaie les événements des modèles realtime pris en charge et ne prend pas en charge les surfaces d'aide REST OpenAI Realtime comme la création de session, client_secrets, les API de contrôle d'appel Calls ou les legacy beta session APIs.

Pour les apps navigateur ou mobile, conservez les clés API longue durée côté serveur. Cet endpoint n’émet pas de Realtime client secrets de courte durée.

ConnexionCopy Anchor Link

import WebSocket from 'ws';

const model = process.env.TOKENLAB_REALTIME_MODEL;
const apiKey = process.env.TOKENLAB_API_KEY;
if (!model || !apiKey) {
  throw new Error('Set TOKENLAB_REALTIME_MODEL and TOKENLAB_API_KEY');
}

const url = new URL('wss://api.tokenlab.sh/v1/realtime');
url.searchParams.set('model', model);
const socket = new WebSocket(url, {
  headers: { Authorization: `Bearer ${apiKey}` }
});

socket.on('open', () => {
  console.log('Realtime connection open');
});

socket.on('message', (data) => {
  console.log('realtime event', data.toString());
});

socket.on('error', (error) => console.error(error.message));
socket.on('close', (code) => console.log('Realtime connection closed', code));

MessagesCopy Anchor Link

TokenLab relaie les messages WebSocket entre votre client et le modèle en temps réel sélectionné. Utilisez le format d'événement décrit dans la documentation de ce modèle et incluez model dans la chaîne de requête plutôt que dans chaque événement.

Facturation et fermetureCopy Anchor Link

Les sessions sont facturées sur le solde de votre clé API : TokenLab réserve une estimation au début, puis règle l'utilisation réelle à la fin et rembourse la différence.

Fermez le socket client lorsque la session est terminée. Si le service ferme la session en premier, TokenLab transmet, dans la mesure du possible, un événement/code de fermeture sécurisé à votre client.

{
  "object": "realtime.endpoint",
  "websocket_url": "/v1/realtime?model={model}",
  "protocol": "tokenlab_realtime_proxy"
}

Champs importantsCopy Anchor Link