Rivya API

Bygg på Rivyas multimodala modellager

Rivya API ger produktteam ett publikt, kontobaserat sätt att anropa Rivya-modeller från sina egna appar. Börja med asynkrona bild-, video- och ljudjobb, lägg till Chat API-omgångar med valfri SSE-streaming när en modell stöder chatt och håll faktureringen i samma Rivya-kreditplånbok.
Läs API-dokumentationenSkapa en API-nyckel

Snabbstartsform

Modellager

Dynamisk katalog

Fakturering

Delade krediter

Första versionen

Jobb + chatt

Åtkomst

API-nycklar

MetodPOST
Endpoint/api/v1/generations

Den verkliga begäran kräver en Rivya API-nyckel och tillgängliga kontokrediter. Publika exempel använder platshållarvärden för hemligheter och anropar inte modeller anonymt.

Begäran
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
}

Vad som lanseras först

Ett publikt API-lager som håller sig i linje med Rivya-produkten

API:t är utformat som en Rivya-produktvy. Det använder Rivyas modell-ID:n, Rivya-krediter, publika uppgiftsstatusar och dokumentation som är kopplad till modellkatalogen.

API för bildgenerering

Skicka bildjobb med prompt och modellparametrar som stöds och polla sedan efter publika resultat.

API för videogenerering

Kör asynkrona videojobb med samma uppgifts- och kreditkontroller som används i Studio.

API för ljudgenerering

Använd API-tillgängliga ljudmodeller genom samma konto-, saldo- och historikgräns.

Delad kreditplånbok

API-anrop och Studio-användning drar från samma Rivya-saldo, med reserverade krediter och felhantering.

Startväg

Från konto till första API-begäran

01

Skapa en nyckel

Logga in, öppna API-nycklar i Inställningar, skapa en nyckel med rätt behörigheter och spara hela hemligheten direkt.

02

Välj en modell

Läs API:s modellreferens eller anropa /api/v1/models för att inspektera modell-ID:n, parametrar, chattfunktioner och om modellen är redo för indata innan du skickar in.

03

Skicka, kontrollera status eller prenumerera

Skicka en idempotent genereringsbegäran, kontrollera den publika uppgiftsendpointen, använd signerade webhooks för genereringsåteranrop eller skicka en Chat API-omgång med valfri SSE-streaming.

Versionsgräns

Tydlig omfattning, inga dolda löften

Landningssidan kan nämna framtida ytor, men aktuell produkttext får inte antyda att ofärdiga API:er redan är live.

Chat API

Tillgängligt

Tillgängligt för icke-streamade och SSE-streamade omgångar med API-skapade sessioner, kontokrediter och valfria bildbilagor via Files API.

Files API

Tillgängligt

Tillgängligt för uppladdning av referensbilder, videor och ljud. Använd det före generering när en modellsida efterfrågar params.referenceMediaItems.

Användarwebhooks

Tillgängligt

Tillgängligt för produktionsintegrationer som vill ha signerade återanrop för genereringsuppgifter som lyckas eller misslyckas.

Onlinedebugger

Förhandsgranska begäran och kör den sedan med din egen API-nyckel

Debuggern startar i mockläge för varje besökare. Genereringsväljaren listar icke-chattmodeller som kan testas utan filuppladdning, medan Files-panelen låter inloggade användare testa /api/v1/files med en tillfällig API-nyckel. Chattexempel finns i API-dokumentationen.

Kontostatus

Kontrollerar konto

Aktivt nyckelprefix

Skapa först en nyckel

Aktuella krediter

Logga in för att kontrollera

MockförhandsgranskningLive Public APIIngen aktiv API-nyckel

Mockläge anropar aldrig en modell och förbrukar aldrig krediter.

Klistra in nyckeln endast för den här begäran. Debuggern sparar den inte efter uppdatering.

Uppladdningstest för Files API

Ladda upp referensmedia via POST /api/v1/files, kopiera sedan den returnerade URL:en och varaktighetstoken till params.referenceMediaItems för en modell som stöder referensinmatningar.

Mock laddar aldrig uppLive använder /api/v1/files

Den valda modellen styr tillåtna MIME-typer, storlek och varaktighetsregler. Liveuppladdningar kräver din tillfälliga API-nyckel och kan anropa den verkliga uppladdningstjänsten.

Skapa API-nyckelLäs API-dokumentation
Förhandsgranskning av begäran
{
  "model": "z-image",
  "prompt": "Redaktionellt produktfoto i en ren studiomiljö",
  "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
}
Svar från Files API
{
  "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
}
Genereringsparametrar
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Uppgiftsstatus

Uppskattade baskrediter

1

Status

queued

API-dokumentation

Läs om autentisering, begäranskroppar, svar, idempotens, modellparametrar och felkoder.

Öppna dokumentation

Hantering av API-nycklar

Skapa, kopiera en gång, återkalla och rotera API-nycklar från den skyddade inställningsytan.

Hantera nycklar

Onlinedebuggning

Använd mockexempel först; verklig debuggning kräver inloggning, en API-nyckel och kontokrediter.

Förhandsgranska flöde