Maak een API-sleutel aan, kies een model, dien een asynchrone generatietaak in en verstuur een Chat API-turn met optionele SSE-streaming.

Deze snelstart toont het kortste veilige pad van accountsetup naar één Rivya API-generatietaak, plus de eerste Chat API-turn.

Gebruik placeholdersleutels in docs en voorbeelden. Plak nooit een echte API-sleutel in publieke code, screenshots, tickets of gedeelde documenten.

De voorbeelden beschrijven het geïmplementeerde contract van de openbare API v1. Controleer vóór het testen of openbare API-toegang voor de deployment is ingeschakeld en voor je account beschikbaar is. Een gedocumenteerd endpoint of een modelpagina bewijst op zichzelf niet dat een verzoek in elke omgeving kan draaien.

1. Maak een API-sleutel aan

Open API Keys-instellingen, maak een sleutel aan, kopieer het volledige geheim één keer en bewaar het in je server-side omgeving.

Aanbevolen eerste scopes:

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

2. Bevestig je base URL

Gebruik de productie-API-base-URL:

https://rivya.ai

Localhost-URL's zijn alleen voor lokale ontwikkeling. Publieke voorbeelden mogen geen lokale secrets gebruiken.

3. Modellen tonen

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

Gebruik het veld id uit de response als de model-waarde wanneer je een generatie aanmaakt.

4. Een generatie indienen

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

De response retourneert een publieke taak-ID. Bewaar die zodat je later de status kunt pollen.

5. Status pollen

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

Statuswaarden zijn:

queued
processing
succeeded
failed

6. Credits controleren

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

Gebruik dit om het huidige accountsaldo vóór of na testen te bevestigen.

7. Optioneel: webhooks toevoegen

Als webhooktoegang voor de deployment en het account is ingeschakeld en je server ondertekende HTTPS-callbacks kan ontvangen, maak dan een webhook endpoint aan:

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

Bewaar de eenmalige signing_secret uit de response en verifieer elke delivery voordat je de payload vertrouwt.

8. Optioneel: verstuur een Chat-turn

Roep voor chatmodellen Chat API aan in plaats van 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"
  }'

Gebruik de teruggegeven session_id om de API-aangemaakte sessie voort te zetten. Afbeeldingsbijlagen moeten verwijzen naar Files API file_id-waarden.

Optioneel: gebruik de TypeScript SDK beta

Server-side TypeScript-integraties kunnen de lokale SDK beta gebruiken:

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

Lees Rivya TypeScript-SDK voordat je die adopteert. De SDK bevat server-side Chat-streamingondersteuning in de private beta.

Rivya API-snelstart