Prezentare generală a API-ului Rivya

Rivya API v1 este interfața prin care poți apela din propriul produs funcțiile Rivya acceptate, cu condiția ca API-ul public să fie activ în instanța curentă și disponibil pentru contul tău.

Contractul implementat acoperă generarea asincronă de imagini, video și audio, precum și răspunsuri Chat API fără streaming sau prin SSE. El folosește ID-uri de model Rivya, creditele contului, ID-uri publice de sarcină și sesiuni de chat pe server. Faptul că o rută este documentată nu înseamnă că poate fi apelată în orice mediu, de orice cont sau cu orice model; verifică accesul efectiv și starea modelului înainte de integrare.

La ce folosește API-ul

Folosește API-ul atunci când vrei să:

• trimiți sarcini de generare a imaginilor, materialelor video sau audio din propria aplicație

• trimiți mesaje de chat cu sau fără streaming și continui sesiuni create prin API

• păstrezi facturarea în același sold de credite al contului Rivya

• verifici starea unei sarcini folosind ID-ul său public

• folosești reîncercări idempotente pentru cereri de producție mai sigure

• folosești Studio și API în limitele aceluiași cont

API-ul face parte din produsul Rivya. Răspunsurile publice folosesc numai denumiri Rivya și câmpuri publice.

Domeniul versiunii curente

Punctele de acces v1 implementate includ:

• 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

Contractul actual include webhook-uri semnate pentru rezultatele asincrone, Chat API și un SDK TypeScript beta cu streaming pe server. Webhook-urile pot fi folosite numai dacă atât această funcție, cât și API-ul public sunt active în instanța curentă.

Autentificare

Punctele de acces pentru generare, stare și credite necesită:

Authorization: Bearer rvya_sk_...

Creează și rotește cheile din setările pentru chei API. Citește Autentificarea API înainte de a folosi o cheie în producție.

Model de facturare

Apelurile API folosesc aceleași credite ale contului Rivya ca Studio.

Sarcinile de generare rezervă sau consumă credite atunci când pornesc. Mesajele de chat rezervă credite înainte de apelarea modelului, iar costul final este calculat pe baza tokenurilor folosite după salvarea răspunsului asistentului. Dacă o generare sau un mesaj de chat eșuează în condițiile definite de Rivya, se aplică aceleași reguli de rambursare.

Citește Credite API și Credite și facturare în Rivya pentru a înțelege soldul afișat utilizatorului.

Prima cale de integrare

1. Creează o cheie API din setările contului.

2. Consultă Modelele API și alege un ID public de model.

3. Citește Referința API pentru modele pentru parametrii modelului.

4. Dacă modelul necesită materiale de referință, încarcă-le prin API-ul pentru fișiere.

5. Trimite o sarcină urmând ghidul Crearea unei generări.

6. Verifică starea generării până când sarcina reușește sau eșuează. Dacă webhook-urile sunt active pentru instanță și cont, poți primi în schimb evenimente de finalizare semnate prin Webhook-uri API.

7. Pentru modelele de chat, folosește Chat API, nu punctul de acces pentru generare. Imaginile atașate unui mesaj trebuie să indice o valoare file_id din API-ul pentru fișiere.

Pagini asociate

• Pornire rapidă cu API-ul

• Autentificare API

• Rivya TypeScript SDK

• Referința API pentru modele

• Chat API

• Webhook-uri API

• Erori și limite API