Rivya API

Costruisci sul layer di modelli multimodali Rivya

Rivya API offre ai team prodotto un modo pubblico e basato su account per chiamare i modelli Rivya dalle proprie app. Parti da job asincroni per immagini, video e audio, aggiungi turni Chat API con streaming SSE opzionale quando un modello supporta la chat e mantieni la fatturazione nello stesso wallet di crediti Rivya.
Leggi la documentazione APICrea una API key

Forma quickstart

Layer modelli

Catalogo dinamico

Fatturazione

Crediti condivisi

Prima versione

Job + Chat

Accesso

API key

MetodoPOST
Endpoint/api/v1/generations

La richiesta reale richiede una Rivya API key e crediti disponibili sull'account. Gli esempi pubblici usano secret placeholder e non chiamano modelli in forma anonima.

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
}

Cosa arriva per primo

Un layer API pubblico che resta allineato al prodotto Rivya

L'API è progettata come superficie di prodotto Rivya. Usa ID modello Rivya, crediti Rivya, stati task pubblici e documentazione collegata al catalogo modelli.

API generazione immagini

Invia job immagine con prompt e parametri supportati dal modello, poi fai polling dei risultati pubblici.

API generazione video

Esegui job video asincroni con gli stessi controlli di task e crediti usati da Studio.

API generazione audio

Usa modelli audio accessibili via API attraverso lo stesso confine di account, saldo e cronologia.

Wallet crediti condiviso

Chiamate API e uso Studio consumano lo stesso saldo Rivya, con crediti riservati e gestione dei fallimenti.

Percorso iniziale

Dall'account alla prima richiesta API

01

Crea una key

Accedi, apri API Keys nelle Impostazioni, crea una key con scope e salva subito il secret completo.

02

Scegli un modello

Leggi il riferimento modelli API o chiama /api/v1/models per ispezionare ID modello, parametri, capacità chat e readiness degli input prima dell'invio.

03

Invia, fai polling o sottoscrivi

Invia una richiesta di generazione idempotente, fai polling dell'endpoint task pubblico, usa webhook firmati per callback di generazione oppure invia un turno Chat API con streaming SSE opzionale.

Confine versione

Ambito chiaro, nessuna promessa nascosta

La landing page può citare superfici future, ma il copy prodotto corrente non deve far pensare che API non finite siano già live.

Chat API

Disponibile

Disponibile per turni non streaming e streaming SSE con sessioni create via API, crediti account e allegati immagine opzionali tramite Files API.

Files API

Disponibile

Disponibile per upload di immagini, video e audio di riferimento. Usala prima della generazione quando una pagina modello richiede params.referenceMediaItems.

Webhook utente

Disponibile

Disponibili per integrazioni di produzione che vogliono callback firmate per task di generazione riusciti o falliti.

Debugger online

Anteprima la richiesta, poi eseguila con la tua API key

Il debugger parte in modalità mock per ogni visitatore. Il selettore di generazione elenca modelli non chat testabili senza upload di file, mentre il pannello Files permette agli utenti autenticati di testare /api/v1/files con una API key temporanea. Gli esempi Chat sono nella documentazione API.

Stato account

Controllo account

Prefisso key attiva

Crea prima una key

Crediti correnti

Accedi per controllare

Anteprima mockPublic API liveNessuna API key attiva

La modalità mock non chiama mai un modello e non consuma crediti.

Incolla la key solo per questa richiesta. Il debugger non la conserva dopo il refresh.

Test upload Files API

Carica media di riferimento tramite POST /api/v1/files, poi copia URL e duration token restituiti in params.referenceMediaItems per un modello che supporta input di riferimento.

Mock non carica mai fileLive usa /api/v1/files

Il modello selezionato controlla MIME type, dimensione e regole di durata consentiti. Gli upload live richiedono la tua API key temporanea e possono chiamare il servizio upload reale.

Crea API keyLeggi documentazione API
Anteprima request
{
  "model": "z-image",
  "prompt": "Foto prodotto editoriale su un set da studio pulito",
  "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
}
Response 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
}
Params generazione
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Stato task

Crediti base stimati

1

Stato

queued

Documentazione API

Leggi autenticazione, body delle request, response, idempotenza, parametri modello e codici errore.

Apri documentazione

Gestione API key

Crea, copia una sola volta, revoca e ruota API key dall'area Impostazioni protetta.

Gestisci key

Debug online

Usa prima gli esempi mock; il debug reale richiede login, una API key e crediti account.

Anteprima flusso