モデル別 API ページ
Z-Image API 連携
Rivya Public API v1 で Z-Image を使うための model id z-image、対応入力、パラメータ、Files API ルール、クレジット、レスポンス例です。
API で利用可能テキスト入力対応画像
API モデル ID
z-image
入力
text
Files API
最小リクエストでは不要
基本クレジット
1
機能
画像
課金
FIXED
Prompt 上限
1000 文字
リクエスト仕様
モデル ID はトップレベルに送ります。モデル固有の制御項目は params に入れます。
| Key | 型 | 必須 | デフォルト | 説明 |
|---|---|---|---|---|
| model | string | はい | z-image | z-image を API モデル ID として使用します。 |
| prompt | string | はい | - | このモデルでは最大 1000 文字です。 |
| params | object | いいえ | - | モデル固有のパラメータオブジェクトです。許可されるキーは下の行で確認してください。 |
| client_request_id | string | いいえ | - | 自社システム内でリクエストを追跡するための任意のクライアント側 ID です。 |
モデルパラメータ
| Key | 型 | 必須 | デフォルト | 範囲 | 選択肢 | 説明 |
|---|---|---|---|---|---|---|
| aspect_ratio | select | いいえ | 1:1 | - | 1:1, 4:3, 3:4, 16:9, 9:16 | アスペクト比 |
最小リクエスト
{
"model": "z-image",
"prompt": "A clean editorial product image on a soft studio background",
"params": {
"aspect_ratio": "1:1"
}
}作成レスポンス
作成エンドポイントは公開タスク ID を返します。タスクが成功または失敗するまで、ステータスエンドポイントをポーリングしてください。
{
"id": "task_z_image_example",
"status": "queued",
"model": "z-image",
"reserved_credits": 1,
"final_credits": 0,
"created_at": "2026-05-11T00:00:00.000Z",
"updated_at": "2026-05-11T00:00:00.000Z",
"result": null,
"error": null
}一般的なエラー
validation_failed, insufficient_credits, idempotency_conflict, rate_limited, not_found
作成エンドポイントは公開タスク ID を返します。タスクが成功または失敗するまで、ステータスエンドポイントをポーリングしてください。