Справочник API — все эндпоинты
Полный список эндпоинтов PlusVibe API с методом, путём, описанием и типом авторизации. Эндпоинты сгруппированы по категориям. Базовый адрес для /v1/* — https://plusvibeapi.ru/v1; для /api/* — https://plusvibeapi.ru.
Машинно-читаемая спецификация OpenAPI 3.0 доступна по адресу /api/openapi — импортируйте в Postman, Swagger UI или любой OpenAPI-совместимый инструмент.
Публичные каталоги
/api/catalog, /api/media-catalog доступны без ключа — используйте их для витрин, расчётов цен и определения моделей до регистрации.Chat & Completions
| Method | Endpoint | Description | Auth |
|---|---|---|---|
| POST | /v1/chat/completions | OpenAI-совместимый чат-эндпоинт. | Bearer |
| POST | /v1/messages | Эндпоинт формата Anthropic Messages. Путь для Claude Code и Anthropic SDK. | x-api-key / Bearer |
| POST | /v1/responses | OpenAI Responses API. Путь для Codex CLI (wire_api = "responses"). | Bearer |
| POST | /v1/messages/count_tokens | Заглушка подсчёта входных токенов для Anthropic SDK / Claude Code (оценка, не точный токенайзер). | x-api-key / Bearer |
Models & Pricing
| Method | Endpoint | Description | Auth |
|---|---|---|---|
| GET | /v1/models | Доступные модели с типом, модальностями и адресами. Медиа по запросу: ?type=image, ?all=true или /v1/models/all; одна модель: /v1/models/{id}. | Bearer |
| GET | /v1/pricing | Канонический программный источник цен для текстовых моделей с учётом live-переопределений оператором. | Bearer |
| POST | /v1/embeddings | Векторные представления текста для поиска, RAG и кластеризации. | Bearer |
| POST | /v1/decisions | Оценка именованных вопросов по состоянию (text->decisions). Не чат-эндпоинт; оплата только за входные токены. | Bearer |
Media
| Method | Endpoint | Description | Auth |
|---|---|---|---|
| POST | /api/media/generate | Асинхронная генерация медиа (image/video/audio/music/3d). Возвращает jobId для опроса. | Bearer |
| GET | /api/media/jobs/{id} | Опрос статуса асинхронной задачи генерации медиа. | Bearer |
| GET | /api/media/file/{id}/{idx} | Подписанный прокси-адрес результата (HMAC в query-параметре sig). Без ключа — для вставки в <img>/<video>. | sig (HMAC) |
| GET | /api/media-catalog | Публичный каталог медиа-моделей: kind, variants, params, fromRub, axes. | public |
Search
| Method | Endpoint | Description | Auth |
|---|---|---|---|
| POST | /api/search | Веб-поиск: возвращает результаты выдачи (заголовок, ссылка, сниппет). | Bearer |
Billing & Usage
| Method | Endpoint | Description | Auth |
|---|---|---|---|
| GET | /v1/balance | Остаток предоплаченного баланса в рублях. | Bearer |
| GET | /v1/generations | История использования с route / address_as (публичный маршрут) и пагинацией. | Bearer |
| GET | /v1/generations/{id} | Одна запись истории использования по её id (из ответа /v1/generations или заголовка x-pv-generation-id). | Bearer |
| GET | /v1/usage | Статистика использования по ключу с полями route и address_as. | Bearer |
| GET | /api/key/usage | Сводка по ключу: баланс, траты за сегодня/месяц, число запросов. | Bearer / x-api-key |
Routing
| Method | Endpoint | Description | Auth |
|---|---|---|---|
| ANY | x-plusvibe-route / x-plusvibe-model | Заголовки ответа только для доверенных reveal/debug-клиентов: публичный :alias и address_as победившего маршрута. | response headers |
Keys
| Method | Endpoint | Description | Auth |
|---|---|---|---|
| GET | /v1/keys | Список API-ключей аккаунта. | Bearer |
| POST | /v1/keys | Недоступно через API. Создание и управление ключами — только в личном кабинете (раздел «Ключи»). | — (UI only) |
Support
| Method | Endpoint | Description | Auth |
|---|---|---|---|
| POST | /v1/tickets | Создать обращение в поддержку (JSON или multipart со скриншотами). API-ключ или сессия кабинета. | Bearer |
| GET | /v1/tickets | Список ваших обращений, новые сверху, с курсорной пагинацией. | Bearer |
| GET | /v1/tickets/{id} | Статус обращения и вся переписка с ответами поддержки. | Bearer |
| POST | /v1/tickets/{id}/messages | Дополнить обращение сообщением. | Bearer |
| POST | /v1/tickets/{id}/close | Закрыть обращение. | Bearer |
| POST | /v1/technical-feedback | Прежний адрес для технических обращений, алиас POST /v1/tickets; поля не изменились. | Bearer |
Webhooks
| Method | Endpoint | Description | Auth |
|---|---|---|---|
| GET | /api/webhooks | Текущие URL webhook (mediaWebhookUrl, balanceWebhookUrl). Только сессия кабинета. | session (кабинет) |
| PATCH | /api/webhooks | Установить или сбросить mediaWebhookUrl / balanceWebhookUrl. Только сессия кабинета. | session (кабинет) |
Public catalogs
| Method | Endpoint | Description | Auth |
|---|---|---|---|
| GET | /api/catalog | Публичный каталог текстовых моделей (без авторизации). Используется сайтом для витрины. | public |
| GET | /api/media-catalog | Публичный каталог медиа-моделей (типы, цены за юнит, params, axes). | public |