Pengesahan API

Rivya API menggunakan API key untuk akses server-to-server.

API key tidak sama dengan sesi log masuk pelayar. Jangan gunakan cookies, keadaan sesi Better Auth, atau token pelayar peribadi sebagai credential API awam.

Format Header

Hantar key dalam header Authorization:

Authorization: Bearer rvya_sk_...

Key penuh hanya ditunjukkan sekali apabila dicipta. Rivya menyimpan hash dan prefix yang boleh dilihat, bukan rahsia penuh.

Cipta Key

1. Log masuk ke Rivya.
2. Buka tetapan API Keys.
3. Cipta key dengan scope yang anda perlukan.
4. Salin key penuh dengan segera.
5. Simpan dalam pengurus rahsia server-side atau environment variable.

Jangan letakkan key dalam JavaScript client-side, bundle aplikasi mudah alih, repo awam, event analytics, atau log.

Scope Semasa

Versi pertama mendokumenkan scope ini:

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

Key baharu yang dicipta dalam Settings menyertakan scope yang didokumenkan secara lalai. Key lama mungkin perlu dicipta semula sebelum menggunakan Files API, API Webhooks, atau Chat API.

Batalkan Dan Rotate

Jika key terdedah:

1. Batalkan key lama daripada Settings.
2. Cipta key baharu.
3. Kemas kini rahsia server-side anda.
4. Sahkan key baharu berfungsi dengan GET /api/v1/credits.
5. Buang key lama daripada sistem build, log, dan pemboleh ubah deployment.

Key yang dibatalkan mengembalikan api_key_revoked.

Ralat Pengesahan

Ralat pengesahan lazim:

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

Lihat Ralat dan Had API untuk jadual ralat awam penuh.

Halaman Berkaitan

• API Quickstart
• Kredit API
• Ralat dan Had API
• Pengesahan dan Akses dalam Rivya