Rivya API er utviklerstien for å bruke Rivyas modellegenskaper fra ditt eget produkt, script eller arbeidsflyt.
Det er ikke et separat produkt fra Rivya Studio. Det bruker samme kontogrense, samme credit wallet og samme offentlige modellag som brukere ser på tvers av Rivya. Forskjellen er hvordan arbeidet starter: i stedet for å klikke deg gjennom Studio sender applikasjonen din forespørsler med en API key.
Hvis du trenger endpoint-detaljer, start med Rivya API Overview og Rivya API Quickstart. Denne artikkelen er forklaringen på produktnivå: hva API-et er til, hvor det passer, og når det ikke bør være første sti.
Den korte versjonen
Rivya API v1 lar en innlogget konto opprette API keys og kalle Rivya-modellegenskaper fra utenfor webgrensesnittet.
Den nåværende API-flaten omfatter:
- modelloppdagelse gjennom API-modellisten
- asynkrone genereringsjobber for bilde, video og lyd
- Files API-opplastinger for modeller som trenger referansemedier
- polling av genereringsstatus med offentlige task IDs
- kontroll av kontocredits
- Chat API-runder, inkludert valgfri SSE-strømming
- signerte webhooks for fullført generering
- en TypeScript SDK beta for team som vil ha en client wrapper
Den offentlige utviklerhuben er Developers. Den er den beste inngangen hvis du vil ha en veiledet oversikt, lenker til API key-innstillinger og en trygg debugger-flyt.
Hvorfor Rivya har et API
Studio er nyttig når en person fortsatt velger modeller, former prompter, gjennomgår outputer og bestemmer hva som skal skje videre.
API-et er nyttig når den beslutningen har blitt til en repeterbar produkt- eller operasjonell arbeidsflyt.
Vanlige eksempler:
- et produkt vil generere bildevarianter etter at en bruker sender inn en brief
- en markedsføringsarbeidsflyt må lage visuelle utkast fra strukturerte kampanjeinputer
- et internt verktøy må sende inn video- eller lydjobber uten å be noen åpne nettleseren
- et support- eller innholdssystem vil ha en chatmodellrunde inne i sitt eget grensesnitt
- en backend-tjeneste vil ha signerte callbacks når genereringsjobber er ferdige
I slike tilfeller holder Rivya API arbeidet koblet til samme Rivya-konto i stedet for å tvinge frem en separat stack for fakturering, modellvalg og oppgavestatus.
Hva API-et ikke erstatter
API-et erstatter ikke alle grunner til å bruke Rivya direkte.
Bruk Studio eller de offentlige arbeidsflatene når:
- prompten fortsatt trenger menneskelig utforsking
- modellvalget ikke er stabilt
- en kreatør må sammenligne outputer visuelt
- prosjektet avhenger av lagret historikk og manuell gjennomgang
- teamet ikke har bestemt hvilket input- og outputformat som bør bli repeterbart
Bruk API-et når arbeidsflyten er tydelig nok til å automatiseres.
Den grensen betyr noe. Et vagt kreativt spørsmål hører vanligvis hjemme i Studio først. En kjent produktflyt med forutsigbare inputer kan flyttes til API-et.
De viktigste byggeklossene
Tenk på API-et som seks koblede deler.
| Byggekloss | Hva den håndterer | Hvor du leser videre |
|---|---|---|
| API keys | Server-til-server-tilgang fra kontoen din | API Authentication |
| Models | Offentlige modell-ID-er og readiness-informasjon | API Models |
| Generations | Asynkrone bilde-, video- og lydjobber | Create Generation |
| Files | Opplasting av referansebilder, video eller lyd | Files API |
| Chat | Ikke-strømmende eller strømmende chatrunder | Chat API |
| Webhooks | Signerte fullføringshendelser for genereringsjobber | API Webhooks |
API-dokumentasjonen er kilden for request- og response-form. Denne artikkelen skal hjelpe deg å avgjøre hvilken del du trenger først.
Slik fungerer credits
API-bruk trekker fra samme Rivya-konto-credit wallet som Studio.
Det betyr at API-et ikke er en anonym modellproxy. En forespørsel tilhører en Rivya-konto, bruker en API key opprettet av den kontoen og følger samme produktnivågrense for credits som beskrives i API Credits.
Dette er nyttig for team fordi Studio-eksperimenter og API-bruk blir værende i én operasjonell modell. Du kan teste en modell manuelt og deretter flytte den repeterbare delen inn i en integrasjon uten å lage et ekstra faktureringslag.
Hvordan filer passer inn
Noen modeller kan kjøre fra tekst alene. Andre trenger et referansebilde, en video eller en lydfil.
For API-integrasjoner bør disse referansene gå gjennom Files API. Opplastingen oppretter en administrert filoppføring som kan sendes inn i støttede modellparametere.
Den praktiske regelen er enkel:
- hvis en modell aksepterer tekst-only input, start med genereringsendepunktet
- hvis en modell trenger referansemedier, last opp filen først
- hvis modellen er en chatmodell med bildevedlegg, bruk Chat API og file IDs
Ikke design integrasjonen rundt browser-only opplastingsflyter eller lagrede Studio-sesjoner. API-et har sin egen offentlige filgrense av en grunn.
Der webhooks hjelper
Polling er den enkleste første integrasjonsstien. Send inn en genereringsjobb, lagre public task ID, og poll til den lykkes eller feiler.
Webhooks blir nyttige når integrasjonen er mer produksjonslik:
- du vil ikke ha en worker som poller hver jobb
- appen din må oppdatere en oppføring når genereringen er ferdig
- du vil ha en signert hendelse som kan prøves trygt igjen
- feilede jobber må flyttes inn i en tydelig recovery-sti
For den signerte hendelseskontrakten, bruk API Webhooks. Hold webhook receiveren smal: verifiser signaturer, håndter duplikathendelser og unngå å legge hemmelige verdier i logger.
Et godt første API-prosjekt
Det beste første API-prosjektet er vanligvis lite og konkret.
For eksempel:
- opprett en API key i innstillinger
- kall modellisten
- velg én tilgjengelig modell
- send inn én genereringsjobb med en idempotency key
- poll status-endepunktet
- sjekk credits før og etter
- legg først deretter til Files API, Chat API eller Webhooks
Den stien gir deg en fungerende integrasjon uten å blande alle API-funksjoner inn i første test.
Når API-et er feil startpunkt
API-et er sannsynligvis ikke riktig første steg når:
- teamet ennå ikke har valgt en modellfamilie
- ønsket output fortsatt endrer seg for hver kjøring
- prompten avhenger av manuell smak og gjennomgang
- integrasjonen ville skjule credit-bruk for de som må forstå den
- produktet trenger en offentlig demo før det trenger automatisering
I slike tilfeller starter du fra Image, Video, Audio, Chat eller AI Models. Når stien er repeterbar, flytter du den stabile delen til API-et.
Hvor du går videre
- Åpne Developers for den offentlige API-huben og debuggeren.
- Les Rivya API Quickstart for å gjøre den første trygge forespørselen.
- Les API Authentication før du legger en key på en server.
- Les API Models før du velger modell-ID-er.
- Les Når du bør bruke Rivya API i stedet for Studio hvis produktgrensen fortsatt er uklar.
- Les Slik bygger du en multimodal AI-arbeidsflyt med Rivya API når du planlegger en full bilde-, video-, lyd- eller chatintegrasjon.
