Використовуйте Rivya API v1, щоб викликати моделі генерації та chat-моделі Rivya зі свого продукту за допомогою API-ключів, кредитів акаунта й необов'язкового потокового передавання SSE.

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

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

Для чого потрібен API

Використовуйте API, коли хочете:

надсилати задачі генерації зображень, відео або аудіо зі свого застосунку
надсилати ходи чату без потокового передавання або з потоковим передаванням і продовжувати chat-сесії, створені через 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

Поточний контракт включає підписані вебхуки результатів асинхронної генерації, Chat API й бета-версію TypeScript SDK із серверним стримінгом. Вебхуки потребують, щоб цю функцію й Public API було ввімкнено в розгортанні.

Автентифікація

Endpoints генерації, статусу й кредитів потребують:

Authorization: Bearer rvya_sk_...

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

Модель білінгу

API-виклики використовують ті самі кредити акаунта Rivya, що й Studio.

Задачі генерації резервують або споживають кредити, коли задача стартує. Ходи Chat резервують кредити перед викликом моделі й остаточно списують кредити за використанням токенів, коли повідомлення асистента збережено. Якщо генерація або хід Chat завершується помилкою за наявними правилами збоїв Rivya, застосовується така сама обробка повернення.

Читайте API-кредити і кредити та білінг у Rivya, щоб зрозуміти користувацьку модель гаманця.

Перший шлях інтеграції

Створіть API-ключ у налаштуваннях.
Викличте список API-моделей, щоб вибрати публічний ID моделі.
Перегляньте довідник моделей API, щоб дізнатися параметри моделі.
Якщо модель потребує референс-медіа, завантажте його через Files API.
Надішліть задачу через створення генерації.
Опитуйте статус генерації, доки завдання не завершиться успіхом або помилкою. Якщо вебхуки ввімкнено для розгортання й акаунта, натомість можна підписатися на підписані події через вебхуки API.
Для chat-моделей використовуйте Chat API замість маршруту генерації. Вкладення зображень у Chat мають посилатися на значення file_id з Files API.

Огляд Rivya API

Для чого потрібен API

Обсяг поточної версії

Автентифікація

Модель білінгу

Перший шлях інтеграції

Пов'язані сторінки

Зміст