Gambaran Keseluruhan API Rivya

Rivya API v1 ialah titik masuk pembangun untuk memanggil keupayaan model Rivya daripada produk anda sendiri.

Public API menyokong penjanaan imej, video dan audio tak segerak serta giliran Chat API dengan respons bukan penstriman atau penstriman SSE. Ia menggunakan ID model Rivya, kredit akaun Rivya, ID tugasan awam untuk penjanaan dan sesi chat sebelah pelayan untuk Chat API.

Tujuan API Ini

Gunakan API apabila anda mahu:

• menghantar tugasan penjanaan imej, video atau audio daripada aplikasi anda sendiri
• menghantar giliran chat bukan penstriman atau penstriman dan meneruskan sesi chat yang dicipta API
• mengekalkan bil dalam wallet kredit akaun Rivya yang sama
• meninjau status tugasan melalui ID tugasan awam
• menggunakan cubaan semula idempotent untuk permintaan produksi yang lebih selamat
• mengekalkan penggunaan Studio dan API dalam sempadan akaun yang sama

API ialah lapisan produk Rivya. Respons awam hanya menggunakan nama Rivya dan medan awam.

Skop Versi Semasa

Endpoint v1 semasa:

• 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

Versi semasa menyertakan webhook bertandatangan untuk hasil penjanaan tak segerak, Chat API dan beta TypeScript SDK dengan sokongan penstriman sebelah pelayan.

Pengesahan

Endpoint penjanaan, status dan kredit memerlukan:

Authorization: Bearer rvya_sk_...

Cipta dan putar key daripada tetapan API Keys. Baca Pengesahan API sebelum menggunakan key dalam produksi.

Model Bil

Panggilan API menggunakan kredit akaun Rivya yang sama seperti Studio.

Tugasan penjanaan merizab atau menggunakan kredit apabila tugasan bermula. Giliran Chat merizab kredit sebelum panggilan model dan menyelesaikan kredit akhir daripada penggunaan token apabila mesej assistant disimpan. Jika penjanaan atau giliran chat gagal di bawah peraturan kegagalan Rivya sedia ada, pengendalian bayaran balik yang sama digunakan.

Baca Kredit API dan Kredit & Bil dalam Rivya untuk model wallet yang berhadapan pengguna.

Laluan Integrasi Pertama

1. Cipta API key dalam Settings.
2. Panggil Senarai Model API untuk memilih ID model awam.
3. Baca Rujukan API Model untuk parameter model.
4. Jika model memerlukan media rujukan, muat naik dengan Files API.
5. Hantar tugasan dengan Cipta Penjanaan.
6. Tinjau Status Penjanaan sehingga tugasan berjaya atau gagal, atau langgan Webhook API untuk acara penyelesaian bertandatangan.
7. Untuk model chat, gunakan Chat API dan bukannya endpoint penjanaan. Lampiran imej Chat mesti merujuk nilai file_id Files API.

Halaman Berkaitan

• Mula Pantas API
• Pengesahan API
• Rivya TypeScript SDK
• Rujukan API Model
• Chat API
• Webhook API
• Ralat dan Had API