Документация API, Byesu Code

START

Быстрый старт

Byesu Code API используется как OpenAI-compatible endpoint для приложений, которые пишут, объясняют и изменяют код.

Адрес Base URL: https://code.byesu.com/v1

Перед запуском Проверьте ключ, base URL и доступность модели для вашего тарифа.

Получите API-ключ в кабинете Byesu Code и храните его в переменной окружения, а не в коде проекта.
Для обычных HTTP-клиентов используйте заголовок Authorization: Bearer <API_KEY>.
Для генерации ответа отправьте messages и model в POST /v1/chat/completions.
Для coding-агентов сначала выбирайте модели семейства Codex, Sonnet или Opus, затем снижайте стоимость через более лёгкую модель для коротких задач.

Минимальный запрос

curl https://code.byesu.com/v1/chat/completions \
  -H "Authorization: Bearer sk-byesu_..." \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.3-codex",
    "messages": [
      { "role": "system", "content": "Ты помогаешь писать безопасный production-код." },
      { "role": "user", "content": "Напиши функцию debounce на TypeScript." }
    ]
  }'

KEY

Авторизация

API-ключ передаётся в каждом запросе. Для локальных инструментов удобнее хранить ключ в переменной BYESU_API_KEY.

Перед запуском Проверьте ключ, base URL и доступность модели для вашего тарифа.

Не коммитьте API-ключи в репозиторий, .env, историю терминала и публичные issue.
На Windows задайте ключ через PowerShell: $env:BYESU_API_KEY="sk-byesu_...".
На macOS и Linux задайте ключ через shell: export BYESU_API_KEY="sk-byesu_...".
Если инструмент ожидает переменную OPENAI_API_KEY, можно временно передать туда тот же ключ, но для командной работы лучше использовать отдельное имя BYESU_API_KEY.

PowerShell

$env:BYESU_API_KEY = "sk-byesu_..."
$env:OPENAI_API_KEY = $env:BYESU_API_KEY

Bash

export BYESU_API_KEY="sk-byesu_..."
export OPENAI_API_KEY="$BYESU_API_KEY"

POST

Генерация кода

Основной метод для IDE, CLI-агентов и собственных приложений: отправьте историю сообщений и получите ответ модели.

Адрес POST /v1/chat/completions

Перед запуском Проверьте ключ, base URL и доступность модели для вашего тарифа.

model: идентификатор модели из списка доступных моделей Byesu Code.
messages: массив сообщений system, user и assistant.
temperature: ниже для предсказуемого кода, выше для вариантов и идей.
stream: true, если приложение должно показывать ответ по мере генерации.

JavaScript

const response = await fetch("https://code.byesu.com/v1/chat/completions", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.BYESU_API_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    model: "gpt-5.3-codex",
    temperature: 0.2,
    messages: [
      { role: "system", content: "Отвечай коротко и показывай готовый код." },
      { role: "user", content: "Сделай React hook для localStorage." }
    ]
  })
});

const data = await response.json();
const answer = data.choices[0].message.content;

LIST

Модели

Используйте модели из вашей группы доступа. Для задач разработки лучше начинать с coding-моделей и Claude Sonnet.

Адрес GET /v1/models

Перед запуском Проверьте ключ, base URL и доступность модели для вашего тарифа.

gpt-5.3-codex: основной выбор для agentic coding, рефакторинга и code review.
gpt-5.4 или gpt-5.5: универсальные модели для объяснений, архитектуры и сложных текстовых задач.
claude-sonnet-4-6: сильный вариант для правок в больших кодовых базах, если модель доступна вашему ключу.
claude-opus-4-8: используйте для самых сложных задач, где качество важнее стоимости.
Точные ставки и доступные группы смотрите на странице цен.

Получить список моделей

curl https://code.byesu.com/v1/models \
  -H "Authorization: Bearer sk-byesu_..."

SSE

Streaming

Streaming нужен редакторам и CLI-агентам, чтобы показывать ответ постепенно и быстрее реагировать на длинные генерации.

Перед запуском Проверьте ключ, base URL и доступность модели для вашего тарифа.

Передайте stream: true в запрос chat completions.
Клиент должен читать Server-Sent Events до финального события [DONE].
Если ваше приложение не умеет читать поток, используйте обычный запрос без stream.

Запрос с потоком

{
  "model": "gpt-5.3-codex",
  "stream": true,
  "messages": [
    { "role": "user", "content": "Проведи code review этого diff." }
  ]
}

CLI

Интеграция с Codex

Codex можно подключить через кастомный OpenAI-compatible provider в config.toml.

Перед запуском Проверьте ключ, base URL и доступность модели для вашего тарифа.

Откройте пользовательский файл ~/.codex/config.toml или проектный .codex/config.toml.
Задайте model_provider и добавьте provider с base_url Byesu Code.
Ключ храните в BYESU_API_KEY, чтобы не смешивать его с другими OpenAI-ключами.
После изменения конфига перезапустите Codex-сессию.

~/.codex/config.toml

model = "gpt-5.3-codex"
model_provider = "byesu"

[model_providers.byesu]
name = "Byesu Code"
base_url = "https://code.byesu.com/v1"
env_key = "BYESU_API_KEY"

CLAUDE

Интеграция с Claude Code

Claude Code использует Anthropic-compatible протокол. Подключайте его только к Anthropic-compatible адресу Byesu Code.

Перед запуском Проверьте ключ, base URL и доступность модели для вашего тарифа.

Если ваш Byesu-ключ доступен только через OpenAI-compatible /v1, используйте Codex или OpenCode.
Для Claude Code нужен Anthropic-compatible base URL, который выдаётся в кабинете или поддержке Byesu Code.
ANTHROPIC_AUTH_TOKEN передаётся как Bearer-токен, а ANTHROPIC_MODEL выбирает модель.
CLAUDE_CODE_ENABLE_GATEWAY_MODEL_DISCOVERY=1 включает выбор моделей через gateway, если endpoint поддерживает /v1/models.

PowerShell

$env:ANTHROPIC_AUTH_TOKEN = "sk-byesu_..."
$env:ANTHROPIC_BASE_URL = "https://code.byesu.com"
$env:ANTHROPIC_MODEL = "claude-sonnet-4-6"
$env:CLAUDE_CODE_ENABLE_GATEWAY_MODEL_DISCOVERY = "1"
claude

.claude/settings.json

{
  "env": {
    "ANTHROPIC_AUTH_TOKEN": "sk-byesu_...",
    "ANTHROPIC_BASE_URL": "https://code.byesu.com",
    "ANTHROPIC_MODEL": "claude-sonnet-4-6",
    "CLAUDE_CODE_ENABLE_GATEWAY_MODEL_DISCOVERY": "1"
  }
}

OPEN

Интеграция с OpenCode

OpenCode поддерживает кастомные OpenAI-compatible providers через opencode.json.

Перед запуском Проверьте ключ, base URL и доступность модели для вашего тарифа.

Сохраните ключ через /connect или передайте его через переменную окружения BYESU_API_KEY.
Добавьте provider byesu с npm-пакетом @ai-sdk/openai-compatible.
В model используйте формат byesu/<model-id>.
Добавьте в models только те модели, которые доступны вашему ключу.

opencode.json

{
  "$schema": "https://opencode.ai/config.json",
  "model": "byesu/gpt-5.3-codex",
  "small_model": "byesu/gpt-5.4-mini",
  "provider": {
    "byesu": {
      "npm": "@ai-sdk/openai-compatible",
      "name": "Byesu Code",
      "options": {
        "baseURL": "https://code.byesu.com/v1",
        "apiKey": "{env:BYESU_API_KEY}"
      },
      "models": {
        "gpt-5.3-codex": {
          "name": "GPT-5.3-Codex"
        },
        "gpt-5.4-mini": {
          "name": "GPT-5.4 Mini"
        },
        "claude-sonnet-4-6": {
          "name": "Claude Sonnet 4.6"
        }
      }
    }
  }
}

HELP

Ошибки и диагностика

Большинство проблем интеграции связано с неверным base URL, отсутствующим ключом или моделью вне группы доступа.

Перед запуском Проверьте ключ, base URL и доступность модели для вашего тарифа.

401 Unauthorized: ключ не передан, неверен или лежит не в той переменной окружения.
403 Forbidden: ключ действителен, но модель или группа доступа недоступна.
404 Not Found: проверьте base URL и путь endpoint. Для OpenAI-compatible клиентов обычно нужен /v1.
429 Too Many Requests: снизьте параллельность, добавьте retry с backoff.
insufficient_balance: пополните баланс API-ключа и повторите запрос.
model_not_found: проверьте точный model id на странице цен или через GET /v1/models.

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