Pornire rapidă cu Rivya API

Acest ghid arată cea mai scurtă cale sigură de la configurarea contului la prima sarcină de generare prin Rivya API și primul mesaj prin Chat API.

Folosește valori demonstrative pentru chei în documentație și exemple. Nu introduce niciodată o cheie API reală în cod public, capturi de ecran, tichete de asistență sau documente partajate.

Exemplele descriu contractul API public v1 implementat. Înainte de testare, confirmă că accesul la API este activ în instanța curentă și disponibil pentru contul tău. Un punct de acces documentat sau o pagină de model nu demonstrează că cererea poate fi executată în orice mediu.

1. Creează o cheie API

Deschide setările pentru chei API, creează o cheie, copiază valoarea secretă completă atunci când este afișată și stocheaz-o numai în mediul de pe server.

Permisiuni recomandate pentru început:

• models:read

• generations:create

• generations:read

• files:create

• files:read

• credits:read

• webhooks:manage

• chat:create

• chat:read

2. Confirmă adresa URL de bază

Folosește adresa URL de bază a API-ului de producție:

https://rivya.ai

Adresele localhost sunt destinate exclusiv dezvoltării locale. Exemplele publice nu trebuie să conțină chei sau secrete locale.

3. Listează modelele

curl https://rivya.ai/api/v1/models

Folosește câmpul id din răspuns drept valoare model atunci când creezi o generare.

4. Trimite o sarcină de 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 editorială curată a produsului, pe un fundal discret de studio"
  }'

Răspunsul conține un ID public al sarcinii. Salvează-l pentru a putea verifica ulterior starea acesteia.

5. Verifică starea sarcinii

curl https://rivya.ai/api/v1/generations/task_public_id \
  -H "Authorization: Bearer rvya_sk_..."

Valorile posibile pentru stare sunt:

• queued

• processing

• succeeded

• failed

6. Verifică soldul de credite

curl https://rivya.ai/api/v1/credits \
  -H "Authorization: Bearer rvya_sk_..."

Folosește această comandă pentru a confirma soldul actual al contului înainte sau după testare.

7. Opțional: adaugă webhook-uri

Dacă accesul la webhook-uri este activ pentru instanță și cont, iar serverul poate primi apeluri HTTPS semnate, creează un punct de acces 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"]
  }'

Salvează valoarea signing_secret, afișată o singură dată în răspuns, și verifică fiecare livrare înainte de a procesa conținutul primit.

8. Opțional: trimite un mesaj prin Chat API

Pentru modelele de chat, apelează Chat API în 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": "claude-sonnet-5-chat",
    "message": "Scrie un plan concis de lansare pentru o nouă campanie de imagini de produs"
  }'

Folosește valoarea session_id returnată pentru a continua sesiunea creată prin API. Imaginile atașate trebuie să indice valori file_id din API-ul pentru fișiere.

Opțional: folosește versiunea beta a SDK-ului TypeScript

Integrările TypeScript de pe server pot folosi versiunea beta locală a SDK-ului:

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 editorială curată a produsului, pe un fundal discret de studio"
});

Citește SDK-ul TypeScript Rivya înainte de adoptare. Versiunea beta privată include streaming Chat procesat pe server.

Pagini următoare

• Autentificare API

• SDK-ul TypeScript Rivya

• Referința API pentru modele

• Creează o generare

• Chat API

• Webhook-uri API

• Erori și limite API