Rivya API

Építs a Rivya multimodális modellrétegére

A Rivya API nyilvános, fiókalapú módot ad a termékcsapatoknak arra, hogy saját alkalmazásaikból hívják a Rivya modelleket. Kezdd aszinkron kép-, videó- és hangfeladatokkal, adj hozzá opcionális SSE streaminget használó Chat API-köröket, amikor egy modell chatképes, és tartsd a számlázást ugyanabban a Rivya kreditkeretben.
API-dokumentáció olvasásaAPI-kulcs létrehozása

Gyorsindítási forma

Modellréteg

Dinamikus katalógus

Számlázás

Megosztott kreditek

Első verzió

Feladatok + Chat

Hozzáférés

API-kulcsok

MetódusPOST
Végpont/api/v1/generations

A valódi kéréshez Rivya API-kulcs és elérhető fiókkreditek szükségesek. A nyilvános példák helyőrző titkokat használnak, és nem hívnak modelleket anonim módon.

Kérés
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"
  }'
Válasz
{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 20,
  "result": null,
  "error": null
}

Mi érkezik először

Nyilvános API-réteg, amely összhangban marad a Rivya termékkel

Az API Rivya-termékfelületként készült. Rivya modellazonosítókat, Rivya krediteket, nyilvános feladatállapotokat és a modellkatalógushoz kapcsolódó dokumentációt használ.

Képgenerálási API

Küldj be képfeladatokat prompttal és támogatott modellparaméterekkel, majd kérdezd le a nyilvános eredményeket.

Videógenerálási API

Futtass aszinkron videófeladatokat ugyanazokkal a feladat- és kreditkontrollokkal, amelyeket a Studio használ.

Hanggenerálási API

Használd az API-n keresztül elérhető hangmodelleket ugyanazon a fiók-, egyenleg- és előzményhatáron belül.

Megosztott kreditkeret

Az API-hívások és a Studio használata ugyanabból a Rivya-egyenlegből dolgozik, lefoglalt kreditekkel és hibakezeléssel.

Kezdő útvonal

A fióktól az első API-kérésig

01

Kulcs létrehozása

Jelentkezz be, nyisd meg a Beállításokban az API Keys oldalt, hozz létre egy hatókörrel ellátott kulcsot, és azonnal mentsd el a teljes titkot.

02

Modell kiválasztása

Olvasd el az API modellreferenciát, vagy hívd meg a /api/v1/models végpontot a modellazonosítók, paraméterek, chatképességek és bemeneti készenlét ellenőrzéséhez, mielőtt beküldesz egy feladatot.

03

Beküldés, lekérdezés vagy feliratkozás

Küldj idempotens generálási kérést, kérdezd le a nyilvános feladatvégpontot, használj aláírt webhookokat a generálási visszahívásokhoz, vagy küldj Chat API-kört opcionális SSE streaminggel.

Verzióhatár

Tiszta hatókör, rejtett ígéretek nélkül

A nyitóoldal említhet jövőbeli felületeket, de az aktuális termékszöveg nem sugallhatja, hogy a még el nem készült API-k már élnek.

Chat API

Elérhető

Elérhető nem streamelt és SSE streaminget használó körökhöz API-val létrehozott munkamenetekkel, fiókkreditekkel és opcionális Files API képmellékletekkel.

Files API

Elérhető

Elérhető referenciakép-, videó- és hangfeltöltésekhez. Használd generálás előtt, amikor egy modelloldal params.referenceMediaItems értéket kér.

Felhasználói webhookok

Elérhető

Elérhető olyan éles integrációkhoz, amelyek aláírt visszahívásokat szeretnének sikeres vagy sikertelen generálási feladatokról.

Online hibakereső

Nézd meg előre a kérést, majd futtasd a saját API-kulcsoddal

A hibakereső minden látogatónál mock módban indul. A generálási választó olyan nem chat modelleket listáz, amelyek fájlfeltöltés nélkül tesztelhetők, míg a Files panel lehetővé teszi a bejelentkezett felhasználóknak a /api/v1/files tesztelését ideiglenes API-kulccsal. A Chat-példák az API-dokumentációban találhatók.

Fiókállapot

Fiók ellenőrzése

Aktív kulcs előtagja

Előbb hozz létre egy kulcsot

Jelenlegi kreditek

Jelentkezz be az ellenőrzéshez

Mock előnézetÉlő Public APINincs aktív API-kulcs

A mock mód soha nem hív modellt, és soha nem fogyaszt kreditet.

Csak ehhez a kéréshez illeszd be a kulcsot. A hibakereső frissítés után nem tárolja.

Files API feltöltési teszt

Tölts fel referencia médiát POST /api/v1/files hívással, majd másold a visszaadott URL-t és duration tokent a params.referenceMediaItems mezőbe egy referencia-bemeneteket támogató modellnél.

A mock soha nem tölt felAz élő mód /api/v1/files végpontot használ

A kiválasztott modell szabja meg az engedélyezett MIME-típusokat, méretet és időtartamszabályokat. Az élő feltöltésekhez ideiglenes API-kulcs szükséges, és valódi feltöltési szolgáltatást hívhatnak.

API-kulcs létrehozásaAPI-dokumentáció olvasása
Kérés előnézete
{
  "model": "z-image",
  "prompt": "Szerkesztőségi termékfotó tiszta stúdiódíszletben",
  "params": {
    "aspect_ratio": "1:1"
  }
}
Válasz
{
  "id": "mock_task_001",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "result": null,
  "error": null
}
Files API válasz
{
  "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
}
Generálási paraméterek
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Feladatállapot

Becsült alap kreditek

1

Állapot

queued

API-dokumentáció

Olvasd el a hitelesítést, kéréstesteket, válaszokat, idempotenciát, modellparamétereket és hibakódokat.

Dokumentáció megnyitása

API-kulcsok kezelése

Hozz létre, másolj ki egyszer, vond vissza és rotálj API-kulcsokat a védett Beállítások területen.

Kulcsok kezelése

Online hibakeresés

Először használj mock példákat; a valódi hibakereséshez bejelentkezés, API-kulcs és fiókkreditek szükségesek.

Folyamat előnézete