Rivya API -yleiskatsaus

Rivya API v1 on kehittäjien sisäänkäynti Rivyan mallikyvykkyyksien kutsumiseen omasta tuotteesta.

Julkinen API tukee asynkronista kuva-, video- ja audiogenerointia sekä Chat API -vuoroja 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.

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

Nykyiset v1-endpointit:

• 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 versio sisältää allekirjoitetut webhookit asynkronisen generoinnin tuloksille, Chat API:n ja TypeScript SDK -betan palvelinpuolen streamaustuella.

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, tai tilaa API-webhookit allekirjoitettuja valmistumistapahtumia varten.
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