API Hop

Документация

Документация API Hop

Интеграция Codex

Используйте совместимый с OpenAI Responses эндпоинт RequestBeam в Codex CLI, расширении VS Code или настольном приложении.

Codex вызывает модели по протоколу OpenAI Responses. Настройте провайдера модели с помощью совместимого с OpenAI базового URL, указанного на этой странице.

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

Предварительные условия

Сначала подготовьте действующий ключ API RequestBeam. Он будет записан в локальный каталог конфигурации 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 = "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: базовый URL публичного API на этой странице + /openai.

Если в config.toml уже есть [marketplaces.*], [plugins.*] или другие настройки инструментов, сохраните их и добавьте либо обновите только приведённые выше настройки провайдера модели Codex.

Режим WebSocket

Когда включены supports_websockets = true и responses_websockets = true, Codex использует следующий эндпоинт Responses WebSocket:

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

Если базовый URL API использует https://, Codex применяет соответствующее соединение wss://.

Этот режим WebSocket — специальный мост Responses-over-WebSocket для Codex:

  • Поддерживает 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.requestbeam]
supports_websockets = false

[features]
responses_websockets = false

Тогда Codex перейдёт на HTTP POST https://api.apihop.ai/openai/responses. Compact — отдельная возможность: у пяти перечисленных сейчас моделей GPT нет проверенного канала Compact. Переключение между HTTP и WebSocket не включает сжатие. Начинайте новый разговор до превышения лимита контекста модели; не полагайтесь на автоматическое сжатие длинного контекста на этих маршрутах.

Запись ключа API

Замените YOUR_REQUESTBEAM_API_KEY своим ключом API RequestBeam:

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

Для Windows CMD:

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

Перезапуск и проверка

Сохраните конфигурацию, полностью закройте Codex и откройте его снова.

Проверить CLI можно так:

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

Для расширения VS Code или настольного приложения полностью закройте приложение, откройте его снова и начните обычный чат.

Устранение неполадок

  • base_url должен быть базовым URL публичного API на этой странице с добавлением /openai.
  • wire_api должен иметь значение responses; не меняйте его на chat.
  • Ошибка недоступности Compact означает отсутствие проверенного канала Compact; изменение локального порога токенов не может его включить.
  • RequestBeam поддерживает HTTP Responses и Codex Responses WebSocket. По умолчанию сохраняйте supports_websockets = true и responses_websockets = true. Если версия Codex или сетевой прокси не может использовать WebSocket, временно задайте supports_websockets = false, чтобы перейти на HTTP.
  • 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: рекомендуемый совместимый с Responses эндпоинт RequestBeam.
  • 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-рукопожатие не доказывает поддержку модели.