Rivya API ialah laluan pembangun untuk menggunakan keupayaan model Rivya daripada produk, skrip, atau aliran kerja anda sendiri.
Ia bukan produk berasingan daripada Rivya Studio. Ia menggunakan sempadan akaun yang sama, dompet kredit yang sama, dan lapisan model awam yang sama seperti yang dilihat pengguna di seluruh Rivya. Perbezaannya ialah cara kerja bermula: bukannya mengklik melalui Studio, aplikasi anda menghantar permintaan dengan API key.
Jika anda perlukan butiran endpoint, mula dengan Rivya API Overview dan Rivya API Quickstart. Artikel ini ialah penjelasan pada tahap produk: kegunaan API, tempat ia sesuai, dan bila ia tidak patut menjadi laluan pertama.
Versi Ringkas
Rivya API v1 membolehkan akaun yang telah log masuk mencipta API key dan memanggil keupayaan model Rivya dari luar antara muka web.
Permukaan API semasa merangkumi:
- penemuan model melalui senarai model API
- tugas penjanaan imej, video, dan audio secara tak segerak
- muat naik Files API untuk model yang memerlukan media rujukan
- polling status penjanaan dengan public task ID
- semakan kredit akaun
- giliran Chat API, termasuk streaming SSE pilihan
- Webhooks bertandatangan untuk penyelesaian penjanaan
- beta TypeScript SDK untuk pasukan yang mahu pembungkus klien
Hab pembangun awam ialah Developers. Ia ialah entri terbaik jika anda mahu gambaran berpandu, pautan ke tetapan API key, dan aliran debugger yang selamat.
Mengapa Rivya Mempunyai API
Studio berguna apabila seseorang masih memilih model, membentuk prompt, menyemak output, dan menentukan langkah seterusnya.
API berguna apabila keputusan itu sudah berubah menjadi aliran kerja produk atau operasi yang boleh diulang.
Contoh biasa:
- produk mahu menjana varian imej selepas pengguna menghantar taklimat
- aliran kerja pemasaran perlu mencipta draf visual daripada input kempen berstruktur
- tool dalaman perlu menghantar tugas video atau audio tanpa meminta seseorang membuka pelayar
- sistem sokongan atau kandungan mahu giliran model chat dalam antara mukanya sendiri
- perkhidmatan backend mahu callback bertandatangan apabila tugas penjanaan selesai
Dalam kes tersebut, Rivya API memastikan kerja kekal terhubung kepada akaun Rivya yang sama, bukannya memaksa stack berasingan untuk pengebilan, pemilihan model, dan status tugas.
Perkara Yang Tidak Digantikan Oleh API
API tidak menggantikan semua sebab untuk menggunakan Rivya secara langsung.
Gunakan Studio atau permukaan kerja awam apabila:
- prompt masih memerlukan penerokaan manusia
- pilihan model belum stabil
- pencipta perlu membandingkan output secara visual
- projek bergantung pada history tersimpan dan semakan manual
- pasukan belum memutuskan format input dan output mana yang patut menjadi boleh ulang
Gunakan API apabila aliran kerja cukup jelas untuk diautomasi.
Sempadan itu penting. Soalan kreatif yang kabur biasanya patut berada dalam Studio dahulu. Aliran produk yang diketahui dengan input yang boleh diramal boleh bergerak ke API.
Blok Binaan Utama
Fikirkan API sebagai enam bahagian yang saling bersambung.
| Blok binaan | Perkara yang dikendalikan | Baca seterusnya |
|---|---|---|
| API keys | Akses server-to-server daripada akaun anda | API Authentication |
| Models | ID model awam dan maklumat kesediaan | API Models |
| Generations | Tugas imej, video, dan audio tak segerak | Create Generation |
| Files | Muat naik imej, video, atau audio rujukan | Files API |
| Chat | Giliran chat bukan streaming atau streaming | Chat API |
| Webhooks | Event penyelesaian bertandatangan untuk tugas penjanaan | API Webhooks |
Dokumen API ialah sumber untuk bentuk permintaan dan respons. Artikel ini membantu anda menentukan bahagian mana yang perlu digunakan dahulu.
Cara Kredit Berfungsi
Penggunaan API mengambil daripada dompet kredit akaun Rivya yang sama seperti Studio.
Ini bermaksud API bukan proxy model tanpa nama. Satu permintaan milik akaun Rivya, menggunakan API key yang dicipta oleh akaun itu, dan mengikuti sempadan kredit tahap produk yang diterangkan dalam API Credits.
Ini berguna untuk pasukan kerana eksperimen Studio dan penggunaan API kekal dalam satu model operasi. Anda boleh menguji model secara manual, kemudian memindahkan bahagian yang boleh diulang ke dalam integrasi tanpa mencipta lapisan pengebilan kedua.
Cara Fail Masuk Dalam Aliran
Sesetengah model boleh berjalan dengan teks sahaja. Model lain memerlukan imej, video, atau fail audio rujukan.
Untuk integrasi API, rujukan tersebut patut melalui Files API. Muat naik itu mencipta rekod fail terurus yang boleh dihantar kepada parameter model yang disokong.
Peraturan praktikalnya mudah:
- jika model menerima input teks sahaja, mula dengan endpoint penjanaan
- jika model memerlukan media rujukan, muat naik fail dahulu
- jika model chat dengan lampiran imej, gunakan Chat API dan file ID
Jangan reka integrasi anda di sekitar aliran muat naik yang hanya boleh dibuat melalui pelayar atau sesi Studio tersimpan. API mempunyai sempadan fail awamnya sendiri atas sebab tertentu.
Di Mana Webhooks Membantu
Polling ialah laluan integrasi pertama yang paling mudah. Hantar tugas penjanaan, simpan public task ID, dan poll sehingga ia berjaya atau gagal.
Webhooks menjadi berguna apabila integrasi lebih menyerupai produksi:
- anda tidak mahu worker melakukan polling untuk setiap tugas
- aplikasi anda perlu mengemas kini rekod apabila penjanaan selesai
- anda mahu event bertandatangan yang boleh dicuba semula dengan selamat
- tugas gagal perlu bergerak ke laluan pemulihan yang jelas
Untuk kontrak event bertandatangan, gunakan API Webhooks. Pastikan penerima webhook sempit: sahkan tandatangan, kendalikan event pendua, dan elakkan meletakkan nilai rahsia dalam log.
Projek API Pertama Yang Baik
Projek API pertama yang terbaik biasanya kecil dan konkrit.
Contohnya:
- cipta API key dalam tetapan
- panggil senarai model
- pilih satu model yang tersedia
- hantar satu tugas penjanaan dengan idempotency key
- poll endpoint status
- semak kredit sebelum dan selepas
- hanya selepas itu tambah Files API, Chat API, atau Webhooks
Laluan itu memberi anda integrasi yang berfungsi tanpa mencampurkan setiap ciri API ke dalam ujian pertama.
Bila API Adalah Titik Mula Yang Salah
API mungkin bukan langkah pertama yang betul apabila:
- pasukan belum memilih keluarga model
- output yang diingini masih berubah setiap percubaan
- prompt bergantung pada rasa dan semakan manual
- integrasi akan menyembunyikan penggunaan kredit daripada orang yang perlu memahaminya
- produk memerlukan demonstrasi awam sebelum memerlukan automasi
Dalam kes itu, mula daripada Image, Video, Audio, Chat, atau AI Models. Apabila laluan boleh diulang, pindahkan bahagian yang stabil ke API.
Ke Mana Seterusnya
- Buka Developers untuk hab API awam dan debugger.
- Baca Rivya API Quickstart untuk membuat permintaan selamat pertama.
- Baca API Authentication sebelum meletakkan key pada server.
- Baca API Models sebelum memilih model IDs.
- Baca Bila Perlu Menggunakan Rivya API Daripada Studio jika sempadan produk masih belum jelas.
- Baca Cara Membina Aliran Kerja AI Multimodal dengan Rivya API apabila anda merancang integrasi penuh imej, video, audio, atau chat.
