Rivya API-overblik

Rivya API v1 er udviklerkontrakten for at kalde understøttede Rivya-modelfunktioner fra dit eget produkt, når Public API-adgang er aktiveret for installationen og tilgængelig for din konto.

Den implementerede kontrakt dækker asynkron generering af billeder, video og lyd samt Chat API-kald med svar uden streaming eller med SSE-streaming. Den bruger Rivya-model-id'er, Rivya-kontocredits, offentlige opgave-id'er til generering og chatsessioner på serversiden til Chat API. En dokumenteret rute er ikke et løfte om, at alle miljøer, konti eller katalogmodeller kan kalde den. Bekræft aktiv adgang og modellens klargøring før integration.

Hvad API'en er til

Brug API'en, når du vil:

• indsende billed-, video- eller audiogenereringsjobs fra din egen app

• sende chatbeskeder med eller uden streaming og fortsætte API-oprettede chatsessioner

• holde faktureringen på den samme kreditsaldo på Rivya-kontoen

• hente opgavestatus med et offentligt opgave-ID

• bruge idempotente gentagne forsøg til sikrere produktionsanmodninger

• holde Studio- og API-brug inden for samme kontogrænse

API'en er et Rivya-produktlag. Offentlige svar bruger kun Rivya-navne og offentlige felter.

Aktuelt versionsomfang

Implementerede v1-endpoints 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 aktuelle kontrakt omfatter signerede webhooks til asynkrone genereringsresultater, Chat API og en TypeScript SDK-beta med understøttelse af streaming på serversiden. Webhook-kald kræver, at webhookfunktionen og Public API-adgang er aktiveret for installationen.

Godkendelse

Endepunkter til generering, status og kreditter kræver:

Authorization: Bearer rvya_sk_...

Opret og rotér nøgler under indstillingerne for API-nøgler. Læs API-godkendelse, før du bruger en nøgle i produktion.

Faktureringsmodel

API-kald bruger de samme kreditter på Rivya-kontoen som Studio.

Genereringsopgaver reserverer eller bruger kreditter, når opgaven starter. Chatbeskeder reserverer kreditter før modelkaldet og afregner de endelige kreditter ud fra tokenforbruget, når assistentbeskeden gemmes. Hvis en generering eller chatbesked fejler efter Rivyas eksisterende fejlregler, gælder den samme refusionshåndtering.

Læs API-kreditter og Kreditter og fakturering i Rivya for den kreditmodel, brugeren møder.

Første integrationssti

1. Opret en API-nøgle under Indstillinger.

2. Kald List API-modeller for at vælge et offentligt model-ID.

3. Læs API-reference for modeller for modellens parametre.

4. Hvis modellen kræver referencemedier, skal du uploade dem med Fil-API-et.

5. Indsend en opgave med Opret generering.

6. Kontrollér genereringsstatus med jævne mellemrum, indtil opgaven lykkes eller mislykkes. Hvis webhooks er aktiveret for installationen og kontoen, kan du i stedet abonnere via API-webhooks på signerede fuldførelseshændelser.

7. For chatmodeller skal du bruge Chat API i stedet for genereringsslutpunktet. Billedvedhæftninger i chat skal referere til file_id-værdier fra Fil-API-et.

Relaterede sider

• API quickstart

• API-godkendelse

• Rivya TypeScript SDK

• API-reference for modeller

• Chat API

• API Webhooks

• API-fejl og grænser