Rivya API er udviklervejen til at bruge Rivyas modelkapaciteter fra dit eget produkt, script eller workflow.
Det er ikke et separat produkt fra Rivya Studio. Det bruger den samme kontogrænse, den samme credit-wallet og det samme offentlige modellag, som brugere ser på tværs af Rivya. Forskellen er, hvordan arbejdet starter: 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 lader en indlogget konto oprette API-nøgler og kalde Rivya-modelkapaciteter uden for webgrænsefladen.
Den aktuelle API-flade omfatter:
- modelfindning gennem API-modellisten
- asynkrone genereringsjobs til billeder, video og lyd
- Files API-uploads til modeller, der har brug for referencemedier
- polling af genereringsstatus med offentlige task IDs
- kontrol af kontocredits
- Chat API-beskeder, inklusive valgfri SSE-streaming
- signerede webhooks for færdig generation
- 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 prompts, gennemgår outputs og beslutter, hvad der skal ske bagefter.
API'et er nyttigt, når den beslutning er blevet til et gentageligt produkt- eller driftsworkflow.
Almindelige eksempler:
- et produkt vil generere billedvarianter, efter at en bruger indsender en brief
- 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 backendservice vil have signerede callbacks, når genereringsjobs 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 creator skal sammenligne outputs visuelt
- projektet afhænger af gemt historik og manuelt review
- teamet endnu ikke har besluttet, hvilket input- og outputformat der skal blive gentageligt
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 produktflow med forudsigelige inputs 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 keys | Server-to-server-adgang fra din konto | API Authentication |
| Models | Offentlige model-ID'er og readiness-oplysninger | API Models |
| Generations | Asynkrone jobs til billeder, video og lyd | Create Generation |
| Files | Uploads af referencebilleder, video eller lyd | Files API |
| Chat | Ikke-streamede eller streamede chatbeskeder | Chat API |
| Webhooks | Signerede completion events for genereringsjobs | API Webhooks |
API-dokumentationen er kilden til request- og responseform. Denne artikel skal hjælpe dig med at beslutte, hvilken del du har brug for først.
Sådan fungerer credits
API-brug trækker fra den samme Rivya-kontos credit-wallet som Studio.
Det betyder, at API'et ikke er en anonym modelproxy. En anmodning tilhører en Rivya-konto, bruger en API-nøgle oprettet af den konto og følger den samme produktgrænse for credits, som er beskrevet i API Credits.
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 Files API. Uploadet opretter en administreret filpost, som kan sendes ind i understøttede modelparametre.
Den praktiske regel er enkel:
- hvis en model accepterer kun tekst-input, så start med generation-endpointet
- 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
Polling er den nemmeste første integrationsvej. Indsend et genereringsjob, gem det offentlige task ID, og poll indtil det lykkes eller fejler.
Webhooks bliver nyttige, når integrationen ligner produktion mere:
- du vil ikke have en worker, der poller hvert job
- din app skal opdatere en post, når generationen er færdig
- du vil have en signeret event, der kan prøves sikkert igen
- fejlede jobs skal flyttes ind i en tydelig genopretningsvej
Brug API Webhooks til den signerede event-kontrakt. Hold webhook-modtageren snæver: verificer signaturer, håndter duplikerede events, og undgå at lægge 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:
- opret en API-nøgle i indstillinger
- kald modellisten
- vælg én tilgængelig model
- indsend ét genereringsjob med en idempotency key
- poll status-endpointet
- tjek credits før og efter
- tilføj først derefter Files API, Chat API eller Webhooks
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 output stadig ændrer sig ved hver kørsel
- prompten afhænger af manuel smag og review
- 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 starte fra Image, Video, Audio, Chat eller AI Models. 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 Authentication, før du lægger en nøgle på en server.
- Læs API Models, 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 et multimodalt AI-workflow med Rivya API, når du planlægger en fuld integration med billede, video, lyd eller chat.
