Mikä Rivya API on?

Rivya API on kehittäjäsopimus, jolla tuettuja Rivya-mallien toimintoja voi käyttää omasta tuotteesta, skriptistä tai työnkulusta. Se edellyttää, että julkinen API on otettu käyttöön kyseisessä ympäristössä ja tililläsi on siihen oikeus.

Se ei ole erillinen tuote Rivya Studiosta. Se käyttää samaa tilirajaa, samaa krediittilompakkoa 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 päätepisteiden yksityiskohtia, aloita sivuista Rivya API -yleiskatsaus ja Rivya API -pika-aloitus. 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 käyttöoikeuden saaneen kirjautuneen tilin luoda API-avaimia ja kutsua API-valmiita Rivya-mallikyvykkyyksiä verkkokäyttöliittymän ulkopuolelta. Kehittäjäsivut kuvaavat toteutettua sopimusta; todellinen käyttöönotto, tilin oikeudet ja mallin valmius ratkaisevat, voiko pyynnön suorittaa.

Toteutettu API-pinta sisältää:

• mallien löytäminen API-mallilistan kautta

• asynkroniset kuva-, video- ja audiogenerointitehtävät

• Files API -lataukset malleille, jotka tarvitsevat referenssimediaa

• generoinnin tilan kysely julkisilla tehtävätunnuksilla

• tilin krediittitarkistukset

• Chat API -vuorot, mukaan lukien valinnainen SSE-suoratoisto

• allekirjoitetut webhookit generoinnin valmistumiselle, kun webhookit on otettu käyttöön kyseisessä käyttöönotossa

• TypeScript SDK:n beetaversio tiimeille, jotka haluavat valmiin asiakasohjelman

Julkinen kehittäjäportaali on paras aloituspaikka, jos haluat ohjatun yleiskuvan, linkit API-avainasetuksiin ja turvallisen vianetsintäpolun.

Miksi Rivyalla on API

Studio on hyödyllinen, kun ihminen vielä valitsee malleja, muotoilee kehotteita, 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.

Kun API-käyttö on otettu käyttöön, tavallisia esimerkkejä ovat:

• tuote haluaa generoida kuvavariantteja käyttäjän lähetettyä toimeksiannon

• 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ä

• taustapalvelu tarvitsee allekirjoitetut takaisinkutsut generointitehtävien valmistuessa

Näissä tapauksissa Rivya API pitää työn samassa Rivya-tilissä sen sijaan, että laskutukselle, mallivalinnalle ja tehtävän tilalle rakennettaisiin erillinen pino.

Mitä API ei korvaa

API ei korvaa jokaista syytä käyttää Rivyaa suoraan.

Käytä Studio:ta tai julkisia työpintoja, kun:

• kehote tarvitsee vielä ihmisen tutkimista

• mallivalinta ei ole vakaa

• sisällöntuottajan 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 tuotevirta ennustettavilla syötteillä voi siirtyä APIin.

Pääasialliset rakennuspalikat

Ajattele APIa kuutena toisiinsa kytkettynä osana.

API-dokumentit ovat pyyntö- ja vastausmuodon lähde. Tämän artikkelin pitäisi auttaa päättämään, mitä osaa tarvitset ensin.

Miten krediitit toimivat

API-käyttö kuluttaa samaa Rivya-tilin krediittilompakkoa 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 krediittirajaa, joka kuvataan sivulla API-krediitit.

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 pelkän tekstisyötteen, aloita generointien päätepisteestä

• jos malli tarvitsee referenssimediaa, lataa tiedosto ensin

• jos malli on chat-malli kuvalliitteillä, käytä Chat APIa ja tiedosto-ID:itä

Älä suunnittele integraatiota vain selaimessa toimivan latauspolun tai tallennettujen Studio-sessioiden varaan. APIlla on oma julkinen tiedostorajansa syystä.

Missä webhookit auttavat

Tilan kysely on helpoin ensimmäinen integraatiopolku. Lähetä generointitehtävä, tallenna julkinen tehtävätunnus ja kysy tilaa, kunnes se onnistuu tai epäonnistuu.

Kun webhookit on otettu käyttöön kyseisessä ympäristössä, niistä tulee hyödyllisiä integraation muuttuessa tuotantomaisemmaksi:

• et halua taustaprosessin kyselevän jokaisen tehtävän tilaa

• sovelluksesi täytyy päivittää tietue, kun generointi valmistuu

• haluat allekirjoitetun tapahtuman, jota voidaan yrittää turvallisesti uudelleen

• epäonnistuneiden tehtävien täytyy siirtyä selkeään palautuspolkuun

Allekirjoitetun tapahtuman sopimukseen käytä API-webhookit. Varmista ominaisuuden saatavuus ennen kuin suunnittelet työnkulun sen varaan. Pidä webhook-vastaanotin kapeana: tarkista allekirjoitukset, käsittele duplikaattitapahtumat ja vältä salaisten arvojen kirjaamista lokiin.

Hyvä ensimmäinen API-projekti

Paras ensimmäinen API-projekti on yleensä pieni ja konkreettinen.

Esimerkiksi:

1. varmista, että API-käyttö on otettu käyttöön kyseisessä käyttöönotossa ja tilillä

2. luo API-avain asetuksissa

3. kutsu mallilistaa

4. valitse yksi API-valmis malli

5. lähetä yksi generointitehtävä idempotenssiavaimella

6. kysy tilapäätepistettä

7. tarkista krediitit ennen ja jälkeen

8. lisää vasta sitten Files API, Chat API tai käyttöönoton tarjoamat webhookit

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

• kehote riippuu manuaalisesta mausta ja arvioinnista

• integraatio piilottaisi krediittien käytön ihmisiltä, joiden täytyy ymmärtää se

• tuote tarvitsee julkisen demon ennen automaatiota

Näissä tapauksissa aloita sivuilta Kuvat, Videot, Ääni, Chat tai AI-mallit. Kun polku on toistettava, siirrä vakaa osa APIin.

Minne seuraavaksi

• Avaa kehittäjäportaali julkista API-osiota ja vianetsintätyökalua varten.

• Lue Rivya API -pika-aloitus ensimmäisen turvallisen pyynnön tekemiseksi.

• Lue API-todennus ennen kuin laitat avaimen palvelimelle.

• Lue API-mallit ennen mallien ID-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.