API Hop

Dokumentation

API Hop-Dokumentation

Codex-Integration

Den OpenAI-Responses-kompatiblen Endpunkt von RequestBeam in Codex CLI, der VS-Code-Erweiterung oder der Desktop-App verwenden.

Codex ruft Modelle über das OpenAI-Responses-Protokoll auf. Konfigurieren Sie den Modellanbieter mit der auf dieser Seite angezeigten OpenAI-kompatiblen Basis-URL.

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

Voraussetzungen

Halten Sie zuerst einen gültigen RequestBeam-API-Schlüssel bereit. Er wird in Ihr lokales Codex-Konfigurationsverzeichnis geschrieben. Übernehmen Sie ihn nicht in Repositories, Protokolle oder Screenshots.

Codex speichert Konfigurationsdateien normalerweise unter:

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

Falls Verzeichnis oder Konfigurationsdatei fehlen, legen Sie sie zuerst an:

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

Für Windows CMD:

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

Konfiguration sichern

Haben Sie Codex bereits verwendet, sichern Sie zuerst die aktuelle Konfiguration:

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

config.toml aktualisieren

Öffnen Sie ~/.codex/config.toml und ergänzen oder aktualisieren Sie diese Konfiguration:

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

Für base_url gilt: die auf dieser Seite angezeigte öffentliche API-Basis-URL + /openai.

Enthält Ihre config.toml bereits [marketplaces.*], [plugins.*] oder andere Werkzeugeinstellungen, behalten Sie diese bei und ergänzen oder aktualisieren Sie nur die obigen Codex-Modellanbietereinstellungen.

WebSocket-Modus

Sind supports_websockets = true und responses_websockets = true aktiviert, verwendet Codex den folgenden Responses-WebSocket-Endpunkt:

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

Verwendet die API-Basis-URL https://, nutzt Codex die entsprechende wss://-Verbindung.

Dieser WebSocket-Modus ist eine Codex-spezifische Brücke für Responses über WebSocket:

  • Unterstützt response.create
  • Unterstützt response.cancel
  • Liefert response.completed
  • Behält außerdem das Kompatibilitätsereignis response.processed bei

response.cancelled bestätigt die lokale Abbruchanforderung. Es bestätigt keine Rückerstattung beim vorgelagerten Anbieter. Bei unbekanntem Anbieterergebnis bleibt der Betrag reserviert, bis Nutzung oder Fehlschlag geprüft wurden.

Dies ist nicht die OpenAI Realtime API. session.update, conversation.item.*, input_audio_buffer.*, Audiostreaming, Binärnachrichten und Realtime-Umschläge werden nicht unterstützt.

Kann ein Netzwerkproxy, Unternehmensgateway oder eine ältere Codex-Version keine WebSocket-Verbindung aufbauen, wechseln Sie vorübergehend zu:

toml
[model_providers.requestbeam]
supports_websockets = false

[features]
responses_websockets = false

Codex fällt dann auf HTTP POST https://api.apihop.ai/openai/responses zurück. Compact ist eine eigenständige Fähigkeit: Für die derzeit gelisteten fünf GPT-Modelle gibt es keinen verifizierten Compact-Kanal. Der Wechsel zwischen HTTP und WebSocket aktiviert keine Komprimierung. Beginnen Sie vor Überschreiten des Kontextlimits des Modells eine neue Unterhaltung; verlassen Sie sich bei diesen Routen nicht auf automatische Komprimierung langer Kontexte.

API-Schlüssel schreiben

Ersetzen Sie YOUR_REQUESTBEAM_API_KEY durch Ihren RequestBeam-API-Schlüssel:

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

Für Windows CMD:

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

Neustarten und testen

Speichern Sie die Konfiguration, beenden Sie Codex vollständig und öffnen Sie es erneut.

Sie können die CLI so testen:

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

Beenden Sie bei der VS-Code-Erweiterung oder Desktop-App die Anwendung vollständig, öffnen Sie sie erneut und starten Sie einen normalen Chat.

Fehlerbehebung

  • base_url muss die auf dieser Seite angezeigte öffentliche API-Basis-URL plus /openai sein.
  • wire_api muss responses sein; ändern Sie es nicht zu chat.
  • Ein Fehler wegen nicht verfügbarem Compact bedeutet, dass kein verifizierter Compact-Kanal vorhanden ist; eine lokale Tokenschwelle kann ihn nicht aktivieren.
  • RequestBeam unterstützt HTTP Responses und Codex Responses WebSocket. Behalten Sie standardmäßig supports_websockets = true und responses_websockets = true bei. Kann Ihre Codex-Version oder Ihr Netzwerkproxy kein WebSocket nutzen, setzen Sie vorübergehend supports_websockets = false, um auf HTTP zurückzufallen.
  • auth.json muss gültiges JSON sein, und der Schlüsselname muss OPENAI_API_KEY lauten.
  • Bei 401 oder invalid key prüfen Sie, ob der API-Schlüssel gültig ist und nicht von einem älteren lokalen Schlüssel überschrieben wurde.
  • Ist das Modell nicht verfügbar, prüfen Sie GET https://api.apihop.ai/v1/models und setzen Sie model sowie review_model auf ein sichtbares GPT-Modell. Das Standardbeispiel verwendet gpt-5.4; gpt-5.3-codex und gpt-5.6-luna sind derzeit nicht aktiviert.
  • Beenden und öffnen Sie Codex nach Konfigurationsänderungen vollständig neu. Nur das Fenster zu schließen lädt auth.json möglicherweise nicht neu.
  • POST https://api.apihop.ai/openai/responses: der empfohlene Responses-kompatible RequestBeam-Endpunkt.
  • POST https://api.apihop.ai/openai/responses/compact: erfordert einen ausdrücklich aktivierten Compact-Kanal; andernfalls wird vor der Reservierung 503 zurückgegeben. Ein unterstützter Kanal liefert response.compaction.
  • WS /openai/responses: Responses-WebSocket-kompatibler Endpunkt. Unterstützt response.create und response.cancel, liefert response.completed und behält das Kompatibilitätsereignis response.processed bei.
  • WS /openai/responses/compact: verwendet dieselbe Compact-Fähigkeitsprüfung und denselben Endpunkt. Ein WebSocket-Handshake allein belegt keine Modellunterstützung.