Rivya API

Construiește pe stratul 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 sarcini asincrone de imagine, video și audio, adaugă interacțiuni Chat API cu transmitere SSE în flux atunci când modelul acceptă chat și păstrează facturarea în același portofel de credite Rivya.

Citește documentația API Creează o cheie API

Format de pornire rapidă

Strat de modele

Catalog dinamic

Facturare

Credite partajate

Prima versiune

Sarcini + Chat

Acces

Chei API

MetodăPOST

Endpoint/api/v1/generations

Cererea reală necesită o cheie API Rivya și credite disponibile în cont. Exemplele publice folosesc secrete demonstrative și nu apelează modele în mod 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": 1,
  "result": null,
  "error": null
}

Depanator online

Previzualizează cererea, apoi ruleaz-o cu propria cheie API

Depanatorul pornește în modul de simulare pentru fiecare vizitator. Selectorul de generare afișează modelele care nu sunt destinate conversațiilor și pot fi testate fără încărcarea fișierelor, iar panoul Files permite utilizatorilor autentificați să testeze `/api/v1/files` cu o cheie API temporară. Exemplele Chat se află în documentația API.

Stare cont

Se verifică contul

Prefix cheie activă

Creează mai întâi o cheie

Credite curente

Autentifică-te pentru verificare

Previzualizare simulatăPublic API activNicio cheie API activă

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

Model

Cheie de idempotență

ID cerere client

Prompt

Cheie API

Lipește cheia doar pentru această cerere. Depanatorul nu o stochează după reîmprospătare.

Test de încărcare Files API

Încarcă materialul media de referință prin `POST /api/v1/files`, apoi copiază URL-ul returnat și tokenul de durată în `params.referenceMediaItems` pentru un model care acceptă intrări de referință.

Simularea nu încarcă niciodată fișiereModul activ folosește /api/v1/files

Model de referință

Tip fișier

Fișier de referință

Modelul selectat controlează tipurile MIME permise, dimensiunea și regulile de durată. Încărcările reale necesită cheia API temporară și pot apela serviciul real de încărcare.

Creează cheia API Citește documentația 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",
        "sizeBytes": 245760
      }
    ]
  }
}

Stare sarcină

Credite de bază estimate

Stare

queued

Traseu de început

De la cont la prima cerere API

Creează o cheie

Autentifică-te, deschide secțiunea Chei API din Setări, creează o cheie cu domeniu de acces și stochează imediat secretul complet.

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 pregătirea intrărilor înainte de trimitere.

Trimite, interoghează sau abonează-te

Trimite o cerere de generare idempotentă, interoghează endpointul public al sarcinii, folosește webhookuri semnate pentru notificările de răspuns ale generării sau trimite o interacțiune Chat API cu transmitere SSE în flux.

Ce este livrat prima dată

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

API-ul face parte din produsul Rivya. Folosește ID-uri de modele Rivya, credite Rivya, stări publice ale sarcinilor și documentație conectată la catalogul de modele.

API generare imagini

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

API generare video

Rulează sarcini video asincrone cu aceleași controale de sarcină ș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.

Limită versiune

Domeniu clar, fără promisiuni ascunse

Această pagină separă funcțiile API disponibile de completările viitoare, ca să îți poți face planul pe baza a ceea ce este activ astăzi.

Chat API

Disponibil

Disponibil pentru interacțiuni fără transmitere în flux și cu transmitere SSE în flux, folosind sesiuni create prin API, creditele contului și atașamente imagine opționale 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ările de producție care au nevoie de notificări de răspuns semnate pentru sarcinile de generare reușite sau eșuate.

Documentație API

Citește despre autentificare, corpurile cererilor, răspunsuri, idempotență, parametri de model și coduri de eroare.

Deschide documentația

Gestionarea cheilor API

Creează o cheie API și copiaz-o o singură dată. Pentru înlocuire, creează o cheie nouă și revoc-o pe cea veche din zona protejată Setări.

Gestionează cheile

Depanare online

Folosește mai întâi exemple simulate; depanarea reală necesită autentificare, o cheie API și credite în cont.

Previzualizează fluxul

Construiește pe stratul multimodal de modele Rivya

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" }'

Previzualizează cererea, apoi ruleaz-o cu propria cheie 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 }

{ "params": { "referenceMediaItems": [ { "url": "https://media.example/reference.png", "kind": "image", "name": "reference.png", "mimeType": "image/png", "sizeBytes": 245760 } ] } }