Přehled Rivya API

Rivya API v1 je vývojářský vstupní bod pro volání modelových schopností Rivya z vašeho vlastního produktu.

Veřejné API podporuje asynchronní generování obrázků, videa a audia a také tahy Chat API s nestreamovanými nebo SSE streamovanými odpověďmi. Používá ID modelů Rivya, kredity účtu Rivya, veřejná ID úloh pro generování a serverové chatové relace pro Chat API.

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
• pollovat 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

Aktuální endpointy v1:

• 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í verze obsahuje podepsané webhooky pro výsledky asynchronního generování, Chat API a beta TypeScript SDK s podporou serverového streamování.

Ověření

Endpointy 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 refundací.

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

První integrační cesta

1. Vytvořte API klíč v Settings.
2. Zavolejte seznam modelů API a zvolte veřejné ID modelu.
3. Přečtěte si referenci modelového API pro parametry modelu.
4. Pokud model potřebuje referenční média, nahrajte je přes Files API.
5. Odešlete úlohu pomocí vytvoření generování.
6. Pollujte stav generování, dokud úloha neuspěje nebo neselže, případně se přihlaste k API Webhooks pro podepsané události dokončení.
7. U chatových modelů použijte Chat API místo endpointu generování. Obrazové přílohy chatu musí odkazovat na hodnoty file_id z Files API.

Související stránky

• Rychlý start API
• Ověření API
• Rivya TypeScript SDK
• Reference modelového API
• Chat API
• API Webhooks
• Chyby a limity API