Buat API kunci, pilih model, kirim pekerjaan generasi asinkron, dan kirim satu turn Chat API dengan aliran langsung SSE opsional.

Mulai cepat ini menunjukkan jalur aman tersingkat dari penyiapan akun ke satu pekerjaan generasi Rivya API, plus turn Chat API pertama.

Gunakan kunci placeholder di docs dan contoh. Jangan pernah menempelkan API kunci nyata ke kode publik, screenshot, tiket, atau dokumen bersama.

Contoh-contoh ini menjelaskan kontrak Public API v1 yang diterapkan. Sebelum menguji, pastikan akses Public API aktif untuk penerapan dan tersedia bagi akun. Endpoint atau halaman model yang terdokumentasi tidak dengan sendirinya membuktikan bahwa permintaan dapat berjalan di semua lingkungan.

1. Buat API Kunci

Buka pengaturan API Keys, buat kunci, salin rahasia lengkap satu kali, lalu simpan di lingkungan sisi server Anda.

Scope pertama yang disarankan:

models:read
generations:create
generations:read
files:create
files:read
credits:read
webhooks:manage
chat:create
chat:read

2. Konfirmasi Base URL

Gunakan base URL API production:

https://rivya.ai

URL localhost hanya untuk pengembangan lokal. Contoh publik tidak boleh memakai rahasia lokal.

3. Daftar Model

curl https://rivya.ai/api/v1/models

Gunakan kolom id dari respons sebagai nilai model saat membuat generasi.

4. Kirim Generasi

curl https://rivya.ai/api/v1/generations \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: quickstart-001" \
  -d '{
    "model": "z-image",
    "prompt": "A clean editorial product image on a soft studio background"
  }'

Respons mengembalikan ID tugas publik. Simpan agar Anda dapat melakukan pemeriksaan berkala status nanti.

5. Polling Status

curl https://rivya.ai/api/v1/generations/task_public_id \
  -H "Authorization: Bearer rvya_sk_..."

Nilai status adalah:

queued
processing
succeeded
failed

6. Periksa Kredit

curl https://rivya.ai/api/v1/credits \
  -H "Authorization: Bearer rvya_sk_..."

Gunakan ini untuk mengonfirmasi saldo akun saat ini sebelum atau setelah pengujian.

7. Opsional: Tambahkan Webhooks

Jika akses webhook aktif untuk penerapan dan akun, serta server Anda dapat menerima panggilan balik HTTPS bertanda tangan, buat titik akhir webhook:

curl https://rivya.ai/api/v1/webhooks \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production webhook",
    "url": "https://example.com/rivya/webhook",
    "event_types": ["generation.succeeded", "generation.failed"]
  }'

Simpan signing_secret sekali tampil dari respons dan verifikasi setiap pengiriman sebelum mempercayai payload.

8. Opsional: Kirim Turn Chat

Untuk model chat, panggil Chat API alih-alih POST /api/v1/generations:

curl https://rivya.ai/api/v1/chat/completions \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: quickstart-chat-001" \
  -d '{
    "model": "claude-sonnet-5-chat",
    "message": "Write a concise launch plan for a new product image campaign"
  }'

Gunakan session_id yang dikembalikan untuk melanjutkan sesi yang dibuat API. Lampiran gambar harus mereferensikan nilai file_id dari Files API.

Opsional: Gunakan TypeScript SDK Beta

Integrasi TypeScript sisi server dapat memakai SDK beta lokal:

import { RivyaClient } from "@rivya/sdk";

const rivya = new RivyaClient({
  apiKey: process.env.RIVYA_API_KEY
});

const generation = await rivya.generations.create({
  model: "z-image",
  prompt: "A clean editorial product image on a soft studio background"
});

Baca Rivya TypeScript SDK sebelum mengadopsinya. SDK private beta menyertakan dukungan Chat aliran langsung sisi server.

Mulai cepat Rivya API