Rivya API

Bygg på Rivyas multimodale modellag

Rivya API gir produktteam en offentlig, kontobasert måte å kalle Rivya-modeller fra egne apper på. Start med asynkrone bilde-, video- og lydjobber, legg til Chat API-runder med valgfri SSE-strømming når en modell støtter chat, og behold faktureringen i den samme Rivya-kredittlommeboken.
Les API-dokumentasjonenOpprett en API-nøkkel

Quickstart-form

Modellag

Dynamisk katalog

Fakturering

Delte kreditter

Første versjon

Jobber + chat

Tilgang

API-nøkler

MetodePOST
Endepunkt/api/v1/generations

Den ekte forespørselen krever en Rivya API-nøkkel og tilgjengelige kontokreditter. Offentlige eksempler bruker plassholderhemmeligheter og kaller ikke modeller anonymt.

Forespørsel
curl https://rivya.ai/api/v1/generations \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-job-001" \
  -d '{
    "model": "z-image",
    "prompt": "Editorial product photo on a clean studio set"
  }'
Svar
{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 20,
  "result": null,
  "error": null
}

Hva som leveres først

Et offentlig API-lag som holder seg på linje med Rivya-produktet

API-et er utformet som en Rivya-produktflate. Det bruker Rivya-modell-ID-er, Rivya-kreditter, offentlige oppgavetilstander og dokumentasjon som holder seg koblet til modellkatalogen.

API for bildegenerering

Send inn bildejobber med prompt og støttede modellparametere, og poll deretter etter offentlige resultater.

API for videogenerering

Kjør asynkrone videojobber med de samme oppgave- og kredittkontrollene som brukes av Studio.

API for lydgenerering

Bruk API-tilgjengelige lydmodeller gjennom samme konto-, saldo- og historikkgrense.

Delt kredittlommebok

API-kall og Studio-bruk trekker fra samme Rivya-saldo, med reserverte kreditter og feilhåndtering.

Startspor

Fra konto til første API-forespørsel

01

Opprett en nøkkel

Logg inn, åpne API-nøkler i Innstillinger, opprett en scoped nøkkel og lagre hele hemmeligheten umiddelbart.

02

Velg en modell

Les API-modellreferansen eller kall /api/v1/models for å inspisere modell-ID-er, parametere, chatstøtte og inndataklarhet før innsending.

03

Send inn, poll eller abonner

Send en idempotent genereringsforespørsel, poll det offentlige oppgaveendepunktet, bruk signerte webhooks for genererings-callbacks eller send en Chat API-runde med valgfri SSE-strømming.

Versjonsgrense

Tydelig omfang, ingen skjulte løfter

Landingssiden kan nevne fremtidige flater, men den nåværende produktteksten må ikke antyde at uferdige API-er allerede er live.

Chat API

Tilgjengelig

Tilgjengelig for ikke-strømmende og SSE-strømmende runder med API-opprettede økter, kontokreditter og valgfrie bildevedlegg fra Files API.

Files API

Tilgjengelig

Tilgjengelig for opplasting av referansebilder, -videoer og -lyd. Bruk det før generering når en modellside ber om params.referenceMediaItems.

Brukerwebhooks

Tilgjengelig

Tilgjengelig for produksjonsintegrasjoner som vil ha signerte callbacks for vellykkede eller mislykkede genereringsoppgaver.

Nettdebugger

Forhåndsvis forespørselen, og kjør den deretter med din egen API-nøkkel

Debuggeren starter i mock-modus for alle besøkende. Genereringsvelgeren lister modeller uten chat som kan testes uten filopplasting, mens Files-panelet lar innloggede brukere teste /api/v1/files med en midlertidig API-nøkkel. Chat-eksempler finnes i API-dokumentasjonen.

Kontotilstand

Sjekker konto

Aktivt nøkkelprefiks

Opprett en nøkkel først

Gjeldende kreditter

Logg inn for å sjekke

Mock-forhåndsvisningLive Public APIIngen aktiv API-nøkkel

Mock-modus kaller aldri en modell og bruker aldri kreditter.

Lim inn nøkkelen bare for denne forespørselen. Debuggeren lagrer den ikke etter oppdatering.

Opplastingstest for Files API

Last opp referansemedier via POST /api/v1/files, og kopier deretter returnert URL og varighetstoken inn i params.referenceMediaItems for en modell som støtter referanseinndata.

Mock laster aldri oppLive bruker /api/v1/files

Den valgte modellen styrer tillatte MIME-typer, størrelse og varighetsregler. Live-opplastinger krever den midlertidige API-nøkkelen din og kan kalle den ekte opplastingstjenesten.

Opprett API-nøkkelLes API-dokumentasjon
Forhåndsvisning av forespørsel
{
  "model": "z-image",
  "prompt": "Redaksjonelt produktfoto på et rent studiosett",
  "params": {
    "aspect_ratio": "1:1"
  }
}
Svar
{
  "id": "mock_task_001",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "result": null,
  "error": null
}
Files API-svar
{
  "id": "file_mock_001",
  "object": "file",
  "kind": "image",
  "file_name": "reference.png",
  "mime_type": "image/png",
  "size_bytes": 245760,
  "url": "https://media.example/reference.png",
  "duration_seconds": null,
  "duration_token": null,
  "created_at": "2026-05-11T00:00:00.000Z",
  "expires_at": null
}
Genereringsparametere
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Oppgavetilstand

Estimerte basiskreditter

1

Status

queued

API-dokumentasjon

Les om autentisering, forespørselskropper, svar, idempotens, modellparametere og feilkoder.

Åpne dokumentasjon

Administrasjon av API-nøkler

Opprett, kopier én gang, tilbakekall og roter API-nøkler fra det beskyttede Innstillinger-området.

Administrer nøkler

Nettfeilsøking

Bruk mock-eksempler først; ekte feilsøking krever innlogging, en API-nøkkel og kontokreditter.

Forhåndsvis flyt