Apa Itu Rivya API?

Rivya API adalah kontrak pengembang untuk memakai kemampuan model Rivya yang didukung dari produk, skrip, atau alur Anda ketika akses Public API aktif untuk penerapan dan tersedia bagi akun.

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 kunci.

Jika Anda membutuhkan detail titik akhir, mulai dari Ikhtisar Rivya API dan Mulai cepat 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 login yang memenuhi syarat membuat kunci API dan memanggil model siap-API dari luar antarmuka web. Halaman pengembang menjelaskan kontrak yang diterapkan; penerapan aktif, izin akun, dan kesiapan model menentukan apakah permintaan dapat berjalan.

Permukaan API yang diterapkan mencakup:

• penemuan model melalui daftar model API

• pekerjaan generasi gambar, video, dan audio asinkron

• unggahan Files API untuk model yang membutuhkan media referensi

• pemeriksaan berkala status generasi dengan tugas ID publik

• pemeriksaan kredit akun

• giliran Chat API, termasuk SSE aliran langsung opsional

• webhook bertanda tangan untuk penyelesaian generasi ketika webhook aktif untuk penerapan

• TypeScript SDK beta untuk tim yang menginginkan klien wrapper

Hub pengembang publik adalah Pengembang. Itu titik masuk terbaik jika Anda menginginkan ringkasan terpandu, tautan ke pengaturan API kunci, dan alur debugger yang aman.

Mengapa Rivya Memiliki API

Studio berguna ketika seseorang masih memilih model, membentuk prompt, meninjau hasil, 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, ketika akses API aktif, meliputi:

• produk ingin menghasilkan variasi gambar setelah pengguna mengirim ringkasan kreatif

• alur kerja marketing perlu membuat draf visual dari masukan kampanye terstruktur

• alat internal perlu mengirim pekerjaan video atau audio tanpa meminta seseorang membuka browser

• sistem dukungan atau konten menginginkan satu giliran model chat di dalam antarmukanya sendiri

• layanan backend menginginkan panggilan balik bertanda tangan saat pekerjaan 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 hasil secara visual

• proyek bergantung pada riwayat tersimpan dan tinjauan manual

• tim belum memutuskan format masukan dan hasil 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 masukan yang dapat diprediksi dapat berpindah ke API.

Building Block Utama

Bayangkan API sebagai enam bagian yang saling terhubung.

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 kunci yang dibuat oleh akun itu, dan mengikuti batas kredit tingkat produk yang dijelaskan di Kredit 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 berkas audio referensi.

Untuk integrasi API, referensi itu sebaiknya melalui Files API. Unggahan membuat catatan berkas terkelola yang dapat diteruskan ke parameter model yang didukung.

Aturan praktisnya sederhana:

• jika model menerima masukan teks saja, mulai dari titik akhir generasi

• jika model membutuhkan media referensi, unggah berkas lebih dulu

• jika model chat memakai lampiran gambar, gunakan Chat API dan berkas ID

Jangan merancang integrasi di sekitar alur unggahan khusus browser atau sesi Studio tersimpan. API memiliki batas berkas publiknya sendiri karena ada alasannya.

Di Mana Webhooks Membantu

Polling adalah jalur integrasi pertama yang paling mudah. Kirim pekerjaan generasi, simpan tugas ID publik, lalu pemeriksaan berkala sampai berhasil atau gagal.

Ketika webhook aktif untuk penerapan, fitur ini berguna saat integrasi makin mendekati produksi:

• Anda tidak ingin worker melakukan pemeriksaan berkala untuk setiap pekerjaan

• aplikasi perlu memperbarui catatan saat generasi selesai

• Anda menginginkan peristiwa bertanda tangan yang dapat dicoba ulang dengan aman

• pekerjaan gagal perlu masuk ke jalur pemulihan yang jelas

Untuk kontrak peristiwa bertanda tangan, gunakan API Webhooks. Pastikan fiturnya tersedia sebelum merancang sistem di sekelilingnya. Jaga penerima webhook tetap terbatas: verifikasi tanda tangan, tangani peristiwa duplikat, dan jangan menaruh nilai rahasia di log.

Proyek API Pertama Yang Baik

Proyek API pertama terbaik biasanya kecil dan konkret.

Contohnya:

1. pastikan akses API aktif untuk penerapan dan akun

2. buat kunci API di pengaturan

3. panggil daftar model

4. pilih satu model siap-API

5. kirim tugas generasi dengan kunci idempotensi

6. lakukan pemeriksaan berkala titik akhir status

7. periksa kredit sebelum dan sesudah

8. baru tambahkan Files API, Chat API, atau Webhooks yang disediakan penerapan

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

• hasil 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 Pengembang untuk pusat API publik dan debugger.

• Baca Mulai cepat Rivya API untuk membuat permintaan aman pertama.

• Baca Autentikasi API sebelum menaruh kunci 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.