xai/grok-imagine-video の API リファレンスです。xAI 提供のモデルを Comfy Router が配信します。
クイックスタート
Comfy ワークスペースでキーを作成し、COMFY_API_KEY としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(pip install comfy-sdk、npm install @comfyorg/sdk)を使用しており、cURL のスニペットは同じ呼び出しを生の HTTP で実行します。
モデル ID: xai/grok-imagine-video
エンドポイント: POST https://api.comfy.org/v2/models/xai/grok-imagine-video
- Wait for the result
- Queue and collect later
スキーマ
入力
string
デフォルト:"\"16:9\""
生成されるビデオのアスペクト比指定可能な値:
1:1、16:9、9:16、4:3、3:4、3:2、2:3integer
デフォルト:"8"
ビデオの再生時間(秒)。範囲 [1, 15]。デフォルトは 8。範囲:
1 から 15object
xAI エンドポイント用の入力画像オブジェクト
string
画像入力のタイプ指定可能な値:
image_urlstring
必須
入力画像の URL(公開 URL または base64 エンコードされたデータ URI)
string
使用するモデル。対応: grok-imagine-video(デフォルト)、grok-imagine-video-1.5-preview、grok-imagine-video-1.5。非推奨の grok-imagine-video-beta ID は grok-imagine-video のエイリアスです。
object
生成されるビデオの任意の出力先
string
必須
ビデオ生成のためのプロンプト。最大 4,096 文字。
object[]
ビデオ生成を導くための 1 つ以上の参照画像(参照から動画モード)。image とは同時に使用できません。Router は application/json のみを転送し、このオブジェクトも XAIImageObject も file_id を受け付けないため、このルートではファイルベースの画像入力はサポートされません。
string
必須
参照画像の URL。HTTPS URL(公開)または base64 エンコードされたデータ URL(例: data:image/jpeg;base64,…)をサポートします。
string
出力ビデオの解像度
string
出力ビデオのサイズ
string
エンドユーザーを表す一意の識別子
GET /v2/models/xai/grok-imagine-video/openapi.json で提供するスキーマから生成されたもので、リクエストがプロバイダーに到達する前に呼び出しを検証する際に使用されるドキュメントと同じです。
出力
string
リクエストが入力モデレーションによってブロックされた場合、そのブロック理由を含みます
string
ビデオの生成に使用されたモデル
string
遅延リクエストのステータス: “pending” または “done”指定可能な値:
pending、doneobject
ビデオ生成リクエストの使用状況情報
integer
このリクエストのコストを USD ティックで表したもの。1 USD セントは 100,000,000 ティック、つまり 1 米ドルは 10,000,000,000 ティックです。
object
xAI によって生成されたビデオ
integer
生成されたビデオの再生時間(秒)
boolean
モデルが生成したビデオがモデレーションルールに従っているかどうか
string
生成されたビデオのダウンロード URL。Router はビデオを Comfy のストレージに再ホストしてこのフィールドを書き換えるため、通常は最大 24 時間有効な Comfy 署名付き URL になります。発行時に 24 時間の署名が付与され、23 時間のメモから再現されるため、後でポーリングすると残り 1 時間しかない URL が返されることがあります。再ホストを実行できなかった場合、このフィールドには xAI 自身の短命な URL がそのまま残ります。NULLABLE:
url が空の成功は、完了した生成ではありません。いずれの場合もリンクは失効するため、URL を保存するのではなくビデオをダウンロードしてください。例
入力
出力
出荷前の確認
SDK はIdempotency-Key を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。
リクエストが失敗すると、Router は理由を示す X-Comfy-Error-Type レスポンスヘッダーを送信します。422 は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味します。生成されたアセットは 結果 URL の有効期限 があるため、早めにダウンロードしてください。
ヘッダー
認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。
Router API の利用
モデルの検出、バリデーションエラー、リトライ、課金。
制限事項
Router が現在対応していないことと、代替手段。