De Rivya API is het ontwikkelaarscontract om ondersteunde Rivya-modelmogelijkheden vanuit je eigen product, script of workflow te gebruiken wanneer openbare API-toegang voor de deployment is ingeschakeld en voor je account beschikbaar is.
Het is geen apart product naast Rivya Studio. Het gebruikt dezelfde accountgrens, dezelfde creditwallet en dezelfde publieke modellaag die gebruikers in Rivya zien. Het verschil is hoe het werk begint: in plaats van door Studio te klikken, stuurt je applicatie requests met een API key.
Als je endpointdetails nodig hebt, begin dan met Rivya API-overzicht en Rivya API-snelstart. Dit artikel is de productuitleg: waar de API voor is, waar die past en wanneer die niet het eerste pad moet zijn.
De korte versie
Rivya API v1 laat een geschikt, ingelogd account API keys maken en API-gereede Rivya-modellen buiten de webinterface aanroepen. De ontwikkelaarspagina's beschrijven het geïmplementeerde contract; de actieve deployment, accountrechten en gereedheid van het model bepalen of een aanvraag kan draaien.
Het geïmplementeerde API-oppervlak omvat:
modelontdekking via de API-modellijst
asynchrone beeld-, video- en audiogeneratietaken
Files API-uploads voor modellen die referentiemedia nodig hebben
polling van generatiestatus met publieke taak-ID's
accountcreditchecks
Chat API-beurten, inclusief optionele SSE-streaming
ondertekende webhooks voor voltooiing van generatie
een TypeScript SDK beta voor teams die een clientwrapper willen
De publieke ontwikkelaarshub is Developers. Dat is de beste ingang als je een begeleid overzicht, links naar API key-instellingen en een veilige debuggerflow wilt.
Waarom Rivya een API heeft
Studio is nuttig wanneer een persoon nog modellen kiest, prompts vormt, resultaten beoordeelt en beslist wat de volgende stap is.
De API is nuttig wanneer die beslissing een herhaalbare product- of operationele workflow is geworden.
Veelvoorkomende voorbeelden wanneer API-toegang is ingeschakeld:
een product wil beeldvarianten genereren nadat een gebruiker een brief indient
een marketingworkflow moet visuele drafts maken vanuit gestructureerde campagne-invoer
een interne tool moet video- of audiotaken indienen zonder iemand te vragen de browser te openen
een support- of contentsysteem wil een beurt van een chatmodel in de eigen interface
een backendservice wil ondertekende callbacks wanneer generatietaken klaar zijn
In die gevallen houdt Rivya API het werk verbonden met hetzelfde Rivya-account in plaats van een aparte stack af te dwingen voor facturering, modelkeuze en taakstatus.
Wat de API niet vervangt
De API vervangt niet elke reden om Rivya direct te gebruiken.
Gebruik Rivya Studio-gids of de publieke werkoppervlakken wanneer:
de prompt nog menselijke verkenning nodig heeft
de modelkeuze niet stabiel is
een maker resultaten visueel moet vergelijken
het project afhangt van opgeslagen geschiedenis en handmatige review
het team nog niet heeft beslist welke invoer- en outputvorm herhaalbaar moet worden
Gebruik de API wanneer de workflow duidelijk genoeg is om te automatiseren.
Die grens is belangrijk. Een vage creatieve vraag hoort meestal eerst in Studio thuis. Een bekende productflow met voorspelbare invoer kan naar de API.
De belangrijkste bouwstenen
Zie de API als zes verbonden stukken.
| Bouwsteen | Wat die afhandelt | Waar je verder leest |
|---|---|---|
| API keys | Server-to-server-toegang vanuit je account | API-authenticatie |
| Models | Publieke model-ID's en gereedheidsinformatie | API-modellen |
| Generations | Async beeld-, video- en audiotaken | Generatie aanmaken |
| Files | Uploads van referentiebeeld, video of audio | Files API |
| Chat | Non-streaming of streaming chatbeurten | Chat API |
| Webhooks | Ondertekende voltooiingsevents voor generatietaken, wanneer ingeschakeld | API-webhooks |
De API-docs zijn de bron voor request- en responsvorm. Dit artikel helpt je bepalen welk stuk je eerst nodig hebt.
Hoe credits werken
API-gebruik put uit dezelfde Rivya-accountcreditwallet als Studio.
Dat betekent dat de API geen anonieme modelproxy is. Een request hoort bij een Rivya-account, gebruikt een API key die door dat account is gemaakt en volgt dezelfde productbrede creditgrens die in API-credits wordt beschreven.
Dat is nuttig voor teams, omdat Studio-experimenten en API-gebruik in één operationeel model blijven. Je kunt een model handmatig testen en daarna het herhaalbare deel naar een integratie verplaatsen zonder een tweede factureringslaag te maken.
Hoe bestanden passen
Sommige modellen kunnen alleen met tekst draaien. Andere hebben een referentiebeeld, video- of audiobestand nodig.
Voor API-integraties moeten die referenties via Files API lopen. De upload maakt een beheerd bestandsrecord dat kan worden doorgegeven aan ondersteunde modelparameters.
De praktische regel is eenvoudig:
als een model tekst-only invoer accepteert, begin met het generation endpoint
als een model referentiemedia nodig heeft, upload eerst het bestand
als het model een chatmodel met beeldbijlagen is, gebruik Chat API en file IDs
Ontwerp je integratie niet rond browser-only uploadflows of opgeslagen Studio-sessies. De API heeft niet voor niets een eigen publieke bestandsgrens.
Waar webhooks helpen
Polling is het makkelijkste eerste integratiepad. Dien een generatietaak in, bewaar de publieke taak-ID en poll totdat die slaagt of faalt.
Wanneer webhooks voor de deployment zijn ingeschakeld, worden ze nuttig naarmate de integratie meer op productie gaat lijken:
je wilt geen worker die elke taak pollt
je app moet een record bijwerken wanneer generatie klaar is
je wilt een ondertekend event dat veilig opnieuw kan worden geprobeerd
mislukte taken moeten naar een duidelijk herstelpad
Gebruik API-webhooks voor het ondertekende eventcontract. Controleer of de functie beschikbaar is voordat je het ontwerp erop baseert. Houd de webhookontvanger beperkt: verifieer handtekeningen, verwerk dubbele events en zet geen geheime waarden in logs.
Een goed eerste API-project
Het beste eerste API-project is meestal klein en concreet.
Bijvoorbeeld:
bevestig dat API-toegang voor de deployment en het account is ingeschakeld
maak een API key aan in settings
roep de modellijst aan
kies één API-gereed model
dien één generatietaak in met een idempotency key
poll het statusendpoint
controleer credits vóór en na
voeg pas daarna Files API, Chat API of door de deployment aangeboden webhooks toe
Dat pad geeft je een werkende integratie zonder elke API-feature in de eerste test te mengen.
Wanneer de API het verkeerde startpunt is
De API is waarschijnlijk niet de juiste eerste stap wanneer:
het team nog geen modelfamilie heeft gekozen
de gewenste output bij elke run nog verandert
de prompt afhangt van handmatige smaak en review
de integratie creditgebruik zou verbergen voor de mensen die het moeten begrijpen
het product een publieke demo nodig heeft voordat het automatisering nodig heeft
Begin in die gevallen met Image, Video, Audio, Chat of AI Models. Zodra het pad herhaalbaar is, verplaats je het stabiele deel naar de API.
Waar je daarna heen gaat
Open Developers voor de publieke API-hub en debugger.
Lees Rivya API-snelstart om het eerste veilige request te maken.
Lees API-authenticatie voordat je een key op een server zet.
Lees API-modellen voordat je model-ID's kiest.
Lees Wanneer je Rivya API gebruikt in plaats van Studio als de productgrens nog onduidelijk is.
Lees Een multimodale AI-workflow bouwen met Rivya API wanneer je een volledige beeld-, video-, audio- of chatintegratie plant.
