Använd Rivya API v1 för att anropa Rivyas genererings- och chattmodeller från din egen produkt med API-nycklar, kontocredits och valfri SSE-streaming.

Rivya API v1 är utvecklaringången för att anropa Rivyas modellfunktioner från din egen produkt.

Det offentliga API:et stöder asynkron bild-, video- och ljudgenerering plus Chat API-turns med icke-streamande eller SSE-streamande svar. Det använder Rivya-modell-ID:n, Rivya-kontocredits, offentliga uppgifts-ID:n för generering och serverbaserade chattsessioner för Chat API.

Vad API:et är till för

Använd API:et när du vill:

skicka bild-, video- eller ljudgenereringsjobb från din egen app
skicka icke-streamande eller streamande chatt-turns och fortsätta API-skapade chattsessioner
hålla faktureringen i samma Rivya-kontos creditplånbok
polla uppgiftsstatus via offentligt uppgifts-ID
använda idempotenta retries för säkrare produktionsbegäranden
hålla Studio- och API-användning inom samma kontogräns

API:et är ett Rivya-produktlager. Offentliga svar använder endast Rivya-namn och offentliga fält.

Aktuell versionsomfattning

Aktuella v1-endpoints:

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

Den aktuella versionen innehåller signerade webhooks för asynkrona genereringsresultat, Chat API och en TypeScript SDK beta med serverbaserat streamingstöd.

Autentisering

Genererings-, status- och creditendpoints kräver:

Authorization: Bearer rvya_sk_...

Skapa och rotera nycklar från inställningar för API-nycklar. Läs API-autentisering innan du använder en nyckel i produktion.

Faktureringsmodell

API-anrop använder samma Rivya-kontocredits som Studio.

Genereringsjobb reserverar eller förbrukar credits när uppgiften startar. Chatt-turns reserverar credits före modellanropet och avräknar slutliga credits från tokenanvändning när assistentmeddelandet sparas. Om en generation eller chatt-turn misslyckas enligt Rivyas befintliga felregler gäller samma återbetalningshantering.

Läs API-credits och credits och fakturering i Rivya för den användarsynliga plånboksmodellen.

Första integrationsvägen

Skapa en API-nyckel i Settings.
Anropa lista API-modeller för att välja ett offentligt modell-ID.
Läs modellreferensen för API för modellens parametrar.
Om modellen behöver referensmedia, ladda upp det med Files API.
Skicka ett jobb med skapa generation.
Polla genereringsstatus tills uppgiften lyckas eller misslyckas, eller prenumerera på API-webhooks för signerade slutförandehändelser.
För chattmodeller, använd Chat API i stället för genereringsendpointen. Chattbildbilagor måste referera till Files API-värden för file_id.

Rivya API-översikt

Vad API:et är till för

Aktuell versionsomfattning

Autentisering

Faktureringsmodell

Första integrationsvägen

Relaterade sidor

Innehållsförteckning