Rivya AI ドキュメント
モデル別 API ページ

Grok Imagine API 連携

Rivya Public API v1 で Grok Imagine を使うための model id grok-imagine、対応入力、パラメータ、Files API ルール、クレジット、レスポンス例です。

API で利用可能テキストまたは URL は対応済み。参照モードでは Files API を使用画像
API モデル ID

grok-imagine

入力

text, file

Files API

参照モードで必要

基本クレジット

4

機能

画像

課金

FIXED

Prompt 上限

5000 文字

リクエスト仕様

モデル ID はトップレベルに送ります。モデル固有の制御項目は params に入れます。

Key必須デフォルト説明
modelstringはいgrok-imaginegrok-imagine を API モデル ID として使用します。
promptstringはい-このモデルでは最大 5000 文字です。
paramsobjectいいえ-モデル固有のパラメータオブジェクトです。許可されるキーは下の行で確認してください。
client_request_idstringいいえ-自社システム内でリクエストを追跡するための任意のクライアント側 ID です。

モデルパラメータ

Key必須デフォルト範囲選択肢説明
aspect_ratioselectいいえ1:1-1:1, 2:3, 3:2, 16:9, 9:16アスペクト比
enable_proselectいいえfalse-false, trueこれはテキストから画像生成専用の Grok Imagine 品質切り替えです。Standard は低コストで、Quality はより細部に寄せた出力を狙います。現在の画像編集パスでは使用しません。

アップロードポリシー

先に参照ファイルをアップロードし、返された URL と durationToken を params.referenceMediaItems に入れてください。

参照ルール

参照画像: 画像プロジェクト用に最大 1 枚の画像ファイルをアップロードできます。

最大ファイル数

1

受け付けるファイル種別

image

Duration token

動画と音声の参照では、長さの検証が必要な場合に /api/v1/files の durationToken を含めてください。

kind最大サイズMIME タイプ
image10 MBimage/jpeg, image/png, image/webp

最小リクエスト

{
  "model": "grok-imagine",
  "prompt": "A clean editorial product image on a soft studio background",
  "params": {
    "aspect_ratio": "1:1",
    "enable_pro": "false"
  }
}

参照ファイル付きリクエスト

{
  "model": "grok-imagine",
  "prompt": "A clean editorial product image on a soft studio background",
  "params": {
    "aspect_ratio": "1:1",
    "enable_pro": "false",
    "referenceMediaItems": [
      {
        "url": "https://cdn.example.com/reference-image.png",
        "kind": "image",
        "name": "reference-image.png",
        "mimeType": "image/png"
      }
    ]
  }
}

作成レスポンス

作成エンドポイントは公開タスク ID を返します。タスクが成功または失敗するまで、ステータスエンドポイントをポーリングしてください。

{
  "id": "task_grok_imagine_example",
  "status": "queued",
  "model": "grok-imagine",
  "reserved_credits": 4,
  "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

一部のモードでは Files API による参照アップロードが必要です。