Pornire rapida Rivya API
Creeaza o cheie API, alege un model, trimite un job asincron de generare si trimite o tura Chat API cu streaming SSE optional.
Ultima revizuire la 2026/05/10
Acest quickstart arata cea mai scurta cale sigura de la configurarea contului la un job de generare Rivya API, plus prima tura Chat API.
Foloseste chei placeholder in documentatie si exemple. Nu lipi niciodata o cheie API reala in cod public, capturi de ecran, tickete sau documente partajate.
1. Creeaza o cheie API
Deschide setarile pentru chei API, creeaza o cheie, copiaza secretul complet o singura data si stocheaza-l in mediul tau server-side.
Scope-uri recomandate pentru inceput:
models:readgenerations:creategenerations:readfiles:createfiles:readcredits:readwebhooks:managechat:createchat:read
2. Confirma URL-ul de baza
Foloseste URL-ul de baza al API-ului de productie:
https://rivya.aiURL-urile localhost sunt doar pentru dezvoltare locala. Exemplele publice nu ar trebui sa foloseasca secrete locale.
3. Listeaza modelele
curl https://rivya.ai/api/v1/modelsFoloseste campul id din raspuns ca valoare model atunci cand creezi o generare.
4. Trimite o generare
curl https://rivya.ai/api/v1/generations \
-H "Authorization: Bearer rvya_sk_..." \
-H "Content-Type: application/json" \
-H "Idempotency-Key: quickstart-001" \
-d '{
"model": "z-image",
"prompt": "O imagine editoriala curata de produs pe un fundal moale de studio"
}'Raspunsul returneaza un ID public de sarcina. Stocheaza-l ca sa poti interoga statusul mai tarziu.
5. Interogheaza statusul
curl https://rivya.ai/api/v1/generations/task_public_id \
-H "Authorization: Bearer rvya_sk_..."Valorile de status sunt:
queuedprocessingsucceededfailed
6. Verifica creditele
curl https://rivya.ai/api/v1/credits \
-H "Authorization: Bearer rvya_sk_..."Foloseste aceasta comanda pentru a confirma soldul curent al contului inainte sau dupa testare.
7. Optional: adauga webhookuri
Daca serverul tau poate primi callbackuri HTTPS semnate, creeaza un endpoint webhook:
curl https://rivya.ai/api/v1/webhooks \
-H "Authorization: Bearer rvya_sk_..." \
-H "Content-Type: application/json" \
-d '{
"name": "Production webhook",
"url": "https://example.com/rivya/webhook",
"event_types": ["generation.succeeded", "generation.failed"]
}'Salveaza signing_secret afisat o singura data in raspuns si verifica fiecare livrare inainte sa ai incredere in payload.
8. Optional: trimite o tura Chat
Pentru modelele de chat, apeleaza Chat API in loc de POST /api/v1/generations:
curl https://rivya.ai/api/v1/chat/completions \
-H "Authorization: Bearer rvya_sk_..." \
-H "Content-Type: application/json" \
-H "Idempotency-Key: quickstart-chat-001" \
-d '{
"model": "gpt-5-2-chat",
"message": "Scrie un plan concis de lansare pentru o campanie noua de imagini de produs"
}'Foloseste session_id returnat pentru a continua sesiunea creata prin API. Atasamentele imagine trebuie sa faca referire la valori file_id din Files API.
Optional: foloseste beta-ul TypeScript SDK
Integrarile TypeScript server-side pot folosi beta-ul SDK local:
import { RivyaClient } from "@rivya/sdk";
const rivya = new RivyaClient({
apiKey: process.env.RIVYA_API_KEY
});
const generation = await rivya.generations.create({
model: "z-image",
prompt: "O imagine editoriala curata de produs pe un fundal moale de studio"
});Citeste Rivya TypeScript SDK inainte sa il adopti. SDK-ul include suport server-side pentru streaming Chat in beta-ul privat.
Paginile urmatoare
Contract OpenAPI si schema
Revizuieste sursele de schema Rivya API v1, regulile de compatibilitate, campurile publice si contractul JSON OpenAPI read-only.
Rivya TypeScript SDK
Foloseste beta-ul Rivya TypeScript SDK pentru a apela Public API v1 pentru modele, generari, fisiere, credite, webhookuri si Chat, inclusiv streaming SSE.