Rivya API

Rivya のマルチモーダルモデル層の上に構築する

Rivya API は、プロダクトチームが自分たちのアプリから Rivya モデルを呼び出すための、公開されたアカウントベースの方法を提供します。非同期の画像、動画、音声ジョブから始め、モデルが chat 対応の場合は必要に応じて SSE streaming 付き Chat API ターンを追加し、請求は同じ Rivya クレジットウォレット内に保てます。
API ドキュメントを読むAPI キーを作成

Quickstart 形式

モデル層

動的カタログ

請求

共有クレジット

初回バージョン

ジョブ + Chat

アクセス

API キー

メソッドPOST
エンドポイント/api/v1/generations

実際のリクエストには Rivya API キーと利用可能なアカウントクレジットが必要です。公開例ではプレースホルダーのシークレットを使い、匿名でモデルを呼び出すことはありません。

リクエスト
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"
  }'
レスポンス
{
  "id": "task_public_id",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 20,
  "result": null,
  "error": null
}

最初に提供されるもの

Rivya 製品と整合した公開 API 層

この API は Rivya の製品面として設計されています。Rivya モデル ID、Rivya クレジット、公開タスク状態、モデルカタログとつながったドキュメントを使用します。

画像生成 API

プロンプトと対応モデルパラメータで画像ジョブを送信し、公開結果をポーリングします。

動画生成 API

Studio と同じタスク管理とクレジット制御を使って、非同期動画ジョブを実行します。

音声生成 API

同じアカウント、残高、履歴境界の中で API 対応の音声モデルを使用します。

共有クレジットウォレット

API 呼び出しと Studio の利用は同じ Rivya 残高から差し引かれ、予約クレジットと失敗時の処理に対応します。

開始経路

アカウントから最初の API リクエストまで

01

キーを作成

サインインして Settings の API Keys を開き、scope 付きキーを作成して、完全なシークレットをすぐに保存します。

02

モデルを選ぶ

API モデルリファレンスを読むか /api/v1/models を呼び出して、送信前にモデル ID、パラメータ、chat capability、入力 readiness を確認します。

03

送信、ポーリング、または購読

冪等な生成リクエストを送信し、公開タスクエンドポイントをポーリングし、生成コールバックには署名付き webhooks を使うか、必要に応じて SSE streaming 付き Chat API ターンを送信します。

バージョン境界

明確な範囲、隠れた約束なし

ランディングページで将来の面に触れることはできますが、現在の製品コピーで未完成の API がすでに live であるかのように示してはいけません。

Chat API

利用可能

API 作成セッション、アカウントクレジット、必要に応じた Files API 画像添付を使った、非 streaming と SSE streaming ターンに対応しています。

Files API

利用可能

参照画像、動画、音声のアップロードに対応しています。モデルページで params.referenceMediaItems が必要な場合は、生成前に使用してください。

ユーザー webhooks

利用可能

生成タスクの成功または失敗に対する署名付きコールバックを必要とする本番連携で利用できます。

オンラインデバッガー

リクエストをプレビューし、自分の API キーで実行する

デバッガーはすべての訪問者に対して mock モードで開始します。生成セレクターにはファイルアップロードなしでテストできる非 chat モデルが表示され、Files パネルではサインイン済みユーザーが一時 API キーで /api/v1/files をテストできます。Chat の例は API ドキュメントにあります。

アカウント状態

アカウントを確認中

有効キーのプレフィックス

先にキーを作成してください

現在のクレジット

サインインして確認

Mock プレビューLive Public API有効な API キーなし

Mock モードではモデルを呼び出さず、クレジットも消費しません。

このリクエストのためだけにキーを貼り付けてください。デバッガーは更新後に保存しません。

Files API アップロードテスト

POST /api/v1/files で参照メディアをアップロードし、返された URL と duration token を、参照入力対応モデルの params.referenceMediaItems にコピーします。

Mock はアップロードしませんLive は /api/v1/files を使用します

選択したモデルによって許可される MIME type、サイズ、duration ルールが決まります。Live アップロードには一時 API キーが必要で、実際のアップロードサービスを呼び出す可能性があります。

API キーを作成API ドキュメントを読む
リクエストプレビュー
{
  "model": "z-image",
  "prompt": "クリーンなスタジオセットで撮影したエディトリアル調の商品写真",
  "params": {
    "aspect_ratio": "1:1"
  }
}
レスポンス
{
  "id": "mock_task_001",
  "status": "queued",
  "model": "z-image",
  "reserved_credits": 1,
  "final_credits": 0,
  "result": null,
  "error": null
}
Files API レスポンス
{
  "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
}
生成パラメータ
{
  "params": {
    "referenceMediaItems": [
      {
        "url": "https://media.example/reference.png",
        "kind": "image",
        "name": "reference.png",
        "mimeType": "image/png"
      }
    ]
  }
}

タスク状態

推定基本クレジット

1

状態

queued

API ドキュメント

認証、リクエスト body、レスポンス、冪等性、モデルパラメータ、エラーコードを確認できます。

ドキュメントを開く

API キー管理

保護された Settings エリアから API キーを作成し、一度だけコピーし、失効またはローテーションできます。

キーを管理

オンラインデバッグ

まず mock 例を使ってください。実際のデバッグにはログイン、API キー、アカウントクレジットが必要です。

フローをプレビュー