Автентифікація API
Автентифікуйте запити Rivya API за допомогою Bearer API-ключів, дозволів зі scope, одноразового показу секрету, відкликання та ротації.
Востаннє переглянуто 2026/05/10
Rivya API використовує API-ключі для доступу server-to-server.
API-ключ - це не те саме, що сесія входу в браузері. Не використовуйте файли cookie, стан сесії Better Auth або особистий браузерний токен як облікові дані публічного API.
Формат заголовка
Надсилайте ключ у заголовку Authorization:
Authorization: Bearer rvya_sk_...Повний ключ показується лише один раз під час створення. Rivya зберігає хеш і видимий префікс, а не повний секрет.
Створення ключа
- Увійдіть у Rivya.
- Відкрийте налаштування API-ключів.
- Створіть ключ із потрібними scopes.
- Одразу скопіюйте повний ключ.
- Збережіть його в серверному менеджері секретів або змінній середовища.
Не додавайте ключ у клієнтський JavaScript, bundles мобільних застосунків, публічні репозиторії, analytics events або logs.
Поточні scopes
Перша версія документує такі scopes:
models:readgenerations:creategenerations:readfiles:createfiles:readcredits:readwebhooks:managechat:createchat:read
Нові ключі, створені в Settings, за замовчуванням містять задокументовані scopes. Старіші ключі може знадобитися створити заново перед використанням Files API, API Webhooks або Chat API.
Відкликання та ротація
Якщо ключ став відкритим:
- Відкличте старий ключ у Settings.
- Створіть новий ключ.
- Оновіть серверний секрет.
- Переконайтеся, що новий ключ працює з
GET /api/v1/credits. - Видаліть старий ключ із build systems, logs і deployment variables.
Відкликані ключі повертають api_key_revoked.
Помилки автентифікації
Поширені помилки автентифікації:
api_key_missingapi_key_invalidapi_key_revokedapi_key_expiredapi_scope_deniedpublic_api_disabled
Повну таблицю публічних помилок дивіться в Помилки та ліміти API.
Пов'язані сторінки
Посібник із налаштувань акаунта Rivya
Керуйте профілем Rivya, білінгом, кредитами, безпекою, аватаром, розсилками, параметрами пароля, видаленням акаунта та налаштуваннями автентифікації.
Журнал змін API
Відстежуйте оновлення документації Rivya API v1, ендпойнтів, довідника моделей, схеми та майбутніх поверхонь API.