Rivya AI Docs

Автентифікація 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 зберігає хеш і видимий префікс, а не повний секрет.

Створення ключа

  1. Увійдіть у Rivya.
  2. Відкрийте налаштування API-ключів.
  3. Створіть ключ із потрібними scopes.
  4. Одразу скопіюйте повний ключ.
  5. Збережіть його в серверному менеджері секретів або змінній середовища.

Не додавайте ключ у клієнтський JavaScript, bundles мобільних застосунків, публічні репозиторії, analytics events або logs.

Поточні scopes

Перша версія документує такі scopes:

  • models:read
  • generations:create
  • generations:read
  • files:create
  • files:read
  • credits:read
  • webhooks:manage
  • chat:create
  • chat:read

Нові ключі, створені в Settings, за замовчуванням містять задокументовані scopes. Старіші ключі може знадобитися створити заново перед використанням Files API, API Webhooks або Chat API.

Відкликання та ротація

Якщо ключ став відкритим:

  1. Відкличте старий ключ у Settings.
  2. Створіть новий ключ.
  3. Оновіть серверний секрет.
  4. Переконайтеся, що новий ключ працює з GET /api/v1/credits.
  5. Видаліть старий ключ із build systems, logs і deployment variables.

Відкликані ключі повертають api_key_revoked.

Помилки автентифікації

Поширені помилки автентифікації:

  • api_key_missing
  • api_key_invalid
  • api_key_revoked
  • api_key_expired
  • api_scope_denied
  • public_api_disabled

Повну таблицю публічних помилок дивіться в Помилки та ліміти API.

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

Зміст