API-ul Rivya este contractul pentru dezvoltatori prin care poți folosi funcțiile acceptate ale modelelor Rivya în propriul produs, într-un script sau într-un flux de lucru, atunci când accesul Public API este activ pentru implementare și disponibil contului tău.
Nu este un produs separat de Rivya Studio. Folosește același cont, același portofel de credite și același catalog public de modele pe care utilizatorii îl văd în Rivya. Diferența constă în modul de inițiere a activității: în loc să folosești interfața Studio, aplicația trimite cereri cu o cheie API.
Dacă ai nevoie de detalii despre punctele finale, începe cu Prezentarea generală a API-ului Rivya și Pornirea rapidă pentru API-ul Rivya. Acest articol explică produsul în ansamblu: la ce servește API-ul, unde se potrivește și când nu ar trebui să fie prima alegere.
Pe scurt
API-ul Rivya v1 permite unui cont autentificat și eligibil să creeze chei API și să apeleze din afară interfeței web funcțiile modelelor Rivya pregătite pentru API. Paginile pentru dezvoltatori descriu contractul implementat; implementarea activă, permisiunile contului și starea modelului stabilesc dacă o cerere poate fi rulată.
Funcțiile implementate ale API-ului includ:
descoperirea modelelor prin listă de modele API
sarcini asincrone de generare pentru imagini, clipuri video și materiale audio
încărcări prin Files API pentru modelele care necesită materiale media de referință
interogarea periodică a stării generărilor, folosind identificatori publici de sarcină
verificarea creditelor contului
conversații prin Chat API, inclusiv transmitere opțională în flux prin SSE
webhook-uri semnate pentru finalizarea generărilor, atunci când webhook-urile sunt active pentru implementare
un SDK TypeScript beta pentru echipele care doresc un client gata de integrat
Centrul public pentru dezvoltatori este Developers. Este cel mai bun punct de intrare dacă vrei o prezentare ghidată, legături către configurarea cheilor API și un parcurs sigur de depanare.
De ce oferă Rivya un API
Studio este util când o persoană încă alege modele, formulează instrucțiuni, evaluează rezultate și decide ce urmează.
API-ul este util atunci când aceste decizii s-au transformat într-un proces repetabil de produs sau operațional.
Atunci când accesul API este activ, printre exemplele obișnuite se numără:
un produs care generează variante de imagine după ce utilizatorul trimite cerințele
un proces de marketing care creează schițe vizuale din date structurate ale campaniei
un instrument intern care trimite sarcini video sau audio fără ca o persoană să deschidă browserul
un sistem de asistență sau de conținut care folosește un model conversațional în propria interfață
un serviciu de server care primește notificări semnate când se încheie sarcinile de generare
În aceste cazuri, API-ul Rivya păstrează activitatea legată de același cont Rivya, fără să impună o infrastructură separată pentru facturare, alegerea modelului și starea sarcinilor.
Ce nu înlocuiește API-ul
API-ul nu înlocuiește toate motivele pentru care ai folosi Rivya direct.
Folosește Studio sau spațiile publice de lucru atunci când:
instrucțiunea necesită încă explorare umană
alegerea modelului nu este stabilă
un creator trebuie să compare vizual rezultatele
proiectul depinde de istoricul salvat și de evaluarea manuală
echipa nu a stabilit încă ce format de intrare și de rezultat trebuie repetat
Folosește API-ul atunci când fluxul de lucru este suficient de clar pentru a fi automatizat.
Această delimitare este importantă. O întrebare creativă vagă își are, de regulă, locul mai întâi în Studio. Un proces de produs bine definit, cu date de intrare previzibile, poate fi mutat în API.
Componentele principale
Privește API-ul ca pe șase componente conectate.
| Componentă | Ce gestionează | Unde citești mai departe |
|---|---|---|
| Chei API | Acces între servere din contul tău | Autentificare API |
| Modele | Identificatori publici de model și informații despre disponibilitatea operațională | Modele API |
| Generări | Sarcini asincrone de imagine, video și audio | Crearea unei generări |
| Fișiere | Încărcarea imaginilor, clipurilor video sau fișierelor audio de referință | Files API |
| Conversații | Schimburi cu răspuns complet sau transmis în flux | Chat API |
| Webhook-uri | Evenimente de finalizare semnate pentru sarcinile de generare, atunci când funcția este activă | API Webhooks |
Documentația API este sursa de referință pentru structura cererilor și a răspunsurilor. Acest articol te ajută să stabilești de ce componentă ai nevoie mai întâi.
Cum funcționează creditele
Utilizarea API-ului consumă credite din același portofel al contului Rivya folosit de Studio.
Prin urmare, API-ul nu este un intermediar anonim între produs și modele. Fiecare cerere aparține unui cont Rivya, folosește o cheie API creată de acel cont și respectă aceeași limită de credite la nivel de produs descrisă în Credite API.
Pentru echipe, avantajul este că experimentele din Studio și utilizarea API rămân în același cadru operațional. Poți testa manual un model, apoi poți muta partea repetabilă într-o integrare, fără să creezi un al doilea sistem de facturare.
Rolul fișierelor
Unele modele pot rula doar din text. Altele au nevoie de o imagine, de un clip video sau de un fișier audio de referință.
În integrările API, aceste referințe trebuie să treacă prin Files API. Încărcarea creează o înregistrare de fișier gestionată, care poate fi transmisă în parametrii modelelor acceptate.
Regulă practică este simplă:
dacă modelul acceptă doar text, începe cu punctul final de generare
dacă modelul necesită materiale media de referință, încarcă mai întâi fișierul
dacă este un model conversațional cu imagini atașate, folosește Chat API și identificatorii fișierelor
Nu proiecta integrarea în jurul proceselor de încărcare disponibile numai în browser sau al sesiunilor Studio salvate. API-ul separă în mod intenționat gestionarea publică a fișierelor.
Când sunt utile webhook-urile
Interogarea periodică este cea mai simplă primă cale de integrare. Trimiți o sarcină de generare, salvezi identificatorul său public și verifici starea până când reușește sau eșuează.
Când webhook-urile sunt active pentru implementare, devin utile pe măsură ce integrarea se apropie de utilizarea în producție:
nu vrei ca un proces de fundal să interogheze fiecare sarcină
aplicația trebuie să actualizeze o înregistrare la finalizarea generării
ai nevoie de un eveniment semnat care poate fi retrimis în siguranță
sarcinile eșuate trebuie să urmeze o cale clară de recuperare
Pentru contractul evenimentelor semnate, folosește API Webhooks. Confirmă disponibilitatea funcției înainte să proiectezi integrarea în jurul acesteia. Păstrează componenta de recepție cât mai restrânsă: verifică semnăturile, gestionează evenimentele duplicate și nu înscrie valori secrete în jurnale.
Un prim proiect API potrivit
Cel mai bun prim proiect API este, de regulă, restrâns și concret.
De exemplu:
confirmă că accesul API este activ pentru implementare și pentru cont
creează o cheie API în setări
apelează lista de modele
alege un model pregătit pentru API
trimite o sarcină de generare cu o cheie de idempotență
interoghează punctul final pentru stare
verifică creditele înainte și după
abia apoi adaugă Files API, Chat API sau webhook-urile pe care le oferă implementarea
Această cale îți oferă o integrare funcțională fără să amestece toate funcțiile API în primul test.
Când API-ul este punctul de plecare greșit
Probabil că API-ul nu este primul pas potrivit atunci când:
echipa nu a ales încă o familie de modele
rezultatul dorit se schimbă la fiecare încercare
instrucțiunea depinde de preferințe și evaluare manuală
integrarea ar ascunde consumul de credite față de persoanele care trebuie să îl înțeleagă
produsul are nevoie de o demonstrație publică înainte de automatizare
În aceste cazuri, începe din Image, Video, Audio, Chat sau AI Models. După ce procesul devine repetabil, mută partea stabilă în API.
Unde să mergi mai departe
Deschide Developers pentru centrul public al API-ului și instrumentul de depanare.
Citește Pornirea rapidă pentru API-ul Rivya pentru a trimite în siguranță prima cerere.
Citește Autentificare API înainte să stochezi o cheie pe server.
Citește Modele API înainte să alegi identificatorii modelelor.
Citește Când să folosești API-ul Rivya în locul Studio dacă granița dintre explorarea din Studio și automatizarea prin API nu este încă limpede.
Citește Cum să construiești un flux de lucru AI multimodal cu API-ul Rivya atunci când planifici o integrare completă pentru imagini, video, audio sau conversații.
