Skapa en API-nyckel, välj en modell, skicka ett asynkront genereringsjobb och skicka en Chat API-turn med valfri SSE-streaming.

Den här snabbstarten visar den kortaste säkra vägen från kontokonfiguration till ett Rivya API-genereringsjobb, plus den första Chat API-turnen.

Använd platshållarnycklar i dokumentation och exempel. Klistra aldrig in en riktig API-nyckel i offentlig kod, skärmbilder, ärenden eller delade dokument.

1. Skapa en API-nyckel

Öppna inställningar för API-nycklar, skapa en nyckel, kopiera hela hemligheten en gång och spara den i din servermiljö.

Rekommenderade första scopes:

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

2. Bekräfta din base URL

Använd produktions-API:ets base URL:

https://rivya.ai

Localhost-URL:er är bara för lokal utveckling. Offentliga exempel ska inte använda lokala hemligheter.

3. Lista modeller

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

Använd fältet id från svaret som värdet model när du skapar en generation.

4. Skicka en generation

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"
  }'

Svaret returnerar ett offentligt uppgifts-ID. Spara det så att du kan polla status senare.

5. Polla status

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

Statusvärden är:

queued
processing
succeeded
failed

6. Kontrollera credits

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

Använd detta för att bekräfta det aktuella kontosaldot före eller efter testning.

7. Valfritt: lägg till webhooks

Om din server kan ta emot signerade HTTPS-callbacks, skapa en webhook-endpoint:

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"]
  }'

Spara den engångsvisade signing_secret från svaret och verifiera varje leverans innan du litar på payloaden.

8. Valfritt: skicka en Chat-turn

För chattmodeller, anropa Chat API i stället för 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"
  }'

Använd det returnerade session_id för att fortsätta den API-skapade sessionen. Bildbilagor måste referera till Files API-värden för file_id.

Valfritt: använd TypeScript SDK Beta

Serverbaserade TypeScript-integrationer kan använda den lokala SDK-betan:

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"
});

Läs Rivya TypeScript SDK innan du börjar använda den. SDK:n innehåller stöd för serverbaserad Chat-streaming i den privata betan.

Rivya API-snabbstart