Arquivos e lotes

Criar Lote

Cria um trabalho em lote compatível com OpenAI a partir de um arquivo de entrada carregado.

POST
/v1/batches

Visão Geral

Este endpoint faz parte da API de Lote compatível com OpenAI da TokenLab. Trabalhos em lote utilizam arquivos JSONL carregados, são executados de forma assíncrona e podem retornar arquivos de saída/erro posteriormente.

Observações

  • Arquivos de entrada em lote devem usar purpose=batch.
  • completion_window é atualmente 24h.
  • A ordenação da saída não é garantida; sempre combine pelo custom_id.
  • Streaming não é suportado dentro dos itens de lote.
  • Os endpoints aceitos para itens de lote são /v1/chat/completions e /v1/embeddings. /v1/responses não é aceito.

Exemplo

Requisição

cURL
curl -X POST "https://api.tokenlab.sh/v1/batches" \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "input_file_id": "file_abc123",
    "endpoint": "/v1/chat/completions",
    "completion_window": "24h"
  }'

Solicitação / Resposta

Use o painel interativo do OpenAPI acima para o esquema exato.

Dicas Operacionais

  • Use custom_id para reconciliação idempotente a montante.
  • Espere output_file_id e error_file_id apenas após o trabalhador finalizar o lote.

Exemplo de resposta

Resposta

200 OK
{
  "id": "batch_abc123",
  "object": "batch",
  "endpoint": "/v1/chat/completions",
  "input_file_id": "file_abc123",
  "completion_window": "24h",
  "status": "validating",
  "output_file_id": null,
  "error_file_id": null,
  "created_at": 1706000000
}

Campos importantes

idstring
Identificador para chamadas seguintes e suporte.
statusstring
Estado atual do ciclo de vida deste recurso.
output_file_idstring|null
Identificador de arquivo usado por APIs relacionadas.

Autorização

BearerAuth
AuthorizationBearer <token>

Autenticação por Chave de API. Crie ou gerencie chaves de API em Dashboard > API > API Keys.

Local: header

Cabeçalhos

X-TokenLab-Delivery-Policy?string

Política de entrega por solicitação. Substitui os padrões da API key e do Workspace. Tenta automaticamente o TokenLab Verified primeiro e pode alternar uma vez para Official apenas antes da saída, aceitação da solicitação ou criação de recurso persistente.

Valores permitidos

  • "auto"
  • "verified"
  • "official"

Corpo da requisição

application/json

Resposta

application/json

application/json

application/json

application/json

application/json