Panoramica Rivya API

Rivya API v1 è il punto di ingresso per sviluppatori che vogliono chiamare capacità dei modelli Rivya dal proprio prodotto.

La public API supporta generazione asincrona di immagini, video e audio, più turni Chat API con risposte non streaming o streaming SSE. Usa ID modello Rivya, crediti account Rivya, ID pubblici dei task per la generazione e sessioni chat lato server per Chat API.

A cosa serve l'API

Usa l'API quando vuoi:

• inviare job di generazione immagine, video o audio dalla tua app
• mandare turni chat non streaming o streaming e continuare sessioni chat create via API
• mantenere la fatturazione nello stesso wallet di crediti account Rivya
• fare polling dello stato del task tramite ID pubblico del task
• usare retry idempotenti per richieste di produzione più sicure
• mantenere uso Studio e API nello stesso perimetro account

L'API è un livello prodotto Rivya. Le risposte pubbliche usano solo nomi Rivya e campi pubblici.

Ambito della versione attuale

Endpoint v1 attuali:

• GET /api/v1/models
• POST /api/v1/generations
• POST /api/v1/files
• GET /api/v1/files/{fileId}
• POST /api/v1/chat/completions
• GET /api/v1/chat/sessions
• GET /api/v1/chat/sessions/{sessionId}
• GET /api/v1/generations/{taskId}
• GET /api/v1/credits
• GET /api/v1/webhooks
• POST /api/v1/webhooks
• GET /api/v1/webhook-events
• GET /api/v1/openapi.json

La versione attuale include webhook firmati per risultati di generazione asincrona, Chat API e una beta del TypeScript SDK con supporto allo streaming lato server.

Autenticazione

Gli endpoint di generazione, stato e crediti richiedono:

Authorization: Bearer rvya_sk_...

Crea e ruota le chiavi da impostazioni API Keys. Leggi autenticazione API prima di usare una chiave in produzione.

Modello di fatturazione

Le chiamate API usano gli stessi crediti account Rivya di Studio.

I job di generazione riservano o consumano crediti quando il task parte. I turni Chat riservano crediti prima della chiamata al modello e regolano i crediti finali in base al token usage quando il messaggio assistant viene salvato. Se una generazione o un turno chat fallisce secondo le regole di errore esistenti di Rivya, si applica la stessa gestione dei rimborsi.

Leggi crediti API e crediti e fatturazione in Rivya per il modello wallet lato utente.

Primo percorso di integrazione

1. Crea una chiave API in Settings.
2. Chiama modelli API per scegliere un ID modello pubblico.
3. Leggi riferimento API dei modelli per i parametri del modello.
4. Se il modello richiede media di riferimento, caricali con Files API.
5. Invia un job con creare una generazione.
6. Fai polling di stato generazione finché il task riesce o fallisce, oppure iscriviti ad API Webhooks per eventi di completamento firmati.
7. Per i modelli chat, usa Chat API invece dell'endpoint di generazione. Gli allegati immagine Chat devono fare riferimento a valori file_id della Files API.

Pagine correlate

• Quickstart API
• Autenticazione API
• Rivya TypeScript SDK
• Riferimento API dei modelli
• Chat API
• API Webhooks
• Errori e limiti API