> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

# API compatível com OpenAI

> Use o Toqan Router como proxy de API compatível com OpenAI e acesse mais de 500 modelos de LLM com o SDK da OpenAI que você já usa, alterando apenas a URL base.

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.

> [!NOTE]
>
> Para ver a especificação da API da OpenAI, consulte [a referência da API](https://platform.openai.com/docs/api-reference/chat)

> [!TIP]
>
> Para migrar uma aplicação existente do SDK da OpenAI, do [**Anthropic SDK**](/docs/pt-BR/ai-gateway/features/anthropic-messages-api.md), do **OpenRouter** ou do **LiteLLM**, consulte [Migrar para o Toqan Router](/docs/pt-BR/ai-gateway/get-started/migrate.md).

> [!TIP]
>
> **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.

> [!NOTE]
>
> 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](/docs/pt-BR/ai-gateway/model-fusion.md).

## URL base

Endpoint compatível com OpenAI:

```text URL theme={"theme":{"light":"github-light","dark":"github-dark"}}
https://router.toqan.ai/eu/v3/router
```

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`.

> [!NOTE]
>
> 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](/docs/pt-BR/ai-gateway/features/embeddings.md))
* `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](/docs/pt-BR/ai-gateway/features/rerank-and-moderations.md#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](/docs/pt-BR/ai-gateway/features/responses-api.md), [Web Search](/docs/pt-BR/ai-gateway/features/web-search.md))
* `GET /responses/{response_id}`: recupera uma resposta armazenada ([Responses API](/docs/pt-BR/ai-gateway/features/responses-api.md))
* `POST /batches`, `GET /batches`, `GET /batches/{batch_id}`, `GET /batches/{batch_id}/results`, `POST /batches/{batch_id}/cancel`: processamento em lote ([Batches](/docs/pt-BR/ai-gateway/features/batches.md))

### 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](/docs/pt-BR/ai-gateway/features/rerank-and-moderations.md#rerank))
* `POST /decisions`: executa perguntas de classificação tipadas em um modelo de decisão ([Decisions](/docs/pt-BR/ai-gateway/features/decisions.md))
* `POST /classify`: alias descontinuado de `POST /decisions`
* `POST /ocr`: extrai texto e estrutura de um documento ou imagem ([OCR](/docs/pt-BR/ai-gateway/features/ocr.md))

## 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](/docs/pt-BR/ai-gateway/using-the-router.md).

## 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](/docs/pt-BR/ai-gateway/get-started/migrate.md#what-does-not-carry-over).
* 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.

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.