Rivya API Genel Bakış

Rivya API v1, Public API erişimi dağıtım için etkin ve hesabınız için kullanılabilir olduğunda ürününüzden desteklenen Rivya model yeteneklerini çağırmaya yönelik geliştirici sözleşmesidir.

Uygulanmış sözleşme asenkron görsel, video ve ses üretimi ile non-akışlı veya SSE yanıtlı Chat API turlarını kapsar. Rivya model kimliklerini, hesap kredilerini, genel görev kimliklerini ve sunucu tarafı sohbet oturumlarını kullanır. Belgelenmiş rota her ortam, hesap veya modelin çağırabileceği anlamına gelmez; entegrasyondan önce canlı erişimi ve model hazırlığını doğrulayın.

API Ne İçin Kullanılır

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

• kendi app'inizden görüntü, video veya ses üretim işleri göndermek

• non-akışlı veya akışlı sohbet turları göndermek ve API tarafından oluşturulan sohbet session'larına devam etmek

• faturalandırmayı aynı Rivya hesap kredi cüzdanı içinde tutmak

• herkese açık görev ID ile görev durum sorgulamak etmek

• daha güvenli üretim istek'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 yanıt'lar yalnızca Rivya adlarını ve herkese açık alanları kullanır.

Geçerli Versiyon Kapsamı

Uygulanmış v1 uç noktaları şunları içerir:

• 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

Güncel sözleşme asenkron sonuçlar için imzalı webhook'ları, Chat API'yi ve sunucu tarafı akışlı destekli TypeScript SDK beta sürümünü içerir. Webhook çağrıları, webhook özelliği ile Public API'nin dağıtımda etkin olmasını gerektirir.

Kimlik Doğrulama

Üretim, durum ve kredi uç noktaları şunu gerektirir:

Authorization: Bearer rvya_sk_...

API Keys ayarlarından anahtar oluşturun ve rotate edin. Üretim 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.

Üretim işleri görev başladığında kredi rezerve eder veya tüketir. Chat turları model çağrısından önce kredi rezerve eder ve asistan mesaj kaydedildiğinde token usage üzerinden nihai kredileri mutabakata bağlar. Bir üretim veya sohbet 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 Dosyalar API ile yükleyin.

5. Oluşturma İşi Başlatma ile bir iş gönderin.

6. Görev başarılı veya başarısız olana kadar Üretim Status uç nokta'ini sorgulayın. Webhook'lar dağıtım ve hesap için etkinse API Webhooks üzerinden imzalı tamamlanma olaylarına abone olabilirsiniz.

7. Chat modelleri için üretim uç nokta'i yerine Chat API kullanın. Chat görüntü ekleri Dosyalar 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