Rivya API

Bouw op Rivya's multimodale modellaag

Rivya API geeft productteams een publieke, accountgebaseerde manier om Rivya-modellen vanuit hun eigen apps aan te roepen. Begin met asynchrone image-, video- en audiojobs, voeg Chat API-turns toe met optionele SSE-streaming wanneer een model chat ondersteunt, en houd facturering binnen dezelfde Rivya-creditwallet.
API-docs lezenAPI-sleutel maken

Quickstart-vorm

Modellaag

Dynamische catalogus

Facturering

Gedeelde credits

Eerste versie

Jobs + Chat

Toegang

API-sleutels

MethodePOST
Endpoint/api/v1/generations

De echte request vereist een Rivya API-sleutel en beschikbare accountcredits. Publieke voorbeelden gebruiken placeholdersecrets en roepen modellen niet anoniem aan.

Request
curl https://rivya.ai/api/v1/generations \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-job-001" \
  -d '{
    "model": "z-image",
    "prompt": "Editorial product photo on a clean studio set"
  }'
Response
{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 20,
  "result": null,
  "error": null
}

Wat eerst beschikbaar is

Een publieke API-laag die afgestemd blijft op het Rivya-product

De API is ontworpen als een Rivya-productoppervlak. Ze gebruikt Rivya-model-ID's, Rivya-credits, publieke taakstatussen en docs die verbonden blijven met de modelcatalogus.

API voor afbeeldingsgeneratie

Dien imagejobs in met prompt en ondersteunde modelparameters, en poll daarna voor publieke resultaten.

API voor videogeneratie

Voer asynchrone videojobs uit met dezelfde taak- en creditcontroles die Studio gebruikt.

API voor audiogeneratie

Gebruik API-toegankelijke audiomodellen binnen dezelfde account-, saldo- en geschiedenisgrens.

Gedeelde creditwallet

API-calls en Studiogebruik gebruiken hetzelfde Rivya-saldo, met gereserveerde credits en foutafhandeling.

Startpad

Van account naar eerste API-request

01

Maak een sleutel

Log in, open API Keys in Settings, maak een gescopete sleutel en sla het volledige secret direct op.

02

Kies een model

Lees de API-modelreferentie of roep /api/v1/models aan om model-ID's, parameters, chatmogelijkheden en inputgereedheid te inspecteren voordat je indient.

03

Indienen, pollen of subscriben

Stuur een idempotente generation request, poll het publieke taakendpoint, gebruik ondertekende webhooks voor generatiecallbacks of stuur een Chat API-turn met optionele SSE-streaming.

Versiegrens

Heldere scope, geen verborgen beloften

De landingspagina mag toekomstige oppervlakken noemen, maar de huidige productcopy mag niet suggereren dat onafgemaakte API's al live zijn.

Chat API

Beschikbaar

Beschikbaar voor niet-streaming en SSE-streaming turns met API-aangemaakte sessies, accountcredits en optionele Files API-afbeeldingsbijlagen.

Files API

Beschikbaar

Beschikbaar voor uploads van referentieafbeeldingen, video en audio. Gebruik dit vóór generatie wanneer een modelpagina om params.referenceMediaItems vraagt.

Gebruikerswebhooks

Beschikbaar

Beschikbaar voor productie-integraties die ondertekende callbacks willen voor geslaagde of mislukte generatietaken.

Online foutopsporing

Preview de request en voer die daarna uit met je eigen API-sleutel

De debugger start voor elke bezoeker in mockmodus. De generatieselector toont niet-chatmodellen die zonder bestandsupload kunnen worden getest, terwijl het Files-paneel ingelogde gebruikers /api/v1/files laat testen met een tijdelijke API-sleutel. Chatvoorbeelden staan in de API-docs.

Accountstatus

Account controleren

Actieve sleutelprefix

Maak eerst een sleutel

Huidige credits

Log in om te controleren

MockpreviewLive openbare APIGeen actieve API-sleutel

Mockmodus roept nooit een model aan en verbruikt nooit credits.

Plak de sleutel alleen voor deze request. De debugger bewaart hem niet na refresh.

Uploadtest voor Files API

Upload referentiemedia via POST /api/v1/files, kopieer daarna de teruggegeven URL en duration token naar params.referenceMediaItems voor een model dat referentie-input ondersteunt.

Mock uploadt nooitLive gebruikt /api/v1/files

Het geselecteerde model bepaalt toegestane MIME-types, grootte- en duurregels. Live uploads vereisen je tijdelijke API-sleutel en kunnen de echte uploadservice aanroepen.

API-sleutel makenAPI-docs lezen
Requestpreview
{
  "model": "z-image",
  "prompt": "Redactionele productfoto op een schone studioset",
  "params": {
    "aspect_ratio": "1:1"
  }
}
Response
{
  "id": "mock_task_001",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "result": null,
  "error": null
}
Files API-response
{
  "id": "file_mock_001",
  "object": "file",
  "kind": "image",
  "file_name": "reference.png",
  "mime_type": "image/png",
  "size_bytes": 245760,
  "url": "https://media.example/reference.png",
  "duration_seconds": null,
  "duration_token": null,
  "created_at": "2026-05-11T00:00:00.000Z",
  "expires_at": null
}
Generatieparams
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Taakstatus

Geschatte basiscredits

1

Status

queued

API-documentatie

Lees authenticatie, request bodies, responses, idempotency, modelparameters en foutcodes.

Docs openen

API-sleutelbeheer

Maak, kopieer één keer, trek in en roteer API-sleutels vanuit het beveiligde Settings-gedeelte.

Sleutels beheren

Online debuggen

Gebruik eerst mockvoorbeelden; echte debugging vereist login, een API-sleutel en accountcredits.

Flow previewen