Rivya API -yleiskatsaus

Rivya API v1 on kehittäjäsopimus tuettujen Rivya-mallien toimintojen kutsumiseen omasta tuotteesta. Se edellyttää, että julkinen API on otettu käyttöön kyseisessä ympäristössä ja tililläsi on siihen oikeus.

Toteutettu sopimus kattaa asynkronisen kuva-, video- ja audiogeneroinnin sekä Chat API -vuorot ei-streamaavilla tai SSE-streamaavilla vastauksilla. Se käyttää Rivya-mallitunnuksia, Rivya-tilin krediittejä, julkisia tehtävätunnuksia generointiin ja palvelinpuolen chat-istuntoja Chat API:a varten. Dokumentoitu reitti ei lupaa, että jokainen ympäristö, tili tai katalogimalli voi kutsua sitä; varmista ajantasainen käyttöoikeus ja mallin valmius ennen integraatiota.

Mihin API on tarkoitettu

Käytä API:a, kun haluat:

• lähettää kuva-, video- tai audiogenerointitöitä omasta sovelluksestasi

• lähettää ei-streamaavia tai streamaavia chat-vuoroja ja jatkaa API:n luomia chat-istuntoja

• pitää laskutuksen saman Rivya-tilin krediittilompakossa

• pollata tehtävän tilaa julkisella tehtävätunnuksella

• käyttää idempotentteja retryjä turvallisempiin tuotantopyyntöihin

• pitää Studion ja API:n käytön saman tilirajan sisällä

API on Rivya-tuotekerros. Julkiset vastaukset käyttävät vain Rivyan nimiä ja julkisia kenttiä.

Nykyisen version scope

Toteutettuihin v1-endpointteihin kuuluvat:

• 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

Nykyinen sopimus sisältää allekirjoitetut webhookit asynkronisen generoinnin tuloksille, Chat API:n ja TypeScript SDK:n beetaversion palvelinpuolen suoratoistotuella. Webhook-kutsut edellyttävät, että sekä webhook-ominaisuus että julkinen API on otettu käyttöön kyseisessä ympäristössä.

Todennus

Generointi-, tila- ja krediittiendpointit vaativat:

Authorization: Bearer rvya_sk_...

Luo ja kierrätä avaimia API-avainten asetuksissa. Lue API-todennus ennen avaimen käyttöä tuotannossa.

Laskutusmalli

API-kutsut käyttävät samoja Rivya-tilin krediittejä kuin Studio.

Generointityöt varaavat tai kuluttavat krediittejä, kun tehtävä alkaa. Chat-vuorot varaavat krediittejä ennen mallikutsua ja selvittävät lopulliset krediitit token-käytöstä, kun assistant-viesti tallennetaan. Jos generointi tai chat-vuoro epäonnistuu Rivyan nykyisten epäonnistumissääntöjen mukaisesti, sama hyvityskäsittely pätee.

Lue API-krediitit ja krediitit ja laskutus Rivyassa käyttäjälle näkyvästä lompakkomallista.

Ensimmäinen integraatiopolku

1. Luo API-avain asetuksissa.

2. Kutsu listaa API-mallit valitaksesi julkisen mallitunnuksen.

3. Lue mallien API-viite mallin parametreista.

4. Jos malli tarvitsee referenssimediaa, lataa se Files API:lla.

5. Lähetä työ sivun luo generointi mukaisesti.

6. Pollaa generoinnin tilaa, kunnes tehtävä onnistuu tai epäonnistuu. Jos webhookit on otettu käyttöön kyseisessä käyttöönotossa ja tilillä, voit vaihtoehtoisesti tilata allekirjoitetut valmistumistapahtumat sivun API-webhookit kautta.

7. Chat-malleissa käytä Chat API:a generointien endpointin sijaan. Chat-kuvaliitteiden täytyy viitata Files API:n file_id-arvoihin.

Liittyvät sivut

• API-pika-aloitus

• API-todennus

• Rivya TypeScript SDK

• Mallien API-viite

• Chat API

• API-webhookit

• API-virheet ja rajoitukset