Rivya AI

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 hold faktureringen i samme Rivya-saldo for kreditter.
Les API-dokumentasjonenOpprett en API-nøkkel

Hurtigstartoppsett

Modellag

Dynamisk katalog

Fakturering

Delte kreditter

Første versjon

Jobber + chat

Tilgang

API-nøkler

MetodePOST
Endepunkt/api/v1/generations

En ekte forespørsel krever en Rivya API-nøkkel og tilgjengelige kontokreditter. Offentlige eksempler bruker plassholdernøkler 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": 1,
  "result": null,
  "error": null
}

Hva som leveres først

Et offentlig API-lag som samsvarer med Rivya-produktet

API-et er en del av Rivya-produktet. Det bruker Rivya-modell-ID-er, Rivya-kreditter, offentlige oppgavetilstander og dokumentasjon som er koblet til modellkatalogen.

API for bildegenerering

Send inn bildejobber med en prompt og støttede modellparametere, og hent deretter offentlige resultater fra oppgaveendepunktet.

API for videogenerering

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

API for lydgenerering

Bruk lydmodeller som er tilgjengelige via API-et, innenfor samme avgrensning for konto, saldo og historikk.

Delt kredittlommebok

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

Startvei

Fra konto til første API-forespørsel

01

Opprett en nøkkel

Logg inn, åpne API-nøkler i Innstillinger, opprett en nøkkel med avgrenset tilgang 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 om inndataene er klare før innsending.

03

Send inn, hent status eller abonner

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

Versjonsgrense

Tydelig omfang, ingen skjulte løfter

Denne siden skiller tilgjengelige API-funksjoner fra fremtidige tillegg, slik at du kan planlegge ut fra det som er aktivt i dag.

Chat API

Tilgjengelig

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

Files API

Tilgjengelig

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

Brukerwebhooker

Tilgjengelig

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

Nettbasert feilsøker

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

Feilsøkeren starter i mock-modus for alle besøkende. Genereringsvelgeren viser ikke-chatmodeller 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. Feilsøkeren lagrer den ikke etter sideoppdatering.

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-modus laster aldri opp filer.Live-modus 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 reelle 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

Nettbasert feilsøking

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

Forhåndsvis flyt