Streaming

Visão geral

O streaming entrega a saída de forma incremental. Use Responses streaming quando o modelo anunciar um contrato Responses nativo e houver uma rota upstream do mesmo protocolo; caso contrário, use Chat Completions ou o protocolo nativo publicado pelo modelo.

Recomendado: Responses Streaming

curl https://api.tokenlab.sh/v1/responses \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.4",
    "input": "Write a short poem.",
    "stream": true
  }'

from openai import OpenAI

client = OpenAI(
    api_key="sk-your-api-key",
    base_url="https://api.tokenlab.sh/v1"
)

stream = client.responses.create(
    model="gpt-5.4",
    input="Write a short poem.",
    stream=True
)

for event in stream:
    if event.type == "response.output_text.delta":
        print(event.delta, end="", flush=True)

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: 'sk-your-api-key',
  baseURL: 'https://api.tokenlab.sh/v1'
});

const stream = await client.responses.create({
  model: 'gpt-5.4',
  input: 'Write a short poem.',
  stream: true
});

for await (const event of stream) {
  if (event.type === 'response.output_text.delta') {
    process.stdout.write(event.delta);
  }
}

Limites de streaming de Responses e Gemini

No Responses SSE, o TokenLab preserva nomes, ordem e campos dos eventos upstream e lê usage e estado terminal fora da banda, sem alterar o wire. Depois do primeiro evento entregue, não tenta outro canal ou credential. Responses WebSocket aceita apenas eventos oficiais response.create. Stream é implícito; background e response.cancel não são oferecidos nesse transporte, e background funciona somente por HTTP. Cada conexão é serial, sem multiplexing, e limitada a 60 minutos. Gemini SSE preserva chunks nativos. Eventos apenas com metadados, chunks intermediários sem finishReason e EOF natural são válidos; o TokenLab não adiciona marcador Chat [DONE].

Streaming de Chat Completions

Se o seu framework ainda espera chunks SSE de /v1/chat/completions, isso também funciona:

stream = client.chat.completions.create(
    model="gpt-4o",
    messages=[{"role": "user", "content": "Write a short poem"}],
    stream=True
)

for chunk in stream:
    content = chunk.choices[0].delta.content
    if content:
        print(content, end="", flush=True)

Condições de término do stream

Condições típicas de conclusão:

response.completed para streams da Responses API
finish_reason: "stop" para streams de Chat Completions
finish_reason: "length" quando um limite de token é atingido
eventos de chamada de tool/function quando o modelo deseja usar tools

Padrão para aplicação web

async function streamChat(message) {
  const response = await fetch('https://api.tokenlab.sh/v1/chat/completions', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer sk-your-api-key',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      model: 'gpt-4o',
      messages: [{ role: 'user', content: message }],
      stream: true
    })
  });

  const reader = response.body.getReader();
  const decoder = new TextDecoder();

  while (true) {
    const { done, value } = await reader.read();
    if (done) break;

    const chunk = decoder.decode(value);
    const lines = chunk.split('\\n').filter(line => line.startsWith('data: '));

    for (const line of lines) {
      const data = line.slice(6);
      if (data === '[DONE]') return;
      const parsed = JSON.parse(data);
      const content = parsed.choices?.[0]?.delta?.content;
      if (content) {
        document.getElementById('output').textContent += content;
      }
    }
  }
}

Boas práticas

Prefira Responses streaming em novas implementações

Use /v1/responses se o seu SDK ou app já oferecer suporte a ele. Mantenha o streaming de /v1/chat/completions para integrações orientadas por compatibilidade.

Descarregue a saída incrementalmente

Acrescente chunks delta à UI ou ao terminal à medida que eles chegarem, em vez de esperar pela resposta completa.

Trate desconexões e novas tentativas

Considere quedas de rede e desconexões upstream como modos normais de falha e reconecte com cuidado em sessões de longa duração.

Primeiros passos

Guias principais

Guias de mídia

Visão geral

Recomendado: Responses Streaming

Limites de streaming de Responses e Gemini

Streaming de Chat Completions

Condições de término do stream

Padrão para aplicação web

Boas práticas

​Visão geral

​Recomendado: Responses Streaming

​Limites de streaming de Responses e Gemini

​Streaming de Chat Completions

​Condições de término do stream

​Padrão para aplicação web

​Boas práticas

Visão geral

Recomendado: Responses Streaming

Limites de streaming de Responses e Gemini

Streaming de Chat Completions

Condições de término do stream

Padrão para aplicação web

Boas práticas