API Authentication
Bearer API keys, scoped permissions, एक बार दिखाए जाने वाले secret, revocation और rotation के साथ Rivya API requests authenticate करें।
अंतिम समीक्षा 2026/05/10 को
Rivya API server-to-server access के लिए API keys इस्तेमाल करता है।
API key ब्राउज़र login session जैसी चीज नहीं है। सार्वजनिक API credential के रूप में cookies, Better Auth session state या personal browser token इस्तेमाल न करें।
Header Format
Key को Authorization header में भेजें:
Authorization: Bearer rvya_sk_...पूरी key केवल बनाते समय एक बार दिखाई जाती है। Rivya पूरा secret नहीं, बल्कि hash और visible prefix store करता है।
Key बनाएं
- Rivya में साइन इन करें।
- API Keys settings खोलें।
- जिन scopes की जरूरत है, उनके साथ key बनाएं।
- पूरी key तुरंत copy करें।
- इसे server-side secret manager या environment variable में store करें।
Key को client-side JavaScript, mobile app bundles, public repos, analytics events या logs में न रखें।
मौजूदा scopes
पहला version इन scopes को document करता है:
models:readgenerations:creategenerations:readfiles:createfiles:readcredits:readwebhooks:managechat:createchat:read
Settings में बनाई गई नई keys में documented scopes default रूप से शामिल होते हैं। Files API, API Webhooks या Chat API इस्तेमाल करने से पहले older keys को फिर से बनाना पड़ सकता है।
Revoke और rotate करें
अगर कोई key उजागर हो जाए:
- Settings से पुरानी key revoke करें।
- नई key बनाएं।
- अपना server-side secret update करें।
- Confirm करें कि नई key
GET /api/v1/creditsके साथ काम करती है। - Build systems, logs और deployment variables से पुरानी key remove करें।
Revoked keys api_key_revoked return करती हैं।
Authentication errors
Common authentication errors:
api_key_missingapi_key_invalidapi_key_revokedapi_key_expiredapi_scope_deniedpublic_api_disabled
Full public error table के लिए API Errors and Limits देखें।