A Rivya API a fejlesztői út arra, hogy a Rivya modellképességeit a saját termékéből, szkriptjéből vagy munkafolyamatából használja.
Nem külön termék a Rivya Studiótól. Ugyanazt a fiókhatárt, ugyanazt a kreditpénztárcát és ugyanazt a nyilvános modellréteget használja, amelyet a felhasználók a Rivyában látnak. A különbség az, hogyan indul a munka: Studio-kattintások helyett az alkalmazása API-kulccsal küld kéréseket.
Ha végpontrészletekre van szüksége, kezdje a Rivya API áttekintéssel és a Rivya API gyorskezdés útmutatóval. Ez a cikk termékszintű magyarázat: mire való az API, hová illik, és mikor nem ez legyen az első út.
A rövid verzió
A Rivya API v1 lehetővé teszi, hogy egy bejelentkezett fiók API-kulcsokat hozzon létre, és a webes felületen kívülről hívja a Rivya modellképességeit.
A jelenlegi API-felület tartalmazza:
- modellfelfedezés az API modelllistán keresztül
- aszinkron kép-, videó- és audiogenerálási feladatok
- Files API feltöltések olyan modellekhez, amelyek referenciamédiát igényelnek
- generálási állapot lekérdezése nyilvános feladatazonosítókkal
- fiókkredit-ellenőrzések
- Chat API fordulók, opcionális SSE streaminggel
- aláírt webhookok generálásbefejezéshez
- TypeScript SDK beta azoknak a csapatoknak, amelyek kliens wrappert szeretnének
A nyilvános fejlesztői központ a Developers. Ez a legjobb belépő, ha vezetett áttekintést, API-kulcs beállítási linkeket és biztonságos debugger folyamatot szeretne.
Miért van a Rivyának API-ja
A Studio akkor hasznos, amikor egy ember még modelleket választ, promptokat formál, kimeneteket ellenőriz és eldönti, mi legyen a következő lépés.
Az API akkor hasznos, amikor ez a döntés ismételhető termék- vagy működési munkafolyamattá vált.
Gyakori példák:
- egy termék képi variációkat szeretne generálni, miután a felhasználó beküld egy briefet
- egy marketing munkafolyamat strukturált kampánybemenetekből szeretne vizuális vázlatokat létrehozni
- egy belső eszköz videó- vagy audiofeladatokat szeretne beküldeni anélkül, hogy valakinek böngészőt kellene nyitnia
- egy support vagy tartalomrendszer chatmodell-fordulót szeretne a saját felületén
- egy backend szolgáltatás aláírt visszahívásokat szeretne, amikor generálási feladatok befejeződnek
Ilyen esetekben a Rivya API ugyanahhoz a Rivya-fiókhoz tartja kapcsolva a munkát, ahelyett hogy külön stacket kényszerítene számlázáshoz, modellválasztáshoz és feladatállapothoz.
Mit nem vált ki az API
Az API nem vált ki minden okot, amiért közvetlenül a Rivyát használná.
Használja a Rivya Studio útmutató felületet vagy a nyilvános munkafelületeket, amikor:
- a prompt még emberi feltárást igényel
- a modellválasztás nem stabil
- egy alkotónak vizuálisan kell összehasonlítania a kimeneteket
- a projekt mentett előzményektől és kézi ellenőrzéstől függ
- a csapat még nem döntötte el, mely bemeneti és kimeneti formátum váljon ismételhetővé
Használja az API-t, amikor a munkafolyamat elég világos az automatizáláshoz.
Ez a határ számít. Egy homályos kreatív kérdés általában először a Studióba tartozik. Egy ismert termékfolyamat kiszámítható bemenetekkel átmehet az API-ba.
A fő építőelemek
Gondoljon az API-ra hat összekapcsolt darabként.
| Építőelem | Mit kezel | Hol olvasson tovább |
|---|---|---|
| API-kulcsok | Szerver-szerver hozzáférés a fiókjából | API-hitelesítés |
| Modellek | Nyilvános modellazonosítók és készenléti információk | API modellek |
| Generálások | Aszinkron kép-, videó- és audiofeladatok | Generálás létrehozása |
| Fájlok | Referenciakép-, videó- vagy audiofeltöltések | Files API |
| Chat | Nem streamelt vagy streamelt chatfordulók | Chat API |
| Webhookok | Aláírt befejezési események generálási feladatokhoz | API webhookok |
Az API-dokumentáció a kérés- és válaszforma forrása. Ez a cikk abban segít, hogy eldöntse, melyik darabra van először szüksége.
Hogyan működnek a kreditek
Az API-használat ugyanabból a Rivya fiókkredit-pénztárcából költ, mint a Studio.
Ez azt jelenti, hogy az API nem névtelen modellproxy. A kérés egy Rivya-fiókhoz tartozik, az adott fiók által létrehozott API-kulcsot használja, és ugyanazt a termékszintű kredithatárt követi, amelyet az API kreditek ír le.
Ez csapatoknak hasznos, mert a Studio-kísérletek és az API-használat egyetlen működési modellben maradnak. Kézzel tesztelhet egy modellt, majd az ismételhető részt integrációba viheti anélkül, hogy második számlázási réteget hozna létre.
Hogyan illeszkednek a fájlok
Egyes modellek csak szövegből is futnak. Másoknak referenciaképre, videóra vagy audiofájlra van szükségük.
API-integrációknál ezeknek a referenciáknak a Files API útvonalon kell menniük. A feltöltés kezelt fájlrekordot hoz létre, amely átadható a támogatott modellparaméterekbe.
A gyakorlati szabály egyszerű:
- ha egy modell csak szöveges bemenetet fogad, kezdjen a generálási végponttal
- ha egy modellnek referenciamédiára van szüksége, először töltse fel a fájlt
- ha a modell képmellékleteket használó chatmodell, használja a Chat API-t és fájlazonosítókat
Ne böngésző-only feltöltési folyamatokra vagy mentett Studio-munkamenetekre tervezze az integrációt. Az API-nak okkal van saját nyilvános fájlhatára.
Hol segítenek a webhookok
A polling a legegyszerűbb első integrációs út. Küldjön be egy generálási feladatot, mentse a nyilvános feladatazonosítót, és kérdezze le, amíg sikerül vagy hibázik.
A webhookok akkor válnak hasznossá, amikor az integráció produkciósabb:
- nem szeretne workert, amely minden feladatot lekérdez
- az alkalmazásnak rekordot kell frissítenie, amikor a generálás befejeződik
- aláírt eseményt szeretne, amely biztonságosan újrapróbálható
- a sikertelen feladatoknak világos helyreállítási útba kell kerülniük
Az aláírt eseményszerződéshez használja az API webhookok oldalt. Tartsa szűken a webhook-fogadót: ellenőrizze az aláírásokat, kezelje a duplikált eseményeket, és ne tegyen titkos értékeket a logokba.
Jó első API-projekt
A legjobb első API-projekt általában kicsi és konkrét.
Például:
- hozzon létre API-kulcsot a beállításokban
- hívja meg a modelllistát
- válasszon egy elérhető modellt
- küldjön be egy generálási feladatot idempotenciakulccsal
- kérdezze le az állapotvégpontot
- ellenőrizze a krediteket előtte és utána
- csak ezután adja hozzá a Files API-t, Chat API-t vagy Webhooks használatát
Ez az út működő integrációt ad anélkül, hogy minden API-funkciót belekeverne az első tesztbe.
Amikor az API rossz kezdőpont
Az API valószínűleg nem a megfelelő első lépés, amikor:
- a csapat még nem választott modellcsaládot
- a kívánt kimenet minden futtatásban változik
- a prompt kézi ízléstől és ellenőrzéstől függ
- az integráció elrejtené a kreditfelhasználást azok elől, akiknek érteniük kell
- a terméknek automatizálás előtt nyilvános demóra van szüksége
Ilyenkor kezdjen az Image, Video, Audio, Chat vagy AI Models oldalról. Amikor az út ismételhető, vigye a stabil részt az API-ba.
Merre tovább
- Nyissa meg a Developers oldalt a nyilvános API hubhoz és debuggerhez.
- Olvassa el a Rivya API gyorskezdés útmutatót az első biztonságos kéréshez.
- Olvassa el az API-hitelesítés oldalt, mielőtt kulcsot tesz szerverre.
- Olvassa el az API modellek oldalt modellazonosítók kiválasztása előtt.
- Olvassa el a Mikor használja a Rivya API-t Studio helyett cikket, ha a termékhatár még nem világos.
- Olvassa el a Hogyan építsen multimodális AI munkafolyamatot a Rivya API-val cikket, amikor teljes kép-, videó-, audio- vagy chatintegrációt tervez.
