Referência da API
Tempo real
Nenhum modelo atende a isto ainda
/v1/realtimeUse o endpoint Realtime quando texto e áudio precisarem trafegar por uma única conexão persistente. Ele é protegido pela mesma chave de API, escopo de chave, permissões de modelo e limites de taxa da API HTTP.
#Conecte a partir do seu servidor
Abra o WebSocket em um processo de servidor confiável e envie Authorization: Bearer com a chave de API durante o handshake. Não exponha uma chave de API de longa duração no JavaScript do navegador: os navegadores não conseguem anexar esse cabeçalho com segurança, e qualquer pessoa pode extrair uma chave publicada.
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.
});#Fluxo de sessão e eventos
Depois de conectar, envie os eventos padrão de sessão e conversa do Realtime para o modelo escolhido. Encaminhe os eventos do servidor para o navegador por um canal próprio de curta duração; assim a chave da plataforma e o WebSocket upstream ficam sob seu controle.
1
Conectar
Abra um socket autenticado no servidor.
2
Configurar
Envie a configuração da sessão e a entrada da conversa.
3
Repassar
Encaminhe os deltas para o seu cliente e feche a sessão ao terminar.
#Reconecte de forma deliberada
Um WebSocket tem estado. Se a conexão fechar, crie uma nova sessão e reproduza apenas o estado da aplicação que você guardou de propósito. Trate 401, 403, 402 e 429 como sinais acionáveis de conta ou chave; repita falhas transitórias de rede e 5xx com backoff limitado.
Comece com HTTP se não precisar de áudio ao vivo
Ainda com problemas?
Envie para nós o ID da requisição ou a mensagem de erro e vamos investigar.