Prezentare generala Rivya API

Rivya API v1 este punctul de intrare pentru dezvoltatori atunci cand vrei sa apelezi capabilitatile modelelor Rivya din propriul produs.

API-ul public accepta generare asincrona de imagini, video si audio, plus ture Chat API cu raspunsuri non-streaming sau streaming SSE. Foloseste ID-uri de modele Rivya, credite din contul Rivya, ID-uri publice de task pentru generare si sesiuni de chat server-side pentru Chat API.

La ce foloseste API-ul

Foloseste API-ul cand vrei sa:

• trimiti joburi de generare de imagini, video sau audio din propria aplicatie
• trimiti ture de chat non-streaming sau streaming si sa continui sesiuni de chat create prin API
• pastrezi facturarea in acelasi portofel de credite al contului Rivya
• interoghezi statusul taskului dupa ID-ul public al taskului
• folosesti reincercari idempotente pentru cereri de productie mai sigure
• pastrezi utilizarea Studio si API in aceeasi limita de cont

API-ul este un strat de produs Rivya. Raspunsurile publice folosesc doar nume Rivya si campuri publice.

Domeniul versiunii curente

Endpointurile v1 curente:

• 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

Versiunea curenta include webhookuri semnate pentru rezultatele generarilor asincrone, Chat API si un beta TypeScript SDK cu suport de streaming server-side.

Autentificare

Endpointurile pentru generare, status si credite necesita:

Authorization: Bearer rvya_sk_...

Creeaza si roteste cheile din setarile API Keys. Citeste Autentificare API inainte sa folosesti o cheie in productie.

Model de facturare

Apelurile API folosesc aceleasi credite de cont Rivya ca Studio.

Joburile de generare rezerva sau consuma credite cand taskul porneste. Turele de chat rezerva credite inainte de apelul modelului si deconteaza creditele finale din utilizarea tokenilor atunci cand mesajul asistentului este salvat. Daca o generare sau o tura de chat esueaza conform regulilor existente Rivya pentru esecuri, se aplica aceeasi gestionare a rambursarii.

Citeste Credite API si Credite si facturare in Rivya pentru modelul portofelului vizibil utilizatorului.

Prima cale de integrare

1. Creeaza o cheie API in Settings.
2. Apeleaza Listarea modelelor API ca sa alegi un ID public de model.
3. Citeste Referinta API pentru model pentru parametrii modelului.
4. Daca modelul are nevoie de media de referinta, incarc-o cu Files API.
5. Trimite un job cu Creare generare.
6. Interogheaza Statusul generarii pana cand taskul reuseste sau esueaza, ori aboneaza-te la API Webhooks pentru evenimente de finalizare semnate.
7. Pentru modele de chat, foloseste Chat API in locul endpointului de generare. Atasamentele imagine pentru chat trebuie sa faca referire la valori Files API file_id.

Pagini asociate

• Quickstart API
• Autentificare API
• Rivya TypeScript SDK
• Referinta API pentru model
• Chat API
• API Webhooks
• Erori si limite API