Rivya API 概要

Rivya API v1 は、自分の製品から Rivya のモデル機能を呼び出すための開発者向け入口です。

公開 API は、非同期の画像、動画、音声生成に加え、非ストリーミングまたは SSE ストリーミング応答の Chat API ターンをサポートします。生成には Rivya モデル ID、Rivya アカウントクレジット、公開タスク ID を使い、Chat API にはサーバー側チャットセッションを使います。

API の用途

次のことを行いたい場合に API を使います。

• 自分のアプリから画像、動画、音声生成ジョブを送信する
• 非ストリーミングまたはストリーミングのチャットターンを送信し、API 作成チャットセッションを続行する
• 同じ Rivya アカウントのクレジットウォレット内で請求を管理する
• 公開タスク ID でタスクステータスをポーリングする
• 冪等なリトライを使って本番リクエストをより安全にする
• Studio と API の利用を同じアカウント境界に保つ

API は Rivya の製品レイヤーです。公開応答は Rivya 名称と公開フィールドのみを使います。

現在のバージョン範囲

現在の v1 エンドポイント:

• 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

現在のバージョンには、非同期生成結果向けの署名付き webhooks、Chat API、サーバー側ストリーミング対応の TypeScript SDK beta が含まれます。

認証

生成、ステータス、クレジットのエンドポイントには次が必要です。

Authorization: Bearer rvya_sk_...

API Keys settings でキーを作成、ローテーションしてください。本番でキーを使う前に API 認証 を読んでください。

請求モデル

API 呼び出しは Studio と同じ Rivya アカウントクレジットを使います。

生成ジョブは、タスク開始時にクレジットを予約または消費します。Chat ターンはモデル呼び出し前にクレジットを予約し、assistant メッセージが保存されたときに token 使用量から最終クレジットを精算します。生成または Chat ターンが既存の Rivya 失敗ルールに従って失敗した場合は、同じ返還処理が適用されます。

ユーザー向けウォレットモデルについては、API クレジット と Rivya のクレジットと請求 を読んでください。

最初の統合パス

1. Settings で API キーを作成します。
2. API モデル一覧 を呼び出して公開モデル ID を選びます。
3. モデル API リファレンス でモデルのパラメータを確認します。
4. モデルが参照メディアを必要とする場合は、Files API でアップロードします。
5. 生成を作成する でジョブを送信します。
6. タスクが成功または失敗するまで 生成ステータス をポーリングするか、API Webhooks に登録して署名付き完了イベントを受信します。
7. チャットモデルでは、生成エンドポイントではなく Chat API を使います。Chat の画像添付は Files API の file_id 値を参照する必要があります。

関連ページ

• API クイックスタート
• API 認証
• Rivya TypeScript SDK
• モデル API リファレンス
• Chat API
• API Webhooks
• API エラーと制限