API Authentication

Rivya API server-to-server access کے لیے API keys استعمال کرتی ہے۔

API key browser login session جیسی نہیں ہوتی۔ cookies، Better Auth session state، یا personal browser token کو public API credential کے طور پر استعمال نہ کریں۔

Header Format

Key کو Authorization header میں بھیجیں:

Authorization: Bearer rvya_sk_...

Full key صرف create ہونے کے وقت ایک بار دکھائی جاتی ہے۔ Rivya full secret نہیں بلکہ hash اور visible prefix store کرتا ہے۔

Create A Key

1. Rivya میں sign in کریں۔
2. API Keys settings کھولیں۔
3. اپنی ضرورت کے scopes کے ساتھ key create کریں۔
4. Full key فوراً copy کریں۔
5. اسے server-side secret manager یا environment variable میں store کریں۔

Key کو client-side JavaScript، mobile app bundles، public repos، analytics events، یا logs میں نہ ڈالیں۔

Current Scopes

First version یہ scopes document کرتا ہے:

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

Settings میں created new keys documented scopes default طور پر include کرتی ہیں۔ Older keys کو Files API، API Webhooks، یا Chat API استعمال کرنے سے پہلے recreate کرنا پڑ سکتا ہے۔

Revoke And Rotate

اگر key expose ہو جائے:

1. Settings سے old key revoke کریں۔
2. New key create کریں۔
3. اپنا server-side secret update کریں۔
4. Confirm کریں کہ new key GET /api/v1/credits کے ساتھ کام کرتی ہے۔
5. Old key کو build systems، logs، اور deployment variables سے remove کریں۔

Revoked keys api_key_revoked return کرتی ہیں۔

Authentication Errors

Common authentication errors:

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

Full public error table کے لیے API Errors and Limits دیکھیں۔

Related Pages

• API Quickstart
• API Credits
• API Errors and Limits
• Authentication and Access in Rivya