Rivya API-oversikt

Rivya API v1 er utviklerkontrakten for å kalle støttede Rivya-modellfunksjoner fra ditt eget produkt når Public API-tilgang er aktivert for distribusjonen og tilgjengelig for kontoen.

Den implementerte kontrakten dekker asynkron generering av bilder, video og lyd samt Chat API-kall med svar uten strømming eller med SSE-strømming. Den bruker Rivya-modell-ID-er, Rivya-kontocredits, offentlige oppgave-ID-er for generering og chatøkter på serversiden for Chat API. En dokumentert rute er ikke et løfte om at alle miljøer, kontoer eller katalogmodeller kan kalle den. Bekreft aktiv tilgang og modellens klargjøring før integrasjon.

Hva API-et er til

Bruk API-et når du vil:

• sende inn bilde-, video- eller lydgenereringsjobber fra din egen app

• sende ikke-streamende eller streamende chatrunder og fortsette API-opprettede chatøkter

• holde fakturering innenfor samme kredittsaldo på Rivya-kontoen

• spørre etter oppgavestatus med en offentlig oppgave-ID

• bruke idempotente retries for tryggere produksjonsforespørsler

• holde Studio- og API-bruk innenfor samme kontogrense

API-et er et Rivya-produktlag. Offentlige responser bruker bare Rivya-navn og offentlige felt.

Nåværende versjonsomfang

Implementerte v1-endepunkter omfatter:

• 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

Den nåværende kontrakten omfatter signerte webhooks for asynkrone genereringsresultater, Chat API og en TypeScript SDK-beta med støtte for strømming på serversiden. Webhook-kall krever at webhookfunksjonen og Public API-tilgang er aktivert for distribusjonen.

Autentisering

Endepunkter for generering, status og kreditter krever:

Authorization: Bearer rvya_sk_...

Opprett og roter nøkler fra innstillingene for API-nøkler. Les API-autentisering før du bruker en nøkkel i produksjon.

Faktureringsmodell

API-kall bruker de samme Rivya-kontocredits som Studio.

Genereringsoppgaver reserverer eller bruker kreditter når oppgaven starter. Chatrunder reserverer kreditter før modellkallet og gjør opp de endelige kredittene ut fra tokenbruken når assistentmeldingen lagres. Hvis en generering eller chatrunde feiler under Rivyas eksisterende feilregler, gjelder samme refusjonshåndtering.

Les API-kreditter og kreditter og fakturering i Rivya for den brukerrettede kredittmodellen.

Første integrasjonsvei

1. Opprett en API-nøkkel i Innstillinger.

2. Kall list opp API-modeller for å velge en offentlig modell-ID.

3. Les modell-API-referanse for modellens parametere.

4. Hvis modellen trenger referansemedier, last dem opp med Fil-API-et.

5. Send inn en jobb med opprett generering.

6. Kontroller genereringsstatus med jevne mellomrom til oppgaven lykkes eller mislykkes. Hvis webhooks er aktivert for distribusjonen og kontoen, kan du i stedet abonnere via API-webhooks på signerte fullføringshendelser.

7. For chatmodeller bruker du Chat API i stedet for genereringsendepunktet. Bildevedlegg i chat må referere til file_id-verdier fra Fil-API-et.

Relaterte sider

• API-hurtigstart

• API-autentisering

• Rivya TypeScript SDK

• Modell-API-referanse

• Chat API

• API-webhooks

• API-feil og begrensninger