Referencia de la API

Tiempo real

Ningún modelo lo admite todavía

Ahora mismo ningún modelo del catálogo admite esta ruta. La página se mantiene como referencia.
WS/v1/realtime

Usa el endpoint Realtime cuando el texto y el audio deban viajar por una única conexión persistente. Está protegido por la misma clave de API, el mismo alcance de clave, los mismos permisos de modelo y los mismos límites de tasa que la API HTTP.

#Conéctate desde tu servidor

Abre el WebSocket desde un proceso de servidor de confianza y envía Authorization: Bearer con la clave de API durante el handshake. No expongas una clave de API de larga duración en el JavaScript del navegador: los navegadores no pueden adjuntar este encabezado de forma segura y cualquiera puede extraer una clave incluida en el código.

server.ts
import WebSocket from "ws";

const socket = new WebSocket("wss://YOUR_DOMAIN/v1/realtime", {
  headers: { Authorization: "Bearer sk-YOUR_KEY" },
});

socket.on("open", () => {
  // Send standard Realtime session and conversation events here.
});

socket.on("message", (event) => {
  // Forward text / audio deltas to your client.
});

#Flujo de sesión y eventos

Tras conectarte, envía los eventos estándar de sesión y conversación de Realtime para el modelo que elegiste. Reenvía los eventos del servidor a tu navegador mediante tu propio canal de corta duración; así la clave de la plataforma y el WebSocket upstream quedan bajo tu control.

1

Conectar

Abre un único socket autenticado en el servidor.

2

Configurar

Envía la configuración de la sesión y la entrada de la conversación.

3

Reenviar

Reenvía los deltas a tu cliente y cierra la sesión al terminar.

#Reconecta de forma deliberada

Un WebSocket tiene estado. Si la conexión se cierra, crea una sesión nueva y vuelve a enviar solo el estado de la aplicación que hayas conservado a propósito. Trata 401, 403, 402 y 429 como señales accionables sobre la cuenta o la clave; reintenta los fallos de red transitorios y los 5xx con un backoff acotado.

Empieza con HTTP si no necesitas audio en vivo

Para texto normal en streaming, /v1/chat/completions es más fácil de desplegar y usa server-sent events. Pasa a Realtime cuando una sesión persistente de baja latencia forme parte de la experiencia del producto.

¿Sigues con el problema?

Envíanos el ID de solicitud o el mensaje de error y lo revisaremos.