Rivya API on kehittäjäpolku Rivyan mallikyvykkyyksien käyttämiseen omasta tuotteesta, skriptistä tai työnkulusta.
Se ei ole erillinen tuote Rivya Studiosta. Se käyttää samaa tilirajaa, samaa credit-lompakkoa ja samaa julkista mallikerrosta, jonka käyttäjät näkevät Rivyan eri pinnoilla. Ero on siinä, miten työ alkaa: Studion läpi klikkaamisen sijaan sovelluksesi lähettää pyyntöjä API-avaimella.
Jos tarvitset endpoint-yksityiskohtia, aloita sivuista Rivya API Overview ja Rivya API Quickstart. Tämä artikkeli on tuotetason selitys: mihin API on tarkoitettu, mihin se sopii ja milloin sen ei pitäisi olla ensimmäinen polku.
Lyhyt versio
Rivya API v1 antaa kirjautuneen tilin luoda API keys ja kutsua Rivyan mallikyvykkyyksiä web-käyttöliittymän ulkopuolelta.
Nykyinen API-pinta sisältää:
- model discovery API-mallilistan kautta
- asynkroniset image-, video- ja audio-generation jobs
- Files API -lataukset malleille, jotka tarvitsevat referenssimediaa
- generation status polling julkisilla task ID:illä
- account credit checks
- Chat API -vuorot, mukaan lukien valinnainen SSE streaming
- signed webhooks generoinnin valmistumiselle
- TypeScript SDK beta tiimeille, jotka haluavat client wrapperin
Julkinen kehittäjähubi on Developers. Se on paras sisäänkäynti, jos haluat ohjatun yleiskuvan, linkit API key -asetuksiin ja turvallisen debugger flow'n.
Miksi Rivyalla on API
Studio on hyödyllinen, kun ihminen vielä valitsee malleja, muotoilee prompteja, arvioi tuotoksia ja päättää, mitä tehdään seuraavaksi.
API on hyödyllinen, kun päätös on muuttunut toistettavaksi tuotteeksi tai operatiiviseksi työnkuluksi.
Yleisiä esimerkkejä:
- tuote haluaa generoida kuvavariantteja käyttäjän lähetettyä briefin
- markkinointityönkulun täytyy luoda visuaaliluonnoksia strukturoiduista kampanjasyötteistä
- sisäinen työkalu tarvitsee video- tai audiotehtävien lähettämistä ilman, että jonkun täytyy avata selain
- tuki- tai sisältöjärjestelmä haluaa chat-mallivuoron omaan käyttöliittymäänsä
- backend-palvelu haluaa signed callbacks, kun generation jobs valmistuvat
Näissä tapauksissa Rivya API pitää työn samassa Rivya-tilissä sen sijaan, että laskutukselle, mallivalinnalle ja tehtävän tilalle rakennettaisiin erillinen stack.
Mitä API ei korvaa
API ei korvaa jokaista syytä käyttää Rivyaa suoraan.
Käytä Studio:ta tai julkisia työpintoja, kun:
- prompt tarvitsee vielä ihmisen tutkimista
- mallivalinta ei ole vakaa
- creatorin täytyy vertailla tuotoksia visuaalisesti
- projekti riippuu tallennetusta historiasta ja manuaalisesta arvioinnista
- tiimi ei ole päättänyt, minkä syöte- ja tuotosformaatin pitäisi muuttua toistettavaksi
Käytä APIa, kun työnkulku on tarpeeksi selkeä automatisoitavaksi.
Tällä rajalla on merkitystä. Epämääräinen luova kysymys kuuluu yleensä ensin Studioon. Tunnettu tuoteflow ennustettavilla syötteillä voi siirtyä APIin.
Pääasialliset rakennuspalikat
Ajattele APIa kuutena toisiinsa kytkettynä osana.
| Rakennuspalikka | Mitä se käsittelee | Mistä lukea seuraavaksi |
|---|---|---|
| API keys | Server-to-server access tililtäsi | API Authentication |
| Models | Julkiset model IDs ja readiness-tieto | API Models |
| Generations | Async image-, video- ja audio jobs | Create Generation |
| Files | Referenssikuvan, -videon tai -audion lataukset | Files API |
| Chat | Non-streaming- tai streaming-chat-vuorot | Chat API |
| Webhooks | Signed completion events generation jobs -tehtäville | API Webhooks |
API-dokumentit ovat request- ja response-muodon lähde. Tämän artikkelin pitäisi auttaa päättämään, mitä osaa tarvitset ensin.
Miten credits toimivat
API-käyttö kuluttaa samaa Rivya-tilin credit-lompakkoa kuin Studio.
Tämä tarkoittaa, että API ei ole anonyymi malliproxy. Pyyntö kuuluu Rivya-tilille, käyttää kyseisen tilin luomaa API-avainta ja noudattaa samaa tuotetason credit-rajaa, joka kuvataan sivulla API Credits.
Tämä on tiimeille hyödyllistä, koska Studio-kokeilut ja API-käyttö pysyvät yhdessä operatiivisessa mallissa. Voit testata mallia manuaalisesti ja siirtää sitten toistettavan osan integraatioon luomatta toista laskutuskerrosta.
Miten tiedostot sopivat mukaan
Jotkin mallit voivat ajaa pelkästä tekstistä. Toiset tarvitsevat referenssikuvan, -videon tai -audiotiedoston.
API-integraatioissa näiden referenssien pitäisi kulkea Files API:n kautta. Lataus luo hallitun tiedostotietueen, jonka voi antaa tuettuihin malliparametreihin.
Käytännön sääntö on yksinkertainen:
- jos malli hyväksyy text-only-syötteen, aloita generation endpointista
- jos malli tarvitsee referenssimediaa, lataa tiedosto ensin
- jos malli on chat-malli kuvalliitteillä, käytä Chat APIa ja file IDs
Älä suunnittele integraatiota selainvain upload flow'n tai tallennettujen Studio-sessioiden varaan. APIlla on oma julkinen tiedostorajansa syystä.
Missä webhooks auttavat
Polling on helpoin ensimmäinen integraatiopolku. Lähetä generation job, tallenna julkinen task ID ja pollaa, kunnes se onnistuu tai epäonnistuu.
Webhooks muuttuvat hyödyllisiksi, kun integraatio on tuotantomaisempi:
- et halua workerin pollaavan jokaista jobia
- sovelluksesi täytyy päivittää tietue, kun generointi valmistuu
- haluat signed eventin, jota voidaan yrittää turvallisesti uudelleen
- epäonnistuneiden jobien täytyy siirtyä selkeään palautuspolkuun
Signed event -sopimukseen käytä API Webhooks. Pidä webhook receiver kapeana: tarkista allekirjoitukset, käsittele duplicate events ja vältä salaisten arvojen kirjaamista lokiin.
Hyvä ensimmäinen API-projekti
Paras ensimmäinen API-projekti on yleensä pieni ja konkreettinen.
Esimerkiksi:
- luo API key asetuksissa
- kutsu mallilistaa
- valitse yksi saatavilla oleva malli
- lähetä yksi generation job idempotency keyllä
- pollaa status endpointia
- tarkista credits ennen ja jälkeen
- lisää vasta sitten Files API, Chat API tai Webhooks
Tämä polku antaa toimivan integraation sekoittamatta jokaista API-ominaisuutta ensimmäiseen testiin.
Milloin API on väärä aloituspiste
API ei todennäköisesti ole oikea ensimmäinen askel, kun:
- tiimi ei ole vielä valinnut malliperhettä
- haluttu tuotos muuttuu yhä joka ajolla
- prompt riippuu manuaalisesta mausta ja arvioinnista
- integraatio piilottaisi credit-käytön ihmisiltä, joiden täytyy ymmärtää se
- tuote tarvitsee julkisen demon ennen automaatiota
Näissä tapauksissa aloita sivuilta Image, Video, Audio, Chat tai AI Models. Kun polku on toistettava, siirrä vakaa osa APIin.
Minne seuraavaksi
- Avaa Developers julkista API-hubia ja debuggeria varten.
- Lue Rivya API Quickstart ensimmäisen turvallisen pyynnön tekemiseksi.
- Lue API Authentication ennen kuin laitat avaimen palvelimelle.
- Lue API Models ennen model IDs -valintaa.
- Lue milloin käyttää Rivya APIa Studion sijaan, jos tuoteraja on yhä epäselvä.
- Lue miten rakentaa multimodaalinen AI-työnkulku Rivya APIlla, kun suunnittelet täyttä image-, video-, audio- tai chat-integraatiota.
