Rivya API áttekintés

A Rivya API v1 a fejlesztői belépési pont, amellyel saját termékedből hívhatod a Rivya modellképességeit.

A nyilvános API aszinkron kép-, videó- és hanggenerálást, valamint nem streamelt vagy SSE streamelt válaszokat adó Chat API fordulókat támogat. Rivya modellazonosítókat, Rivya fiókkrediteket, generáláshoz nyilvános task ID-ket, a Chat API-hoz pedig szerveroldali chatmunkameneteket használ.

Mire való az API

Használd az API-t, ha ezt szeretnéd:

• kép-, videó- vagy hanggenerálási feladatokat beküldeni a saját alkalmazásodból
• nem streamelt vagy streamelt chatfordulókat küldeni, és API-val létrehozott chatmunkameneteket folytatni
• a számlázást ugyanabban a Rivya fiókkredit-pénztárcában tartani
• feladatállapotot lekérdezni nyilvános task ID alapján
• idempotens újrapróbálkozásokat használni biztonságosabb éles kérésekhez
• a Studio- és API-használatot ugyanazon fiókhatáron belül tartani

Az API egy Rivya termékréteg. A nyilvános válaszok csak Rivya neveket és nyilvános mezőket használnak.

Jelenlegi verzióhatókör

Jelenlegi v1 endpointok:

• 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

A jelenlegi verzió aláírt webhookokat tartalmaz aszinkron generálási eredményekhez, Chat API-t, valamint TypeScript SDK betát szerveroldali streaming támogatással.

Hitelesítés

A generálási, állapot- és kredit endpointok ezt igénylik:

Authorization: Bearer rvya_sk_...

Kulcsokat az API-kulcs beállításokban hozhatsz létre és rotálhatsz. Éles használat előtt olvasd el az API-hitelesítés oldalt.

Számlázási modell

Az API-hívások ugyanazokat a Rivya fiókkrediteket használják, mint a Studio.

A generálási feladatok a feladat indulásakor krediteket foglalnak vagy fogyasztanak. A chatfordulók a modellhívás előtt kreditet foglalnak, majd az asszisztensüzenet mentésekor a tokenhasználat alapján számolják el a végső krediteket. Ha egy generálás vagy chatforduló a Rivya meglévő hibakezelési szabályai szerint sikertelen, ugyanaz a visszatérítési kezelés érvényes.

Olvasd el az API kreditek és a Kreditek és számlázás a Rivyában oldalakat a felhasználói pénztárcamodellhez.

Első integrációs út

1. Hozz létre API-kulcsot a Beállításokban.
2. Hívd meg az API modellek listázása oldalt nyilvános modellazonosító választásához.
3. Olvasd el a Modell API referenciát a modell paramétereihez.
4. Ha a modell referenciamédiát igényel, töltsd fel a Files API segítségével.
5. Küldj be feladatot a Generálás létrehozása útmutatóval.
6. Kérdezd le a Generálási állapotot, amíg a feladat sikeres vagy sikertelen nem lesz, vagy iratkozz fel az API webhookokra aláírt befejezési eseményekhez.
7. Chatmodellekhez a generálási endpoint helyett használd a Chat API oldalt. A chat képcsatolmányoknak Files API file_id értékekre kell hivatkozniuk.

Kapcsolódó oldalak

• API gyorskezdés
• API-hitelesítés
• Rivya TypeScript SDK
• Modell API referencia
• Chat API
• API webhookok
• API hibák és limitek