RouterAPI Docs

Быстрый старт — первый запрос к API

Документация RouterAPI помогает быстро понять, как работать с публичным API, кабинетом, RouterAPI Gateway и мультимодальными сценариями.

Публичная документация

С чего начать

У проекта есть несколько подтверждённых публичных эндпоинтов, с которых удобно начинать знакомство:

  • GET https://routerapi.ru/api/v1/key — информация о ключе и балансе;
  • GET https://routerapi.ru/api/v1/models — список доступных моделей;
  • POST https://routerapi.ru/api/v1/chat/completions — основной proxy endpoint RouterAPI для запросов к моделям.

Ниже — минимальный пример запроса именно к chat/completions.

curl https://routerapi.ru/api/v1/chat/completions \
  -H "Authorization: Bearer $YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "openai/gpt-3.5-turbo",
    "messages": [
      {
        "role": "user",
        "content": "Привет! Расскажи, что ты умеешь."
      }
    ]
  }'

В ответ вы получите JSON с массивом choices, где в choices[0].message.content будет содержаться текст ответа модели.

Проверка ключа и баланса

Перед первым вызовом модели удобно проверить, что ключ вообще принимается gateway:

curl https://routerapi.ru/api/v1/key \
  -H "Authorization: Bearer $YOUR_API_KEY"

Если ключ валиден, вы получите объект data с данными по ключу, лимитам и текущему балансу.

Получение списка моделей

Чтобы не подставлять model ID вслепую, запросите список доступных моделей:

curl https://routerapi.ru/api/v1/models \
  -H "Authorization: Bearer $YOUR_API_KEY"

Этот маршрут проксируется через gateway и возвращает список моделей, доступных через upstream‑провайдера.

Структура запроса

  • model — идентификатор выбранной модели (например, openai/gpt-3.5-turbo или другой ID из /api/v1/models).
  • messages — массив сообщений в формате диалога:
    • role: user, assistant или system;
    • content: текстовое содержимое сообщения или массив контент‑блоков для мультимодальных моделей.
  • Дополнительные параметры (temperature, max_tokens, stream и другие совместимые поля) gateway не вырезает из исходного JSON и проксирует дальше.

Структура ответа

Типичный успешный ответ включает:

  • id — идентификатор вызова;
  • model — фактически использованная модель;
  • choices — массив вариантов ответа:
    • choices[0].message.role — обычно assistant;
    • choices[0].message.content — основной текст ответа;
  • usage — статистика по использованным токенам (если поддерживается).

Проверка работоспособности

Если вы получили осмысленный текст в choices[0].message.content, значит:

  • ключ валиден;
  • базовый URL https://routerapi.ru/api/v1 и эндпоинт указаны верно;
  • формат запроса соответствует требованиям API.

Если вместо ответа вы получили 402, это значит, что у пользователя недостаточно баланса и нет активных пакетов. Эта проверка выполняется gateway до обращения к upstream‑провайдеру.

Далее вы можете переходить к более сложным сценариям: мультимодальности, генерации изображений и интеграции в backend/фронтенд‑приложения.

Нужен следующий раздел?

Откройте обзор, dashboard, мультимодальность или технические сценарии API.