Rivya AI

API Rivya

Bina di atas lapisan model multimodal Rivya

API Rivya memberi pasukan produk cara awam berasaskan akaun untuk memanggil model Rivya daripada aplikasi mereka sendiri. Mulakan dengan kerja imej, video dan audio tak segerak, tambah giliran Chat API dengan penstriman SSE pilihan apabila model menyokong chat, dan kekalkan bil dalam dompet kredit Rivya yang sama.
Baca dokumentasi APICipta kunci API

Bentuk mula pantas

Lapisan model

Katalog dinamik

Bil

Kredit kongsi

Versi pertama

Kerja + Chat

Akses

Kunci API

KaedahPOST
Endpoint/api/v1/generations

Permintaan sebenar memerlukan kunci API Rivya dan kredit akaun yang tersedia. Contoh awam menggunakan rahsia contoh dan tidak memanggil model secara tanpa nama.

Permintaan
curl https://rivya.ai/api/v1/generations \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-job-001" \
  -d '{
    "model": "z-image",
    "prompt": "Editorial product photo on a clean studio set"
  }'
Respons
{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "result": null,
  "error": null
}

Perkara yang dihantar dahulu

Lapisan API awam yang kekal selari dengan produk Rivya

API ialah sebahagian daripada produk Rivya. Ia menggunakan ID model Rivya, kredit Rivya, keadaan tugasan awam dan dokumentasi yang bersambung dengan katalog model.

API penjanaan imej

Hantar kerja imej dengan prompt dan parameter model yang disokong, kemudian semak status untuk mendapatkan hasil awam.

API penjanaan video

Jalankan kerja video tak segerak dengan kawalan tugasan dan kredit yang sama digunakan oleh Studio.

API penjanaan audio

Gunakan model audio yang boleh diakses API melalui sempadan akaun, baki dan sejarah yang sama.

Dompet kredit kongsi

Panggilan API dan penggunaan Studio menarik daripada baki Rivya yang sama, dengan kredit dirizabkan dan pengendalian kegagalan.

Laluan mula

Daripada akaun ke permintaan API pertama

01

Cipta kunci

Log masuk, buka Kunci API dalam Tetapan, cipta kunci berskop dan simpan rahsia penuh serta-merta.

02

Pilih model

Baca rujukan model API atau panggil /api/v1/models untuk memeriksa ID model, parameter, keupayaan chat dan kesediaan input sebelum menghantar.

03

Hantar, semak status atau langgan

Hantar permintaan penjanaan idempotent, semak endpoint tugasan awam, gunakan webhook bertandatangan untuk callback penjanaan, atau hantar giliran Chat API dengan penstriman SSE pilihan.

Sempadan versi

Skop jelas, tiada janji tersembunyi

Halaman ini membezakan keupayaan API yang tersedia daripada penambahan akan datang supaya anda boleh merancang berdasarkan perkara yang aktif hari ini.

Chat API

Tersedia

Tersedia untuk giliran bukan penstriman dan penstriman SSE dengan sesi yang dicipta API, kredit akaun dan lampiran imej Files API pilihan.

Files API

Tersedia

Tersedia untuk muat naik imej, video dan audio rujukan. Gunakannya sebelum penjanaan apabila halaman model meminta params.referenceMediaItems.

Webhook pengguna

Tersedia

Tersedia untuk integrasi produksi yang mahu callback bertandatangan bagi tugasan penjanaan yang berjaya atau gagal.

Debugger dalam talian

Pratonton permintaan, kemudian jalankan dengan kunci API anda sendiri

Debugger bermula dalam mod simulasi untuk setiap pelawat. Pemilih penjanaan menyenaraikan model bukan chat yang boleh diuji tanpa memuat naik fail, manakala panel Files membolehkan pengguna log masuk menguji /api/v1/files dengan kunci API sementara. Contoh chat berada dalam dokumentasi API.

Keadaan akaun

Menyemak akaun

Awalan kunci aktif

Cipta kunci dahulu

Kredit semasa

Log masuk untuk menyemak

Pratonton simulasiPublic API langsungTiada kunci API aktif

Mod simulasi tidak pernah memanggil model dan tidak pernah menggunakan kredit.

Tampal kunci hanya untuk permintaan ini. Debugger tidak menyimpannya selepas segar semula.

Ujian muat naik Files API

Muat naik media rujukan melalui POST /api/v1/files, kemudian salin URL dan token durasi yang dikembalikan ke params.referenceMediaItems untuk model yang menyokong input rujukan.

Simulasi tidak pernah memuat naikMod langsung menggunakan /api/v1/files

Model yang dipilih mengawal jenis MIME, saiz dan peraturan durasi yang dibenarkan. Muat naik langsung memerlukan kunci API sementara anda dan mungkin memanggil perkhidmatan muat naik sebenar.

Cipta kunci APIBaca dokumentasi API
Pratonton permintaan
{
  "model": "z-image",
  "prompt": "Foto produk editorial pada set studio yang bersih",
  "params": {
    "aspect_ratio": "1:1"
  }
}
Respons
{
  "id": "mock_task_001",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "result": null,
  "error": null
}
Respons Files API
{
  "id": "file_mock_001",
  "object": "file",
  "kind": "image",
  "file_name": "reference.png",
  "mime_type": "image/png",
  "size_bytes": 245760,
  "url": "https://media.example/reference.png",
  "duration_seconds": null,
  "duration_token": null,
  "created_at": "2026-05-11T00:00:00.000Z",
  "expires_at": null
}
Parameter penjanaan
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Keadaan tugasan

Anggaran kredit asas

1

Status

queued

Dokumentasi API

Baca pengesahan, badan permintaan, respons, idempotensi, parameter model dan kod ralat.

Buka dokumentasi

Pengurusan kunci API

Cipta, salin sekali, batalkan dan putar kunci API daripada kawasan Tetapan yang dilindungi.

Urus kunci

Debug dalam talian

Gunakan contoh simulasi dahulu; debug sebenar memerlukan log masuk, kunci API dan kredit akaun.

Pratonton aliran