Rivya API er udviklerkontrakten for at bruge understøttede Rivya-modelfunktioner fra dit eget produkt, script eller din egen arbejdsgang, når Public API-adgang er aktiveret for installationen og tilgængelig for din konto.
Det er ikke et separat produkt fra Rivya Studio. Det bruger den samme kontogrænse, den samme kreditsaldo og det samme offentlige modellag, som brugerne møder i Rivya. Forskellen er, hvordan arbejdet begynder: I stedet for at klikke sig gennem Studio sender din applikation anmodninger med en API-nøgle.
Hvis du har brug for endpointdetaljer, så start med Rivya API Overview og Rivya API Quickstart. Denne artikel er forklaringen på produktniveau: hvad API'et er til, hvor det passer ind, og hvornår det ikke bør være første vej.
Den korte version
Rivya API v1 giver en kvalificeret, indlogget konto mulighed for at oprette API-nøgler og kalde API-klare Rivya-modelfunktioner uden for webgrænsefladen. Udviklersiderne beskriver den implementerede kontrakt. Den aktive installation, kontotilladelserne og modellens klargøring afgør, om en anmodning kan køres.
Den implementerede API-flade omfatter:
modelfindning gennem API-modellisten
asynkrone genereringsjobs til billeder, video og lyd
upload via Fil-API-et til modeller, der har brug for referencemedier
regelmæssig hentning af genereringsstatus med offentlige opgave-ID'er
kontrol af kontocredits
Chat API-beskeder, inklusive valgfri SSE-streaming
signerede webhooks ved fuldførelse af generering, når webhooks er aktiveret for installationen
en TypeScript SDK-beta til teams, der vil have en klient-wrapper
Det offentlige udviklerhub er Developers. Det er det bedste indgangspunkt, hvis du vil have et guidet overblik, links til API-nøgleindstillinger og et sikkert debugger-flow.
Hvorfor Rivya har et API
Studio er nyttigt, når en person stadig vælger modeller, former instruktioner, gennemgår resultater og beslutter, hvad der skal ske bagefter.
API'et er nyttigt, når den beslutning er blevet til et gentageligt produkt- eller driftsworkflow.
Typiske eksempler, når API-adgang er aktiveret, er:
et produkt skal generere billedvarianter, efter at en bruger indsender en opgavebeskrivelse
et marketingworkflow skal skabe visuelle udkast fra strukturerede kampagneinputs
et internt værktøj skal indsende video- eller lydjobs uden at bede nogen om at åbne browseren
et support- eller indholdssystem vil have en chatmodelbesked inde i sin egen grænseflade
en tjeneste på serversiden skal modtage signerede tilbagekald, når genereringsopgaver er færdige
I de tilfælde holder Rivya API arbejdet knyttet til den samme Rivya-konto i stedet for at tvinge en separat stack til fakturering, modelvalg og opgavestatus.
Hvad API'et ikke erstatter
API'et erstatter ikke alle grunde til at bruge Rivya direkte.
Brug Studio eller de offentlige arbejdsflader når:
prompten stadig kræver menneskelig udforskning
modelvalget ikke er stabilt
en indholdsskaber skal sammenligne resultaterne visuelt
projektet afhænger af gemt historik og manuel gennemgang
teamet endnu ikke har besluttet, hvilket format for kildemateriale og resultat der skal kunne gentages
Brug API'et, når workflowet er klart nok til at automatisere.
Den grænse betyder noget. Et vagt kreativt spørgsmål hører som regel først hjemme i Studio. Et kendt produktforløb med forudsigeligt kildemateriale kan flyttes til API'et.
De vigtigste byggesten
Tænk på API'et som seks forbundne dele.
| Byggesten | Hvad den håndterer | Hvor du kan læse videre |
|---|---|---|
| API-nøgler | Adgang mellem servere fra din konto | API-godkendelse |
| Modeller | Offentlige model-ID'er og oplysninger om driftsklarhed | API-modeller |
| Genereringer | Asynkrone opgaver til billeder, video og lyd | Opret generering |
| Filer | Upload af referencebilleder, video eller lyd | Fil-API |
| Chat | Ikke-streamede eller streamede chatbeskeder | Chat API |
| Webhooks | Signerede fuldførelseshændelser for genereringsopgaver, når funktionen er aktiveret | API-webhooks |
API-dokumentationen er kilden til anmodnings- og svarformatet. Denne artikel hjælper dig med at afgøre, hvilken del du har brug for først.
Sådan fungerer kreditter
API-brug trækker fra den samme kreditsaldo på Rivya-kontoen som Studio.
Det betyder, at API-et ikke er en anonym modelmellemmand. En anmodning tilhører en Rivya-konto, bruger en API-nøgle oprettet af den konto og følger de samme kreditgrænser på produktniveau, som er beskrevet under API-kreditter.
Det er nyttigt for teams, fordi Studio-eksperimenter og API-brug bliver i én driftsmodel. Du kan teste en model manuelt og derefter flytte den gentagelige del ind i en integration uden at oprette et ekstra faktureringslag.
Hvordan filer passer ind
Nogle modeller kan køre kun fra tekst. Andre har brug for et referencebillede, en video eller en lydfil.
I API-integrationer bør disse referencer gå gennem Fil-API-et. Uploaden opretter en administreret filpost, som kan sendes med i understøttede modelparametre.
Den praktiske regel er enkel:
hvis en model kun accepterer tekstinput, så begynd med genereringsslutpunktet
hvis en model har brug for referencemedier, så upload filen først
hvis modellen er en chatmodel med billedvedhæftninger, så brug Chat API og file IDs
Design ikke din integration omkring uploadflows, der kun findes i browseren, eller gemte Studio-sessioner. API'et har sin egen offentlige filgrænse af en grund.
Hvor webhooks hjælper
Regelmæssige statusforespørgsler er den enkleste første integrationsvej. Indsend en genereringsopgave, gem det offentlige opgave-ID, og hent status, indtil opgaven lykkes eller fejler.
Når webhooks er aktiveret for installationen, bliver de nyttige, efterhånden som integrationen får mere produktionspræg:
du vil ikke have en baggrundsproces, der henter status for hver opgave
din app skal opdatere en post, når generationen er færdig
du vil have en signeret event, der kan prøves sikkert igen
mislykkede opgaver skal føres ind i en tydelig vej til genopretning
Brug API Webhooks til kontrakten for signerede hændelser. Bekræft, at funktionen er tilgængelig, før du bygger løsningen omkring den. Hold webhookmodtageren enkel: verificér signaturer, håndter dubletter, og undgå at skrive hemmelige værdier i logs.
Et godt første API-projekt
Det bedste første API-projekt er som regel lille og konkret.
For eksempel:
bekræft, at API-adgang er aktiveret for installationen og kontoen
opret en API-nøgle i indstillingerne
hent modellisten
vælg én API-klar model
indsend én genereringsopgave med en idempotency key
kontrollér statusendepunktet med jævne mellemrum
tjek kreditter før og efter
tilføj først derefter Fil-API-et, Chat API eller de webhooks, som installationen tilbyder
Den vej giver dig en fungerende integration uden at blande alle API-funktioner ind i den første test.
Når API'et er det forkerte udgangspunkt
API'et er sandsynligvis ikke det rigtige første skridt når:
teamet endnu ikke har valgt en modelfamilie
det ønskede resultat stadig ændrer sig ved hver kørsel
instruktionen afhænger af menneskelig smag og manuel gennemgang
integrationen ville skjule creditforbrug for de personer, der skal forstå det
produktet har brug for en offentlig demo, før det har brug for automatisering
I de tilfælde skal du begynde fra Billede, Video, Lyd, Chat eller AI-modeller. Når vejen er gentagelig, kan den stabile del flyttes til API-et.
Hvor du kan gå videre
Åbn Developers for det offentlige API-hub og debuggeren.
Læs Rivya API Quickstart for at lave den første sikre anmodning.
Læs API-godkendelse, før du lægger en nøgle på en server.
Læs API-modeller, før du vælger model-ID'er.
Læs Hvornår du bør bruge Rivya API i stedet for Studio, hvis produktgrænsen stadig er uklar.
Læs Sådan bygger du en multimodal AI-arbejdsgang med Rivya API, når du planlægger en fuld integration med billede, video, lyd eller chat.
