Rivya API este ruta pentru dezvoltatori prin care folosesti capabilitatile modelelor Rivya din propriul produs, script sau workflow.
Nu este un produs separat de Rivya Studio. Foloseste aceeasi granita de cont, acelasi portofel de credite si acelasi strat public de modele pe care utilizatorii il vad in Rivya. Diferenta este felul in care incepe munca: in loc sa dai click prin Studio, aplicatia ta trimite cereri cu o cheie API.
Daca ai nevoie de detalii despre endpointuri, incepe cu Prezentare generala Rivya API si Pornire rapida Rivya API. Acest articol este explicatia la nivel de produs: pentru ce este API-ul, unde se potriveste si cand nu ar trebui sa fie prima ruta.
Versiunea scurta
Rivya API v1 permite unui cont autentificat sa creeze chei API si sa apeleze capabilitatile modelelor Rivya din afara interfetei web.
Suprafata API curenta include:
- descoperirea modelelor prin lista de modele API
- joburi asincrone de generare pentru imagine, video si audio
- uploaduri Files API pentru modele care au nevoie de media de referinta
- polling de status pentru generari, cu ID-uri publice de task
- verificari de credite ale contului
- ture Chat API, inclusiv streaming SSE optional
- webhookuri semnate pentru finalizarea generarilor
- un SDK TypeScript beta pentru echipe care vor un wrapper client
Hubul public pentru dezvoltatori este Developers. Este cea mai buna intrare daca vrei o privire ghidata, linkuri catre setarile de chei API si un flux sigur de depanare.
De ce are Rivya un API
Studio este util cand o persoana inca alege modele, modeleaza prompturi, revizuieste rezultate si decide ce urmeaza.
API-ul este util cand acea decizie s-a transformat intr-un workflow repetabil de produs sau de operare.
Exemple comune:
- un produs vrea sa genereze variante de imagine dupa ce un utilizator trimite un brief
- un workflow de marketing trebuie sa creeze drafturi vizuale din inputuri structurate de campanie
- un instrument intern trebuie sa trimita joburi video sau audio fara sa ceara cuiva sa deschida browserul
- un sistem de suport sau continut vrea o tura de model chat in propria interfata
- un serviciu backend vrea callbackuri semnate cand joburile de generare se termina
In acele cazuri, Rivya API pastreaza munca legata de acelasi cont Rivya, in loc sa forteze un stack separat pentru billing, selectie de model si status de task.
Ce nu inlocuieste API-ul
API-ul nu inlocuieste fiecare motiv de a folosi Rivya direct.
Foloseste Ghid Rivya Studio sau suprafetele publice de lucru cand:
- promptul inca are nevoie de explorare umana
- alegerea modelului nu este stabila
- un creator trebuie sa compare vizual rezultatele
- proiectul depinde de istoric salvat si revizuire manuala
- echipa nu a decis ce format de input si output ar trebui sa devina repetabil
Foloseste API-ul cand workflowul este suficient de clar ca sa fie automatizat.
Aceasta granita conteaza. O intrebare creativa vaga apartine de obicei mai intai in Studio. Un flux de produs cunoscut, cu inputuri predictibile, poate trece in API.
Principalele blocuri de constructie
Gandeste API-ul ca sase piese conectate.
| Bloc de constructie | Ce gestioneaza | Unde citesti mai departe |
|---|---|---|
| Chei API | Acces server-to-server din contul tau | Autentificare API |
| Modele | ID-uri publice de model si informatii de readiness | Modele API |
| Generari | Joburi asincrone de imagine, video si audio | Creeaza o generare |
| Fisiere | Uploaduri de imagine, video sau audio de referinta | Files API |
| Chat | Ture de chat non-streaming sau streaming | Chat API |
| Webhookuri | Evenimente semnate de finalizare pentru joburi de generare | API Webhooks |
Documentatia API este sursa pentru forma cererilor si raspunsurilor. Acest articol ar trebui sa te ajute sa decizi de ce piesa ai nevoie mai intai.
Cum functioneaza creditele
Folosirea API consuma din acelasi portofel de credite al contului Rivya ca Studio.
Asta inseamna ca API-ul nu este un proxy anonim de modele. O cerere apartine unui cont Rivya, foloseste o cheie API creata de acel cont si urmeaza aceeasi granita de credite la nivel de produs descrisa in Credite API.
Acest lucru este util pentru echipe, deoarece experimentele din Studio si folosirea API raman intr-un singur model operational. Poti testa manual un model, apoi poti muta partea repetabila intr-o integrare fara sa creezi un al doilea strat de billing.
Cum se potrivesc fisierele
Unele modele pot rula doar din text. Altele au nevoie de o imagine, un video sau un fisier audio de referinta.
Pentru integrari API, aceste referinte ar trebui sa treaca prin Files API. Uploadul creeaza o inregistrare de fisier gestionata, care poate fi trimisa in parametrii modelelor acceptate.
Regula practica este simpla:
- daca un model accepta input doar text, incepe cu endpointul de generare
- daca un model are nevoie de media de referinta, uploadeaza mai intai fisierul
- daca modelul este un model de chat cu atasamente imagine, foloseste Chat API si ID-uri de fisier
Nu proiecta integrarea in jurul fluxurilor de upload disponibile doar in browser sau al sesiunilor Studio salvate. API-ul are propria granita publica de fisiere pentru un motiv.
Unde ajuta webhookurile
Pollingul este cea mai usoara prima ruta de integrare. Trimite un job de generare, salveaza ID-ul public de task si fa polling pana cand reuseste sau esueaza.
Webhookurile devin utile cand integrarea este mai aproape de productie:
- nu vrei un worker care sa faca polling pentru fiecare job
- aplicatia ta trebuie sa actualizeze o inregistrare cand generarea se termina
- vrei un eveniment semnat care poate fi reincercat in siguranta
- joburile esuate trebuie sa intre intr-o ruta clara de recuperare
Pentru contractul evenimentelor semnate, foloseste API Webhooks. Pastreaza receiverul de webhook ingust: verifica semnaturile, gestioneaza evenimentele duplicate si evita sa pui valori secrete in loguri.
Un prim proiect API bun
Cel mai bun prim proiect API este de obicei mic si concret.
De exemplu:
- creeaza o cheie API in setari
- apeleaza lista de modele
- alege un model disponibil
- trimite un job de generare cu o cheie de idempotenta
- fa polling pe endpointul de status
- verifica creditele inainte si dupa
- abia apoi adauga Files API, Chat API sau Webhooks
Aceasta ruta iti da o integrare functionala fara sa amesteci fiecare functie API in primul test.
Cand API-ul este punctul de start gresit
API-ul probabil nu este primul pas potrivit cand:
- echipa nu a ales inca o familie de modele
- rezultatul dorit se schimba la fiecare rulare
- promptul depinde de gust si revizuire manuala
- integrarea ar ascunde utilizarea creditelor de oamenii care trebuie sa o inteleaga
- produsul are nevoie de un demo public inainte sa aiba nevoie de automatizare
In acele cazuri, incepe din Image, Video, Audio, Chat sau AI Models. Dupa ce ruta devine repetabila, muta partea stabila in API.
Unde sa mergi mai departe
- Deschide Developers pentru hubul public API si debugger.
- Citeste Pornire rapida Rivya API ca sa faci prima cerere sigura.
- Citeste Autentificare API inainte sa pui o cheie pe server.
- Citeste Modele API inainte sa alegi ID-uri de model.
- Citeste Cand sa folosesti Rivya API in loc de Studio daca granita de produs inca nu este clara.
- Citeste Cum sa construiesti un workflow AI multimodal cu Rivya API cand planifici o integrare completa de imagine, video, audio sau chat.
