Cipta API key, pilih model, hantar tugasan penjanaan tak segerak dan hantar giliran Chat API dengan penstriman SSE pilihan.

Mula pantas ini menunjukkan laluan selamat terpendek daripada persediaan akaun kepada satu tugasan penjanaan Rivya API, serta giliran Chat API pertama.

Gunakan key placeholder dalam dokumen dan contoh. Jangan sekali-kali tampal API key sebenar ke dalam kod awam, tangkapan skrin, tiket atau dokumen kongsi.

1. Cipta API Key

Buka tetapan API Keys, cipta key, salin rahsia penuh sekali sahaja dan simpan dalam persekitaran sebelah pelayan anda.

Scope pertama yang disyorkan:

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

2. Sahkan Base URL Anda

Gunakan base URL API produksi:

https://rivya.ai

URL localhost hanya untuk pembangunan setempat. Contoh awam tidak sepatutnya menggunakan rahsia setempat.

3. Senaraikan Model

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

Gunakan medan id daripada respons sebagai nilai model ketika mencipta penjanaan.

4. Hantar Penjanaan

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 tugasan awam. Simpan ID itu supaya anda boleh meninjau status kemudian.

5. Tinjau Status

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

Nilai status ialah:

queued
processing
succeeded
failed

6. Semak Kredit

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

Gunakan ini untuk mengesahkan baki akaun semasa sebelum atau selepas ujian.

7. Pilihan: Tambah Webhooks

Jika pelayan anda boleh menerima callback HTTPS bertandatangan, cipta endpoint 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 papar daripada respons dan sahkan setiap delivery sebelum mempercayai payload.

8. Pilihan: Hantar Giliran Chat

Untuk model chat, panggil Chat API dan bukannya 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": "gpt-5-2-chat",
    "message": "Write a concise launch plan for a new product image campaign"
  }'

Gunakan session_id yang dikembalikan untuk meneruskan sesi yang dicipta API. Lampiran imej mesti merujuk nilai file_id Files API.

Pilihan: Gunakan TypeScript SDK Beta

Integrasi TypeScript sebelah pelayan boleh menggunakan SDK beta setempat:

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 menggunakannya. SDK merangkumi sokongan penstriman Chat sebelah pelayan dalam private beta.

Mula Pantas API Rivya