Opret en API-nøgle, vælg en model, indsend en asynkron genereringsopgave, og send en Chat API-besked med valgfri SSE-streaming.

Denne quickstart viser den korteste sikre vej fra kontoopsætning til ét Rivya API-genereringsjob plus den første Chat API-turn.

Brug placeholder-nøgler i docs og eksempler. Indsæt aldrig en rigtig API-nøgle i offentlig kode, screenshots, tickets eller delte dokumenter.

Eksemplerne beskriver den implementerede Public API v1-kontrakt. Før du tester, skal du bekræfte, at Public API-adgang er aktiveret for installationen og tilgængelig for din konto. Et dokumenteret endpoint eller en modelside beviser ikke i sig selv, at en anmodning kan køres i alle miljøer.

1. Opret en API-nøgle

Åbn indstillingerne for API-nøgler, opret en nøgle, kopiér hele hemmeligheden én gang, og gem den i dit servermiljø.

Anbefalede første scopes:

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

2. Bekræft din base-URL

Brug denne basis-URL til API-et i produktion:

https://rivya.ai

Localhost-URL'er er kun til lokal udvikling. Offentlige eksempler bør ikke bruge lokale secrets.

3. List modeller

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

Brug feltet id fra svaret som model-værdi, når du opretter en generation.

4. Indsend 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 returnerer et offentligt opgave-ID. Gem det, så du kan hente status senere.

5. Kontrollér status

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

Statusværdierne er:

queued
processing
succeeded
failed

6. Tjek kreditter

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

Brug dette til at bekræfte den aktuelle kontosaldo før eller efter test.

7. Valgfrit: tilføj webhooks

Hvis webhookadgang er aktiveret for installationen og kontoen, og din server kan modtage signerede HTTPS-tilbagekald, kan du oprette et webhookslutpunkt:

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

Gem den engangsviste signing_secret fra svaret, og verificer hver delivery, før du stoler på payloaden.

8. Valgfrit: send en chat-turn

For chatmodeller skal du kalde 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": "claude-sonnet-5-chat",
    "message": "Write a concise launch plan for a new product image campaign"
  }'

Brug det returnerede session_id til at fortsætte den API-oprettede session. Billedvedhæftninger skal referere til file_id-værdier fra Fil-API-et.

Valgfrit: brug TypeScript SDK Beta

Serverbaserede TypeScript-integrationer kan bruge den lokale betaversion af SDK'et:

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, før du tager den i brug. SDK'et omfatter understøttelse af chatstreaming på serversiden i den private beta.

Rivya API quickstart