Rivya API-overzicht

Rivya API v1 is het developer entrypoint om Rivya-modelmogelijkheden vanuit je eigen product aan te roepen.

De publieke API ondersteunt asynchrone beeld-, video- en audiogeneratie plus Chat API-turns met non-streaming of SSE-streaming responses. De API gebruikt Rivya-model-ID's, Rivya-accountcredits, publieke taak-ID's voor generaties en server-side chatsessies voor Chat API.

Waarvoor de API bedoeld is

Gebruik de API wanneer je dit wilt:

• beeld-, video- of audiogeneratiejobs indienen vanuit je eigen app
• non-streaming of streaming chatturns versturen en API-aangemaakte chatsessies voortzetten
• billing binnen dezelfde Rivya-accountcreditwallet houden
• taakstatus poll'en via publieke taak-ID
• idempotente retries gebruiken voor veiligere productierequests
• Studio- en API-gebruik binnen dezelfde accountgrens houden

De API is een Rivya-productlaag. Publieke responses gebruiken alleen Rivya-namen en publieke velden.

Huidige versiescope

Huidige 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

De huidige versie bevat ondertekende webhooks voor asynchrone generatieresultaten, Chat API en een TypeScript SDK beta met server-side streaming support.

Authenticatie

Generatie-, status- en creditendpoints vereisen:

Authorization: Bearer rvya_sk_...

Maak en roteer sleutels via API Keys settings. Lees API-authenticatie voordat je een sleutel in productie gebruikt.

Billingmodel

API-calls gebruiken dezelfde Rivya-accountcredits als Studio.

Generatiejobs reserveren of verbruiken credits wanneer de taak start. Chatturns reserveren credits voor de modelcall en verrekenen de definitieve credits op basis van token usage wanneer het assistant message wordt opgeslagen. Als een generatie of chatturn faalt volgens de bestaande Rivya-failure rules, geldt dezelfde refundafhandeling.

Lees API-credits en Credits en billing in Rivya voor het gebruikersgerichte walletmodel.

Eerste integratiepad

1. Maak een API-sleutel aan in Settings.
2. Roep API-modellenlijst aan om een publiek model-ID te kiezen.
3. Lees Model-API-reference voor de parameters van het model.
4. Als het model referentiemedia nodig heeft, upload die dan met Files API.
5. Dien een job in met Generatie aanmaken.
6. Poll Generatiestatus totdat de taak slaagt of faalt, of abonneer je op API-webhooks voor ondertekende completion events.
7. Gebruik voor chatmodellen Chat API in plaats van het generatie-endpoint. Chatbeeldbijlagen moeten verwijzen naar Files API file_id-waarden.

Gerelateerde pagina's

• API-snelstart
• API-authenticatie
• Rivya TypeScript-SDK
• Model-API-reference
• Chat API
• API-webhooks
• API-fouten en limieten