Mi az a Rivya API?

A Rivya API fejlesztői szerződés, amellyel a támogatott Rivya-modellképességeket saját termékből, szkriptből vagy munkafolyamatból használhatja, ha a Public API-hozzáférés engedélyezve van a telepítéshez és elérhető a fióknak.

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 jogosult, bejelentkezett fiók API-kulcsokat hozzon létre, és API-képes Rivya-modelleket hívjon meg a webes felületen kívülről. A fejlesztői oldalak a megvalósított szerződést írják le; a futtathatóságot az élő telepítés, a fiókjogosultságok és a modellkészültség határozza meg.

A megvalósított API-felület részei:

• 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 generálásbefejezési webhookok, ha a webhookok engedélyezve vannak a telepítésben

• 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, amikor az API-hozzáférés engedélyezve van:

• egy termék képi variációkat szeretne generálni, miután a felhasználó beküld egy feladatleírást

• 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 ügyféltámogatási vagy tartalomkezelő rendszer Chat-modellforduló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 eszközrendszert követelne meg a számlázáshoz, a modellválasztáshoz és a 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 generálási leírás 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.

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 lekérdezés a legegyszerűbb első integrációs út. Küldjön be egy generálási feladatot, mentse el a nyilvános feladatazonosítót, majd kérdezze le az állapotot a sikeres vagy sikertelen befejezésig.

Ha a telepítésben engedélyezve vannak a webhookok, az integráció éles üzemi érettségével egyre hasznosabbá válnak:

• nem szeretné, hogy egy worker minden feladatot lekérdezzen

• az alkalmazásnak frissítenie kell egy rekordot a generálás befejezésekor

• biztonságosan megismételhető, aláírt eseményre van szükség

• a sikertelen feladatoknak egyértelmű helyreállítási útra kell kerülniük

Az aláírt eseményszerződést az API-webhookok ismertetik. Mielőtt ezekre épít, ellenőrizze, hogy a funkció elérhető-e. A webhookfogadó feladata maradjon szűk: ellenőrizze az aláírásokat, kezelje a duplikált eseményeket, és ne írjon titkos értékeket a naplókba.

Jó első API-projekt

A legjobb első API-projekt általában kicsi és konkrét.

Például:

1. ellenőrizze, hogy az API-hozzáférés engedélyezve van-e a telepítéshez és a fiókhoz

2. hozzon létre API-kulcsot a beállításokban

3. kérje le a modelllistát

4. válasszon egy API-képes modellt

5. küldjön be egy generálási feladatot idempotenciakulccsal

6. kérdezze le az állapot-végpontot

7. ellenőrizze a krediteket előtte és utána

8. csak ezután adja hozzá a Files API-t, a Chat API-t vagy a telepítés által elérhetővé tett webhookokat

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 generálási leírás emberi í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-modellek oldalról. Amikor a folyamat ismételhetővé válik, vigye át 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.