API Hop

दस्तावेज़

API Hop दस्तावेज़

Codex एकीकरण

Codex CLI, VS Code एक्सटेंशन या डेस्कटॉप ऐप में API Hop का OpenAI Responses-संगत एंडपॉइंट इस्तेमाल करें।

Codex, OpenAI Responses प्रोटोकॉल से मॉडल कॉल करता है। इस पृष्ठ के OpenAI-संगत Base URL से मॉडल प्रदाता कॉन्फ़िगर करें।

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

पूर्वापेक्षाएँ

पहले वैध API Hop API कुंजी तैयार करें। कुंजी आपकी स्थानीय Codex कॉन्फ़िगरेशन डायरेक्टरी में लिखी जाएगी। उसे रिपॉज़िटरी, लॉग या स्क्रीनशॉट में न डालें।

Codex आम तौर पर कॉन्फ़िगरेशन फ़ाइलें यहाँ रखता है:

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

डायरेक्टरी या कॉन्फ़िगरेशन फ़ाइल न हो तो पहले बनाएँ:

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

Windows CMD के लिए:

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

कॉन्फ़िगरेशन का बैकअप लें

पहले Codex इस्तेमाल किया हो तो वर्तमान कॉन्फ़िगरेशन का बैकअप पहले लें:

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

config.toml अपडेट करें

~/.codex/config.toml खोलें, फिर यह कॉन्फ़िगरेशन जोड़ें या अपडेट करें:

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

base_url का नियम है: इस पृष्ठ का सार्वजनिक API Base URL + /openai।

आपके config.toml में पहले से [marketplaces.*], [plugins.*] या दूसरी टूल सेटिंग हों तो उन्हें रखें और केवल ऊपर की Codex मॉडल प्रदाता सेटिंग जोड़ें या अपडेट करें।

WebSocket मोड

supports_websockets = true और responses_websockets = true चालू हों तो Codex नीचे का Responses WebSocket एंडपॉइंट इस्तेमाल करता है:

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

API Base URL में https:// हो तो Codex संबंधित wss:// कनेक्शन इस्तेमाल करता है।

यह WebSocket मोड Codex-विशिष्ट Responses-over-WebSocket ब्रिज है:

  • response.create समर्थित है
  • response.cancel समर्थित है
  • response.completed लौटाता है
  • response.processed संगतता इवेंट भी रखता है

response.cancelled स्थानीय रद्द अनुरोध की पुष्टि करता है। यह अपस्ट्रीम रिफ़ंड की पुष्टि नहीं करता। अपस्ट्रीम परिणाम अज्ञात हो तो अनुरोध का आरक्षण उसके उपयोग या विफलता के सत्यापन तक बना रहता है।

यह OpenAI Realtime API नहीं है। यह session.update, conversation.item.*, input_audio_buffer.*, ऑडियो स्ट्रीमिंग, बाइनरी संदेश या Realtime अनुरोध संरचनाएँ समर्थित नहीं करता।

नेटवर्क प्रॉक्सी, कंपनी गेटवे या पुराना Codex संस्करण WebSocket कनेक्शन न बना सके तो अस्थायी रूप से बदलें:

toml
[model_providers.apihop]
supports_websockets = false

[features]
responses_websockets = false

फिर Codex, HTTP POST https://api.apihop.ai/openai/responses पर लौटेगा। Compact अलग क्षमता है: वर्तमान सूची के पाँच GPT मॉडल का कोई सत्यापित Compact चैनल नहीं है। HTTP/WebSocket मोड बदलने से compaction चालू नहीं होता। मॉडल की संदर्भ सीमा पार करने से पहले नई बातचीत शुरू करें; इन रूट पर लंबे संदर्भ के स्वचालित compaction पर निर्भर न रहें।

API कुंजी लिखें

YOUR_APIHOP_API_KEY को अपनी API Hop API कुंजी से बदलें:

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

Windows CMD के लिए:

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

पुनः आरंभ करें और परखें

कॉन्फ़िगरेशन सहेजें, Codex पूरी तरह बंद करें, फिर दोबारा खोलें।

CLI को इससे परख सकते हैं:

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

VS Code एक्सटेंशन या डेस्कटॉप ऐप में ऐप पूरी तरह बंद करके फिर खोलें और सामान्य चैट शुरू करें।

समस्या निदान

  • base_url इस पृष्ठ का सार्वजनिक API Base URL और /openai होना चाहिए।
  • wire_api को responses रखें; chat न करें।
  • Compact अनुपलब्ध त्रुटि का अर्थ सत्यापित Compact चैनल नहीं है; स्थानीय टोकन सीमा बदलकर उसे चालू नहीं कर सकते।
  • API Hop, HTTP Responses और Codex Responses WebSocket दोनों समर्थित करता है। डिफ़ॉल्ट रूप से supports_websockets = true और responses_websockets = true रखें। Codex संस्करण या नेटवर्क प्रॉक्सी WebSocket न इस्तेमाल कर सके तो HTTP पर लौटने के लिए अस्थायी supports_websockets = false सेट करें।
  • auth.json वैध JSON और कुंजी नाम OPENAI_API_KEY होना चाहिए।
  • 401 या invalid key मिले तो पुष्टि करें API कुंजी वैध है और पुरानी स्थानीय कुंजी ने उसे ओवरराइट नहीं किया।
  • मॉडल अनुपलब्ध हो तो GET https://api.apihop.ai/v1/models जाँचें और model तथा review_model को दिखने वाले GPT मॉडल पर सेट करें। डिफ़ॉल्ट उदाहरण में gpt-5.4 है; gpt-5.3-codex और gpt-5.6-luna फिलहाल चालू नहीं हैं।
  • कॉन्फ़िगरेशन बदलने के बाद Codex पूरी तरह बंद करके खोलें। केवल विंडो बंद करने से auth.json फिर लोड न हो सकता है।
  • POST https://api.apihop.ai/openai/responses: सुझाया API Hop Responses-संगत एंडपॉइंट।
  • POST https://api.apihop.ai/openai/responses/compact: स्पष्ट चालू Compact चैनल चाहिए; अन्यथा आरक्षण से पहले 503 लौटाता है। समर्थित चैनल response.compaction देता है।
  • WS /openai/responses: Responses WebSocket-संगत एंडपॉइंट। यह response.create, response.cancel समर्थित करता है, response.completed लौटाता है और response.processed संगतता इवेंट रखता है।
  • WS /openai/responses/compact: वही Compact क्षमता जाँच और एंडपॉइंट इस्तेमाल करता है। केवल WebSocket हैंडशेक मॉडल समर्थन का प्रमाण नहीं।