Rivya API

Rivya'nın çok modlu model katmanı üzerine geliştirin

Rivya API, ürün ekiplerine Rivya modellerini kendi uygulamalarından çağırmak için herkese açık ve hesap tabanlı bir yol sunar. Asenkron görsel, video ve ses işleriyle başlayın; model sohbet destekliyorsa isteğe bağlı SSE akışıyla Chat API turları ekleyin ve faturalandırmayı aynı Rivya kredi cüzdanı içinde tutun.
API dokümanlarını okuAPI anahtarı oluştur

Hızlı başlangıç biçimi

Model katmanı

Dinamik katalog

Faturalandırma

Paylaşılan krediler

İlk sürüm

İşler + Chat

Erişim

API anahtarları

YöntemPOST
Endpoint/api/v1/generations

Gerçek istek için Rivya API anahtarı ve kullanılabilir hesap kredileri gerekir. Herkese açık örnekler yer tutucu sırlar kullanır ve modelleri anonim olarak çağırmaz.

İstek
curl https://rivya.ai/api/v1/generations \
  -H "Authorization: Bearer rvya_sk_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: demo-job-001" \
  -d '{
    "model": "z-image",
    "prompt": "Editorial product photo on a clean studio set"
  }'
Yanıt
{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 20,
  "result": null,
  "error": null
}

İlk gelen özellikler

Rivya ürünüyle hizalı kalan herkese açık API katmanı

API, Rivya ürün yüzeyi olarak tasarlandı. Rivya model IDleri, Rivya kredileri, herkese açık görev durumları ve model kataloğuyla bağlı kalan dokümanları kullanır.

Görsel üretim API'si

Prompt ve desteklenen model parametreleriyle görsel işleri gönderin, ardından herkese açık sonuçlar için sorgulayın.

Video üretim API'si

Studio tarafından kullanılan aynı görev ve kredi kontrolleriyle asenkron video işleri çalıştırın.

Ses üretim API'si

API ile erişilebilen ses modellerini aynı hesap, bakiye ve geçmiş sınırı üzerinden kullanın.

Paylaşılan kredi cüzdanı

API çağrıları ve Studio kullanımı, ayrılmış krediler ve hata yönetimiyle aynı Rivya bakiyesinden harcar.

Başlangıç yolu

Hesaptan ilk API isteğine

01

Anahtar oluşturun

Oturum açın, Ayarlar içinde API Anahtarları'nı açın, kapsamlı bir anahtar oluşturun ve tam sırrı hemen saklayın.

02

Model seçin

Göndermeden önce model IDlerini, parametreleri, sohbet yeteneklerini ve giriş hazır olup olmadığını incelemek için API model referansını okuyun veya /api/v1/models çağırın.

03

Gönderin, sorgulayın veya abone olun

Idempotent bir üretim isteği gönderin, herkese açık görev endpointini sorgulayın, üretim callbackleri için imzalı webhooklar kullanın veya isteğe bağlı SSE akışıyla bir Chat API turu gönderin.

Sürüm sınırı

Net kapsam, gizli vaat yok

Landing page gelecekteki yüzeylerden söz edebilir, ancak mevcut ürün metni tamamlanmamış API'lerin zaten canlı olduğunu ima etmemelidir.

Chat API

Kullanılabilir

API tarafından oluşturulan oturumlar, hesap kredileri ve isteğe bağlı Files API görsel ekleriyle non-streaming ve SSE streaming turları için kullanılabilir.

Files API

Kullanılabilir

Referans görsel, video ve ses yüklemeleri için kullanılabilir. Bir model sayfası params.referenceMediaItems istediğinde üretimden önce bunu kullanın.

Kullanıcı webhookları

Kullanılabilir

Başarılı veya başarısız üretim görevleri için imzalı callback isteyen üretim entegrasyonlarında kullanılabilir.

Çevrimiçi hata ayıklayıcı

İsteği önizleyin, sonra kendi API anahtarınızla çalıştırın

Hata ayıklayıcı her ziyaretçi için mock modda başlar. Üretim seçici, dosya yüklemeden test edilebilen chat dışı modelleri listeler; Files paneli ise oturum açmış kullanıcıların geçici API anahtarıyla /api/v1/files test etmesini sağlar. Chat örnekleri API dokümanlarında yer alır.

Hesap durumu

Hesap kontrol ediliyor

Etkin anahtar prefixi

Önce bir anahtar oluşturun

Geçerli krediler

Kontrol etmek için oturum açın

Mock önizlemeCanlı Public APIEtkin API anahtarı yok

Mock mod hiçbir zaman model çağırmaz ve kredi tüketmez.

Anahtarı yalnızca bu istek için yapıştırın. Hata ayıklayıcı yenilemeden sonra bunu saklamaz.

Files API yükleme testi

POST /api/v1/files üzerinden referans medya yükleyin, sonra dönen URLyi ve süre tokenını referans girişleri destekleyen bir model için params.referenceMediaItems içine kopyalayın.

Mock hiçbir zaman yükleme yapmazCanlı mod /api/v1/files kullanır

Seçili model izin verilen MIME türlerini, boyutu ve süre kurallarını belirler. Canlı yüklemeler geçici API anahtarınızı gerektirir ve gerçek yükleme servisini çağırabilir.

API anahtarı oluşturAPI dokümanlarını oku
İstek önizlemesi
{
  "model": "z-image",
  "prompt": "Temiz bir stüdyo setinde editoryal ürün fotoğrafı",
  "params": {
    "aspect_ratio": "1:1"
  }
}
Yanıt
{
  "id": "mock_task_001",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "result": null,
  "error": null
}
Files API yanıtı
{
  "id": "file_mock_001",
  "object": "file",
  "kind": "image",
  "file_name": "reference.png",
  "mime_type": "image/png",
  "size_bytes": 245760,
  "url": "https://media.example/reference.png",
  "duration_seconds": null,
  "duration_token": null,
  "created_at": "2026-05-11T00:00:00.000Z",
  "expires_at": null
}
Üretim parametreleri
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

Görev durumu

Tahmini temel krediler

1

Durum

queued

API dokümantasyonu

Kimlik doğrulamayı, istek gövdelerini, yanıtları, idempotency davranışını, model parametrelerini ve hata kodlarını okuyun.

Dokümanları aç

API anahtarı yönetimi

Korunan Ayarlar alanından API anahtarları oluşturun, bir kez kopyalayın, iptal edin ve döndürün.

Anahtarları yönet

Çevrimiçi hata ayıklama

Önce mock örnekleri kullanın; gerçek hata ayıklama için oturum, API anahtarı ve hesap kredileri gerekir.

Akışı önizle