Rivya API je vývojářský kontrakt pro použití podporovaných možností modelů Rivya ve vlastním produktu, skriptu nebo procesu, když je přístup k veřejnému API zapnutý pro nasazení a dostupný vašemu účtu.
Není to samostatný produkt oddělený od Rivya Studia. Používá stejnou hranici účtu, stejnou kreditní peněženku a stejnou veřejnou vrstvu modelů, kterou uživatelé vidí napříč Rivya. Rozdíl je v tom, jak práce začíná: místo klikání ve Studiu vaše aplikace odesílá požadavky s API klíčem.
Pokud potřebujete podrobnosti o koncových bodech, začněte stránkami Přehled Rivya API a Rychlý start Rivya API. Tento článek vysvětluje API na úrovni produktu: k čemu slouží, kam zapadá a kdy by nemělo být první cestou.
Krátká verze
Rivya API v1 umožňuje oprávněnému přihlášenému účtu vytvářet API klíče a volat modely Rivya připravené pro API mimo webové rozhraní. Vývojářské stránky popisují implementovaný kontrakt; možnost spuštění určuje aktivní nasazení, oprávnění účtu a připravenost modelu.
Implementované rozhraní API zahrnuje:
objevování modelů přes seznam API modelů
asynchronní generační úlohy pro obrázky, video a audio
nahrávání přes rozhraní Files API pro modely, které potřebují referenční média
pravidelné dotazování na stav generování s veřejnými ID úloh
kontroly kreditů účtu
tahy Chat API včetně volitelného SSE streamování
podepsané webhooky dokončení generování, pokud jsou webhooky v nasazení zapnuté
soukromá zkušební verze TypeScript SDK pro týmy, které chtějí klientskou knihovnu
Veřejný vývojářský hub je Developers. Je to nejlepší vstup, pokud chcete řízený přehled, odkazy na nastavení API klíčů a bezpečný tok debuggeru.
Proč má Rivya API
Studio je užitečné, když člověk stále vybírá modely, tvaruje prompty, reviduje výstupy a rozhoduje, co dělat dál.
API je užitečné, když se toto rozhodnutí změnilo v opakovatelný produktový nebo provozní pracovní postup.
Běžné příklady, když je přístup k API zapnutý:
produkt má generovat varianty obrázků poté, co uživatel odešle zadání
marketingový pracovní postup potřebuje vytvářet vizuální návrhy ze strukturovaných vstupů kampaně
interní nástroj potřebuje odesílat video nebo audio úlohy, aniž by někdo otevíral prohlížeč
podpůrný nebo obsahový systém chce tah chatového modelu uvnitř svého vlastního rozhraní
serverová služba potřebuje podepsaná zpětná volání po dokončení úloh generování
V těchto případech Rivya API udržuje práci napojenou na stejný účet Rivya místo toho, aby vás nutilo stavět oddělený stack pro fakturaci, výběr modelů a stav úloh.
Co API nenahrazuje
API nenahrazuje každý důvod používat Rivya přímo.
Použijte Průvodce Rivya Studio nebo veřejné pracovní plochy, když:
prompt stále potřebuje lidské zkoumání
volba modelu není stabilní
tvůrce potřebuje vizuálně porovnat výstupy
projekt závisí na uložené historii a ruční revizi
tým ještě nerozhodl, který vstupní a výstupní formát se má stát opakovatelným
Použijte API, když je pracovní postup dost jasný na automatizaci.
Na této hranici záleží. Vágní kreativní otázka obvykle patří nejdřív do Studia. Známý produktový tok s předvídatelnými vstupy se může přesunout do API.
Hlavní stavební bloky
Představte si API jako šest propojených částí.
| Stavební blok | Co obsluhuje | Kde číst dál |
|---|---|---|
| API klíče | Přístup server-to-server z vašeho účtu | Ověřování API |
| Modely | Veřejná ID modelů a informace o připravenosti | Modely API |
| Generations | Asynchronní úlohy pro obrázky, video a audio | Vytvoření generování |
| Soubory | Nahrávání referenčních obrázků, videí nebo zvuku | Files API |
| Chat | Nestreamované nebo streamované chatové tahy | Chat API |
| Webhooky | Podepsané události o dokončení generování, pokud je funkce zapnutá | Webhooky API |
API dokumentace je zdrojem tvaru požadavků a odpovědí. Tento článek vám má pomoct rozhodnout, který díl potřebujete jako první.
Jak fungují kredity
Používání API čerpá ze stejné kreditní peněženky účtu Rivya jako Studio.
To znamená, že API není anonymní proxy k modelům. Požadavek patří účtu Rivya, používá API klíč vytvořený tímto účtem a dodržuje stejnou produktovou hranici kreditů popsanou v API kreditech.
Pro týmy je to užitečné, protože experimenty ve Studiu a používání API zůstávají v jednom provozním modelu. Model můžete ručně otestovat a potom přesunout opakovatelnou část do integrace bez vytváření druhé fakturační vrstvy.
Jak do toho zapadají soubory
Některé modely mohou běžet jen z textu. Jiné potřebují referenční obrázek, video nebo audio soubor.
V integracích API mají tyto referenční podklady procházet přes Files API. Nahrání vytvoří spravovaný záznam souboru, který lze předat do podporovaných parametrů modelu.
Praktické pravidlo je jednoduché:
pokud model přijímá pouze textový vstup, začněte koncovým bodem generování
pokud model potřebuje referenční média, nahrajte nejdřív soubor
pokud je model chatový a má obrazové přílohy, použijte Chat API a file IDs
Nenavrhujte integraci kolem uploadových toků určených jen pro prohlížeč nebo uložených relací Studia. API má vlastní veřejnou hranici pro soubory z dobrého důvodu.
Kde pomáhají webhooky
Pravidelné dotazování je nejjednodušší první cesta integrace. Odešlete úlohu generování, uložte její veřejné ID a dotazujte stav, dokud úloha neskončí úspěchem nebo chybou.
Když jsou webhooky pro nasazení zapnuté, začnou být užitečné s tím, jak se integrace blíží produkčnímu provozu:
nechcete, aby worker dotazoval každou úlohu
aplikace potřebuje po dokončení generování aktualizovat záznam
potřebujete podepsanou událost, kterou lze bezpečně opakovat
selhané úlohy musí přejít do jasného procesu obnovy
Smlouvu podepsaných událostí popisují webhooky API. Než na nich postavíte návrh, ověřte dostupnost funkce. Příjemce webhooků udržujte úzce zaměřený: ověřujte podpisy, zpracovávejte duplicitní události a nezapisujte tajné hodnoty do protokolů.
Dobrý první API projekt
Nejlepší první API projekt je obvykle malý a konkrétní.
Například:
ověřte, že je přístup k API zapnutý pro nasazení i účet
vytvořte API klíč v nastavení
načtěte seznam modelů
zvolte model připravený pro API
odešlete jednu úlohu generování s klíčem idempotence
dotazujte koncový bod stavu
zkontrolujte kredity před a po
teprve potom přidejte Files API, Chat API nebo webhooky, které nasazení zpřístupňuje
Tato cesta vám dá funkční integraci, aniž byste do prvního testu míchali každou API funkci.
Kdy je API špatný výchozí bod
API pravděpodobně není správný první krok, když:
tým si ještě nezvolil rodinu modelů
požadovaný výstup se mění při každém běhu
prompt závisí na ručním vkusu a revizi
integrace by skryla využití kreditů před lidmi, kteří mu musí rozumět
produkt potřebuje veřejné demo dřív než automatizaci
V těchto případech začněte z Image, Video, Audio, Chat nebo AI Models. Jakmile je cesta opakovatelná, přesuňte stabilní část do API.
Kam pokračovat
Otevřete Developers pro veřejný API hub a debugger.
Přečtěte si Rychlý start Rivya API, abyste vytvořili první bezpečný požadavek.
Před vložením klíče na server si přečtěte Ověřování API.
Před výběrem ID modelů si přečtěte Modely API.
Pokud je produktová hranice stále nejasná, přečtěte si Kdy použít Rivya API místo Studia.
Pokud plánujete plnou integraci obrázků, videa, audia nebo chatu, přečtěte si Jak vytvořit multimodální AI pracovní postup s Rivya API.
