# CLODEX Docs V2

> Машиночитаемая документация CLODEX API: протоколы, модели, SDK, CLI, биллинг, надёжность и безопасность.

- Обновлено: 2026-10-01
- OpenAI-compatible base URL: `https://clodex.xyz/v1`
- Anthropic-compatible base URL: `https://clodex.xyz`
- JSON: [https://clodex.xyz/docs-v2.json](https://clodex.xyz/docs-v2.json)

## Разделы

### Обзор платформы {#overview}

Единый API gateway для GPT, Claude, Gemini, Grok и других моделей.

CLODEX предоставляет единый аккаунт, API-ключи, баланс, usage-логи и маршруты OpenAI-compatible и Anthropic-compatible.

Доступность, лимиты и цены зависят от группы пользователя, ключа и активных каналов. Источник истины — /pricing и авторизованный /v1/models.

Связанные ссылки:

- /pricing
- /docs
- /v1/models

### Быстрый старт {#quickstart}

Создайте ключ и выполните первый запрос через OpenAI SDK или cURL.

Для OpenAI SDK используйте base_url=https://clodex.xyz/v1 и API-ключ CLODEX.

Начните с короткого non-streaming запроса, затем отдельно проверьте streaming, ошибки и tool calls.

```bash
curl https://clodex.xyz/v1/responses -H "Authorization: Bearer clodex_YOUR_KEY" -H "Content-Type: application/json" -d '{"model":"gpt-5.6-sol","input":"Проверь этот запрос"}'
```

Связанные ссылки:

- /pricing
- /docs#quickstart

### Авторизация {#authentication}

Ключи передаются в Authorization Bearer и не должны попадать в браузерный код.

OpenAI-compatible: Authorization: Bearer clodex_YOUR_KEY.

Anthropic-compatible: x-api-key: clodex_YOUR_KEY или Authorization в зависимости от клиента.

Храните ключи только на сервере, выпускайте отдельный ключ на приложение и отзывайте скомпрометированные ключи.

Связанные ссылки:

- /docs#authentication
- /profile
- /keys

### Модели и capabilities {#models}

Каталог моделей и поддерживаемые операции нужно проверять перед запуском production-трафика.

GET https://clodex.xyz/v1/models возвращает модели, доступные конкретному ключу.

Не подменяйте модель молча: если выбранная модель недоступна, возвращайте явную ошибку или используйте заранее определённый fallback.

Возможности chat, reasoning, tools, images, audio и video могут различаться между каналами.

Связанные ссылки:

- /pricing
- /v1/models

### Reasoning: Max и Ultra {#reasoning}

Ultra — клиентский режим, а не серверная ступень выше max.

GPT-6 Astra поддерживает серверные reasoning low, medium, high, xhigh и max. Отдельного API-уровня ultra нет.

gpt-6.1-sol доступна в каталоге Codex App с контекстом 200 000 токенов и reasoning low, medium, high, xhigh, max и ultra; ultra остаётся клиентским multi-agent режимом Codex.

В поддерживающем Ultra клиенте Codex этот режим включает максимальное reasoning и проактивных субагентов; запрос к API содержит max. Доступность зависит от модели, клиента и аккаунта.

CLODEx Web Chat может отправить ultra; на GPT-маршруте через CodexLB ultra преобразуется в max. Max и xhigh передаются без такого преобразования. Принудительная политика ключа или канала может переопределить effort.

Web Chat и CodexLB не запускают субагентов от одного значения ultra. Для сырого API запроса указывайте max: Responses использует reasoning.effort, а Chat Completions — reasoning_effort.

Запись max в usage-логе не различает Max и Ultra, если клиент нормализовал значение до отправки запроса.

```bash
curl https://clodex.xyz/v1/responses -H "Authorization: Bearer $CLODEX_API_KEY" -H "Content-Type: application/json" -d '{"model":"gpt-6.1-sol","input":"Explain this algorithm.","reasoning":{"effort":"max"}}'
```

Связанные ссылки:

- /docs#reasoning
- /v1/models/gpt-6.1-sol
- https://developers.openai.com/api/docs/models/gpt-6-astra
- https://learn.chatgpt.com/docs/models

### Responses API {#responses}

Основной OpenAI-compatible маршрут для типизированного ввода, streaming и tools.

POST https://clodex.xyz/v1/responses принимает model и input.

Для streaming обрабатывайте SSE-события и требуйте финальное событие завершения.

Перед выполнением tool call проверьте JSON-аргументы, модель и права пользователя.

Связанные ссылки:

- /docs#responses
- /v1/responses

### Chat Completions {#chat-completions}

Совместимый маршрут для существующих OpenAI-клиентов и простых диалогов.

POST https://clodex.xyz/v1/chat/completions принимает messages и model.

Проверяйте finish_reason, ошибки upstream и terminal event в streaming-ответе.

Для новых agent-сценариев предпочтительнее Responses API, если его поддерживает выбранная модель.

Связанные ссылки:

- /docs#chat-completions
- /v1/chat/completions

### Anthropic Messages {#anthropic-messages}

Anthropic-compatible endpoint для Claude SDK и Claude Code.

POST https://clodex.xyz/v1/messages используется через base URL https://clodex.xyz.

Обычный ключ UNIFIED маршрутизирует Claude через CLAUDE_AWS. Включение Claude MAX у ключа создаёт scope ["UNIFIED","CLAUDE_MAX"] и полностью заменяет Claude-маршрут на CLAUDE_MAX без fallback на AWS; остальные семейства моделей остаются в UNIFIED.

Сохраняйте content blocks, обрабатывайте tool_use и ждите обязательное message_stop в streaming.

Связанные ссылки:

- /claude-api
- /claude-code-api
- /docs#anthropic-messages

### Embeddings и Rerank {#embeddings-rerank}

Векторизация и переупорядочивание документов для поиска и RAG.

Проверьте доступную embedding-модель через авторизованный каталог и не смешивайте векторы разных размерностей.

Индексируйте документы небольшими чанками, сохраняйте model и vector dimension рядом с индексом.

Связанные ссылки:

- /docs#embeddings-rerank
- /v1/embeddings

### Images API {#images}

Генерация и редактирование изображений с учётом capability выбранной модели.

Параметры image-моделей различаются: проверяйте размер, формат, качество и поддержку image input.

Большие результаты сохраняйте в собственное object storage и возвращайте клиенту контролируемую ссылку.

Связанные ссылки:

- /docs#images
- /chat/images

### Audio API {#audio}

Speech, transcription и translation через доступные audio-capable каналы.

Валидируйте content type и размер загружаемого файла до отправки upstream.

Для длинных операций возвращайте идентификатор задачи и опрашивайте статус с ограниченным retry budget.

Связанные ссылки:

- /docs#audio

### Video API {#video}

Асинхронная генерация видео, polling статуса и получение результата.

Все видеомодели через API оплачиваются только с переводимого платного баланса кошелька, включая средства после подтверждённого пополнения. Промобаланс, CLODEx Credits и лимит подписки не используются.

Генерация видео может завершаться существенно позже выдачи generation ID: слот аккаунта удерживается до terminal status.

Результат нужно скачать потоково в приватное S3/R2-хранилище, не записывая временный upstream URL в логи.

При timeout используйте idempotency и ограниченный retry, не создавая дубликаты генерации.

Связанные ссылки:

- /video
- /studio-v2
- /docs#video

### SDK и cURL {#sdks}

Примеры подключения для Python, JavaScript, Go и raw HTTP.

Большинство OpenAI SDK подключаются заменой api_key и base_url.

Не встраивайте ключ в browser bundle, мобильное приложение или публичный репозиторий.

Связанные ссылки:

- /docs#sdks
- /openai-compatible-api

### IDE и CLI {#ide-cli}

CLODEx можно использовать в Codex, Claude Code, Cursor, Cline и OpenCode.

OpenAI-compatible clients используют https://clodex.xyz/v1; Claude Code использует https://clodex.xyz.

В IDE задайте отдельный ключ, модель и лимит расходов для проекта.

Связанные ссылки:

- /claude-code-api
- /connect
- /docs#ide-cli

### CLODEx Connect {#connect-cli}

Device login и безопасная настройка клиентов без передачи ключа в чат.

Используйте официальный пакет Connect и проверяйте подпись релиза перед установкой.

Команда doctor помогает проверить endpoint, авторизацию, модель и сетевое соединение.

Связанные ссылки:

- /connect
- /docs#connect-cli

### Web-продукты {#web-products}

Chat, Coding, Studio, Design, Images, Clone и связанные рабочие пространства.

Веб-продукты используют аккаунт CLODEX и не раскрывают API-ключ браузеру.

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

Все платные AI-операции внутри CLODEx Studio списываются только с платного баланса. Промобаланс, CLODEx Credits и лимит подписки для Studio не используются.

Связанные ссылки:

- /chat/clodex
- /coding
- /studio
- /design
- /video

### Account API {#account-api}

Аккаунт, ключи, quota и dashboard endpoints для собственных интеграций.

Dashboard API не является публичным backend для конечных клиентов: передавайте операции через собственный авторизованный сервер.

Проверяйте владельца ключа и не принимайте user ID или token из непроверенного запроса.

Связанные ссылки:

- /docs#account-api
- /keys
- /profile

### Billing и Usage {#billing-usage}

Баланс, quota, cache tokens, списания и usage-логи.

Платный баланс — переводимые средства кошелька, включая средства после подтверждённого пополнения. Промобаланс хранится отдельно и доступен только в поддерживаемых сервисах.

CLODEx Studio и все видеомодели используют только платный баланс; перед запуском проверяйте quote и доступный платный остаток.

Стоимость может включать input, output, cache read, reasoning или Fixed Usage в зависимости от модели.

Используйте usage logs и request ID как источник диагностики фактического списания.

Не фиксируйте цены в клиентском коде: публичный каталог и биллинг могут обновляться.

Связанные ссылки:

- /pricing
- /billing
- /usage-logs/common

### Ошибки и retry {#errors}

Единый разбор статусов, rate limit, timeout и upstream ошибок.

Сохраняйте request ID, HTTP status, code и безопасное сообщение ошибки.

Повторяйте только классифицированные transient errors с exponential backoff и ограниченным числом попыток.

Ошибки auth, quota, validation и policy нельзя повторять вслепую.

Связанные ссылки:

- /docs#errors
- /support

### Streaming и надёжность {#reliability}

Timeout, SSE, idempotency, polling и circuit breaker.

Разделяйте connect timeout, response timeout и общий deadline операции.

EOF без terminal event считайте неполным ответом; безопасно завершайте или повторяйте только идемпотентную операцию.

Для async generation используйте lifecycle-aware scheduler и удерживайте concurrency slot до terminal status.

Связанные ссылки:

- /docs#reliability
- /support

### Безопасность {#security}

Хранение ключей, приватность prompt и безопасные интеграции.

Не логируйте Authorization, API keys, refresh tokens и чувствительные prompt без явного обоснования.

Ограничивайте модели, budget, payload size и инструменты на стороне приложения.

При компрометации ключа немедленно отзовите его и выпустите новый.

Связанные ссылки:

- /privacy
- /docs#security

### Диагностика и поддержка {#support}

Как подготовить обращение, чтобы быстро разобрать проблему.

Приложите request ID, дату и часовой пояс, endpoint, модель, HTTP status и безопасный фрагмент ошибки.

Не присылайте пароль, 2FA, полный API-ключ, cookies или приватные prompt.

Связанные ссылки:

- /support
- https://t.me/clodex_labs