Visão geral da API
O OfoxAI oferece três protocolos de API, totalmente compatíveis com os SDKs oficiais de cada provedor.
Base URL
| Protocolo | Base URL | Descrição |
|---|---|---|
| OpenAI compatível | https://api.ofox.ai/v1 | Compatível com o SDK OpenAI, suporta todos os modelos |
| Anthropic nativo | https://api.ofox.ai/anthropic | Compatível com o SDK Anthropic, experiência nativa do Claude |
| Gemini nativo | https://api.ofox.ai/gemini | Compatível com o SDK Google GenAI |
Autenticação
Todos os protocolos usam uma API Key unificada do OfoxAI, porém o formato do header varia conforme o protocolo:
| Protocolo | Header | Formato |
|---|---|---|
| OpenAI | Authorization | Bearer sk-xxx |
| Anthropic | x-api-key | sk-xxx |
| Gemini | x-goog-api-key | sk-xxx |
Veja detalhes no guia de autenticação.
Endpoints disponíveis
Protocolo compatível com OpenAI
| Endpoint | Método | Descrição |
|---|---|---|
/v1/chat/completions | POST | Criar completação de chat |
/v1/embeddings | POST | Criar embeddings de texto |
/v1/models | GET | Listar modelos disponíveis |
/v1/models/{model_id} | GET | Obter detalhes do modelo |
/v1/images/generations | POST | Geração de imagens |
Protocolo nativo Anthropic
| Endpoint | Método | Descrição |
|---|---|---|
/anthropic/v1/messages | POST | Criar Messages |
Protocolo nativo Gemini
| Endpoint | Método | Descrição |
|---|---|---|
/gemini/v1beta/models/{model}:generateContent | POST | Gerar conteúdo |
/gemini/v1beta/models/{model}:streamGenerateContent | POST | Geração de conteúdo em streaming |
Limites de taxa
O OfoxAI cobra por uso. Todos os usuários compartilham uma política de taxa unificada, sem diferenças entre planos:
| Limite | Cota |
|---|---|
| RPM (requisições/minuto) | 200 |
| TPM (tokens/minuto) | Ilimitado |
Se você precisar de limites de taxa mais altos, entre em contato com o suporte OfoxAI para solicitar um ajuste.
Quando o limite de taxa é atingido, a API retorna 429 Too Many Requests, com os seguintes headers na resposta:
x-ratelimit-limit-requests: 200
x-ratelimit-remaining-requests: 0
x-ratelimit-reset-requests: 1sCódigos de erro
Todos os protocolos retornam códigos de status HTTP unificados:
| Código | Descrição | Causas comuns |
|---|---|---|
200 | Sucesso | — |
400 | Requisição inválida | Formato de parâmetro inválido, campos obrigatórios ausentes |
401 | Falha na autenticação | API Key inválida ou expirada |
403 | Permissão insuficiente | Conta sem acesso ao modelo |
404 | Recurso não encontrado | ID do modelo incorreto |
429 | Limite de taxa atingido | Limite de taxa excedido |
500 | Erro do servidor | Erro interno, tente novamente |
502 | Erro upstream | Falha no serviço do provedor do modelo |
503 | Serviço indisponível | Em manutenção |
Formato da resposta de erro
{
"error": {
"code": "invalid_api_key",
"message": "A API Key fornecida é inválida. Verifique e tente novamente.",
"type": "authentication_error"
}
}Parâmetros de extensão do OfoxAI
O OfoxAI oferece parâmetros adicionais para roteamento avançado e controle de failover:
{
"model": "openai/gpt-4o",
"messages": [...],
"provider": {
"routing": "cost",
"fallback": ["anthropic/claude-sonnet-4.5", "google/gemini-3-flash-preview"]
}
}Veja detalhes em roteamento de provedores e failover.