Opprett en API-nøkkel, velg en modell, send inn en asynkron genereringsjobb og send en Chat API-runde med valgfri SSE-streaming.

Denne hurtigstarten viser den korteste trygge veien fra kontooppsett til én Rivya API-genereringsjobb, pluss den første Chat API-runden.

Bruk plassholdernøkler i dokumentasjon og eksempler. Lim aldri inn en ekte API-nøkkel i offentlig kode, skjermbilder, tickets eller delte dokumenter.

1. Opprett en API-nøkkel

Åpne API Keys-innstillinger, opprett en nøkkel, kopier hele hemmeligheten én gang og lagre den i servermiljøet ditt.

Anbefalte første scopes:

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

2. Bekreft base-URL-en din

Bruk produksjons-API-ens base-URL:

https://rivya.ai

Localhost-URL-er er bare for lokal utvikling. Offentlige eksempler bør ikke bruke lokale hemmeligheter.

3. List opp modeller

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

Bruk id-feltet fra responsen som model-verdi når du oppretter en generering.

4. Send inn en generering

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

Responsen returnerer en offentlig task ID. Lagre den slik at du kan polle status senere.

5. Poll status

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

Statusverdiene er:

queued
processing
succeeded
failed

6. Sjekk credits

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

Bruk dette for å bekrefte nåværende kontosaldo før eller etter testing.

7. Valgfritt: Legg til webhooks

Hvis serveren din kan motta signerte HTTPS-callbacks, kan du opprette et webhook-endepunkt:

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

Lagre engangsverdien signing_secret fra responsen og verifiser hver levering før du stoler på payloaden.

8. Valgfritt: Send en chatrunde

For chatmodeller kaller du Chat API i stedet for 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"
  }'

Bruk den returnerte session_id for å fortsette den API-opprettede økten. Bildevedlegg må referere til Files API file_id-verdier.

Valgfritt: Bruk TypeScript SDK Beta

Server-side TypeScript-integrasjoner kan bruke den lokale SDK-betaen:

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

Les Rivya TypeScript SDK før du tar den i bruk. SDK-en inkluderer server-side Chat streaming-støtte i privat beta.

Rivya API-hurtigstart