Comfy Router で Grok Imagine Video を使用する

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

結果を待つ
キューに送信して後で収集

from comfy_sdk import Comfy

# 環境変数から COMFY_API_KEY を読み取ります。
# SDK は自動的に冪等性キーを作成し、自動再試行のために再利用します。
with Comfy() as client:
    result = client.models.run(
        "xai/grok-imagine-video",
        {
            "duration": 4,
            "prompt": "a single red maple leaf falling onto still water, slow motion",
        },
    )

print(result)

import { comfy } from "@comfyorg/sdk";

// 環境変数から COMFY_API_KEY を読み取ります。
// SDK は自動的に冪等性キーを作成し、自動再試行のために再利用します。
const { data } = await comfy.models.run("xai/grok-imagine-video", {
  duration: 4,
  prompt: "a single red maple leaf falling onto still water, slow motion",
});

console.log(data);

curl https://api.comfy.org/v2/models/xai/grok-imagine-video \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"duration\": 4, \"prompt\": \"a single red maple leaf falling onto still water, slow motion\"}"

同じボディを POST https://api.comfy.org/v2/models/xai/grok-imagine-video/requests に送信します。Router は実行が受け付けられ次第 201 と request_id を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも収集できます。キュー配信では、ステータス、キャンセル、結果の収集について説明します。

import asyncio
from comfy_sdk import AsyncComfy

# 環境変数から COMFY_API_KEY を読み取ります。
# 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動再試行のために再利用します。
async def main():
    async with AsyncComfy() as client:
        handle = await client.models.submit(
            "xai/grok-imagine-video",
            {
                "duration": 4,
                "prompt": "a single red maple leaf falling onto still water, slow motion",
            },
        )
        print("request_id:", handle.request_id)  # モデル ID と合わせて、別のプロセスに必要なものはこれだけです

        # リクエストが完了するまでポーリングし、サーバーが指定する Retry-After を待ちます。
        async for update in handle.iter_events():
            print(update.status, update.queue_position)

        # プロバイダー自身のペイロードで、models.run() が返す値と同じです。
        # 失敗またはキャンセル済みのリクエストは、ここで型付きの Router エラーを送出します。
        result = await handle.get()

    print(result)

asyncio.run(main())

import { comfy } from "@comfyorg/sdk";

// 環境変数から COMFY_API_KEY を読み取ります。
// 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動再試行のために再利用します。
const handle = await comfy.models.submit("xai/grok-imagine-video", {
  duration: 4,
  prompt: "a single red maple leaf falling onto still water, slow motion",
});
console.log("requestId:", handle.requestId); // モデル ID と合わせて、別のプロセスに必要なものはこれだけです

// リクエストが完了するまでポーリングし、サーバーが指定する Retry-After を待ちます。
for await (const update of handle.events()) {
  console.log(update.status, update.queuePosition);
}

// models.run() が返すのと同じ結果です。失敗またはキャンセル済みのリクエストは、ここで reject されます。
const result = await handle.get();

console.log(result.data);

# 1. 送信。Router は request_id、status_url、response_url、cancel_url とともに 201 を返します。
curl https://api.comfy.org/v2/models/xai/grok-imagine-video/requests \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"duration\": 4, \"prompt\": \"a single red maple leaf falling onto still water, slow motion\"}"

# 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒を待ちます。
REQUEST_ID="<request_id from the 201 body>"
curl -i https://api.comfy.org/v2/models/xai/grok-imagine-video/requests/$REQUEST_ID/status \
  -H "X-API-Key: $COMFY_API_KEY"

# 3. 収集。モデルのネイティブ出力とともに 200、まだ実行中はステータスボディとともに 202 を返します。
curl https://api.comfy.org/v2/models/xai/grok-imagine-video/requests/$REQUEST_ID \
  -H "X-API-Key: $COMFY_API_KEY"

スキーマ

入力

string

デフォルト:"\"16:9\""

生成されるビデオのアスペクト比指定可能な値: 1:1、16:9、9:16、4:3、3:4、3:2、2:3

integer

デフォルト:"8"

ビデオの再生時間（秒）。範囲 [1, 15]。デフォルトは 8。範囲: 1 から 15

object

xAI エンドポイント用の入力画像オブジェクト

string

画像入力のタイプ指定可能な値: image_url

string

必須

入力画像の URL（公開 URL または base64 エンコードされたデータ URI）

string

使用するモデル。対応: grok-imagine-video（デフォルト）、grok-imagine-video-1.5-preview、grok-imagine-video-1.5、grok-imagine-video-1.5-lite。非推奨の 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

エンドユーザーを表す一意の識別子

これは Router が GET /v2/models/xai/grok-imagine-video/openapi.json で提供するスキーマから生成されたもので、リクエストがプロバイダーに到達する前に呼び出しを検証する際に使用されるドキュメントと同じです。

出力

string

このドキュメントでは理由を一切含みません。空でないブロック理由は入力モデレーションによる拒否であり、Router はこのボディではなく Comfy Router エラーとして応答します。ここでは存在しないか、null または空です。

string

ビデオの生成に使用されたモデル

string

このドキュメントでは存在しないか done です。pending は Router が完了していないポーリングのボディであり、200 として返されることはありません。Router は video.url が設定されている場合は status の不足を許容するため、呼び出し側はこれを必須にしてはなりません。指定可能な値: done

object

ビデオ生成リクエストの使用状況情報

integer

このリクエストのコストを USD ティックで表したもの。1 USD セントは 100,000,000 ティック、つまり 1 米ドルは 10,000,000,000 ティックです。

object

必須

完了した生成。ポーリング用ドキュメントとは異なり、ここでは必須です。video.url を持たないターミナルな結果は Comfy Router エラーとして応答されるため、200 には常にこれが含まれます。

integer

生成されたビデオの再生時間（秒）

boolean

モデルが生成したビデオがモデレーションルールに従っているかどうか

string

必須

このドキュメントでは空ではありません。Router はこのリーフが設定されている場合にのみ成功を報告します。これは上記で説明した再ホストされた Comfy 署名付き URL、または再ホストを実行できなかった場合は xAI 自身の短命な URL です。

例

入力

{
  "duration": 4,
  "prompt": "a single red maple leaf falling onto still water, slow motion"
}

出力

{
  "model": "grok-imagine-video",
  "status": "done",
  "usage": {
    "cost_in_usd_ticks": 3500000000
  },
  "video": {
    "duration": 4,
    "respect_moderation": true,
    "url": "https://example.invalid/xai/grok-imagine-video/generated.mp4"
  }
}

出荷前の確認

SDK は Idempotency-Key を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。リクエストが失敗すると、Router は理由を説明する X-Comfy-Error-Type レスポンスヘッダーを送信します。422 は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味し、413 はリクエスト本文が Router の受け入れ可能なサイズを超えていたことを意味します。生成されたアセットは結果 URL の有効期限があるため、早めにダウンロードしてください。上記のフィールド説明に記載されているサイズ制限は、プロバイダーの仕様から引用した、そのフィールドに対するプロバイダー自身の上限です。Router はリクエスト本文全体に対して別の上限を適用し、base64 エンコードされたメディアもこれにカウントされます。リクエスト本文のサイズを参照してください。このページは、Comfy Router 経由で呼び出す 1 つのパートナーモデルについて説明しています。同じ comfy-sdk / @comfyorg/sdk パッケージには、Comfy Cloud 上で ComfyUI のワークフローグラフ全体を実行するための 2 つ目のクライアントも含まれています: Comfy(api_key=...) / new Comfy({ apiKey })、および client.workflows、client.assets、client.jobs。Comfy SDKs を参照してください。

ヘッダー

認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。

Router API の利用

モデルの検出、バリデーションエラー、リトライ、課金。

制限事項

Router が現在対応していないことと、代替手段。

Comfy で開発する

ワークフローの実行

Comfy Router

Comfy CLI

仕様

Demo Apps

Comfy Router で Grok Imagine Video を使用する

クイックスタート

スキーマ

入力

出力

例

入力

出力

出荷前の確認

ヘッダー

Router API の利用

制限事項

​クイックスタート

​スキーマ

​入力

​出力

​例

​入力

​出力

​出荷前の確認

ヘッダー

Router API の利用

制限事項

クイックスタート

スキーマ

入力

出力

例

入力

出力

出荷前の確認