Rivya API Hızlı Başlangıç
Bir API anahtarı oluşturun, model seçin, asenkron oluşturma işi gönderin ve isteğe bağlı SSE streaming ile bir Chat API turu gönderin.
Son inceleme 2026/05/10
Bu hızlı başlangıç, hesap kurulumundan bir Rivya API oluşturma işine giden en kısa güvenli yolu ve ilk Chat API turunu gösterir.
Dokümanlarda ve örneklerde placeholder anahtarlar kullanın. Gerçek API anahtarını public koda, ekran görüntülerine, destek kayıtlarına veya paylaşılan dokümanlara asla yapıştırmayın.
1. API Anahtarı Oluşturma
API Keys ayarlarını açın, bir anahtar oluşturun, tam secret değerini bir kez kopyalayın ve sunucu tarafı ortamınızda saklayın.
Önerilen ilk scope'lar:
models:readgenerations:creategenerations:readfiles:createfiles:readcredits:readwebhooks:managechat:createchat:read
2. Base URL'yi Doğrulama
Production API base URL'sini kullanın:
https://rivya.aiLocalhost URL'leri yalnızca yerel geliştirme içindir. Public örnekler local secret kullanmamalıdır.
3. Modelleri Listeleme
curl https://rivya.ai/api/v1/modelsBir oluşturma işi başlatırken response içindeki id alanını model değeri olarak kullanın.
4. Oluşturma İşi Gönderme
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"
}'Yanıt public task ID döndürür. Daha sonra durumu poll etmek için bunu saklayın.
5. Durumu Poll Etme
curl https://rivya.ai/api/v1/generations/task_public_id \
-H "Authorization: Bearer rvya_sk_..."Durum değerleri:
queuedprocessingsucceededfailed
6. Kredileri Kontrol Etme
curl https://rivya.ai/api/v1/credits \
-H "Authorization: Bearer rvya_sk_..."Testten önce veya sonra güncel hesap bakiyesini doğrulamak için bunu kullanın.
7. İsteğe Bağlı: Webhooks Ekleme
Sunucunuz imzalı HTTPS callback'leri alabiliyorsa bir webhook endpoint oluşturun:
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"]
}'Yanıt içindeki tek seferlik signing_secret değerini saklayın ve payload'a güvenmeden önce her teslimatı doğrulayın.
8. İsteğe Bağlı: Chat Turu Gönderme
Chat modelleri için POST /api/v1/generations yerine Chat API çağırın:
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"
}'API tarafından oluşturulan oturuma devam etmek için dönen session_id değerini kullanın. Görüntü ekleri Files API file_id değerlerine referans vermelidir.
İsteğe Bağlı: TypeScript SDK Beta Kullanma
Sunucu tarafı TypeScript entegrasyonları local SDK beta'yı kullanabilir:
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"
});Benimsemeden önce Rivya TypeScript SDK sayfasını okuyun. SDK, private beta içinde sunucu tarafı Chat streaming desteği içerir.
Sonraki Sayfalar
OpenAPI ve Şema Sözleşmesi
Rivya API v1 şema kaynaklarını, uyumluluk kurallarını, public alanları ve salt okunur OpenAPI JSON sözleşmesini inceleyin.
Rivya TypeScript SDK
SSE streaming dahil Chat, modeller, generation işleri, dosyalar, krediler ve webhook'lar için Public API v1 çağrılarında Rivya TypeScript SDK beta'yı kullanın.