Rivya AI

Rivya API

Rakenna Rivyan multimodaalisen mallikerroksen päälle

Rivya API antaa tuotetiimeille julkisen, tilipohjaisen tavan kutsua Rivya-malleja omista sovelluksistaan. Aloita asynkronisista kuva-, video- ja äänitöistä, lisää Chat API -vuoroja valinnaisella SSE-streamauksella, kun malli tukee chatia, ja pidä laskutus samassa Rivya-krediittilompakossa.
Lue API-dokumentaatioLuo API-avain

Quickstart-muoto

Mallikerros

Dynaaminen katalogi

Laskutus

Jaetut krediitit

Ensimmäinen versio

Työt + Chat

Käyttöoikeus

API-avaimet

MetodiPOST
Endpoint/api/v1/generations

Todellinen pyyntö vaatii Rivya API -avaimen ja tilillä saatavilla olevia krediittejä. Julkiset esimerkit käyttävät placeholder-secretejä eivätkä kutsu malleja anonyymisti.

Pyyntö
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"
  }'
Vastaus
{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "result": null,
  "error": null
}

Mitä toimitetaan ensin

Julkinen API-kerros, joka pysyy linjassa Rivya-tuotteen kanssa

API on osa Rivya-tuotetta. Se käyttää Rivyan mallitunnisteita ja krediittejä, julkisia tehtävätiloja sekä mallikatalogiin liittyvää dokumentaatiota.

Kuvageneroinnin API

Lähetä kuvatöitä promptilla ja tuetuilla malliparametreilla, ja pollaa sen jälkeen julkisia tuloksia.

Videogeneroinnin API

Aja asynkronisia videotöitä samoilla tehtävä- ja krediittirajoilla, joita Studio käyttää.

Äänigeneroinnin API

Käytä API:n kautta saatavilla olevia äänimalleja saman tilin, saldon ja historiarajan sisällä.

Jaettu krediittilompakko

API-kutsut ja Studio-käyttö käyttävät samaa Rivya-saldoa, mukaan lukien varatut krediitit ja virheiden käsittely.

Aloituspolku

Tilistä ensimmäiseen API-pyyntöön

01

Luo avain

Kirjaudu sisään, avaa Settings-kohdan API Keys, luo rajattu avain ja tallenna koko secret heti.

02

Valitse malli

Lue API-malliviite tai kutsu /api/v1/models nähdäksesi malli-ID:t, parametrit, chat-ominaisuudet ja syötteen valmiuden ennen lähettämistä.

03

Lähetä, pollaa tai tilaa

Lähetä idempotentti generointipyyntö, pollaa julkista tehtäväendpointia, käytä allekirjoitettuja webhookeja generointicallbackeihin tai lähetä Chat API -vuoro valinnaisella SSE-streamauksella.

Versioraja

Selkeä rajaus, ei piilotettuja lupauksia

Tällä sivulla erotetaan saatavilla olevat API-ominaisuudet tulevista lisäyksistä, jotta voit suunnitella nykyisten ominaisuuksien pohjalta.

Chat API

Saatavilla

Saatavilla ei-streamaaville ja SSE-streamaaville vuoroille, joissa on API:n luomat istunnot, tilikrediitit ja valinnaiset Files API -kuvaliitteet.

Files API

Saatavilla

Saatavilla referenssikuvien, -videoiden ja -äänien latauksiin. Käytä sitä ennen generointia, kun mallisivu pyytää params.referenceMediaItems-arvoa.

Käyttäjäwebhookit

Saatavilla

Saatavilla tuotantointegraatioihin, jotka haluavat allekirjoitettuja callbackeja onnistuneista tai epäonnistuneista generointitehtävistä.

Online-debuggeri

Esikatsele pyyntö ja aja se sitten omalla API-avaimellasi

Debuggeri käynnistyy mock-tilassa jokaiselle kävijälle. Generointivalitsin listaa muut kuin chat-mallit, joita voi testata ilman tiedostojen latausta, ja Files-paneeli antaa kirjautuneiden käyttäjien testata /api/v1/files-reittiä väliaikaisella API-avaimella. Chat-esimerkit ovat API-dokumentaatiossa.

Tilin tila

Tarkistetaan tiliä

Aktiivisen avaimen prefix

Luo ensin avain

Nykyiset krediitit

Kirjaudu sisään tarkistaaksesi

Mock-esikatseluLive Public APIEi aktiivista API-avainta

Mock-tila ei koskaan kutsu mallia eikä kuluta krediittejä.

Liitä avain vain tätä pyyntöä varten. Debuggeri ei tallenna sitä päivityksen jälkeen.

Files API -lataustesti

Lataa referenssimedia POST /api/v1/files -kutsulla, kopioi sitten palautettu URL ja duration token mallin params.referenceMediaItems-arvoon, kun malli tukee referenssisyötteitä.

Mock ei koskaan lataa tiedostoaLive käyttää /api/v1/files-reittiä

Valittu malli määrittää sallitut MIME-tyypit, koon ja kestosäännöt. Live-lataukset vaativat väliaikaisen API-avaimesi ja voivat kutsua oikeaa latauspalvelua.

Luo API-avainLue API-dokumentaatio
Pyynnön esikatselu
{
  "model": "z-image",
  "prompt": "Editoriaalinen tuotekuva puhtaassa studioasetelmassa",
  "params": {
    "aspect_ratio": "1:1"
  }
}
Vastaus
{
  "id": "mock_task_001",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "result": null,
  "error": null
}
Files API -vastaus
{
  "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
}
Generointiparametrit
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Tehtävän tila

Arvioidut peruskrediitit

1

Tila

queued

API-dokumentaatio

Lue autentikointi, pyyntöjen rungot, vastaukset, idempotenssi, malliparametrit ja virhekoodit.

Avaa dokumentaatio

API-avainten hallinta

Luo, kopioi kerran, peru ja vaihda API-avaimia suojatulla Settings-alueella.

Hallitse avaimia

Online-debuggaus

Käytä ensin mock-esimerkkejä; todellinen debuggaus vaatii kirjautumisen, API-avaimen ja tilin krediittejä.

Esikatsele virta