Použijte Rivya API v1 k volání generovacích a chatových modelů Rivya z vlastního produktu pomocí API klíčů, kreditů účtu a volitelného SSE streamování.

Rivya API v1 je vývojářský kontrakt pro volání podporovaných možností modelů Rivya z vlastního produktu, když je veřejné API zapnuté v nasazení a dostupné účtu.

Implementovaný kontrakt pokrývá asynchronní generování obrazů, videa a zvuku i Chat API s běžnými nebo SSE odpověďmi. Používá ID modelů Rivya, kredity účtu, veřejná ID úloh a serverové chatovací relace. Dokumentovaná cesta neslibuje přístup pro každé prostředí, účet nebo model; před integrací ověřte živý přístup a připravenost modelu.

K čemu API slouží

Použijte API, když chcete:

odesílat úlohy generování obrázků, videa nebo audia z vlastní aplikace
posílat nestreamované nebo streamované chatové tahy a pokračovat v chatových relacích vytvořených přes API
držet účtování ve stejné kreditní peněžence účtu Rivya
dotazovat stav úlohy podle veřejného ID úlohy
používat idempotentní opakování pro bezpečnější produkční požadavky
udržet použití Studia a API pod stejnou hranicí účtu

API je produktová vrstva Rivya. Veřejné odpovědi používají pouze názvy a veřejná pole Rivya.

Rozsah aktuální verze

Implementované koncové body v1 zahrnují:

GET /api/v1/models
POST /api/v1/generations
POST /api/v1/files
GET /api/v1/files/{fileId}
POST /api/v1/chat/completions
GET /api/v1/chat/sessions
GET /api/v1/chat/sessions/{sessionId}
GET /api/v1/generations/{taskId}
GET /api/v1/credits
GET /api/v1/webhooks
POST /api/v1/webhooks
GET /api/v1/webhook-events
GET /api/v1/openapi.json

Aktuální kontrakt zahrnuje podepsané webhooky výsledků asynchronního generování, Chat API a soukromou zkušební verzi TypeScript SDK se serverovým streamováním. Webhooky vyžadují zapnutí této funkce a veřejného API v nasazení.

Ověření

Koncové body pro generování, stav a kredity vyžadují:

Authorization: Bearer rvya_sk_...

Klíče vytvářejte a rotujte v nastavení API klíčů. Před použitím klíče v produkci si přečtěte ověření API.

Model účtování

API volání používají stejné kredity účtu Rivya jako Studio.

Úlohy generování rezervují nebo spotřebují kredity při spuštění úlohy. Chatové tahy rezervují kredity před voláním modelu a finální kredity vyrovnají ze spotřeby tokenů při uložení zprávy asistenta. Pokud generování nebo chatový tah selže podle stávajících pravidel selhání Rivya, použije se stejné zacházení s vrácením kreditů.

Uživatelský model peněženky najdete v kreditech API a kreditech a fakturaci v Rivya.

První integrační cesta

Vytvořte API klíč v Nastavení.
Zavolejte seznam modelů API a zvolte veřejné ID modelu.
Přečtěte si dokumentaci modelů API pro parametry modelu.
Pokud model potřebuje referenční média, nahrajte je přes Files API.
Odešlete úlohu pomocí vytvoření generování.
Dotazujte stav generování, dokud úloha neuspěje nebo neselže. Pokud jsou webhooky zapnuté pro nasazení a účet, můžete místo toho odebírat podepsané události přes Webhooky API.
U chatových modelů použijte Chat API místo koncového bodu generování. Obrazové přílohy chatu musí odkazovat na hodnoty file_id z Files API.

Přehled Rivya API

K čemu API slouží

Rozsah aktuální verze

Ověření

Model účtování

První integrační cesta

Související stránky

Obsah