Справочник API
Справочник API
REST API центра управления LLM Router. Используется личным кабинетом и вашими автоматизациями.
Base URL
Адрес API платформы предоставляет администратор вашего экземпляра. Примеры в документации используют плейсхолдер https://api.example.com.
Проверка доступности:
GET /healthzcurl https://api.example.com/healthzФормат запросов
- Тело — JSON (
Content-Type: application/json), если не указано иное. - Ответ — JSON (кроме CSV export usage).
- Кодировка — UTF-8.
Авторизация
Большинство endpoints требуют сессию:
Authorization: Bearer <token>Токен выдаётся при:
POST /api/auth/registerPOST /api/auth/loginPOST /api/invitations/{id}/acceptGET /api/auth/oidc/callback(после SSO)
Проверка текущей сессии: GET /api/auth/session.
Endpoints изменения (организация, ключи, модели, usage, политики, аудит) — роли owner или admin.
Ошибки
При ошибке тело обычно содержит поле error с текстом на русском:
{"error": "Требуется авторизация"}| Код | Значение |
|---|---|
| 400 | Некорректные данные |
| 401 | Не авторизован |
| 403 | Нет прав |
| 404 | Ресурс не найден |
| 500 | Внутренняя ошибка |
Документация по разделам
| Раздел | Файл | Endpoints |
|---|---|---|
| Аутентификация | Аутентификация | register, login, session, accept invitation, OIDC |
| Организации | Организации | GET /api/overview, PATCH /api/organizations/{orgId} |
| Приглашения | Приглашения | POST .../invitations, POST /api/invitations/{id}/accept |
| API-ключи | API-ключи | POST .../api-keys, POST .../api-keys/{keyId}/revoke |
| Способы входа | Способы входа | POST .../auth-providers, OIDC discover |
| Модели | Модели | статус API моделей, GET/PATCH .../models |
| Расходы | Расходы | sync, snapshots, export |
| Коммерческий биллинг | Коммерческий биллинг | invoices, top-ups, mark-paid |
| Политики | Policy Rules | rules, evaluate, preview, virtual-groups, systems |
| Аудит | Журнал аудита | GET .../audit-events |
Сводная таблица endpoints
Аутентификация
| Метод | Путь | Auth | Описание |
|---|---|---|---|
| POST | /api/auth/register | — | Регистрация организации |
| POST | /api/auth/login | — | Вход |
| GET | /api/auth/session | Bearer | Текущая сессия |
| POST | /api/invitations/{id}/accept | — | Принять приглашение |
| GET | /api/auth/oidc/{providerId}/login | — | Начало OIDC |
| GET | /api/auth/oidc/callback | — | Callback OIDC |
| POST | /api/auth/oidc/providers/{id}/discover | Bearer | Discovery OIDC |
Организация
| Метод | Путь | Auth | Описание |
|---|---|---|---|
| GET | /api/overview | Bearer | Сводка кабинета |
| PATCH | /api/organizations/{orgId} | токен администратора | Обновить организацию |
| POST | /api/organizations/{orgId}/invitations | токен администратора | Пригласить |
| POST | /api/organizations/{orgId}/api-keys | токен администратора | Создать ключ |
| POST | /api/organizations/{orgId}/auth-providers | токен администратора | Способ входа |
Модели
| Метод | Путь | Auth | Описание |
|---|---|---|---|
| GET | /api/organizations/{orgId}/gateway/status | токен администратора | Статус API моделей |
| GET | /api/organizations/{orgId}/models | токен администратора | Каталог моделей |
| PATCH | /api/organizations/{orgId}/models | токен администратора | Включить модели |
Расходы
| Метод | Путь | Auth | Описание |
|---|---|---|---|
| GET | /api/organizations/{orgId}/usage | токен администратора | Сводка из usage_events |
| POST | /api/organizations/{orgId}/usage/snapshots | токен администратора | Снимок |
| GET | /api/organizations/{orgId}/usage/snapshots | токен администратора | Список снимков |
| GET | /api/organizations/{orgId}/usage/export | токен администратора | JSON/CSV |
Коммерческий биллинг
| Метод | Путь | Auth | Описание |
|---|---|---|---|
| GET | /api/organizations/{orgId}/billing/invoices | токен администратора | Список счетов |
| POST | /api/organizations/{orgId}/billing/top-ups | токен администратора | Счет на пополнение |
| POST | /api/organizations/{orgId}/billing/invoices/{invoiceId}/mark-paid | токен администратора | Отметить счет оплаченным |
Политики и аудит
| Метод | Путь | Auth | Описание |
|---|---|---|---|
| GET | /api/organizations/{orgId}/policy/rules | токен администратора | Список policy rules |
| POST | /api/organizations/{orgId}/policy/rules | токен администратора | Создать policy rule |
| PATCH | /api/organizations/{orgId}/policy/rules/{id} | токен администратора | Обновить policy rule |
| DELETE | /api/organizations/{orgId}/policy/rules/{id} | токен администратора | Удалить policy rule |
| GET | /api/organizations/{orgId}/policy/form-options | токен администратора | Справочник для форм |
| POST | /api/organizations/{orgId}/policy/evaluate | токен администратора | Проверить контент по policy |
| POST | /api/organizations/{orgId}/policy/preview | токен администратора | Предпросмотр access для ключа/системы |
| GET | /api/organizations/{orgId}/virtual-groups | Bearer | Список виртуальных групп |
| POST | /api/organizations/{orgId}/virtual-groups | токен администратора | Создать виртуальную группу |
| PATCH | /api/organizations/{orgId}/virtual-groups/{id} | токен администратора | Обновить группу |
| DELETE | /api/organizations/{orgId}/virtual-groups/{id} | токен администратора | Архивировать группу |
| GET | /api/organizations/{orgId}/systems | токен администратора | Список систем/агентов |
| POST | /api/organizations/{orgId}/systems | токен администратора | Создать систему/агента |
| GET | /api/organizations/{orgId}/audit-events | токен администратора | Журнал |
Сервис маршрутизации (запросы к моделям)
Запросы приложений к моделям идут не через API платформы, а через API моделей:
| Формат | OpenAI-compatible API |
| Chat | POST /v1/chat/completions |
| Auth | Authorization: Bearer <api-key> |
Адрес API моделей предоставляет администратор платформы. См. Первый запрос к модели.