Ikhtisar Rivya API

Rivya API v1 adalah kontrak pengembang untuk memanggil kemampuan model Rivya yang didukung dari produk Anda ketika akses Public API aktif untuk penerapan dan tersedia bagi akun.

Kontrak yang diterapkan mencakup generasi gambar, video, dan audio asinkron, serta giliran Chat API dengan respons non-aliran langsung atau SSE. Kontrak memakai ID model Rivya, kredit akun, ID tugas publik, dan sesi chat server. Rute yang terdokumentasi bukan janji bahwa setiap lingkungan, akun, atau model dapat memanggilnya; pastikan akses langsung dan kesiapan model sebelum integrasi.

Untuk Apa API Ini

Gunakan API saat Anda ingin:

• mengirim pekerjaan generasi gambar, video, atau audio dari aplikasi Anda sendiri

• mengirim turn chat non-aliran langsung atau aliran langsung dan melanjutkan sesi chat yang dibuat API

• menjaga penagihan tetap di saldo kredit akun Rivya yang sama

• melakukan pemeriksaan berkala status tugas berdasarkan ID tugas publik

• memakai percobaan ulang idempoten untuk permintaan production yang lebih aman

• menjaga penggunaan Studio dan API tetap berada dalam batas akun yang sama

API adalah lapisan produk Rivya. Respons publik hanya memakai nama Rivya dan kolom publik.

Cakupan Versi Saat Ini

Endpoint v1 yang diterapkan meliputi:

• 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

Kontrak saat ini mencakup webhook bertanda tangan untuk hasil generasi asinkron, Chat API, dan SDK TypeScript beta dengan aliran langsung server. Panggilan webhook memerlukan fitur webhook dan Public API yang aktif untuk penerapan.

Autentikasi

Endpoint generasi, status, dan kredit membutuhkan:

Authorization: Bearer rvya_sk_...

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

Model Penagihan

Panggilan API memakai kredit akun Rivya yang sama dengan Studio.

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

Baca Kredit API dan Kredit & Penagihan di Rivya untuk model saldo yang dilihat pengguna.

Jalur Integrasi Pertama

1. Buat API kunci di Pengaturan.

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. Lakukan pemeriksaan berkala Generation Status sampai tugas berhasil atau gagal. Jika webhook aktif untuk penerapan dan akun, Anda dapat berlangganan peristiwa penyelesaian bertanda tangan melalui API Webhooks.

7. Untuk model chat, gunakan Chat API, bukan titik akhir generasi. Lampiran gambar Chat harus mereferensikan nilai file_id dari Files API.

Halaman Terkait

• Mulai cepat API

• Autentikasi API

• Rivya TypeScript SDK

• Referensi API Model

• Chat API

• API Webhooks

• Error dan Limit API