Gambaran Keseluruhan API Rivya

Rivya API v1 ialah kontrak pembangun untuk memanggil keupayaan model Rivya yang disokong daripada produk anda sendiri apabila akses API Awam diaktifkan untuk persekitaran pelaksanaan dan tersedia kepada akaun anda.

Kontrak yang telah dilaksanakan merangkumi 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. Laluan yang didokumenkan bukan jaminan bahawa setiap persekitaran, akaun atau model katalog boleh memanggilnya; pastikan akses aktif dan kesediaan model sebelum membuat integrasi.

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 dompet 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

Titik akhir v1 yang telah dilaksanakan termasuk:

• 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

Kontrak semasa menyertakan webhook bertandatangan untuk hasil penjanaan tak segerak, API Sembang dan SDK TypeScript beta dengan sokongan penstriman sebelah pelayan. Panggilan webhook memerlukan ciri webhook dan akses API Awam diaktifkan untuk persekitaran pelaksanaan.

Pengesahan

Titik akhir penjanaan, status dan kredit memerlukan:

Authorization: Bearer rvya_sk_...

Cipta dan putar kunci daripada tetapan kunci API. Baca Pengesahan API sebelum menggunakan kunci 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 dan Pengebilan dalam Rivya untuk memahami dompet kredit yang dilihat pengguna.

Laluan Integrasi Pertama

1. Cipta kunci API dalam Tetapan.

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 API Fail.

5. Hantar tugasan dengan Cipta Penjanaan.

6. Tinjau Status Penjanaan sehingga tugasan berjaya atau gagal. Jika webhook diaktifkan untuk persekitaran pelaksanaan dan akaun, anda boleh melanggan untuk menerima peristiwa penyelesaian bertandatangan.

7. Untuk model Chat, gunakan Chat API dan bukannya titik akhir penjanaan. Lampiran imej Chat mesti merujuk nilai file_id daripada API Fail.

Halaman Berkaitan

• Mula Pantas API

• Pengesahan API

• Rivya TypeScript SDK

• Rujukan API Model

• Chat API

• Webhook API

• Ralat dan Had API