RouterAPI Docs

Обзор платформы RouterAPI

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

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

Что такое RouterAPI

RouterAPI предоставляет единый API‑слой для работы с различными AI‑моделями: от классических чат‑моделей до мультимодальных систем, умеющих обрабатывать текст, изображения, аудио и документы. Вместо интеграции с десятком разных провайдеров вы подключаете один API и выбираете нужную модель в параметрах запроса.

Публичный прокси поддерживает два совместимых входа:

  • OpenAI-compatible: базовый URL https://routerapi.ru/api/v1 (например POST /chat/completions, GET /models, GET /key);
  • Anthropic-compatible (для Claude Code и Anthropic-клиентов): базовый URL https://routerapi.ru с путями вида /v1/* (например POST /v1/messages).

Таблица по базовым URL и заголовкам: шпаргалка.

Путь новичка (за несколько минут)

  1. Аккаунт и доступ — регистрация и окружения.
  2. API-ключи — создать ключ.
  3. Первый запрос — проверка через curl.
  4. Каталог моделей или GET /api/v1/models — выбрать model.
  5. VS Code и другие IDE или SDK (Python, Node…) — перенести URL и ключ в клиент.
  6. При стриминге — стриминг и биллинг.

Связанные страницы продукта

  • Тарифы и цены — публичные тарифы и пополнение.
  • Документация API (Swagger) — интерактивная спецификация подмножества публичных маршрутов; остальные совместимые пути (изображения, embeddings и т.д.) проксируются шлюзом при поддержке upstream — детали в разделах ниже и в OpenAPI описании на странице Swagger.

Для кого создана платформа

  • Продуктовые команды: быстрый запуск новых AI‑функций без глубокой погруженности в особенности конкретных провайдеров.
  • Бэкенд‑разработчики: единый, предсказуемый API вместо зоопарка разных SDK.
  • Интеграторы и SI‑партнёры: возможность строить многопровайдерные решения с минимальными затратами на поддержку.

Ключевые сценарии использования

  • внешняя интеграция через публичный proxy API (https://routerapi.ru/api/v1/* или https://routerapi.ru/v1/*);
  • чат‑боты и ассистенты для пользователей и сотрудников;
  • генерация и редактирование текстов, кода и структурированных данных;
  • генерация изображений и визуализаций по текстовым описаниям;
  • анализ изображений, документов и мультимедийного контента;
  • распознавание и генерация речи;
  • построение кастомных тулов поверх единого AI‑шлюза.

Основные преимущества

  • Единый API: единый формат запросов, ответов и ошибок для всех моделей и провайдеров.
  • Два протокольных входа: OpenAI-compatible и Anthropic-compatible без отдельного шлюза для каждого клиента.
  • Гибкий выбор моделей: вы можете переключаться между моделями и провайдерами без изменения бизнес‑логики.
  • Мультимодальность: поддержка текста, изображений, аудио и документов в одном интерфейсе.
  • Прозрачный биллинг: тарификация по использованию с детализированной статистикой.
  • Интеграция с существующей инфраструктурой: удобная работа из PHP, Node.js, Python и других стеков.
  • Единый ключ доступа: внешний клиент передает API-ключ и работает по единому контракту аутентификации.

Базовые публичные эндпоинты

На текущий момент для внешних интеграций в проекте подтверждены следующие маршруты:

  • GET /api/v1/key — информация о ключе и балансе: data плюс верхнеуровневый balance;
  • GET /api/v1/models — список доступных моделей;
  • POST /api/v1/chat/completions — основной chat endpoint;
  • POST /v1/messages — Anthropic-compatible endpoint для Claude Code/Anthropic SDK;
  • POST /api/v1/images/generations и другие пути в совместимом с OpenAI API формате также проксируются шлюзом, если поддерживаются upstream‑провайдером.

В этой документации основной акцент сделан на публичном API для внешних клиентов.

Что читать дальше

  • «Быстрый старт» — чтобы за несколько минут выполнить первый запрос.
  • «Аутентификация» и «Безопасность для интеграций» — ключи и безопасная эксплуатация.
  • «Интерфейс и принципы работы», «Структура документации», «Шпаргалка по URL» — навигация и контракт API.
  • «Обзор панели управления» — чтобы быстро сориентироваться в ключах, балансе и usage.
  • «Мультимодальность» — примеры для текста, изображений, аудио, видео и файлов.
  • «HTTP-коды и ошибки», «FAQ», «Стриминг и биллинг», «Плагины и доп. расходы», «Устранение неполадок», «Мониторинг» — продакшен и поддержка.
  • «Инструменты (tools)» — function calling при поддержке модели.
  • «VS Code и другие IDE», «Python, Node.js и другие SDK» — клиенты и примеры кода.
  • «Организации и общий баланс» — командный биллинг.
  • «Чек-лист proxy» — проверка интеграции перед запуском.

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

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