API Hop

Documentação

Documentação do API Hop

Integração com Codex

Use o endpoint compatível com OpenAI Responses da RequestBeam no Codex CLI, na extensão do VS Code ou no aplicativo desktop.

O Codex chama modelos pelo protocolo OpenAI Responses. Configure o provedor do modelo com a URL base compatível com OpenAI mostrada nesta página.

text
Codex base_url: https://api.apihop.ai/openai

Pré-requisitos

Prepare primeiro uma chave de API RequestBeam válida. Ela será gravada no diretório local de configuração do Codex. Não a inclua em repositórios, registros ou capturas de tela.

O Codex normalmente armazena os arquivos de configuração em:

  • macOS / Linux: ~/.codex/
  • Windows: %userprofile%\.codex\

Se o diretório ou o arquivo de configuração não existir, crie-o primeiro:

bash
mkdir -p ~/.codex
touch ~/.codex/config.toml

Para Windows CMD:

bat
mkdir %userprofile%\.codex
type nul > %userprofile%\.codex\config.toml

Backup da configuração

Se você já usou o Codex, faça primeiro um backup da configuração atual:

bash
cp ~/.codex/config.toml ~/.codex/config.toml.bak
cp ~/.codex/auth.json ~/.codex/auth.json.bak

Atualizar config.toml

Abra ~/.codex/config.toml e adicione ou atualize esta configuração:

toml
model_provider = "requestbeam"
model = "gpt-5.4"
review_model = "gpt-5.4"
model_reasoning_effort = "high"
disable_response_storage = true
network_access = "enabled"

[model_providers.requestbeam]
name = "RequestBeam"
base_url = "https://api.apihop.ai/openai"
wire_api = "responses"
requires_openai_auth = true
supports_websockets = true
websocket_connect_timeout_ms = 15000

[features]
responses_websockets = true

A regra de base_url é: a URL base da API pública mostrada nesta página + /openai.

Se seu config.toml já contiver [marketplaces.*], [plugins.*] ou outras configurações de ferramentas, mantenha-as e adicione ou atualize somente as configurações do provedor de modelo do Codex acima.

Modo WebSocket

Quando supports_websockets = true e responses_websockets = true estão ativados, o Codex usa o endpoint Responses WebSocket abaixo:

text
https://api.apihop.ai/openai/responses

Se a URL base da API usar https://, o Codex usa a conexão wss:// correspondente.

Este modo WebSocket é uma ponte Responses-over-WebSocket específica do Codex:

  • Suporta response.create
  • Suporta response.cancel
  • Retorna response.completed
  • Também mantém o evento de compatibilidade response.processed

response.cancelled confirma a solicitação local de cancelamento. Não confirma um reembolso do provedor. Uma requisição com resultado desconhecido no provedor permanece reservada até que seu uso ou falha seja verificado.

Não é a API OpenAI Realtime. Não suporta session.update, conversation.item.*, input_audio_buffer.*, streaming de áudio, mensagens binárias ou envelopes Realtime.

Se um proxy de rede, gateway corporativo ou versão antiga do Codex não conseguir estabelecer conexões WebSocket, mude temporariamente para:

toml
[model_providers.requestbeam]
supports_websockets = false

[features]
responses_websockets = false

O Codex então usará HTTP POST https://api.apihop.ai/openai/responses como alternativa. Compact é uma capacidade separada: os cinco modelos GPT listados atualmente não têm um canal Compact verificado. Alternar entre HTTP e WebSocket não habilita a compactação. Inicie uma nova conversa antes de ultrapassar o limite de contexto do modelo; não dependa de compactação automática de contextos longos nestas rotas.

Gravar a chave de API

Substitua YOUR_REQUESTBEAM_API_KEY pela sua chave de API RequestBeam:

bash
echo '{"OPENAI_API_KEY":"YOUR_REQUESTBEAM_API_KEY"}' > ~/.codex/auth.json

Para Windows CMD:

bat
echo {"OPENAI_API_KEY":"YOUR_REQUESTBEAM_API_KEY"} > %userprofile%\.codex\auth.json

Reiniciar e testar

Salve a configuração, encerre completamente o Codex e abra-o novamente.

Você pode testar a CLI com:

bash
codex "Reply in one sentence whether the current model is available."

Para a extensão do VS Code ou o aplicativo desktop, encerre completamente o aplicativo, abra-o novamente e inicie um chat normal.

Solução de problemas

  • base_url deve ser a URL base da API pública mostrada nesta página mais /openai.
  • wire_api deve ser responses; não altere para chat.
  • Um erro de Compact indisponível significa que não há um canal Compact verificado; alterar um limite local de tokens não pode habilitá-lo.
  • A RequestBeam suporta HTTP Responses e Codex Responses WebSocket. Mantenha supports_websockets = true e responses_websockets = true por padrão. Se sua versão do Codex ou proxy de rede não conseguir usar WebSocket, defina temporariamente supports_websockets = false para usar HTTP.
  • auth.json deve ser um JSON válido, e o nome da chave deve ser OPENAI_API_KEY.
  • Se receber 401 ou invalid key, confirme que a chave de API é válida e não foi sobrescrita por uma chave local antiga.
  • Se o modelo estiver indisponível, consulte GET https://api.apihop.ai/v1/models e defina model e review_model como um modelo GPT visível. O exemplo padrão usa gpt-5.4; gpt-5.3-codex e gpt-5.6-luna não estão ativados atualmente.
  • Encerre completamente e reabra o Codex depois de alterar a configuração. Fechar apenas a janela pode não recarregar auth.json.
  • POST https://api.apihop.ai/openai/responses: endpoint recomendado da RequestBeam compatível com Responses.
  • POST https://api.apihop.ai/openai/responses/compact: exige um canal Compact explicitamente ativado; caso contrário, retorna 503 antes da reserva. Um canal compatível retorna response.compaction.
  • WS /openai/responses: endpoint compatível com Responses WebSocket. Suporta response.create e response.cancel, retorna response.completed e mantém o evento de compatibilidade response.processed.
  • WS /openai/responses/compact: usa a mesma verificação de capacidade Compact e o mesmo endpoint. Um handshake WebSocket, por si só, não comprova o suporte do modelo.