Jurnal Rivya
Pengarang
Kategori
Teruskan meneroka
Teruskan dengan panduan berkaitan, nota produk dan pecahan aliran kerja daripada pasukan Rivya.
Rivya API ialah kontrak pembangun untuk menggunakan keupayaan model Rivya yang disokong daripada produk, skrip atau aliran kerja anda sendiri apabila akses API Awam diaktifkan untuk persekitaran pelaksanaan dan tersedia kepada akaun anda.
Ia bukan produk berasingan daripada Rivya Studio. Ia menggunakan sempadan akaun, dompet kredit 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 kunci API.
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.
Rivya API v1 membolehkan akaun layak yang telah log masuk mencipta kunci API dan memanggil keupayaan model Rivya yang sedia digunakan melalui API dari luar antara muka web. Halaman pembangun menerangkan kontrak yang telah dilaksanakan; sama ada permintaan boleh dijalankan tetap bergantung pada persekitaran pelaksanaan yang aktif, kebenaran akaun dan status kesediaan model.
Permukaan API yang telah dilaksanakan merangkumi:
penemuan model melalui senarai model API
tugas penjanaan imej, video, dan audio secara tak segerak
muat naik melalui API Fail untuk model yang memerlukan media rujukan
semakan berkala status penjanaan dengan ID tugas awam
semakan kredit akaun
giliran Chat API, termasuk streaming SSE pilihan
Webhook bertandatangan untuk penyelesaian penjanaan apabila ciri itu diaktifkan untuk persekitaran pelaksanaan
beta TypeScript SDK untuk pasukan yang mahu pembungkus klien
Hab pembangun awam ialah Pembangun. Ia ialah titik mula terbaik jika anda mahukan gambaran berpandu, pautan ke tetapan kunci API dan aliran penyahpepijatan yang selamat.
Studio berguna apabila seseorang masih memilih model, membentuk gesaan, menyemak hasil dan menentukan langkah seterusnya.
API berguna apabila keputusan itu sudah berubah menjadi aliran kerja produk atau operasi yang boleh diulang.
Contoh biasa, apabila akses API diaktifkan, termasuk:
produk mahu menjana varian imej selepas pengguna menghantar taklimat
aliran kerja pemasaran perlu mencipta draf visual daripada masukan 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 sisi pelayan memerlukan panggilan balik bertandatangan apabila tugasan 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.
API tidak menggantikan semua sebab untuk menggunakan Rivya secara langsung.
Gunakan Studio atau permukaan kerja awam apabila:
gesaan masih memerlukan penerokaan oleh manusia
pilihan model belum stabil
pencipta perlu membandingkan hasil secara visual
projek bergantung pada sejarah tersimpan dan semakan manual
pasukan belum memutuskan format masukan dan hasil yang patut dijadikan berulang
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 sudah diketahui dan mempunyai masukan yang boleh diramal boleh bergerak ke API.
Fikirkan API sebagai enam bahagian yang saling bersambung.
| Blok binaan | Perkara yang dikendalikan | Baca seterusnya |
|---|---|---|
| Kunci API | Akses antara pelayan daripada akaun anda | Pengesahan API |
| Model | ID model awam dan maklumat kesediaan | Model API |
| Generations | Tugas imej, video, dan audio tak segerak | Create Generation |
| Fail | Muat naik imej, video atau audio rujukan | API Fail |
| Chat | Giliran chat bukan streaming atau streaming | Chat API |
| Webhooks | Event penyelesaian bertandatangan untuk tugas penjanaan apabila ciri itu diaktifkan | API Webhooks |
Dokumen API ialah sumber untuk bentuk permintaan dan respons. Artikel ini membantu anda menentukan bahagian mana yang perlu digunakan dahulu.
Penggunaan API mengambil daripada dompet kredit akaun Rivya yang sama seperti Studio.
Ini bermaksud API bukan proksi model tanpa nama. Setiap permintaan dimiliki oleh akaun Rivya, menggunakan kunci API yang dicipta oleh akaun itu dan mengikuti sempadan kredit produk yang diterangkan dalam Kredit API.
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.
Sesetengah model boleh berjalan dengan teks sahaja. Model lain memerlukan imej, video, atau fail audio rujukan.
Untuk integrasi API, rujukan tersebut patut melalui API Fail. Muat naik itu mencipta rekod fail terurus yang boleh dihantar kepada parameter model yang disokong.
Peraturan praktikalnya mudah:
jika model menerima masukan teks sahaja, mula dengan titik akhir 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.
Semakan berkala ialah laluan integrasi pertama yang paling mudah. Hantar tugas penjanaan, simpan ID tugas awam dan semak status sehingga tugas berjaya atau gagal.
Apabila webhook diaktifkan untuk persekitaran pelaksanaan, ciri itu berguna apabila integrasi semakin menyerupai sistem produksi:
anda tidak mahu proses pekerja menyemak setiap tugas secara berkala
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 ciri itu tersedia sebelum mereka bentuk aliran yang bergantung padanya. Kekalkan skop penerima webhook secara minimum: sahkan tandatangan, kendalikan event pendua dan elakkan memasukkan nilai rahsia ke dalam log.
Projek API pertama yang terbaik biasanya kecil dan konkrit.
Contohnya:
pastikan akses API diaktifkan untuk persekitaran pelaksanaan dan akaun
cipta kunci API dalam tetapan
panggil senarai model
pilih satu model yang sedia digunakan melalui API
hantar satu tugas penjanaan dengan kunci idempotensi
semak titik akhir status secara berkala
semak kredit sebelum dan selepas
hanya selepas itu tambah API Fail, API Sembang atau webhook yang disediakan oleh persekitaran pelaksanaan
Laluan itu memberi anda integrasi yang berfungsi tanpa mencampurkan setiap ciri API ke dalam ujian pertama.
API mungkin bukan langkah pertama yang betul apabila:
pasukan belum memilih keluarga model
hasil yang diingini masih berubah pada setiap percubaan
gesaan bergantung pada pertimbangan 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.
Buka Developers untuk hab API awam dan debugger.
Baca Rivya API Quickstart untuk membuat permintaan selamat pertama.
Baca Pengesahan API sebelum meletakkan kunci pada pelayan.
Baca Model API sebelum memilih ID model.
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.
