Rivya API-översikt

Rivya API v1 är utvecklarkontraktet för att anropa de Rivya-modellfunktioner som stöds från din egen produkt. Det förutsätter att det offentliga API:et är aktiverat för driftsmiljön och tillgängligt för kontot.

Det implementerade kontraktet omfattar 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. En dokumenterad route innebär inte att alla miljöer, konton eller katalogmodeller kan anropa den; kontrollera aktuell åtkomst och modellberedskap innan du integrerar.

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

De implementerade v1-rutterna omfattar:

• 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

Det aktuella kontraktet omfattar signerade webhooks för asynkrona genereringsresultat, Chat API och en betaversion av TypeScript SDK med serverbaserat strömningsstöd. Webhook-anrop kräver att både webhook-funktionen och det offentliga API:et är aktiverade för driftsmiljön.

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 krediter när uppgiften startar. Chatturer reserverar krediter före modellanropet och avräknar slutbeloppet utifrån tokenanvändningen när assistentmeddelandet sparas. Om en generering eller chattur misslyckas enligt Rivyas befintliga felregler gäller samma återbetalningshantering.

Läs API-krediter och krediter och fakturering i Rivya för den kreditmodell som visas för användaren.

Första integrationsvägen

1. Skapa en API-nyckel i Settings.

2. Anropa lista API-modeller för att välja ett offentligt modell-ID.

3. Läs modellreferensen för API för modellens parametrar.

4. Om modellen behöver referensmedia, ladda upp det med Files API.

5. Skicka ett jobb med skapa generation.

6. Polla genereringsstatus tills uppgiften lyckas eller misslyckas. Om webhooks är aktiverade för driftsmiljön och kontot kan du i stället prenumerera via API-webhooks på signerade slutförandehändelser.

7. 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.

Relaterade sidor

• API-snabbstart

• API-autentisering

• Rivya TypeScript SDK

• Modellreferens för API

• Chat API

• API-webhooks

• API-fel och gränser