Обзор Rivya API

Rivya API v1 — контракт для разработчиков, позволяющий вызывать поддерживаемые возможности моделей Rivya из собственного продукта, когда Public API включен для развертывания и доступен аккаунту.

Реализованный контракт охватывает асинхронную генерацию изображений, видео и аудио, а также Chat API с обычными или SSE-ответами. Он использует ID моделей Rivya, кредиты аккаунта, публичные ID задач и серверные чат-сессии. Документированный маршрут не обещает доступ для каждой среды, аккаунта или модели; до интеграции проверьте актуальный доступ и готовность модели.

Для чего нужен API

Используйте API, когда хотите:

• отправлять задачи генерации изображений, видео или аудио из собственного приложения

• отправлять ходы чата без стриминга или со стримингом и продолжать созданные API сессии чата

• сохранять биллинг в том же кредитном кошельке аккаунта Rivya

• опрашивать статус задачи по публичному ID задачи

• использовать идемпотентные повторы для более безопасных запросов в рабочей среде

• держать использование Studio и API внутри одной границы аккаунта

API - продуктовый слой Rivya. Публичные ответы используют только имена Rivya и публичные поля.

Область текущей версии

Реализованные конечные точки v1:

• GET /api/v1/models

• POST /api/v1/generations

• POST /api/v1/files

• GET /api/v1/files/{fileId}

• POST /api/v1/chat/completions

• GET /api/v1/chat/sessions

• GET /api/v1/chat/sessions/{sessionId}

• GET /api/v1/generations/{taskId}

• GET /api/v1/credits

• GET /api/v1/webhooks

• POST /api/v1/webhooks

• GET /api/v1/webhook-events

• GET /api/v1/openapi.json

Текущая версия включает подписанные вебхуки для результатов асинхронной генерации, API чата и бета-версию SDK для TypeScript с поддержкой серверной потоковой передачи.

Аутентификация

Конечные точки генерации, статуса и кредитов требуют:

Authorization: Bearer rvya_sk_...

Создавайте и меняйте ключи в настройках ключей API. Перед использованием ключа в рабочей среде прочитайте материал об аутентификации API.

Модель биллинга

Вызовы API используют те же кредиты аккаунта Rivya, что и Studio.

Задачи генерации резервируют или расходуют кредиты при старте задачи. Ходы чата резервируют кредиты перед вызовом модели и списывают финальные кредиты по token usage, когда сообщение ассистента сохранено. Если генерация или ход чата завершается ошибкой по действующим правилам отказов Rivya, применяется та же обработка возврата.

Пользовательскую модель кошелька см. в кредитах API и кредитах и биллинге в Rivya.

Первый путь интеграции

1. Создайте API-ключ в настройках.

2. Вызовите список моделей API, чтобы выбрать публичный ID модели.

3. Прочитайте справочник Model API для параметров модели.

4. Если модели нужны справочные медиа, загрузите их через Files API.

5. Отправьте задачу через создание генерации.

6. Опрашивайте статус генерации, пока задача не завершится успехом или ошибкой. Если вебхуки включены для развертывания и аккаунта, можно вместо этого подписаться на подписанные события через API-вебхуки.

7. Для моделей чата используйте API чата вместо конечной точки генерации. Вложения изображений в чате должны ссылаться на значения file_id из Files API.

Связанные страницы

• Быстрый старт API

• Аутентификация API

• Rivya TypeScript SDK

• Справочник Model API

• API чата

• API-вебхуки

• Ошибки и лимиты API