Rivya API-oversikt

Rivya API v1 er utviklerinngangen for å kalle Rivya-modellfunksjoner fra ditt eget produkt.

Det offentlige API-et støtter asynkron bilde-, video- og lydgenerering pluss Chat API-runder med ikke-streamende eller SSE-streamende responser. Det bruker Rivya-modell-ID-er, Rivya-kontocredits, offentlige task ID-er for generering og server-side chatøkter for Chat API.

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 inne i samme Rivya-kontolommebok for credits
• polle oppgavestatus etter offentlig task 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

Nåværende v1-endepunkter:

• 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 versjonen inkluderer signerte webhooks for asynkrone genereringsresultater, Chat API og en TypeScript SDK beta med server-side streaming-støtte.

Autentisering

Endepunkter for generering, status og credits krever:

Authorization: Bearer rvya_sk_...

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

Faktureringsmodell

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

Genereringsjobber reserverer eller bruker credits når oppgaven starter. Chatrunder reserverer credits før modellkallet og gjør opp endelige credits fra tokenbruk når assistentmeldingen lagres. Hvis en generering eller chatrunde feiler under Rivyas eksisterende feilregler, gjelder samme refusjonshåndtering.

Les API-credits og credits og fakturering i Rivya for den brukerrettede lommebokmodellen.

Første integrasjonsvei

1. Opprett en API-nøkkel i Settings.
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 Files API.
5. Send inn en jobb med opprett generering.
6. Poll genereringsstatus til oppgaven lykkes eller feiler, eller abonner på API-webhooks for signerte fullføringshendelser.
7. For chatmodeller bruker du Chat API i stedet for genereringsendepunktet. Chat-bildevedlegg må referere til Files API file_id-verdier.

Relaterte sider

• API-hurtigstart
• API-autentisering
• Rivya TypeScript SDK
• Modell-API-referanse
• Chat API
• API-webhooks
• API-feil og begrensninger