Rivya API

Bangun di atas layer model multimodal Rivya

Rivya API memberi tim produk cara publik berbasis akun untuk memanggil model Rivya dari app mereka sendiri. Mulai dari job gambar, video, dan audio asynchronous, tambahkan turn Chat API dengan SSE streaming opsional saat model mendukung chat, dan pertahankan tagihan di wallet kredit Rivya yang sama.

Bentuk quickstart

Layer model

Katalog dinamis

Tagihan

Kredit bersama

Versi pertama

Job + Chat

Akses

API key

MetodePOST
Endpoint/api/v1/generations

Request nyata membutuhkan API key Rivya dan kredit akun yang tersedia. Contoh publik memakai secret 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
}

Yang hadir lebih dulu

Layer API publik yang tetap selaras dengan produk Rivya

API ini dirancang sebagai permukaan produk Rivya. Ia memakai ID model Rivya, kredit Rivya, status tugas publik, dan docs yang tetap terhubung ke katalog model.

API generasi gambar

Kirim job gambar dengan prompt dan parameter model yang didukung, lalu polling untuk hasil publik.

API generasi video

Jalankan job video asynchronous dengan kontrol tugas dan kredit yang sama seperti Studio.

API generasi audio

Gunakan model audio yang dapat diakses API melalui batas akun, saldo, dan riwayat yang sama.

Wallet kredit bersama

Panggilan API dan penggunaan Studio menarik saldo Rivya yang sama, dengan kredit dicadangkan dan penanganan kegagalan.

Jalur mulai

Dari akun ke request API pertama

01

Buat key

Sign in, buka API Keys di Settings, buat key dengan scope, lalu simpan secret lengkapnya segera.

02

Pilih model

Baca referensi model API atau panggil /api/v1/models untuk memeriksa ID model, parameter, kapabilitas chat, dan kesiapan input sebelum mengirim.

03

Kirim, polling, atau subscribe

Kirim request generasi idempotent, polling endpoint tugas publik, gunakan webhook bertanda tangan untuk callback generasi, atau kirim turn Chat API dengan SSE streaming opsional.

Batas versi

Scope jelas, tanpa janji tersembunyi

Landing page dapat menyebut permukaan masa depan, tetapi copy produk saat ini tidak boleh menyiratkan API yang belum selesai sudah live.

Chat API

Tersedia

Tersedia untuk turn non-streaming dan SSE streaming dengan session yang dibuat API, kredit akun, dan lampiran gambar Files API opsional.

Files API

Tersedia

Tersedia untuk unggahan referensi gambar, video, dan audio. Gunakan sebelum generasi saat halaman model meminta params.referenceMediaItems.

Webhook pengguna

Tersedia

Tersedia untuk integrasi produksi yang menginginkan callback bertanda tangan untuk tugas generasi berhasil atau gagal.

Debugger online

Pratinjau request, lalu jalankan dengan API key Anda sendiri

Debugger mulai dalam mode mock untuk setiap pengunjung. Selector generasi mencantumkan model non-chat yang dapat diuji tanpa mengunggah file, sementara panel Files memungkinkan pengguna yang sudah sign in menguji /api/v1/files dengan API key sementara. Contoh chat berada di docs API.

Status akun

Memeriksa akun

Prefix key aktif

Buat key terlebih dahulu

Kredit saat ini

Sign in untuk memeriksa

Pratinjau mockPublic API liveTidak ada API key aktif

Mode mock tidak pernah memanggil model dan tidak pernah mengonsumsi kredit.

Tempel key hanya untuk request ini. Debugger tidak menyimpannya setelah refresh.

Tes unggah Files API

Unggah media referensi melalui POST /api/v1/files, lalu salin URL dan duration token yang dikembalikan ke params.referenceMediaItems untuk model yang mendukung input referensi.

Mock tidak pernah mengunggahLive memakai /api/v1/files

Model yang dipilih mengontrol tipe MIME, ukuran, dan aturan durasi yang diizinkan. Unggahan live membutuhkan API key sementara Anda dan dapat memanggil layanan unggah nyata.

Pratinjau request
{
  "model": "z-image",
  "prompt": "Foto produk editorial di 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
}
Response 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 generasi
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Status tugas

Estimasi kredit dasar

1

Status

queued

Dokumentasi API

Baca autentikasi, request body, response, idempotency, parameter model, dan kode error.

Buka docs

Manajemen API key

Buat, salin sekali, cabut, dan rotasi API key dari area Settings yang terlindungi.

Kelola key

Debugging online

Gunakan contoh mock terlebih dahulu; debugging nyata membutuhkan login, API key, dan kredit akun.

Pratinjau flow