Rivya API Genel Bakış

Rivya API v1, kendi ürününüzden Rivya model yeteneklerini çağırmak için developer giriş noktasıdır.

Public API; asenkron görüntü, video ve ses generation yanında non-streaming veya SSE streaming response'larıyla Chat API turlarını destekler. Generation için Rivya model ID'leri, Rivya hesap kredileri ve public task ID'leri; Chat API için sunucu tarafı chat session'ları kullanılır.

API Ne İçin Kullanılır

Şunları yapmak istediğinizde API'yi kullanın:

• kendi app'inizden görüntü, video veya ses generation işleri göndermek
• non-streaming veya streaming chat turları göndermek ve API tarafından oluşturulan chat session'larına devam etmek
• faturalandırmayı aynı Rivya hesap kredi cüzdanı içinde tutmak
• public task ID ile task status poll etmek
• daha güvenli production request'leri için idempotent retry kullanmak
• Studio ve API kullanımını aynı hesap sınırı altında tutmak

API bir Rivya ürün katmanıdır. Public response'lar yalnızca Rivya adlarını ve public alanları kullanır.

Geçerli Versiyon Kapsamı

Geçerli v1 endpoint'leri:

• GET /api/v1/models
• POST /api/v1/generations
• POST /api/v1/files
• GET /api/v1/files/{fileId}
• POST /api/v1/chat/completions
• GET /api/v1/chat/sessions
• GET /api/v1/chat/sessions/{sessionId}
• GET /api/v1/generations/{taskId}
• GET /api/v1/credits
• GET /api/v1/webhooks
• POST /api/v1/webhooks
• GET /api/v1/webhook-events
• GET /api/v1/openapi.json

Geçerli versiyon; asenkron generation sonuçları için imzalı webhooks, Chat API ve sunucu tarafı streaming destekli TypeScript SDK beta içerir.

Kimlik Doğrulama

Generation, status ve kredi endpoint'leri şunu gerektirir:

Authorization: Bearer rvya_sk_...

API Keys ayarlarından anahtar oluşturun ve rotate edin. Production içinde anahtar kullanmadan önce API Kimlik Doğrulama sayfasını okuyun.

Faturalandırma Modeli

API çağrıları Studio ile aynı Rivya hesap kredilerini kullanır.

Generation işleri task başladığında kredi rezerve eder veya tüketir. Chat turları model çağrısından önce kredi rezerve eder ve assistant message kaydedildiğinde token usage üzerinden final kredileri mutabakata bağlar. Bir generation veya chat turu mevcut Rivya hata kuralları kapsamında başarısız olursa aynı iade işlemi uygulanır.

Kullanıcıya dönük cüzdan modeli için API Kredileri ve Rivya'da Krediler ve Faturalandırma sayfalarını okuyun.

İlk Entegrasyon Yolu

1. Settings içinde bir API anahtarı oluşturun.
2. Public model ID seçmek için API Modelleri sayfasını çağırın.
3. Model parametreleri için Model API Referansı sayfasını okuyun.
4. Model referans medya gerektiriyorsa Files API ile yükleyin.
5. Oluşturma İşi Başlatma ile bir iş gönderin.
6. Task başarılı veya başarısız olana kadar Oluşturma Durumu ile poll edin ya da imzalı completion event'leri için API Webhooks aboneliği kurun.
7. Chat modelleri için generation endpoint'i yerine Chat API kullanın. Chat görüntü ekleri Files API file_id değerlerine referans vermelidir.

İlgili Sayfalar

• API Hızlı Başlangıç
• API Kimlik Doğrulama
• Rivya TypeScript SDK
• Model API Referansı
• Chat API
• API Webhooks
• API Hataları ve Limitleri