Rivya API gyorskezdés

Ez a gyorskezdés a legrövidebb biztonságos utat mutatja meg a fiókbeállítástól egy Rivya API generálási feladatig, valamint az első Chat API fordulóig.

A dokumentációban és a példákban helyőrző kulcsokat használj. Soha ne illessz valódi API-kulcsot nyilvános kódba, képernyőképbe, hibajegybe vagy megosztott dokumentumba.

A példák a megvalósított Public API v1 szerződést írják le. Tesztelés előtt ellenőrizd, hogy a Public API-hozzáférés engedélyezve van-e az adott telepítésben, és elérhető-e a fiókod számára. Egy dokumentált végpont vagy modelloldal önmagában nem bizonyítja, hogy a kérés minden környezetben fut.

1. API-kulcs létrehozása

Nyisd meg az API-kulcs beállításokat, hozz létre kulcsot, egyszer másold ki a teljes titkot, és tárold a szerveroldali környezetedben.

Elsőként ajánlott jogosultsági körök:

• models:read

• generations:create

• generations:read

• files:create

• files:read

• credits:read

• webhooks:manage

• chat:create

• chat:read

2. Alap URL megerősítése

Használd az éles API alap URL-t:

https://rivya.ai

A localhost URL-ek csak helyi fejlesztésre valók. Nyilvános példákban nem szabad helyi titkokat használni.

3. Modellek listázása

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

Generálás létrehozásakor a válasz id mezőjét használd model értékként.

4. Generálás beküldése

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": "A clean editorial product image on a soft studio background"
  }'

A válasz egy nyilvános feladatazonosítót ad vissza. Tárold el, hogy később le tudd kérdezni az állapotát.

5. Állapot lekérdezése

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

Az állapotértékek:

• queued

• processing

• succeeded

• failed

6. Kreditek ellenőrzése

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

Ezzel tesztelés előtt vagy után ellenőrizheted az aktuális fiókegyenleget.

7. Opcionális: webhookok hozzáadása

Ha a webhook-hozzáférés engedélyezett az adott telepítésben és a fiókod számára, a szervered pedig tud aláírt HTTPS-visszahívásokat fogadni, hozz létre webhook-végpontot:

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"]
  }'

Mentsd el a válaszból az egyszer megjelenő signing_secret értéket, és minden kézbesítést ellenőrizz, mielőtt megbíznál a kérés tartalmában.

8. Opcionális: Chat forduló küldése

Chatmodellekhez a POST /api/v1/generations helyett a Chat API-t hívd:

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": "Write a concise launch plan for a new product image campaign"
  }'

A visszakapott session_id értékkel folytathatod az API-val létrehozott munkamenetet. A képcsatolmányoknak Files API file_id értékekre kell hivatkozniuk.

Opcionális: TypeScript SDK beta használata

Szerveroldali TypeScript integrációk használhatják a helyi SDK betát:

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: "A clean editorial product image on a soft studio background"
});

Használatbavétel előtt olvasd el a Rivya TypeScript SDK oldalt. Az SDK a zárt bétában szerveroldali Chat-adatfolyamot is támogat.

Következő oldalak

• API-hitelesítés

• Rivya TypeScript SDK

• Modell API referencia

• Generálás létrehozása

• Chat API

• API webhookok

• API hibák és limitek