Rivya API-overblik

Rivya API v1 er udviklerindgangen til at kalde Rivyas modelkapaciteter fra dit eget produkt.

Den offentlige API understøtter asynkron billed-, video- og audiogenerering plus Chat API-turns med ikke-streaming- eller SSE-streaming-svar. Den bruger Rivya-model-ID'er, Rivya-konto-credits, offentlige task-ID'er til generation og server-side chat-sessioner til Chat API.

Hvad API'en er til

Brug API'en, når du vil:

• indsende billed-, video- eller audiogenereringsjobs fra din egen app
• sende ikke-streaming eller streaming chat-turns og fortsætte API-oprettede chat-sessioner
• holde fakturering i den samme Rivya account credit wallet
• polle task-status efter offentligt task-ID
• bruge idempotente retries til sikrere production-anmodninger
• 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

Aktuelle v1-endpoints:

• 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 version inkluderer signerede webhooks for asynkrone genereringsresultater, Chat API og en TypeScript SDK beta med server-side streaming-support.

Godkendelse

Generation-, status- og credit-endpoints kræver:

Authorization: Bearer rvya_sk_...

Opret og rotér nøgler fra API Keys-indstillinger. Læs API-godkendelse, før du bruger en nøgle i production.

Faktureringsmodel

API-kald bruger de samme Rivya-konto-credits som Studio.

Genereringsjobs reserverer eller forbruger credits, når opgaven starter. Chat-turns reserverer credits før modelkaldet og afregner endelige credits ud fra tokenforbrug, når assistant-beskeden gemmes. Hvis en generation eller chat-turn fejler under Rivyas eksisterende fejlregler, gælder samme refusionshåndtering.

Læs API Credits og Credits og fakturering i Rivya for den brugerrettede wallet-model.

Første integrationssti

1. Opret en API-nøgle i Settings.
2. Kald List API-modeller for at vælge et offentligt model-ID.
3. Læs Model API Reference for modellens parametre.
4. Hvis modellen kræver referencemedier, skal du uploade dem med Files API.
5. Indsend et job med Opret generation.
6. Poll Genereringsstatus, indtil opgaven lykkes eller fejler, eller abonner på API Webhooks for signerede completion-events.
7. For chatmodeller skal du bruge Chat API i stedet for generation-endpointet. Chat-billedvedhæftninger skal referere til Files API file_id-værdier.

Relaterede sider

• API quickstart
• API-godkendelse
• Rivya TypeScript SDK
• Model API Reference
• Chat API
• API Webhooks
• API-fejl og grænser