Огляд Rivya API

Rivya API v1 - це точка входу для розробників, які хочуть викликати можливості моделей Rivya зі свого продукту.

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

Для чого потрібен 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

Поточна версія містить підписані webhooks для результатів асинхронної генерації, Chat API та TypeScript SDK beta із серверною підтримкою потокового передавання.

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

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

Authorization: Bearer rvya_sk_...

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

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

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

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

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

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

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

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

• Швидкий старт API
• Автентифікація API
• Rivya TypeScript SDK
• Model API Reference
• Chat API
• API Webhooks
• Помилки та ліміти API