Ikhtisar Rivya API

Rivya API v1 adalah titik masuk developer untuk memanggil kemampuan model Rivya dari produk Anda sendiri.

Public API mendukung generasi gambar, video, dan audio asinkron plus turn Chat API dengan respons non-streaming atau streaming SSE. API ini memakai ID model Rivya, credits akun Rivya, ID tugas publik untuk generasi, dan session chat sisi server untuk Chat API.

Untuk Apa API Ini

Gunakan API saat Anda ingin:

• mengirim pekerjaan generasi gambar, video, atau audio dari aplikasi Anda sendiri
• mengirim turn chat non-streaming atau streaming dan melanjutkan session chat yang dibuat API
• menjaga billing tetap di wallet credits akun Rivya yang sama
• melakukan polling status tugas berdasarkan ID tugas publik
• memakai retry idempoten untuk request production yang lebih aman
• menjaga penggunaan Studio dan API tetap berada dalam batas akun yang sama

API adalah layer produk Rivya. Respons publik hanya memakai nama Rivya dan field publik.

Cakupan Versi Saat Ini

Endpoint v1 saat ini:

• GET /api/v1/models
• POST /api/v1/generations
• POST /api/v1/files
• GET /api/v1/files/{fileId}
• POST /api/v1/chat/completions
• GET /api/v1/chat/sessions
• GET /api/v1/chat/sessions/{sessionId}
• GET /api/v1/generations/{taskId}
• GET /api/v1/credits
• GET /api/v1/webhooks
• POST /api/v1/webhooks
• GET /api/v1/webhook-events
• GET /api/v1/openapi.json

Versi saat ini mencakup webhook bertanda tangan untuk hasil generasi asinkron, Chat API, dan beta TypeScript SDK dengan dukungan streaming sisi server.

Autentikasi

Endpoint generasi, status, dan credits membutuhkan:

Authorization: Bearer rvya_sk_...

Buat dan rotasi key dari pengaturan API Keys. Baca Autentikasi API sebelum memakai key di production.

Model Billing

Panggilan API memakai credits akun Rivya yang sama dengan Studio.

Pekerjaan generasi mereservasi atau memakai credits saat tugas dimulai. Turn Chat mereservasi credits sebelum panggilan model dan menyelesaikan credits final dari penggunaan token saat pesan assistant disimpan. Jika generasi atau turn chat gagal berdasarkan aturan kegagalan Rivya yang ada, penanganan refund yang sama berlaku.

Baca Credits API dan Credits & Billing di Rivya untuk model wallet yang dilihat pengguna.

Jalur Integrasi Pertama

1. Buat API key di Settings.
2. Panggil Daftar Model API untuk memilih ID model publik.
3. Baca Referensi API Model untuk parameter model.
4. Jika model membutuhkan media referensi, unggah dengan Files API.
5. Kirim pekerjaan dengan Membuat Generasi.
6. Polling Status Generasi sampai tugas berhasil atau gagal, atau berlangganan API Webhooks untuk event penyelesaian bertanda tangan.
7. Untuk model chat, gunakan Chat API, bukan endpoint generasi. Lampiran gambar Chat harus mereferensikan nilai file_id dari Files API.

Halaman Terkait

• Quickstart API
• Autentikasi API
• Rivya TypeScript SDK
• Referensi API Model
• Chat API
• API Webhooks
• Error dan Limit API