Rivya API Hızlı Başlangıç

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 yer tutucu anahtarlar kullanın. Gerçek API anahtarını herkese açık koda, ekran görüntülerine, destek kayıtlarına veya paylaşılan dokümanlara asla yapıştırmayın.

Örnekler uygulanmış Public API v1 sözleşmesini açıklar. Testten önce Public API erişiminin dağıtım için etkin ve hesabınız için kullanılabilir olduğunu doğrulayın. Belgelenmiş uç nokta veya model sayfası, isteğin her ortamda çalışacağını tek başına kanıtlamaz.

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 kapsam'lar:

• models:read

• generations:create

• generations:read

• files:create

• files:read

• credits:read

• webhooks:manage

• chat:create

• chat:read

2. Base URL'yi Doğrulama

Üretim API temel URL'sini kullanın:

https://rivya.ai

Localhost 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/models

Bir oluşturma işi başlatırken yanıt 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 herkese açık görev ID döndürür. Daha sonra durumu sorgulamak 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:

• queued

• processing

• succeeded

• failed

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

Webhook erişimi dağıtım ve hesap için etkinse ve sunucunuz imzalı HTTPS callback'leri alabiliyorsa bir webhook uç nokta'i 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": "claude-sonnet-5-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 Dosyalar 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, özel beta içinde sunucu tarafı Chat akışlı desteği içerir.

Sonraki Sayfalar

• API Kimlik Doğrulama

• Rivya TypeScript SDK

• Model API Referansı

• Oluşturma İşi Başlatma

• Chat API

• API Webhooks

• API Hataları ve Limitleri