API Hop

Dokumentasi

Dokumentasi API Hop

Integrasi Codex

Gunakan endpoint kompatibel OpenAI Responses API Hop di Codex CLI, ekstensi VS Code, atau aplikasi desktop.

Codex memanggil model melalui protokol OpenAI Responses. Konfigurasikan penyedia model dengan URL Dasar kompatibel OpenAI yang ditampilkan di halaman ini.

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

Prasyarat

Siapkan API Key API Hop yang valid terlebih dahulu. Kunci akan ditulis ke direktori konfigurasi Codex lokal Anda. Jangan memasukkannya ke repositori, log, atau tangkapan layar.

Codex biasanya menyimpan file konfigurasi di:

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

Jika direktori atau file konfigurasi belum ada, buat terlebih dahulu:

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

Untuk Windows CMD:

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

Cadangkan Konfigurasi

Jika pernah menggunakan Codex, cadangkan konfigurasi saat ini terlebih dahulu:

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

Perbarui config.toml

Buka ~/.codex/config.toml, lalu tambahkan atau perbarui konfigurasi ini:

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

[model_providers.apihop]
name = "API Hop"
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

Aturan base_url adalah: URL Dasar API publik yang ditampilkan di halaman ini + /openai.

Jika config.toml Anda sudah berisi [marketplaces.*], [plugins.*], atau pengaturan alat lainnya, pertahankan dan hanya tambahkan atau perbarui pengaturan penyedia model Codex di atas.

Mode WebSocket

Saat supports_websockets = true dan responses_websockets = true diaktifkan, Codex menggunakan endpoint Responses WebSocket di bawah:

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

Jika URL Dasar API menggunakan https://, Codex menggunakan koneksi wss:// yang sesuai.

Mode WebSocket ini adalah penghubung Responses melalui WebSocket khusus Codex:

  • Mendukung response.create
  • Mendukung response.cancel
  • Mengembalikan response.completed
  • Juga mempertahankan peristiwa kompatibilitas response.processed

response.cancelled mengakui permintaan pembatalan lokal. Ini tidak mengonfirmasi pengembalian dana upstream. Permintaan yang hasil upstream-nya tidak diketahui tetap direservasi sampai penggunaan atau kegagalannya terverifikasi.

Ini bukan OpenAI Realtime API. Ini tidak mendukung session.update, conversation.item.*, input_audio_buffer.*, streaming audio, pesan biner, atau envelope Realtime.

Jika proksi jaringan, gateway perusahaan, atau versi Codex lama tidak dapat membuat koneksi WebSocket, ubah sementara ke:

toml
[model_providers.apihop]
supports_websockets = false

[features]
responses_websockets = false

Codex kemudian akan beralih ke HTTP POST https://api.apihop.ai/openai/responses. Compact adalah kemampuan terpisah: lima model GPT yang saat ini tercantum tidak memiliki kanal Compact terverifikasi. Mengganti mode HTTP/WebSocket tidak mengaktifkan pemadatan. Mulai percakapan baru sebelum melebihi batas konteks model; jangan bergantung pada pemadatan konteks panjang otomatis dengan rute ini.

Tulis API Key

Ganti YOUR_APIHOP_API_KEY dengan API Key API Hop Anda:

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

Untuk Windows CMD:

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

Mulai Ulang dan Uji

Simpan konfigurasi, tutup Codex sepenuhnya, lalu buka kembali.

Anda dapat menguji CLI dengan:

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

Untuk ekstensi VS Code atau aplikasi desktop, tutup aplikasi sepenuhnya, buka kembali, lalu mulai chat biasa.

Pemecahan Masalah

  • base_url harus berupa URL Dasar API publik yang ditampilkan di halaman ini ditambah /openai.
  • wire_api harus bernilai responses; jangan mengubahnya menjadi chat.
  • Kesalahan Compact tidak tersedia berarti tidak ada kanal Compact terverifikasi; mengubah ambang token lokal tidak dapat mengaktifkannya.
  • API Hop mendukung HTTP Responses dan Codex Responses WebSocket. Pertahankan supports_websockets = true dan responses_websockets = true sebagai bawaan. Jika versi Codex atau proksi jaringan Anda tidak dapat menggunakan WebSocket, atur sementara supports_websockets = false untuk beralih ke HTTP.
  • auth.json harus berupa JSON yang valid, dan nama kunci harus OPENAI_API_KEY.
  • Jika menerima 401 atau invalid key, pastikan API Key valid dan tidak ditimpa kunci lokal lama.
  • Jika model tidak tersedia, periksa GET https://api.apihop.ai/v1/models dan atur model serta review_model ke model GPT yang terlihat. Contoh bawaan menggunakan gpt-5.4; gpt-5.3-codex dan gpt-5.6-luna saat ini belum diaktifkan.
  • Tutup sepenuhnya dan buka kembali Codex setelah mengubah konfigurasi. Hanya menutup jendela mungkin tidak memuat ulang auth.json.
  • POST https://api.apihop.ai/openai/responses: endpoint kompatibel Responses API Hop yang direkomendasikan.
  • POST https://api.apihop.ai/openai/responses/compact: memerlukan kanal Compact yang diaktifkan secara eksplisit; jika tidak, mengembalikan 503 sebelum reservasi. Kanal yang didukung mengembalikan response.compaction.
  • WS /openai/responses: endpoint kompatibel Responses WebSocket. Mendukung response.create, response.cancel, mengembalikan response.completed, dan mempertahankan peristiwa kompatibilitas response.processed.
  • WS /openai/responses/compact: menggunakan pemeriksaan kemampuan dan endpoint Compact yang sama. Handshake WebSocket saja tidak membuktikan dukungan model.