API Hop

Belgeler

API Hop Belgeleri

Codex entegrasyonu

Codex CLI, VS Code uzantısı veya masaüstü uygulamasında RequestBeam’in OpenAI Responses uyumlu uç noktasını kullanın.

Codex, modelleri OpenAI Responses protokolü üzerinden çağırır. Model sağlayıcısını bu sayfada gösterilen OpenAI uyumlu temel URL ile yapılandırın.

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

Ön koşullar

Önce geçerli bir RequestBeam API anahtarı hazırlayın. Anahtar yerel Codex yapılandırma dizininize yazılacaktır. Depolara, günlüklere veya ekran görüntülerine eklemeyin.

Codex genellikle yapılandırma dosyalarını şu konumlarda saklar:

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

Dizin veya yapılandırma dosyası yoksa önce oluşturun:

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

Windows CMD için:

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

Yapılandırmayı yedekleme

Codex’i daha önce kullandıysanız önce geçerli yapılandırmayı yedekleyin:

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

config.toml güncelleme

~/.codex/config.toml dosyasını açın ve şu yapılandırmayı ekleyin veya güncelleyin:

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

base_url kuralı: bu sayfada gösterilen genel API temel URL’si + /openai.

config.toml dosyanız zaten [marketplaces.*], [plugins.*] veya başka araç ayarları içeriyorsa bunları koruyun; yalnızca yukarıdaki Codex model sağlayıcısı ayarlarını ekleyin veya güncelleyin.

WebSocket modu

supports_websockets = true ve responses_websockets = true etkinleştirildiğinde Codex aşağıdaki Responses WebSocket uç noktasını kullanır:

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

API temel URL’si https:// kullanıyorsa Codex karşılık gelen wss:// bağlantısını kullanır.

Bu WebSocket modu, Codex’e özel bir Responses-over-WebSocket köprüsüdür:

  • response.create desteklenir
  • response.cancel desteklenir
  • response.completed döndürülür
  • response.processed uyumluluk olayı da korunur

response.cancelled, yerel iptal isteğini onaylar. Üst sağlayıcının geri ödeme yaptığını doğrulamaz. Üst sağlayıcı sonucu bilinmeyen bir isteğin rezervasyonu, kullanımı veya başarısızlığı doğrulanana kadar sürer.

Bu, OpenAI Realtime API değildir. session.update, conversation.item.*, input_audio_buffer.*, ses akışı, ikili iletiler veya Realtime zarfları desteklenmez.

Bir ağ proxy’si, kurumsal ağ geçidi veya eski Codex sürümü WebSocket bağlantısı kuramıyorsa geçici olarak şu ayarlara geçin:

toml
[model_providers.requestbeam]
supports_websockets = false

[features]
responses_websockets = false

Codex ardından HTTP POST https://api.apihop.ai/openai/responses kullanır. Compact ayrı bir yetenektir: şu anda listelenen beş GPT modelinin doğrulanmış Compact kanalı yoktur. HTTP/WebSocket modlarını değiştirmek sıkıştırmayı etkinleştirmez. Modelin bağlam sınırını aşmadan yeni bir konuşma başlatın; bu rotalarda otomatik uzun bağlam sıkıştırmasına güvenmeyin.

API anahtarını yazma

YOUR_REQUESTBEAM_API_KEY değerini kendi RequestBeam API anahtarınızla değiştirin:

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

Windows CMD için:

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

Yeniden başlatma ve test

Yapılandırmayı kaydedin, Codex’i tamamen kapatın ve yeniden açın.

CLI’yi şu komutla test edebilirsiniz:

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

VS Code uzantısı veya masaüstü uygulaması için uygulamayı tamamen kapatıp yeniden açın ve normal bir sohbet başlatın.

Sorun giderme

  • base_url, bu sayfada gösterilen genel API temel URL’si ile /openai birleşimi olmalıdır.
  • wire_api, responses olmalıdır; chat olarak değiştirmeyin.
  • Compact kullanılamıyor hatası, doğrulanmış Compact kanalı bulunmadığını belirtir; yerel token eşiğini değiştirmek bunu etkinleştirmez.
  • RequestBeam hem HTTP Responses hem Codex Responses WebSocket destekler. Varsayılan olarak supports_websockets = true ve responses_websockets = true değerlerini koruyun. Codex sürümünüz veya ağ proxy’niz WebSocket kullanamıyorsa HTTP’ye dönmek için geçici olarak supports_websockets = false ayarlayın.
  • auth.json geçerli JSON olmalı ve anahtar adı OPENAI_API_KEY olmalıdır.
  • 401 veya invalid key alırsanız API anahtarının geçerli olduğunu ve eski bir yerel anahtar tarafından üzerine yazılmadığını doğrulayın.
  • Model kullanılamıyorsa GET https://api.apihop.ai/v1/models yanıtını kontrol edin; model ve review_model değerlerini görünür bir GPT modeline ayarlayın. Varsayılan örnek gpt-5.4 kullanır; gpt-5.3-codex ve gpt-5.6-luna şu anda etkin değildir.
  • Yapılandırmayı değiştirdikten sonra Codex’i tamamen kapatıp yeniden açın. Yalnızca pencereyi kapatmak auth.json dosyasını yeniden yüklemeyebilir.
  • POST https://api.apihop.ai/openai/responses: önerilen RequestBeam Responses uyumlu uç noktası.
  • POST https://api.apihop.ai/openai/responses/compact: açıkça etkinleştirilmiş bir Compact kanalı gerektirir; aksi halde rezervasyondan önce 503 döndürür. Desteklenen kanal response.compaction döndürür.
  • WS /openai/responses: Responses WebSocket uyumlu uç nokta. response.create ve response.cancel desteklenir, response.completed döndürülür ve response.processed uyumluluk olayı korunur.
  • WS /openai/responses/compact: aynı Compact yetenek kontrolünü ve uç noktasını kullanır. Yalnızca WebSocket el sıkışması model desteğini kanıtlamaz.