Rivya API

Byg på Rivyas multimodale modellag

Rivya API giver produktteams en offentlig, kontobaseret måde at kalde Rivya-modeller fra deres egne apps. Start med asynkrone billed-, video- og lydjobs, tilføj Chat API-turns med valgfri SSE-streaming, når en model kan chatte, og hold faktureringen i den samme Rivya credit-wallet.
Læs API-dokumentationenOpret en API-nøgle

Quickstart-form

Modellag

Dynamisk katalog

Fakturering

Fælles credits

Første version

Jobs + Chat

Adgang

API-nøgler

MetodePOST
Endpoint/api/v1/generations

Den rigtige request kræver en Rivya API-nøgle og tilgængelige credits på kontoen. Offentlige eksempler bruger placeholder-secrets og kalder ikke modeller anonymt.

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
}

Første levering

Et offentligt API-lag, der forbliver på linje med Rivya-produktet

API'et er designet som en Rivya-produktgrænseflade. Det bruger Rivya-model-ID'er, Rivya-credits, offentlige opgavetilstande og dokumentation, der forbliver koblet til modelkataloget.

API til billedgenerering

Indsend billedjobs med prompt og understøttede modelparametre, og poll derefter efter offentlige resultater.

API til videogenerering

Kør asynkrone videojobs med de samme opgave- og credit-kontroller, som Studio bruger.

API til lydgenerering

Brug API-tilgængelige lydmodeller gennem samme konto-, saldo- og historikgrænse.

Fælles credit-wallet

API-kald og Studio-brug trækker fra samme Rivya-saldo med reserverede credits og fejlhåndtering.

Startspor

Fra konto til første API-request

01

Opret en nøgle

Log ind, åbn API-nøgler i Indstillinger, opret en nøgle med afgrænset adgang, og gem den fulde secret med det samme.

02

Vælg en model

Læs API-modelreferencen, eller kald /api/v1/models for at inspicere model-ID'er, parametre, chatfunktioner og inputklarhed, før du indsender.

03

Indsend, poll eller abonnér

Send en idempotent genereringsrequest, poll det offentlige task-endpoint, brug signerede webhooks til genereringscallbacks, eller send en Chat API-turn med valgfri SSE-streaming.

Versionsgrænse

Klar afgrænsning, ingen skjulte løfter

Landingssiden kan nævne fremtidige flader, men den aktuelle produkttekst må ikke antyde, at ufærdige API'er allerede er live.

Chat API

Tilgængelig

Tilgængelig til ikke-streaming og SSE-streaming-turns med API-oprettede sessioner, kontocredits og valgfrie Files API-billedvedhæftninger.

Files API

Tilgængelig

Tilgængelig til uploads af referencebilleder, -videoer og -lyd. Brug den før generering, når en modelside beder om params.referenceMediaItems.

Brugerwebhooks

Tilgængelig

Tilgængelig til produktionsintegrationer, der ønsker signerede callbacks for vellykkede eller fejlede genereringsopgaver.

Online-debugger

Forhåndsvis requesten, og kør den derefter med din egen API-nøgle

Debuggeren starter i mock-tilstand for alle besøgende. Genereringsvælgeren viser ikke-chatmodeller, der kan testes uden filupload, mens Files-panelet lader indloggede brugere teste /api/v1/files med en midlertidig API-nøgle. Chateksempler findes i API-dokumentationen.

Kontotilstand

Tjekker konto

Aktivt nøglepræfiks

Opret først en nøgle

Aktuelle credits

Log ind for at tjekke

Mock-forhåndsvisningLive Public APIIngen aktiv API-nøgle

Mock-tilstand kalder aldrig en model og bruger aldrig credits.

Indsæt kun nøglen til denne request. Debuggeren gemmer den ikke efter genindlæsning.

Files API-uploadtest

Upload referencemedier via POST /api/v1/files, og kopiér derefter den returnerede URL og duration-token ind i params.referenceMediaItems for en model, der understøtter referenceinput.

Mock uploader aldrigLive bruger /api/v1/files

Den valgte model styrer tilladte MIME-typer, størrelse og varighedsregler. Live-uploads kræver din midlertidige API-nøgle og kan kalde den rigtige uploadservice.

Opret API-nøgleLæs API-dokumentation
Request-forhåndsvisning
{
  "model": "z-image",
  "prompt": "Redaktionelt produktfoto på et rent studiosæt",
  "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-svar
{
  "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
}
Genereringsparametre
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Opgavetilstand

Estimerede basiscredits

1

Status

queued

API-dokumentation

Læs om autentificering, request bodies, svar, idempotens, modelparametre og fejlkoder.

Åbn dokumentation

Administration af API-nøgler

Opret, kopiér én gang, tilbagekald og rotér API-nøgler fra det beskyttede område Indstillinger.

Administrér nøgler

Online-debugging

Brug mock-eksempler først; live-debugging kræver login, en API-nøgle og kontocredits.

Forhåndsvis flow