API Hop

Documentación

Documentación de API Hop

Integración de Codex

Usa el endpoint de RequestBeam compatible con OpenAI Responses en Codex CLI, la extensión de VS Code o la aplicación de escritorio.

Codex llama a los modelos mediante el protocolo OpenAI Responses. Configura el proveedor del modelo con la URL base compatible con OpenAI indicada en esta página.

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

Requisitos previos

Prepara primero una clave de API válida de RequestBeam. La clave se guardará en el directorio local de configuración de Codex. No la incluyas en repositorios, registros ni capturas de pantalla.

Codex suele guardar los archivos de configuración en:

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

Si el directorio o el archivo de configuración no existe, créalo primero:

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

Para CMD de Windows:

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

Copia de seguridad de la configuración

Si ya has usado Codex, haz primero una copia de la configuración actual:

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

Actualizar config.toml

Abre ~/.codex/config.toml y añade o actualiza esta configuración:

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

La regla de base_url es: la URL base pública de la API indicada en esta página + /openai.

Si tu config.toml ya contiene [marketplaces.*], [plugins.*] u otros ajustes de herramientas, consérvalos y solo añade o actualiza los ajustes del proveedor de modelos de Codex anteriores.

Modo WebSocket

Cuando se activan supports_websockets = true y responses_websockets = true, Codex usa el endpoint WebSocket de Responses mostrado a continuación:

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

Si la URL base usa https://, Codex utiliza la conexión wss:// correspondiente.

Este modo WebSocket es un puente de Responses sobre WebSocket específico de Codex:

  • Admite response.create
  • Admite response.cancel
  • Devuelve response.completed
  • También conserva el evento de compatibilidad response.processed

response.cancelled confirma la solicitud local de cancelación. No confirma un reembolso del proveedor. Una solicitud cuyo resultado del proveedor se desconoce mantiene la reserva hasta verificar su uso o fallo.

No es la API OpenAI Realtime. No admite session.update, conversation.item.*, input_audio_buffer.*, streaming de audio, mensajes binarios ni envoltorios Realtime.

Si un proxy de red, pasarela corporativa o versión antigua de Codex no puede establecer conexiones WebSocket, cambia temporalmente a:

toml
[model_providers.requestbeam]
supports_websockets = false

[features]
responses_websockets = false

Codex pasará entonces a HTTP POST https://api.apihop.ai/openai/responses. Compact es una capacidad independiente: los cinco modelos GPT actualmente listados no tienen un canal Compact verificado. Cambiar entre HTTP y WebSocket no activa la compactación. Inicia una conversación nueva antes de superar el límite de contexto del modelo; no dependas de la compactación automática de contexto largo con estas rutas.

Guardar la clave de API

Sustituye YOUR_REQUESTBEAM_API_KEY por tu clave de API de RequestBeam:

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

Para CMD de Windows:

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

Reiniciar y probar

Guarda la configuración, cierra completamente Codex y vuelve a abrirlo.

Puedes probar la CLI con:

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

Para la extensión de VS Code o la aplicación de escritorio, cierra completamente la aplicación, ábrela de nuevo e inicia un chat normal.

Resolución de problemas

  • base_url debe ser la URL base pública indicada en esta página más /openai.
  • wire_api debe ser responses; no lo cambies a chat.
  • Un error de Compact no disponible indica que no existe un canal Compact verificado; cambiar un umbral local de tokens no puede activarlo.
  • RequestBeam admite HTTP Responses y Codex Responses WebSocket. Mantén supports_websockets = true y responses_websockets = true por defecto. Si tu versión de Codex o proxy no puede usar WebSocket, establece temporalmente supports_websockets = false para pasar a HTTP.
  • auth.json debe ser JSON válido y el nombre de la clave debe ser OPENAI_API_KEY.
  • Si recibes 401 o invalid key, confirma que la clave es válida y no ha sido sobrescrita por una clave local antigua.
  • Si el modelo no está disponible, consulta GET https://api.apihop.ai/v1/models y establece model y review_model en un modelo GPT visible. El ejemplo predeterminado usa gpt-5.4; gpt-5.3-codex y gpt-5.6-luna no están activados actualmente.
  • Cierra completamente y vuelve a abrir Codex tras cambiar la configuración. Cerrar solo la ventana puede no recargar auth.json.
  • POST https://api.apihop.ai/openai/responses: endpoint recomendado de RequestBeam compatible con Responses.
  • POST https://api.apihop.ai/openai/responses/compact: requiere un canal Compact activado explícitamente; en caso contrario devuelve 503 antes de reservar saldo. Un canal compatible devuelve response.compaction.
  • WS /openai/responses: endpoint compatible con Responses WebSocket. Admite response.create y response.cancel, devuelve response.completed y conserva el evento de compatibilidad response.processed.
  • WS /openai/responses/compact: usa la misma comprobación de capacidad Compact y endpoint. Un establecimiento de conexión WebSocket, por sí solo, no demuestra la compatibilidad del modelo.