Pular para o conteúdo principal
O AI Gateway expõe endpoints totalmente compatíveis com a API da OpenAI, permitindo usar todos os modelos disponíveis no AI Gateway sem alterar a lógica da sua aplicação. Mantenha o cliente da OpenAI que você já usa, aponte-o para a baseURL do proxy do Toqan Router e continue normalmente.
Para ver a especificação da API da OpenAI, consulte a referência da API
Para migrar uma aplicação existente do SDK da OpenAI, do Anthropic SDK, do OpenRouter ou do LiteLLM, consulte Migrar para o Toqan Router.
Integração direta (sem alterações de código)
  1. Mantenha sua integração atual com o SDK da OpenAI ou por HTTP.
  2. Defina a URL base como https://router.toqan.ai/eu/v3/router
  3. Use a chave de API do Toqan Router no cabeçalho Authorization.
  4. Chame os mesmos endpoints e envie os mesmos payloads que você já usa com a OpenAI.
Uma Model Fusion responde a cada requisição com um painel de modelos e retorna uma única resposta avaliada: passe o ID do modelo dela como model. Consulte Model Fusion.

​
URL base

Endpoint compatível com OpenAI:
Todas as rotas abaixo são relativas a essa URL base. As rotas compatíveis com OpenAI espelham os formatos de requisição e resposta da OpenAI.

​
Autenticação

Autentique-se com a chave de API do Toqan Router por meio do cabeçalho Authorization: Bearer $TOQAN_API_KEY.
Para saber mais sobre a chave de API do Toqan Router, consulte Chave de API.
Cabeçalhos mínimos:
  • Authorization: Bearer $TOQAN_API_KEY
  • Content-Type: application/json

​
Endpoints compatíveis

​
Compatíveis com OpenAI

Estas rotas correspondem à API da OpenAI: mesmo esquema, mesmos parâmetros e mesmo formato de resposta. Consulte as notas de compatibilidade abaixo para conhecer as exceções.
  • GET /models: lista os modelos disponíveis
  • POST /chat/completions: chat completions (com suporte a streaming, imagens, arquivos e chamadas de ferramentas)
  • POST /completions: completions de texto
  • POST /embeddings: embeddings vetoriais (Embeddings)
  • POST /images/generations: geração de imagens
  • POST /images/edits: edição de imagens
  • POST /images/variations: variações de imagens
  • POST /moderations: moderação de texto (Rerank e Moderations)
  • POST /audio/speech: texto para fala
  • POST /audio/transcriptions: transcreve áudio no idioma de entrada
  • POST /audio/translations: traduz áudio para inglês
  • POST /responses: cria uma resposta do modelo com ferramentas integradas (Responses API, Web Search)
  • GET /responses/{response_id}: recupera uma resposta armazenada (Responses API)
  • POST /batches, GET /batches, GET /batches/{batch_id}, GET /batches/{batch_id}/results, POST /batches/{batch_id}/cancel: processamento em lote (Batches)

​
Rotas do Toqan Router

Estas rotas são servidas na mesma URL base, mas usam seus próprios contratos de requisição e resposta, e não os da OpenAI.
  • POST /rerank: reordena resultados (Rerank e Moderations)
  • POST /decisions: executa perguntas de classificação tipadas em um modelo de decisão (Decisions)
  • POST /classify: alias descontinuado de POST /decisions
  • POST /ocr: extrai texto e estrutura de um documento ou imagem (OCR)

​
Modelos

Use o campo model exatamente como faria com a OpenAI, substituindo-o pelo ID de qualquer modelo disponível em Modelos do AI Gateway.

​
Tratamento de erros e notas de compatibilidade

  • Os códigos de status HTTP e as estruturas de erro seguem as convenções da OpenAI.
  • Streaming, chamadas de funções/ferramentas e entradas multimodais (imagens/arquivos) são compatíveis com /chat/completions.
  • Enviar tools para /chat/completions com um modelo de raciocínio da OpenAI, como openai/gpt-5.6-sol, retorna 400. Use /responses em vez disso, ou defina reasoning_effort como none, o que elimina o raciocínio que o modelo faria. Consulte Migrar para o Toqan Router.
  • O AI Gateway serve a superfície atual em /v3/router: use esse caminho em novas integrações. Os caminhos anteriores em /v2/router/ continuam publicados para manter a compatibilidade com versões anteriores.