Rivya API je vývojářská cesta pro používání modelových schopností Rivya z vašeho vlastního produktu, skriptu nebo pracovního postupu.
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 detaily endpointů, začněte stránkami Přehled Rivya API a Rychlý start Rivya API. Tento článek je vysvětlení na produktové úrovni: k čemu API slouží, kam zapadá a kdy by nemělo být první cestou.
Krátká verze
Rivya API v1 umožňuje přihlášenému účtu vytvořit API klíče a volat modelové schopnosti Rivya mimo webové rozhraní.
Aktuální API plocha zahrnuje:
- objevování modelů přes seznam API modelů
- asynchronní generační úlohy pro obrázky, video a audio
- uploady přes Files API pro modely, které potřebují referenční média
- polling stavu generování s veřejnými ID úloh
- kontroly kreditů účtu
- tahy Chat API včetně volitelného SSE streamování
- podepsané webhooky pro dokončení generování
- beta TypeScript SDK pro týmy, které chtějí klientskou obálku
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:
- produkt chce generovat varianty obrázků poté, co uživatel odešle brief
- 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í
- backendová služba chce podepsané callbacky po dokončení generačních úloh
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í |
| Files | Uploady referenčních obrázků, videí nebo audia | Files API |
| Chat | Nestreamované nebo streamované chatové tahy | Chat API |
| Webhooks | Podepsané události dokončení pro generační úlohy | API Webhooks |
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.
Pro API integrace mají tyto reference procházet přes Files API. Upload 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 endpointem 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
Polling je nejjednodušší první integrační cesta. Odešlete generační úlohu, uložte veřejné ID úlohy a pollujte, dokud neuspěje nebo neselže.
Webhooky jsou užitečné, když se integrace více blíží produkci:
- nechcete worker, který polluje každou úlohu
- vaše aplikace musí po dokončení generování aktualizovat záznam
- chcete podepsanou událost, kterou lze bezpečně zopakovat
- neúspěšné úlohy se musí přesunout do jasné cesty obnovy
Pro smlouvu podepsaných událostí použijte API Webhooks. Přijímač webhooku držte úzký: ověřujte podpisy, obsluhujte duplicitní události a nedávejte tajné hodnoty do logů.
Dobrý první API projekt
Nejlepší první API projekt je obvykle malý a konkrétní.
Například:
- vytvořte API klíč v nastavení
- zavolejte seznam modelů
- vyberte jeden dostupný model
- odešlete jednu generační úlohu s idempotency key
- pollujte stavový endpoint
- zkontrolujte kredity před a po
- teprve potom přidejte Files API, Chat API nebo Webhooks
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.
