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 async, tambah giliran Chat API dengan streaming SSE pilihan apabila model menyokong chat, dan kekalkan bil dalam dompet kredit Rivya yang sama.
Baca docs APICipta kunci API

Bentuk quickstart

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 placeholder dan tidak memanggil model secara anonim.

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": 20,
  "result": null,
  "error": null
}

Perkara yang dihantar dahulu

Lapisan API awam yang kekal selari dengan produk Rivya

API direka sebagai permukaan produk Rivya. Ia menggunakan ID model Rivya, kredit Rivya, keadaan tugasan awam dan docs yang kekal bersambung dengan katalog model.

API penjanaan imej

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

API penjanaan video

Jalankan kerja video async 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, poll atau langgan

Hantar permintaan generasi idempotent, poll endpoint tugasan awam, gunakan webhook bertandatangan untuk callback generasi, atau hantar giliran Chat API dengan streaming SSE pilihan.

Sempadan versi

Skop jelas, tiada janji tersembunyi

Landing page boleh menyebut permukaan masa depan, tetapi salinan produk semasa tidak boleh menggambarkan API yang belum selesai sebagai sudah live.

Chat API

Tersedia

Tersedia untuk giliran bukan streaming dan streaming 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 production yang mahu callback bertandatangan bagi tugasan generasi yang berjaya atau gagal.

Debugger dalam talian

Pratonton permintaan, kemudian jalankan dengan kunci API anda sendiri

Debugger bermula dalam mod mock untuk setiap pelawat. Pemilih generasi 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 docs API.

Keadaan akaun

Menyemak akaun

Prefix kunci aktif

Cipta kunci dahulu

Kredit semasa

Log masuk untuk menyemak

Pratonton mockPublic API liveTiada kunci API aktif

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

Tampal kunci hanya untuk permintaan ini. Debugger tidak menyimpannya selepas refresh.

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.

Mock tidak pernah memuat naikLive menggunakan /api/v1/files

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

Cipta kunci APIBaca docs 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
}
Params generasi
{
  "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 docs

Pengurusan kunci API

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

Urus kunci

Debug dalam talian

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

Pratonton aliran