Referência da API
A Synthorai expõe uma API REST multiprotocolo sobre HTTPS. A mesma URL base, chave e cobrança atendem a três formatos de requisição - OpenAI Chat Completions, OpenAI Responses e Anthropic Messages - além de endpoints auxiliares para embeddings, imagens, áudio e reranking.
Base URL: https://synthorai.io/v1
All endpoints require:
Content-Type: application/json
Authorization: Bearer <your-api-key>
(or x-api-key: <your-api-key> for /v1/messages) Endpoints
| Endpoint | Tipo | Descrição |
|---|---|---|
POST /v1/chat/completions | chat | OpenAI Chat Completions - ponto de entrada universal, roteia para qualquer provedor. |
POST /v1/responses | chat | OpenAI Responses - uso de ferramentas, raciocínio, saída estruturada. |
POST /v1/messages | chat | Anthropic Messages - nativo Claude / Bedrock-Anthropic. |
POST /v1/embeddings | embedding | Gera embeddings vetoriais. |
POST /v1/images/generations | image | Gera imagens a partir de prompts de texto. |
POST /v1/videos | video | Criar e fazer polling de jobs assíncronos de geração de vídeo. |
POST /v1/audio/transcriptions | audio | Transcreve áudio em texto. |
POST /v1/audio/speech | audio | Converte texto em fala. |
GET /v1/models | read | Lista todos os modelos disponíveis para a chave autenticada. |
/api/v1/keys | keys | Crie, liste, altere, rotacione e exclua chaves de inferência pelo seu código (requer uma chave de administração com keys.read ou keys.write). |
GET /api/v1/requests | logs | Liste e leia as requisições do workspace: modelo, chave, tokens, custo, tempos e rótulos, nunca o prompt nem a resposta (requer uma chave de administração com logs.read). |
/api/v1/prompts | prompts | Leia e altere a biblioteca de prompts pelo seu código: prompts, versões, rótulos e lançamentos graduais, além de conjuntos de testes e execuções de avaliação (requer uma chave de administração com prompts.read ou prompts.write; evals.read ou evals.write para os testes). |
GET /api/v1/audit-logs | workspace | Leia como o workspace está configurado e o que foi alterado nele: log de auditoria, membros e convites, configurações de BYOK e destinos de exportação, cada um com seu próprio escopo de leitura. Nenhuma credencial é retornada. |
GET /api/v1/billing/* | billing | Dados somente leitura de uso, custo e atualidade para o seu próprio workspace (requer uma chave de cobrança, não uma chave de API normal). |
POST /v1/mcp | mcp | Servidor MCP: todos os modelos, o gerenciamento de chaves de API e os dados de cobrança como ferramentas para agentes de IA (Claude Code, Cursor, Codex…), com a sua chave de API. |
Cada endpoint é cobrado pelo mesmo catálogo por token - veja a model price comparison para saber quanto custa cada modelo roteável.