Utwórz klucz API, wybierz model, wyślij asynchroniczne zadanie generowania i prześlij turę Chat API z opcjonalnym streamingiem SSE.

Ten quickstart pokazuje najkrótszą bezpieczną ścieżkę od konfiguracji konta do jednego zadania generowania Rivya API, a także pierwszej tury Chat API.

W dokumentacji i przykładach używaj kluczy zastępczych. Nigdy nie wklejaj prawdziwego klucza API do publicznego kodu, zrzutów ekranu, zgłoszeń ani współdzielonych dokumentów.

1. Utwórz Klucz API

Otwórz ustawienia API Keys, utwórz klucz, skopiuj pełny sekret tylko raz i zapisz go w środowisku po stronie serwera.

Zalecane pierwsze zakresy:

models:read
generations:create
generations:read
files:create
files:read
credits:read
webhooks:manage
chat:create
chat:read

2. Potwierdź Bazowy URL

Używaj produkcyjnego bazowego URL API:

https://rivya.ai

Adresy localhost służą tylko do lokalnego developmentu. Publiczne przykłady nie powinny używać lokalnych sekretów.

3. Wyświetl Modele

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

Użyj pola id z odpowiedzi jako wartości model podczas tworzenia generowania.

4. Wyślij Generowanie

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

Odpowiedź zwraca publiczny ID zadania. Zapisz go, aby później odpytywać status.

5. Odpytaj Status

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

Wartości statusu to:

queued
processing
succeeded
failed

6. Sprawdź Kredyty

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

Użyj tego, aby potwierdzić bieżące saldo konta przed testowaniem albo po nim.

7. Opcjonalnie: Dodaj Webhooks

Jeśli Twój serwer może odbierać podpisane callbacki HTTPS, utwórz endpoint webhooka:

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

Zapisz jednorazowy signing_secret z odpowiedzi i weryfikuj każdą dostawę, zanim zaufasz payloadowi.

8. Opcjonalnie: Wyślij Turę Chat

Dla modeli czatu wywołaj Chat API zamiast 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": "Write a concise launch plan for a new product image campaign"
  }'

Użyj zwróconego session_id, aby kontynuować sesję utworzoną przez API. Załączniki obrazów muszą odwoływać się do wartości file_id z Files API.

Opcjonalnie: Użyj Bety TypeScript SDK

Integracje TypeScript po stronie serwera mogą używać lokalnej bety SDK:

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"
});

Przed wdrożeniem przeczytaj Rivya TypeScript SDK. SDK zawiera obsługę streamingu Chat po stronie serwera w prywatnej becie.

Szybki start Rivya API