Rivya API

Construiește pe layerul multimodal de modele Rivya

Rivya API oferă echipelor de produs o cale publică, bazată pe cont, pentru a apela modelele Rivya din propriile aplicații. Începe cu joburi asincrone de imagine, video și audio, adaugă turnuri Chat API cu streaming SSE opțional când modelul suportă chat și păstrează billingul în același portofel de credite Rivya.
Citește docs APICreează un API key

Formă quickstart

Layer modele

Catalog dinamic

Billing

Credite partajate

Prima versiune

Joburi + Chat

Acces

API keys

MetodăPOST
Endpoint/api/v1/generations

Cererea reală necesită un API key Rivya și credite disponibile în cont. Exemplele publice folosesc secrete placeholder și nu apelează modele anonim.

Cerere
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"
  }'
Răspuns
{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 20,
  "result": null,
  "error": null
}

Ce este livrat prima dată

Un layer API public care rămâne aliniat cu produsul Rivya

API-ul este proiectat ca o suprafață de produs Rivya. Folosește ID-uri de modele Rivya, credite Rivya, stări publice de task și docs conectate la catalogul de modele.

API generare imagini

Trimite joburi de imagine cu prompt și parametri suportați de model, apoi interoghează rezultatele publice.

API generare video

Rulează joburi video asincrone cu aceleași controale de task și credite folosite de Studio.

API generare audio

Folosește modele audio accesibile prin API în aceeași limită de cont, sold și istoric.

Portofel de credite partajat

Apelurile API și utilizarea Studio trag din același sold Rivya, cu credite rezervate și gestionarea eșecurilor.

Traseu de început

De la cont la prima cerere API

01

Creează un key

Autentifică-te, deschide API Keys în Settings, creează un key cu scope și stochează imediat secretul complet.

02

Alege un model

Citește referința de modele API sau apelează /api/v1/models pentru a inspecta ID-urile modelelor, parametrii, capabilitățile chat și input readiness înainte de trimitere.

03

Trimite, interoghează sau abonează-te

Trimite o cerere de generare idempotentă, interoghează endpointul public de task, folosește webhookuri semnate pentru callbackuri de generare sau trimite un turn Chat API cu streaming SSE opțional.

Limită versiune

Scope clar, fără promisiuni ascunse

Landing page-ul poate menționa suprafețe viitoare, dar textul curent de produs nu trebuie să sugereze că API-uri neterminate sunt deja live.

Chat API

Disponibil

Disponibil pentru turnuri non-streaming și SSE streaming cu sesiuni create prin API, credite de cont și atașamente opționale de imagine prin Files API.

Files API

Disponibil

Disponibil pentru încărcări de imagini, video și audio de referință. Folosește-l înainte de generare când o pagină de model cere params.referenceMediaItems.

Webhookuri utilizator

Disponibil

Disponibile pentru integrări de producție care vor callbackuri semnate pentru taskuri de generare reușite sau eșuate.

Debugger online

Previzualizează cererea, apoi ruleaz-o cu propriul API key

Debuggerul începe în mod mock pentru fiecare vizitator. Selectorul de generare listează modele non-chat care pot fi testate fără încărcare de fișiere, iar panoul Files permite utilizatorilor autentificați să testeze /api/v1/files cu un API key temporar. Exemplele Chat sunt în docs API.

Stare cont

Se verifică contul

Prefix key activ

Creează mai întâi un key

Credite curente

Autentifică-te pentru verificare

Previzualizare mockPublic API liveNiciun API key activ

Modul mock nu apelează niciodată un model și nu consumă credite.

Lipește key-ul doar pentru această cerere. Debuggerul nu îl stochează după refresh.

Test upload Files API

Încarcă media de referință prin POST /api/v1/files, apoi copiază URL-ul returnat și duration token în params.referenceMediaItems pentru un model care acceptă inputuri de referință.

Mock nu încarcă niciodată fișiereLive folosește /api/v1/files

Modelul selectat controlează tipurile MIME permise, dimensiunea și regulile de durată. Uploadurile live necesită API key-ul temporar și pot apela serviciul real de upload.

Creează API keyCitește docs API
Previzualizare cerere
{
  "model": "z-image",
  "prompt": "Fotografie editorială de produs într-un decor de studio curat",
  "params": {
    "aspect_ratio": "1:1"
  }
}
Răspuns
{
  "id": "mock_task_001",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "result": null,
  "error": null
}
Răspuns Files API
{
  "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
}
Parametri generare
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Stare task

Credite de bază estimate

1

Status

queued

Documentație API

Citește despre autentificare, request bodies, răspunsuri, idempotency, parametri de model și coduri de eroare.

Deschide docs

Gestionare API key

Creează, copiază o singură dată, revocă și rotește API keys din zona protejată Settings.

Gestionează key-uri

Debugging online

Folosește mai întâi exemple mock; debuggingul real necesită autentificare, un API key și credite în cont.

Previzualizează fluxul