Menu dos Docs

Referência da API

v1· Atualizado em jul. de 2026

160+ modelos · 12 famílias de modelos

A WayJet é um gateway compatível com a OpenAI. Aponte qualquer SDK da OpenAI para a URL base abaixo, use uma chave de API sk- e chame todos os provedores por uma única API.

12 famílias de modelos

OpenAI, Anthropic, Gemini, Groq e mais, atrás de uma única API.

Compatível com a OpenAI

Aponte qualquer SDK da OpenAI para a URL base, sem mudar o código.

Streaming

SSE token a token em chat completions, pronto para usar.

Chaves e orçamentos

Chaves com escopo, limites de gasto por período e acompanhamento do uso.

Chame GET /v1/models com a sua chave para listar os modelos que o gateway oferece.

Introdução#

Toda requisição vai para uma única URL base. Como o gateway fala o formato da OpenAI, os SDKs e ferramentas que você já usa funcionam sem mudanças: basta trocar a URL base e a chave.

https://api.wayjet.ai/v1

Autenticação#

Autentique-se com um token Bearer no cabeçalho Authorization. Crie uma chave com o prefixo sk- na página de chaves de API: o segredo aparece só uma vez, então guarde-o em um lugar seguro.

header
Authorization: Bearer sk-xxxxxxxxxxxxxxxxxxxxxxxx
Nunca exponha uma chave em código do lado do cliente. Chame o gateway a partir do seu servidor ou por um proxy.
Criar uma chave de API

Início rápido#

Envie o seu primeiro chat completion. Defina WAYJET_API_KEY com a sua chave de API e rode como está, ou troque gpt-5.1 por qualquer id de modelo de GET /v1/models, que lista os modelos que a sua chave pode chamar.

curl https://api.wayjet.ai/v1/chat/completions \
  -H "Authorization: Bearer $WAYJET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.1",
    "messages": [{"role": "user", "content": "Hello"}]
  }'
Experimente no Playground

Chat completions#

POST /v1/chat/completions: o endpoint principal. Requisições e respostas seguem o esquema da OpenAI; o gateway acrescenta provider e cache_status à resposta.

ParâmetroTipoDescrição
model*stringUm id de modelo de GET /v1/models (gpt-5.1 nos exemplos)
messages*arrayMensagens da conversa (role + content)
streambooleanDevolve os tokens como server-sent events
temperaturenumberTemperatura de amostragem, 0–2 (padrão 1)
max_tokensintegerMáximo de tokens a gerar
top_pnumberMassa de probabilidade da amostragem nucleus
toolsarrayDefinições de funções/ferramentas que o modelo pode chamar
tool_choicestring | objectForça ou restringe a escolha de ferramenta
response_formatobjectex.: { "type": "json_object" } para o modo JSON
reasoning_effortstringlow · medium · high (modelos de raciocínio)
stopstring | arrayAté 4 sequências de parada
seedintegerAmostragem determinística na medida do possível
providerstringExclusivo do gateway: fixa a requisição em um provedor

* obrigatório

Streaming#

Defina stream: true para receber os tokens como server-sent events. Cada evento é uma linha data: com um delta; o fluxo termina com data: [DONE].

curl https://api.wayjet.ai/v1/chat/completions \
  -H "Authorization: Bearer $WAYJET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.1",
    "messages": [{"role": "user", "content": "Hello"}],
    "stream": true
  }'
# → server-sent events: lines of  data: {...}  terminated by  data: [DONE]

Cache de prompts#

Vários provedores guardam em cache o início de um prompt visto recentemente e cobram menos para processá-lo de novo. Na OpenAI, no Gemini e no DeepSeek isso acontece automaticamente: não precisa de nenhum parâmetro seu, e nem você nem a WayJet podem desativar. A Anthropic só usa cache quando a requisição pede.

Com a chave da plataforma, a WayJet só respeita `cache_control` em contas fixadas ao próprio workspace da Anthropic. Nos outros casos, o marcador é aceito e removido antes de a requisição chegar à Anthropic. A chamada funciona, mas o seu usage não traz tokens de cache e todo token de entrada é cobrado pela tarifa de entrada cheia, que é também o que a Anthropic cobra por ele. Com a sua própria chave da Anthropic, o marcador sempre passa.

Cada provedor traça o limite do cache no seu próprio cliente. Com uma chave da plataforma WayJet, esse cliente é a WayJet; por isso, nos três provedores automáticos, as suas requisições compartilham um espaço de cache com outras contas da WayJet durante a janela de reuso abaixo. O gateway devolve cache_status nos chat completions, mas ele indica se um prefixo foi reutilizado, não de quem era.

ProvedorCacheLimite do cacheJanela de reuso
OpenAIAutomáticoA organização: a da WayJet, com a chave da plataformaaté 30 min
GeminiAutomáticoO projeto do Google Cloud: o da WayJet, com a chave da plataformaaté 24 h
DeepSeekAutomáticoA conta: a da WayJet, com a chave da plataformade horas a dias
AnthropicSob demanda (cache_control), com a sua própria chave ou uma conta fixadaA sua própria conta (BYOK) ou o seu workspace fixado5 min
Claude no Bedrock / VertexSob demanda, só com credenciais própriasA conta da AWS / o projeto do GCP5 min

O que um cache compartilhado significa e o que não significa

Nenhum conteúdo de prompt ou de resposta atravessa um cache de prompts. Um acerto de cache é o provedor processando de novo, mais barato, um prefixo que o próprio chamador já enviou: não entrega o texto de ninguém a ninguém. O que um espaço compartilhado expõe é o tempo: alguém que já tenha um prefixo exato poderia, em teoria, deduzir de uma resposta mais rápida ou mais barata que ele foi enviado há pouco. Primeiro é preciso conhecer o prefixo, e é isso que limita o risco.

Publicamos isso porque você não consegue observar sozinho. A WayJet esconde de propósito qual provedor atendeu cada requisição, então nada na API ou no painel diria onde fica o limite do cache de um provedor. Se você revende inferência para os seus próprios usuários, esta é a resposta para a mesma pergunta, um nível abaixo.

Se você precisa de um espaço de cache só seu

Há dois caminhos, e são os únicos honestos: não existe nenhuma configuração por cliente na chave da plataforma que faça isso.

  • Use a sua própria chave. Adicione as suas próprias credenciais do provedor e o seu tráfego passa pela sua conta no provedor, com o limite do cache traçado em você. Funciona em todos os provedores e é a resposta completa.
  • Peça um workspace da Anthropic. Só para a Anthropic, podemos fixar a sua conta em um workspace próprio da Anthropic, para que o seu cache de prompts seja só seu enquanto você continua usando a chave da plataforma. É sob pedido e ativado por conta: não há chave de autoatendimento, e não vale para o Claude acessado pelo Bedrock ou pelo Vertex, que não têm equivalente. É também o que ativa o cache da Anthropic para uma conta na chave da plataforma.

Embeddings#

POST /v1/embeddings: vetoriza texto para busca e RAG. Aceita uma string ou um array de strings.

curl https://api.wayjet.ai/v1/embeddings \
  -H "Authorization: Bearer $WAYJET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "your-embedding-model",
    "input": "The quick brown fox"
  }'

Áudio (voz)#

POST /v1/audio/speech transforma texto em voz (cobrado por caractere de entrada), e POST /v1/audio/transcriptions transforma um arquivo de áudio em texto (cobrado por minuto de áudio). Os dois são compatíveis com a OpenAI.

Texto para fala

curl https://api.wayjet.ai/v1/audio/speech \
  -H "Authorization: Bearer $WAYJET_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "your-tts-model",
    "input": "The quick brown fox jumped over the lazy dog.",
    "voice": "alloy"
  }' \
  --output speech.mp3

Fala para texto

Envie o arquivo como multipart/form-data. Defina response_format como srt, vtt ou verbose_json para receber legendas com marcação de tempo em vez de texto puro.

curl https://api.wayjet.ai/v1/audio/transcriptions \
  -H "Authorization: Bearer $WAYJET_API_KEY" \
  -F "model=your-stt-model" \
  -F "file=@audio.mp3" \
  -F "response_format=json"   # json (default) · text · srt · vtt · verbose_json

Modelos#

GET /v1/models devolve o catálogo disponível para a sua chave, cada modelo com preço e capacidades. Use um id dessa lista como model em todos os exemplos desta página.

shell
curl https://api.wayjet.ai/v1/models \
  -H "Authorization: Bearer $WAYJET_API_KEY"
Ver todos os modelos

Ferramentas CLI (Claude Code, Codex)#

O gateway fala a API Messages da Anthropic (POST /v1/messages) e a API Responses da OpenAI (POST /v1/responses), então as CLIs de programação mais usadas apontam direto para a WayJet e cobram pela sua própria chave, sem proxy nem SDK de cada provedor. Aponte cada ferramenta para um modelo que você pode chamar.

O que é um squad?

Um squad é um nome de modelo que você chama: um produto com nome no gateway, que responde com esse nome. Use um nome de squad em qualquer lugar onde vai um nome de modelo. GET /v1/models lista os que a sua chave pode chamar. Os nomes de modelo das configurações abaixo são squads, então funcionam como estão.

Claude Code

Adicione ao ~/.claude/settings.json. A chave vai em ANTHROPIC_AUTH_TOKEN (ou em ANTHROPIC_API_KEY como cabeçalho x-api-key), e cada nível corresponde a um modelo à sua escolha.

~/.claude/settings.json
{
  "hasCompletedOnboarding": true,
  "env": {
    "ANTHROPIC_BASE_URL": "https://api.wayjet.ai",
    "ANTHROPIC_AUTH_TOKEN": "sk-your-key",
    "ANTHROPIC_DEFAULT_OPUS_MODEL": "claude-opus-5",
    "ANTHROPIC_DEFAULT_SONNET_MODEL": "claude-sonnet-5",
    "ANTHROPIC_DEFAULT_HAIKU_MODEL": "claude-haiku-4-5-20251001"
  }
}

Codex

O Codex usa a API Responses da OpenAI por padrão: não precisa de wire_api = "chat".

~/.codex/config.toml
model = "gpt-5.1"
model_provider = "wayjet"

[model_providers.wayjet]
name = "WayJet"
base_url = "https://api.wayjet.ai/v1"
wire_api = "responses"
~/.codex/auth.json
{
  "auth_mode": "apikey",
  "OPENAI_API_KEY": "sk-your-key"
}

O Claude Code e o Codex enviam cada requisição ao único modelo que nomeiam.

Erros#

Os erros usam códigos de status HTTP padrão e uma estrutura no estilo da OpenAI.

json
{
  "error": {
    "message": "Incorrect API key provided.",
    "type": "authentication_error",
    "code": null,
    "param": null
  }
}
StatusTipoSignificado
200OKA requisição deu certo
400invalid_request_errorRequisição malformada ou parâmetros inválidos
401authentication_errorChave de API ausente, inválida ou revogada
403permission_errorA chave não tem permissão para esta ação
404not_found_errorModelo ou recurso desconhecido
429rate_limit_errorLimite de taxa atingido, ou orçamento estourado
500api_errorErro inesperado do gateway
Ver o seu uso e os seus limites

Endpoints#

Os endpoints que você pode chamar com uma chave de API. Chaves, uso e orçamentos são gerenciados no painel.

MétodoEndpointDescrição
POST/v1/chat/completionsChat completion (com e sem streaming)
POST/v1/messagesFormato Messages da Anthropic (com e sem streaming; x-api-key ou Bearer)
POST/v1/responsesFormato Responses da OpenAI (com e sem streaming). Sem estado: previous_response_id é ignorado, então envie a conversa inteira a cada vez
GET/v1/generationCusto e tokens de uma requisição, pelo seu X-Wayjet-Request-Id (?id=)
POST/v1/embeddingsCriar embeddings
POST/v1/audio/speechTexto para fala (sai áudio)
POST/v1/audio/transcriptionsFala para texto (transcrição)
GET/v1/modelsListar os modelos disponíveis

Registro de alterações#

Mudanças importantes da API pública. A URL base continua /v1 por compatibilidade.

  • jul. de 2026Ferramentas CLI: use o Claude Code (/v1/messages) e o Codex (/v1/responses) diretamente. Estatísticas de geração (/v1/generation).
  • jul. de 2026Áudio: texto para fala (/v1/audio/speech) e fala para texto (/v1/audio/transcriptions, com formatos srt/vtt/verbose_json).
  • jun. de 2026reasoning_effort adicionado.
  • mai. de 2026Endpoint de embeddings e modo JSON (response_format).
  • abr. de 2026Streaming (SSE) em chat completions; fixação de provedor.
Registro completo