Dokumentace Rivya AI

Ověřování API

Ověřujte požadavky Rivya API pomocí Bearer API klíčů, scoped oprávnění, jednorázového zobrazení secretu, revokace a rotace.

Naposledy zkontrolováno 2026/05/10

Rivya API používá API klíče pro přístup server-to-server.

API klíč není totéž jako přihlašovací relace v prohlížeči. Nepoužívejte cookies, stav relace Better Auth ani osobní token z prohlížeče jako veřejné API přihlašovací údaje.

Formát Headeru

Pošlete klíč v headeru Authorization:

Authorization: Bearer rvya_sk_...

Celý klíč se zobrazí pouze jednou při vytvoření. Rivya ukládá hash a viditelný prefix, ne celý secret.

Vytvoření Klíče

  1. Přihlaste se do Rivya.
  2. Otevřete nastavení API Keys.
  3. Vytvořte klíč se scopes, které potřebujete.
  4. Okamžitě zkopírujte celý klíč.
  5. Uložte ho do serverového správce secretů nebo proměnné prostředí.

Nedávejte klíč do klientského JavaScriptu, balíčků mobilních aplikací, veřejných repozitářů, analytics událostí ani logů.

Aktuální Scopes

První verze dokumentuje tyto scopes:

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

Nové klíče vytvořené v Settings obsahují dokumentované scopes ve výchozím nastavení. Starší klíče může být nutné znovu vytvořit před použitím Files API, API Webhooks nebo Chat API.

Revokace A Rotace

Pokud je klíč vystaven:

  1. Revokujte starý klíč v Settings.
  2. Vytvořte nový klíč.
  3. Aktualizujte serverový secret.
  4. Ověřte, že nový klíč funguje s GET /api/v1/credits.
  5. Odstraňte starý klíč z build systémů, logů a deployment proměnných.

Revokované klíče vracejí api_key_revoked.

Chyby Ověřování

Běžné chyby ověřování:

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

Úplnou tabulku veřejných chyb najdete v API chyby a limity.

Související Stránky

Obsah