Перейти к содержанию

Поддерживаемые маршруты

Кратко

Nexus поддерживает девятнадцать публичных маршрутов:

  • GET /v1/models
  • GET /v1/models/{model}
  • GET /v1/balance
  • GET /v1/realtime
  • POST /v1/chat/completions
  • POST /v1/completions
  • POST /v1/messages
  • POST /v1/messages/count_tokens
  • POST /v1/responses
  • POST /v1/responses/compact
  • POST /v1/embeddings
  • POST /v1/rerank
  • POST /v1/moderations
  • POST /v1/images/generations
  • POST /v1/images/edits
  • POST /v1/images/variations
  • POST /v1/audio/speech
  • POST /v1/audio/transcriptions
  • POST /v1/audio/translations

GET /v1/models

Возвращает модели, доступные вашему ключу.

Используйте этот маршрут перед настройкой клиента или при смене модели.

GET /v1/models/{model}

Возвращает одну конкретную модель, если она доступна вашему ключу.

Используйте этот маршрут для точечной проверки модели, но не для обхода списка: если модель не видна вашему ключу, Nexus вернет безопасный 404.

GET /v1/balance

Возвращает текущий баланс профиля Nexus, к которому относится API-ключ.

GET /v1/realtime

WebSocket-маршрут для Realtime-совместимых клиентов.

Передавайте модель в query string, например GET /v1/realtime?model=gpt-5.5.

Этот маршрут проверяет ключ, доступ к endpoint family, доступ к модели и стартовый баланс до WebSocket upgrade. Надёжный terminal usage списывается после ответа. При отсутствующем или противоречивом usage скрытого списания нет.

POST /v1/messages

Основной маршрут для Claude Code и Claude-совместимых клиентов.

Поддерживает streaming.

Claude-модели доступны через этот маршрут, если они видны вашему ключу в GET /v1/models.

POST /v1/messages/count_tokens

Маршрут для предварительного подсчета токенов в Claude-совместимых клиентах.

Не списывает баланс и не запускает генерацию ответа.

POST /v1/chat/completions

Маршрут для OpenAI-совместимых клиентов, которые используют формат chat.completions.

Поддерживает streaming.

Claude-модели с поддержкой openai также могут использовать этот маршрут.

POST /v1/completions

Маршрут для OpenAI-совместимых клиентов, которые используют формат completions.

Для этого маршрута используйте обычный JSON-ответ. prompt должен быть строкой; batch prompts и token-id prompts возвращают unsupported_prompt_shape.

POST /v1/responses

Основной маршрут для Codex и response-совместимых клиентов.

Поддерживает streaming.

POST /v1/responses/compact

Маршрут для compact response-сценариев.

Поддерживает streaming.

POST /v1/embeddings

Маршрут для OpenAI-compatible embeddings-запросов.

Использует обычный JSON-ответ.

POST /v1/rerank

Маршрут для rerank-запросов.

Использует обычный JSON-ответ.

POST /v1/moderations

Маршрут для moderation-запросов.

Использует обычный JSON-ответ.

POST /v1/images/generations

Маршрут для JSON image generation запросов.

Ожидает application/json и body не больше 1 MiB.

POST /v1/images/edits

Маршрут для image edit запросов с upload.

Ожидает multipart/form-data и body не больше 25 MiB.

POST /v1/images/variations

Маршрут для image variation запросов с upload.

Ожидает multipart/form-data и body не больше 25 MiB.

POST /v1/audio/speech

Маршрут для text-to-speech JSON запросов.

Ожидает application/json и body не больше 1 MiB.

Успешный ответ может быть binary audio body, поэтому используйте raw response mode.

POST /v1/audio/transcriptions

Маршрут для audio transcription запросов с upload.

Ожидает multipart/form-data и body не больше 25 MiB.

POST /v1/audio/translations

Маршрут для audio translation запросов с upload.

Ожидает multipart/form-data и body не больше 25 MiB.

Media preview

Media routes сейчас работают как preview surface.

Nexus всё равно проверяет стартовый баланс перед proxy, но итоговое списание по таким маршрутам может появиться не сразу.

Лимит выходных токенов

Лучше явно передавать лимит ответа:

  • max_tokens для messages;
  • max_completion_tokens или max_tokens для chat.completions;
  • max_tokens для completions;
  • max_output_tokens для responses и responses/compact.

Если лимит не передан, Nexus подставит безопасное значение автоматически.

Как выбирать маршрут

  • для Claude Code используйте POST /v1/messages;
  • для Codex используйте POST /v1/responses;
  • для Realtime-совместимых WebSocket-клиентов используйте GET /v1/realtime;
  • для OpenAI-совместимых клиентов используйте POST /v1/chat/completions;
  • для image generation используйте POST /v1/images/generations;
  • для image edit / variation upload используйте POST /v1/images/edits и POST /v1/images/variations;
  • для text-to-speech используйте POST /v1/audio/speech;
  • для speech-to-text upload используйте POST /v1/audio/transcriptions и POST /v1/audio/translations;
  • POST /v1/completions нужен только для клиентов, которые всё ещё используют legacy completions API.