Rivya API áttekintés

A Rivya API v1 fejlesztői szerződés a támogatott Rivya-modellképességek saját termékből való meghívásához, ha a Public API engedélyezve van a telepítésben és elérhető a fióknak.

A megvalósított szerződés aszinkron kép-, videó- és hanggenerálást, valamint egyszerre visszaadott vagy SSE-adatfolyamos Chat API-válaszokat fed le. Rivya-modellazonosítókat, fiókkrediteket, nyilvános feladatazonosítókat és szerveroldali chatmunkameneteket használ. A dokumentált útvonal nem ígér hozzáférést minden környezethez, fiókhoz vagy modellhez; integráció előtt ellenőrizd az aktuális hozzáférést és a modell készenléti állapotát.

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

• egyszerre visszaadott vagy adatfolyamos 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 feladatazonosító 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

A megvalósított v1 végpontok:

• 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 szerződés aláírt webhookokat tartalmaz az aszinkron generálás eredményeihez, továbbá Chat API-t és szerveroldali streamelést támogató TypeScript SDK-bétát. A webhookokhoz a funkciónak és a Public API-nak engedélyezve kell lennie a telepítésben.

Hitelesítés

A generálási, állapot- és kreditvégpontok 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ás állapotát, amíg a feladat sikeres vagy sikertelen nem lesz. Ha a webhookok engedélyezve vannak az adott telepítésben és a fiókod számára, ehelyett aláírt eseményekre iratkozhatsz fel az API-webhookokon keresztül.

7. Chatmodellekhez a generálási végpont 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