Rivya API 概要
API キー、アカウントクレジット、任意の SSE ストリーミングを使い、Rivya API v1 から自分の製品で Rivya の生成モデルとチャットモデルを呼び出します。
2026年8月29日 最終レビュー
デプロイで Public API が有効になっており、アカウントに利用権限がある場合、Rivya API v1 は自社製品から Rivya の対応済みモデル機能を呼び出すための開発者向け契約です。
実装済みの契約は、画像・動画・音声の非同期生成と、非ストリーミングまたは SSE ストリーミング応答に対応する Chat API ターンを対象とします。Rivya のモデル ID とアカウントクレジットを使用し、生成では公開タスク ID、Chat API ではサーバー側チャットセッションを扱います。ルートが文書化されていても、すべての環境、アカウント、カタログモデルで使えるとは限りません。統合前に現在のアクセス権とモデルの提供状況を確認してください。
API の用途
次のことを行いたい場合に API を使います。
自分のアプリから画像、動画、音声生成ジョブを送信する
非ストリーミングまたはストリーミングのチャットターンを送信し、API 作成チャットセッションを続行する
同じ Rivya アカウントのクレジットウォレット内で請求を管理する
公開タスク ID でタスクステータスをポーリングする
冪等なリトライを使って本番リクエストをより安全にする
Studio と API の利用を同じアカウント境界に保つ
API は Rivya の製品レイヤーです。公開応答は Rivya 名称と公開フィールドのみを使います。
現在のバージョン範囲
実装済みの v1 エンドポイントは次のとおりです。
GET /api/v1/modelsPOST /api/v1/generationsPOST /api/v1/filesGET /api/v1/files/{fileId}POST /api/v1/chat/completionsGET /api/v1/chat/sessionsGET /api/v1/chat/sessions/{sessionId}GET /api/v1/generations/{taskId}GET /api/v1/creditsGET /api/v1/webhooksPOST /api/v1/webhooksGET /api/v1/webhook-eventsGET /api/v1/openapi.json
現在の契約には、非同期生成結果向けの署名付き webhook、Chat API、サーバー側ストリーミング対応の TypeScript SDK beta が含まれます。Webhook エンドポイントを呼び出すには、デプロイで webhook 機能と Public API アクセスの両方が有効になっている必要があります。
認証
生成、ステータス、クレジットのエンドポイントには次が必要です。
Authorization: Bearer rvya_sk_...API キー設定 でキーを作成、ローテーションしてください。本番でキーを使う前に API 認証 を読んでください。
請求モデル
API 呼び出しは Studio と同じ Rivya アカウントクレジットを使います。
生成ジョブは、タスク開始時にクレジットを予約または消費します。Chat ターンはモデル呼び出し前にクレジットを予約し、assistant メッセージが保存されたときに token 使用量から最終クレジットを精算します。生成または Chat ターンが既存の Rivya 失敗ルールに従って失敗した場合は、同じ返還処理が適用されます。
ユーザー向けウォレットモデルについては、API クレジット と Rivya のクレジットと請求 を読んでください。
最初の統合パス
設定 で API キーを作成します。
API モデル一覧 を呼び出して公開モデル ID を選びます。
モデル API リファレンス でモデルのパラメータを確認します。
モデルが参照メディアを必要とする場合は、Files API でアップロードします。
生成を作成する でジョブを送信します。
タスクが成功または失敗するまで 生成ステータス をポーリングします。デプロイとアカウントで webhook が有効な場合は、代わりに API Webhooks を購読して署名付き完了イベントを受信できます。
チャットモデルでは、生成エンドポイントではなく Chat API を使います。Chat の画像添付は Files API の
file_id値を参照する必要があります。