Rivya API adalah jalur developer untuk memakai kemampuan model Rivya dari produk, skrip, atau alur kerja Anda sendiri.
Ini bukan produk terpisah dari Rivya Studio. API memakai batas akun yang sama, dompet kredit yang sama, dan lapisan model publik yang sama yang dilihat pengguna di Rivya. Bedanya adalah cara pekerjaan dimulai: alih-alih mengklik lewat Studio, aplikasi Anda mengirim permintaan dengan API key.
Jika Anda membutuhkan detail endpoint, mulai dari Ikhtisar Rivya API dan Quickstart Rivya API. Artikel ini adalah penjelasan tingkat produk: untuk apa API digunakan, di mana posisinya, dan kapan API sebaiknya bukan jalur pertama.
Versi Singkat
Rivya API v1 memungkinkan akun yang sudah masuk membuat API key dan memanggil kemampuan model Rivya dari luar antarmuka web.
Permukaan API saat ini mencakup:
- penemuan model melalui daftar model API
- job generasi gambar, video, dan audio asinkron
- unggahan Files API untuk model yang membutuhkan media referensi
- polling status generasi dengan task ID publik
- pemeriksaan kredit akun
- giliran Chat API, termasuk SSE streaming opsional
- webhooks bertanda tangan untuk penyelesaian generasi
- TypeScript SDK beta untuk tim yang menginginkan client wrapper
Hub developer publik adalah Developers. Itu titik masuk terbaik jika Anda menginginkan ringkasan terpandu, tautan ke pengaturan API key, dan alur debugger yang aman.
Mengapa Rivya Memiliki API
Studio berguna ketika seseorang masih memilih model, membentuk prompt, meninjau output, dan memutuskan apa yang harus dilakukan berikutnya.
API berguna ketika keputusan itu sudah berubah menjadi alur kerja produk atau operasional yang dapat diulang.
Contoh umum:
- produk ingin menghasilkan variasi gambar setelah pengguna mengirim brief
- alur kerja marketing perlu membuat draf visual dari input kampanye terstruktur
- tool internal perlu mengirim job video atau audio tanpa meminta seseorang membuka browser
- sistem support atau konten menginginkan satu giliran model chat di dalam antarmukanya sendiri
- layanan backend menginginkan callback bertanda tangan saat job generasi selesai
Dalam kasus itu, Rivya API menjaga pekerjaan tetap terhubung ke akun Rivya yang sama, alih-alih memaksa stack terpisah untuk penagihan, pemilihan model, dan status tugas.
Apa Yang Tidak Digantikan API
API tidak menggantikan setiap alasan untuk memakai Rivya secara langsung.
Gunakan Panduan Rivya Studio atau permukaan kerja publik ketika:
- prompt masih membutuhkan eksplorasi manusia
- pilihan model belum stabil
- kreator perlu membandingkan output secara visual
- proyek bergantung pada riwayat tersimpan dan tinjauan manual
- tim belum memutuskan format input dan output mana yang harus dapat diulang
Gunakan API ketika alur kerja sudah cukup jelas untuk diautomasi.
Batas itu penting. Pertanyaan kreatif yang masih samar biasanya lebih dulu berada di Studio. Alur produk yang sudah diketahui dengan input yang dapat diprediksi dapat berpindah ke API.
Building Block Utama
Bayangkan API sebagai enam bagian yang saling terhubung.
| Building block | Yang ditangani | Baca berikutnya |
|---|---|---|
| API keys | Akses server-to-server dari akun Anda | Autentikasi API |
| Models | ID model publik dan informasi kesiapan | Model API |
| Generations | Job gambar, video, dan audio asinkron | Membuat Generasi |
| Files | Unggahan gambar, video, atau audio referensi | Files API |
| Chat | Giliran chat non-streaming atau streaming | Chat API |
| Webhooks | Event penyelesaian bertanda tangan untuk job generasi | API Webhooks |
Dokumentasi API adalah sumber untuk bentuk permintaan dan respons. Artikel ini membantu Anda memutuskan bagian mana yang dibutuhkan lebih dulu.
Cara Kredit Bekerja
Penggunaan API mengambil dari dompet kredit akun Rivya yang sama dengan Studio.
Artinya API bukan proxy model anonim. Sebuah permintaan menjadi milik akun Rivya, memakai API key yang dibuat oleh akun itu, dan mengikuti batas kredit tingkat produk yang dijelaskan di Credits API.
Ini berguna untuk tim karena eksperimen Studio dan penggunaan API tetap berada dalam satu model operasional. Anda dapat menguji model secara manual, lalu memindahkan bagian yang dapat diulang ke integrasi tanpa membuat lapisan penagihan kedua.
Bagaimana File Masuk Ke Dalamnya
Sebagian model dapat berjalan hanya dari teks. Sebagian lain membutuhkan gambar, video, atau file audio referensi.
Untuk integrasi API, referensi itu sebaiknya melalui Files API. Unggahan membuat record file terkelola yang dapat diteruskan ke parameter model yang didukung.
Aturan praktisnya sederhana:
- jika model menerima input teks saja, mulai dari endpoint generasi
- jika model membutuhkan media referensi, unggah file lebih dulu
- jika model chat memakai lampiran gambar, gunakan Chat API dan file ID
Jangan merancang integrasi di sekitar alur unggahan khusus browser atau sesi Studio tersimpan. API memiliki batas file publiknya sendiri karena ada alasannya.
Di Mana Webhooks Membantu
Polling adalah jalur integrasi pertama yang paling mudah. Kirim job generasi, simpan task ID publik, lalu polling sampai berhasil atau gagal.
Webhooks menjadi berguna ketika integrasi lebih mirip produksi:
- Anda tidak ingin worker melakukan polling untuk setiap job
- aplikasi perlu memperbarui record saat generasi selesai
- Anda menginginkan event bertanda tangan yang dapat dicoba ulang dengan aman
- job gagal perlu masuk ke jalur pemulihan yang jelas
Untuk kontrak event bertanda tangan, gunakan API Webhooks. Jaga penerima webhook tetap sempit: verifikasi tanda tangan, tangani event duplikat, dan hindari memasukkan nilai rahasia ke log.
Proyek API Pertama Yang Baik
Proyek API pertama terbaik biasanya kecil dan konkret.
Contohnya:
- buat API key di pengaturan
- panggil daftar model
- pilih satu model yang tersedia
- kirim satu job generasi dengan idempotency key
- polling endpoint status
- cek kredit sebelum dan sesudah
- baru setelah itu tambahkan Files API, Chat API, atau Webhooks
Jalur itu memberi Anda integrasi yang bekerja tanpa mencampur setiap fitur API ke tes pertama.
Kapan API Adalah Titik Awal Yang Salah
API kemungkinan bukan langkah pertama yang tepat ketika:
- tim belum memilih keluarga model
- output yang diinginkan masih berubah di setiap proses
- prompt bergantung pada selera dan tinjauan manual
- integrasi akan menyembunyikan penggunaan kredit dari orang yang perlu memahaminya
- produk membutuhkan demo publik sebelum membutuhkan otomasi
Dalam kasus itu, mulai dari Image, Video, Audio, Chat, atau AI Models. Setelah jalurnya dapat diulang, pindahkan bagian stabil ke API.
Ke Mana Selanjutnya
- Buka Developers untuk hub API publik dan debugger.
- Baca Quickstart Rivya API untuk membuat permintaan aman pertama.
- Baca Autentikasi API sebelum menaruh key di server.
- Baca Model API sebelum memilih model ID.
- Baca Kapan Menggunakan Rivya API Alih-Alih Studio jika batas produk masih belum jelas.
- Baca Cara Membangun Alur Kerja AI Multimodal dengan Rivya API ketika Anda merencanakan integrasi gambar, video, audio, atau chat lengkap.
