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

Ten szybki start pokazuje najkrótszą bezpieczną ścieżkę od konfiguracji konta do jednego zadania generowania i 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.

Przykłady opisują wdrożony kontrakt Public API v1. Przed testem potwierdź, że dostęp do Public API jest włączony we wdrożeniu i dostępny dla konta. Udokumentowany punkt końcowy lub strona modelu nie dowodzą, że żądanie zadziała w każdym środowisku.

1. Utwórz Klucz API

Otwórz ustawienia kluczy API, utwórz klucz, skopiuj pełną wartość tajną tylko raz i zapisz ją w środowisku po stronie serwera.

Zalecane pierwsze zakresy:

models:read
generations:create
generations:read
files:create
files:read
credits:read Jeśli dostęp do webhooków jest włączony dla wdrożenia i konta, a serwer może odbierać podpisane wywołania HTTPS, utwórz punkt końcowy webhooka:
chat:create
chat:read

2. Potwierdź bazowy adres URL

Używaj produkcyjnego bazowego URL API:

https://rivya.ai

Adresy localhost służą tylko do lokalnego tworzenia i testowania aplikacji. 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": "Czyste, redakcyjne zdjęcie produktu na miękkim tle studyjnym"
  }'

Odpowiedź zwraca publiczny identyfikator 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ź punkty

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 wywołania zwrotne HTTPS, utwórz punkt końcowy 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żde zdarzenie, zanim zaufasz jego treści.

8. Opcjonalnie: wyślij turę czatu

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": "claude-sonnet-5-chat",
    "message": "Napisz zwięzły plan uruchomienia nowej kampanii obrazów produktowych"
  }'

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: "Czyste, redakcyjne zdjęcie produktu na miękkim tle studyjnym"
});

Przed wdrożeniem przeczytaj Rivya TypeScript SDK. Prywatna wersja beta SDK obsługuje strumień czatu po stronie serwera.

Szybki start Rivya API