> ## Documentation Index
> Fetch the complete documentation index at: https://docs.comfy.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Comfy Router で Wan 2.7 R2V を使用する

> Comfy Router 経由で HTTP から wan/wan2.7-r2v を呼び出すための Python、TypeScript、cURL スニペット、およびリクエストフィールドと結果の形状

Wan 2.7 R2V の API リファレンスです。Wan 2.7 の参照から動画は、参照画像や参照ビデオに含まれる被写体を新しいシーンへ持ち込み、プロンプト内で character1、character2 などとして指定します。

**入力：** 画像, ビデオ, テキスト · **出力：** ビデオ

## クイックスタート

[お使いの Comfy ワークスペース](https://platform.comfy.org/profile/api-keys?onboarding=router)でキーを作成し、`COMFY_API_KEY` としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK（`pip install comfy-sdk` および `npm install @comfyorg/sdk`）を使用しています。cURL のスニペットは、同じ呼び出しを生の HTTP で行うものです。

**モデル ID:** `wan/wan2.7-r2v`

**エンドポイント:** `POST https://api.comfy.org/v2/models/wan/wan2.7-r2v`

> [tab] 結果を待つ
>
> ```python Python theme={null}
> import asyncio
> from comfy_sdk import AsyncComfy
>
> # 環境変数から COMFY_API_KEY を読み取ります。
> # SDK は冪等性キーを自動的に作成し、自動リトライのために再利用します。
> async def main():
>     async with AsyncComfy() as client:
>         result = await client.models.run(
>             "wan/wan2.7-r2v",
>             {
>                 "input": {
>                     "prompt": "character1 walks in from the left, turns to the camera and waves, plain orange backdrop",
>                     "media": [
>                         {
>                             "type": "reference_image",
>                             "url": "https://raw.githubusercontent.com/Comfy-Org/workflow_templates/main/input/pink_robot_front.png",
>                         },
>                     ],
>                 },
>                 "parameters": {
>                     "resolution": "720P",
>                     "duration": 5,
>                 },
>             },
>         )
>
>     print("video:", result["output"]["video_url"])
>
> asyncio.run(main())
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 環境変数から COMFY_API_KEY を読み取ります。
> // SDK は冪等性キーを自動的に作成し、自動リトライのために再利用します。
> type Result = { output: { video_url: string } };
> const result = await comfy.models.run<Result>("wan/wan2.7-r2v", {
>   input: {
>     prompt: "character1 walks in from the left, turns to the camera and waves, plain orange backdrop",
>     media: [
>       {
>         type: "reference_image",
>         url: "https://raw.githubusercontent.com/Comfy-Org/workflow_templates/main/input/pink_robot_front.png",
>       },
>     ],
>   },
>   parameters: {
>     resolution: "720P",
>     duration: 5,
>   },
> });
> if (result.kind !== "json") throw new Error("expected a JSON result");
>
> console.log("video:", result.data.output.video_url);
> ```
>
> ```bash cURL theme={null}
> curl https://api.comfy.org/v2/models/wan/wan2.7-r2v \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"input\": {\"prompt\":\"character1 walks in from the left, turns to the camera and waves, plain orange backdrop\",\"media\":[{\"type\":\"reference_image\",\"url\":\"https://raw.githubusercontent.com/Comfy-Org/workflow_templates/main/input/pink_robot_front.png\"}]}, \"parameters\": {\"resolution\":\"720P\",\"duration\":5}}"
> ```

> [tab] キューに登録して後で収集
>
> 同じボディを `POST https://api.comfy.org/v2/models/wan/wan2.7-r2v/requests` に送信します。Router は実行が受け付けられ次第 `201` と `request_id` を返し、結果は準備ができたら収集します。同じプロセスからでも、別のプロセスからでもかまいません。[キュー配信](https://docs.comfy.org/ja/development/comfy-router/queue.md) では、ステータス、キャンセル、収集の流れを順に説明します。
>
> ```python Python theme={null}
> 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(
>             "wan/wan2.7-r2v",
>             {
>                 "input": {
>                     "prompt": "character1 walks in from the left, turns to the camera and waves, plain orange backdrop",
>                     "media": [
>                         {
>                             "type": "reference_image",
>                             "url": "https://raw.githubusercontent.com/Comfy-Org/workflow_templates/main/input/pink_robot_front.png",
>                         },
>                     ],
>                 },
>                 "parameters": {
>                     "resolution": "720P",
>                     "duration": 5,
>                 },
>             },
>         )
>         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("video:", result["output"]["video_url"])
>
> asyncio.run(main())
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 環境変数から COMFY_API_KEY を読み取ります。
> // 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライ時に再利用します。
> type Result = { output: { video_url: string } };
> const handle = await comfy.models.submit<Result>("wan/wan2.7-r2v", {
>   input: {
>     prompt: "character1 walks in from the left, turns to the camera and waves, plain orange backdrop",
>     media: [
>       {
>         type: "reference_image",
>         url: "https://raw.githubusercontent.com/Comfy-Org/workflow_templates/main/input/pink_robot_front.png",
>       },
>     ],
>   },
>   parameters: {
>     resolution: "720P",
>     duration: 5,
>   },
> });
> 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();
> if (result.kind !== "json") throw new Error("expected a JSON result");
>
> console.log("video:", result.data.output.video_url);
> ```
>
> ```bash cURL theme={null}
> # 1. 送信します。Router は request_id、status_url、response_url、cancel_url とともに 201 を返します。
> curl https://api.comfy.org/v2/models/wan/wan2.7-r2v/requests \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"input\": {\"prompt\":\"character1 walks in from the left, turns to the camera and waves, plain orange backdrop\",\"media\":[{\"type\":\"reference_image\",\"url\":\"https://raw.githubusercontent.com/Comfy-Org/workflow_templates/main/input/pink_robot_front.png\"}]}, \"parameters\": {\"resolution\":\"720P\",\"duration\":5}}"
>
> # 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After の秒数だけ待機します。
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/wan/wan2.7-r2v/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 収集します。200 はモデルのネイティブ出力、202 はまだ実行中の場合のステータスボディです。
> curl https://api.comfy.org/v2/models/wan/wan2.7-r2v/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## スキーマ

### 入力

**input** `object` *required*

プロンプトなどの基本情報を入力します。

**input.audio\_url** `string`

オーディオファイルのダウンロードURL。対応形式: mp3 および wav。reference\_video\_urls とは併用できません。

**input.img\_url** `string`

先頭フレーム画像のURL、またはBase64エンコードされたデータ。wan2.5-i2v-preview および wan2.6-i2v モデルでは必須です。happyhorse-1.x の i2v 系スペルはここで先頭フレームを受け取りません。先頭フレームは type が first\_frame の media 要素として受け取ります（下記の media を参照）。また、wan2.6-i2v で成功する img\_url のボディは、happyhorse-1.0-i2v および happyhorse-1.1-i2v ではプロバイダーに拒否されます。wan2.7/wan3.0 系のスペルも参照アセットを media で受け取ります。画像形式: JPEG、JPG、PNG、BMP、WEBP。解像度: 360-2000 ピクセル。ファイルサイズ: 最大 10MB。

**input.media** `object[]`

メディアアセットのリスト。動画生成用の参照素材（画像、オーディオ、ビデオ）を指定します。各要素は type と url フィールドを持ちます。このフィールドはこのコンポーネントから提供されるすべてのモデルで共通であり、どの type 値を受け付けるか、また画像やビデオの入力を img\_url や reference\_video\_urls ではなくここで受け取るかどうかはモデルごとに異なります。モデルごとの対応 type 値:

* wan2.7-i2v: first\_frame、last\_frame、driving\_audio、first\_clip。first\_frame と last\_frame: JPEG/JPG/PNG/BMP/WEBP、1辺 240-8000 ピクセル、アスペクト比 1:8 から 8:1 の間、最大 20MB、公開URL または data:\{MIME\_type};base64,... URL。driving\_audio（WAV/MP3、2-30 秒、最大 15MB）と first\_clip（MP4/MOV、2-10 秒、1辺 240-4096 ピクセル、最大 100MB）: 公開 HTTP/HTTPS URL。インラインの data: URL は受け付けられません。
* wan2.7-r2v: first\_frame（任意、最大 1）、reference\_image、reference\_video。reference\_image または reference\_video が少なくとも 1 つ必要で、参照画像と参照ビデオの合計は最大 5 です。first\_frame と reference\_image: JPEG/JPG/PNG/BMP/WEBP（アルファチャンネルなし）、1辺 240-8000 ピクセル、アスペクト比 1:8 から 8:1 の間、最大 20MB、公開URL または data:\{MIME\_type};base64,... URL。reference\_video: 公開 HTTP/HTTPS URL。インラインの data: URL は受け付けられません。
* wan2.7-videoedit: video（ちょうど 1 つ。編集対象のクリップ: MP4/MOV、2-10 秒、1辺 240-4096 ピクセル、最大 100MB、公開 HTTP/HTTPS URL。インラインの data: URL は受け付けられません）に加えて、任意で 0 から 4 個の reference\_image（JPEG/JPG/PNG/BMP/WEBP、1辺 240-8000 ピクセル、アスペクト比 1:8 から 8:1 の間、最大 20MB、公開URL または data:\{MIME\_type};base64,... URL）。
* wan3.0-video、wan3.0-video-prime: first\_frame（最大 1）、last\_frame（最大 1）、reference\_image（最大 10）、reference\_video（最大 5 クリップ、合計再生時間 \<= 15 秒）、reference\_audio（最大 5 クリップ、合計再生時間 \<= 15 秒）、file（最大 1、link とは併用不可）、link（最大 1、file とは併用不可）。reference\_\*/file/link タイプと first\_frame/last\_frame タイプは同じリクエスト内では排他的です。配列の順序がプロンプト内でのアセットの参照順（Image 1、Video 1、Audio 1、...）を定義します。first\_frame、last\_frame、reference\_image: JPEG/JPG/PNG/BMP/WEBP、1辺 240-8000 ピクセル、アスペクト比最大 8:1、最大 20MB、公開URL または data:\{MIME\_type};base64,... URL。reference\_video、reference\_audio、file、link: 公開 HTTP/HTTPS URL。インラインの data: URL は受け付けられません。
* happyhorse-1.0-i2v、happyhorse-1.1-i2v: first\_frame のみ、ちょうど 1 つ。これらのスペルは先頭フレームを img\_url ではなくここで受け取ります。最小 300x300 ピクセル、アスペクト比 1:2.5 から 2.5:1 の間、JPEG/JPG/PNG/WEBP、最大 20MB、公開URL または data:\{MIME\_type};base64,... URL。
* happyhorse-1.0-r2v、happyhorse-1.1-r2v: reference\_image のみ、1 から 9 個。これはモデル唯一の参照入力です。最短辺が 400 ピクセル以上、JPEG/JPG/PNG/WEBP、最大 20MB、公開URL または data:\{MIME\_type};base64,... URL。reference\_video はこの操作の入力タイプではありません。
* happyhorse-1.0-video-edit: video（ちょうど 1 つ。編集対象のクリップ: MP4/MOV、3-60 秒、長辺が最大 4096 ピクセル、短辺が最小 360 ピクセル、アスペクト比 1:2.5 から 2.5:1 の間、最大 100MB、公開 HTTP/HTTPS URL。インラインの data: URL は受け付けられません）に加えて、任意で 0 から 5 個の reference\_image（JPEG/JPG/PNG/BMP/WEBP、最小 300x300 ピクセル、アスペクト比 1:2.5 から 2.5:1 の間、最大 20MB、公開URL または data:\{MIME\_type};base64,... URL）。
* happyhorse-1.0-t2v、happyhorse-1.1-t2v、wan2.7-t2v、wan2.6-t2v、wan2.5-t2v-preview: テキストから動画への操作。対応するパートナーのリファレンスにはメディア入力が記載されていないため、このフィールドは未設定のままにしてください。
* wan2.5-i2v-preview、wan2.6-i2v、wan2.6-r2v: このコンポーネントはこれらのスペルに対するメディアの語彙を列挙していません。wan2.5-i2v-preview と wan2.6-i2v は先頭フレームを img\_url で受け取り、wan2.6-r2v は参照クリップを reference\_video\_urls で受け取ります。
  上記のモデルごとの個数はこのスキーマの制約ではなく、パートナーの制約です。media には minItems/maxItems が宣言されていません。許容されるタイプとその上限はモデルごとに異なるためです。スキーマが受け付けることはプロバイダーが受け付けることを意味しません。そして逆方向についても、上記のアセットごとの「最大 20MB」という数値（インラインで送信できる唯一の入力である画像入力に対する上限）は、パートナーが最終的に受け取るアセットに対する上限であり、アセットが公開URLの場合はそのまま適用されます。そのバイト列が Comfy を経由することはないためです。インラインの data:\{MIME\_type};base64,... URL は Comfy を経由するため、転送時の上限にも直面します。Comfy Router の POST ボディは合計 100 MiB に制限され、それを超えると 413 が返されます。さらに base64 はペイロードを約 4/3 に膨らませるため、およそ 75 MB を超える単一のインラインアセットは、ここに示すパートナーのルールに到達する前に拒否されます。そのサイズでは、パートナー自身の
  20MB の上限にはインラインでも余裕で収まるため、アセット 1 件の場合はパートナーのルールが制約となります。トランスポートの上限は複数のアセットにまたがる場合に制約となります。100 MiB の Router の上限は個々の要素ではなくリクエスト全体を制限するためです。これらの上限に近いサイズのものは、パブリック URL として送信してください。

**input.media\[].type** `string` *required*

メディアアセットの種類

指定可能な値: `first_frame`、`last_frame`、`driving_audio`、`first_clip`、`reference_image`、`reference_video`、`reference_audio`、`video`、`file`、`link`

**input.media\[].url** `string` *required*

メディアファイルの URL。パブリックな HTTP/HTTPS URL、または、上記の `media` の説明でモデルごとに列挙されている IMAGE 入力（wan2.7-i2v の first\_frame と last\_frame、wan2.7-r2v の first\_frame と reference\_image、wan2.7-videoedit の reference\_image、wan3.0-video と wan3.0-video-prime の first\_frame、last\_frame、reference\_image、happyhorse-1.0-i2v と happyhorse-1.1-i2v の first\_frame、happyhorse-1.0-r2v と happyhorse-1.1-r2v の reference\_image、happyhorse-1.0-video-edit の reference\_image）に限り、インラインの `data:{MIME_type};base64,...` URL を指定できます。これらのモデルのいずれにおいても、video、audio、file、link の入力はインラインの data: URL を受け付けません。パートナー自身のアップロードサービスが発行する oss\://dashscope-instant の一時 URL、または（wan2.7-videoedit では）Asset Center の asset\_id は、それをアップロードした Alibaba Cloud アカウントに対してのみ解決されます。Comfy は自身のキーでモデルを呼び出し、アップロード用のルートを公開していないため、呼び出し元自身の oss\:// URL や asset\_id はサポートされる入力ではありません。このフィールドは URL スキームを検証しないため、そのような値はここで拒否されず、そのままパートナーへ転送されます。モデルごとのサイズとピクセルの制限、およびインラインのペイロードを全体として制限する 100 MiB の Router リクエストボディ上限については、`media` の説明を参照してください。

**input.negative\_prompt** `string`

ネガティブプロンプト（reverse prompt words）は、ビデオ画面に表示したくないコンテンツを記述するために使用します。500 文字を超えると、wan モデルは拒否せずに切り捨てます。これは prompt と同じ入力バジェットにカウントされます。

**input.prompt** `string`

テキストプロンプト。中国語と英語をサポートします。文書化された独自の長さを超えると、wan2.x モデルはプロンプトを拒否せずに切り捨てます。wan2.5 と wan2.6 では 1,500 文字、wan2.7 では 5,000 文字です。wan3.0-video と wan3.0-video-prime は最大 20,000 文字を受け付けます。prompt と negative\_prompt を合わせて約 60,850 バイトの UTF-8 テキスト（約 20,000 中国語文字）を超えるリクエストは、プロバイダーが拒否し、InvalidParameter `Range of input length should be [1, 61440]` を返します。
複数の参照ビデオを伴う wan2.6-r2v では、参照ビデオの順序に対応して 'character1'、'character2' などで被写体を参照してください。例: "Character1 sings on the roadside, Character2 dances beside it"
wan3.0-video の参照モードでは、media 配列内の対応する順序のメディアアセットを参照するために 'Image 1'、'Video 1'、'Audio 1' などを使用します。

**input.reference\_video\_urls** `string[]`

wan2.6-r2v モデル専用の参照ビデオ URL。1～3 本のビデオ URL の配列です。
入力の制限:

* 形式: mp4, mov
* 数量: 1～3 本
* 単一ビデオの長さ: 2～30 秒
* 単一ファイルサイズ: 最大 30MB
* audio\_url と併用できません
  参照の再生時間: 単一ビデオは最大 5 秒、2 本の場合はそれぞれ最大 2.5 秒、3 本の場合はそれに比例して短くなります。
  課金: 実際に使用された参照の再生時間に基づきます。

**input.template** `string`

ビデオエフェクトのテンプレート名。任意。現在サポートされているのは squish、flying、carousel です。使用した場合、prompt パラメータは無視されます。

**model** `string`

呼び出すモデルの ID。このコンポーネントでは制約されません。Comfy Router が `POST /v2/models/wan/{model}` の `{model}` パスセグメントから設定するため、Router の呼び出し元は省略します。`POST /proxy/wan/api/v1/services/aigc/video-generation/video-synthesis` への直接の v1 呼び出しでは必ず指定する必要があり、受け付けられる表記の列挙はそのオペレーション自身のコンポーネント `WanVideoGenerationRequest` にあります。

**parameters** `object`

ビデオ処理パラメータ

**parameters.audio** `boolean` (default: true)

ビデオにオーディオを追加するかどうか。wan3.0-video と wan3.0-video-prime のみでサポートされます。その他の wan モデルについては、プロバイダーはそのような切り替えを文書化していません。

**parameters.audio\_setting** `string` (default: "auto")

wan2.7-videoedit モデルのビデオオーディオ設定。

* auto（デフォルト）: プロンプトの内容に基づいてモデルがインテリジェントに判断します
* origin: 入力ビデオのオリジナルオーディオを強制的に保持します

  指定可能な値: `auto`、`origin`

**parameters.duration** `integer` (default: 5)

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

* wan2.5 モデル: 5 秒または 10 秒
* wan2.6-t2v、wan2.6-i2v: 5 秒、10 秒、または 15 秒
* wan2.6-r2v: 5 秒または 10 秒のみ（15 秒は非サポート）
* wan2.7-i2v、wan2.7-t2v: \[2, 15] の整数
* wan2.7-r2v、wan2.7-videoedit: \[2, 10] の整数
* wan3.0-video: ビデオ入力なしの場合は \[2, 30] の整数。ビデオ入力ありの場合は、入力ビデオの再生時間と出力ビデオの再生時間の合計が 30 秒を超えてはなりません。-1 を指定すると、モデルが適切な再生時間を選択するスマート再生時間モードが有効になります
  このプロキシは \[-1, 30] の範囲外の再生時間に対して 400 を返します。

  範囲: `-1` から `30`

**parameters.prompt\_extend** `boolean` (default: true)

プロンプトのインテリジェントな書き換えを有効にするかどうか。デフォルトは true です

**parameters.ratio** `string`

生成されるビデオのアスペクト比。wan2.7 および wan3.0 モデルのみ。
wan2.7 モデルでは、指定しない場合、解像度ティアに基づいてデフォルトが決まります。
wan3.0-video では、adaptive（デフォルト）が入力メディアの比率と意図に基づいて適切なアスペクト比を自動的に推奨します。

指定可能な値: `adaptive`, `16:9`, `9:16`, `1:1`, `4:3`, `3:4`

**parameters.resolution** `string`

解像度レベル。サポートされる値はモデルによって異なります:

* wan2.5-i2v-preview: 480P、720P、1080P
* wan2.6 モデル（t2v、i2v、r2v）: 720P、1080P のみ（480P 非対応）
* wan2.7 モデル（i2v、t2v、r2v、videoedit）: 720P、1080P（デフォルト 1080P）
* wan3.0-video、wan3.0-video-prime: 480P、720P、1080P（アップストリームのデフォルトは 1080P）
* happyhorse-1.0-\*（t2v、i2v、r2v、video-edit）: 720P、1080P
* happyhorse-1.1-\*（t2v、i2v、r2v）: 480P、720P、1080P
  このプロキシは、resolution も size も指定しないビデオ生成リクエストを拒否します。解像度の階層が課金レートを決めるためです。チェックの前に resolution を大文字化し、大文字化した値をそのまま転送します。この列挙型に含まれない値には 400 を返し、上記で 480P 非対応とされている wan2.6、wan2.7、happyhorse-1.0 のモデルでは、480P（resolution として送信された場合も、480P の size として送信された場合も）に対して 400 を返します。

  指定可能な値: `480P`, `720P`, `1080P`

**parameters.seed** `integer`

乱数シード。モデルが生成するコンテンツのランダム性を制御するために使用します

範囲: `0` から `2147483647`

**parameters.shot\_type** `string` (default: "single")

インテリジェントなマルチレンズ制御。prompt\_extend が有効な場合にのみ動作します。
wan2.6 および wan2.7-r2v モデル向け。

* single: 単一ショットのビデオ（デフォルト）
* multi: マルチショットのビデオ

  指定可能な値: `multi`, `single`

**parameters.size** `string`

width*height 形式のビデオ解像度。サポートされる解像度はモデルによって異なります:
wan2.5 T2V の場合: 480P（480*832, 832*480, 624*624）、720P、1080P の各サイズ
wan2.6 T2V/R2V の場合（480P なし）:
720P: 1280*720, 720*1280, 960*960, 1088*832, 832*1088
1080P: 1920*1080, 1080*1920, 1440*1440, 1632*1248, 1248*1632
size と resolution の両方を送信した場合、課金階層を決めるのは size であり、resolution はそのモデルに対してこのプロキシが受け付ける値である必要があります。480P の size は、resolution の説明で 480P 非対応とされているすべてのモデルで 400 を返します。

**parameters.watermark** `boolean` (default: false)

ウォーターマークロゴを追加するかどうか。ウォーターマークは右下隅に配置されます

`GET /v2/models/wan/wan2.7-r2v/openapi.json` で Router が提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に呼び出しを検証する際に使用される同じドキュメントです。

### 出力

**output** `object` *required*

**output.actual\_prompt** `string`

インテリジェントリライト後の実際のプロンプト（ビデオタスク用）

**output.check\_audio** `string`

音声生成を伴うI2Vタスク用のオーディオURL

**output.code** `string`

失敗したリクエストのエラーコード（リクエストが成功した場合は返されません）

**output.end\_time** `string`

タスク完了時間

**output.message** `string`

失敗したリクエストの詳細情報（リクエストが成功した場合は返されません）

**output.orig\_prompt** `string`

元の入力プロンプト（ビデオタスク用）

**output.results** `object[]`

画像生成タスクのタスク結果のリスト

**output.results\[].actual\_prompt** `string`

インテリジェントリライト後の実際のプロンプト（有効な場合）

**output.results\[].code** `string`

画像のエラーコード（一部のタスクが失敗した場合に返されます）

**output.results\[].message** `string`

画像のエラー情報（一部のタスクが失敗した場合に返されます）

**output.results\[].orig\_prompt** `string`

元の入力プロンプト

**output.results\[].url** `string`

生成済み画像のURLアドレス

**output.scheduled\_time** `string`

タスクの実行時間

**output.submit\_time** `string`

タスクの送信時間

**output.task\_id** `string` *required*

タスクID

**output.task\_metrics** `object`

画像生成タスクのタスク結果の統計

**output.task\_metrics.FAILED** `integer`

失敗したタスクの数

**output.task\_metrics.SUCCEEDED** `integer`

成功したタスクの数

**output.task\_metrics.TOTAL** `integer`

タスクの合計数

**output.task\_status** `string` *required*

タスクステータス

取り得る値: `PENDING`、`RUNNING`、`SUCCEEDED`、`FAILED`、`CANCELED`、`UNKNOWN`

**output.video\_url** `string`

完了したビデオ生成タスク用のビデオURL。リンクの有効期間は24時間です

**request\_id** `string` *required*

一意のリクエスト識別子

**usage** `object`

出力情報の統計。成功した結果のみがカウントされます

**usage.SR** `integer`

ビデオ解像度のレベル（I2Vおよびwan3.0-videoタスク）

**usage.duration** `number`

生成されたビデオの再生時間（秒）（I2Vおよびwan3.0-videoタスク）

**usage.fps** `integer`

生成されたビデオのフレームレート（wan3.0-videoタスク）

**usage.image\_count** `integer`

生成された画像の数（T2IおよびI2Iタスク）

**usage.input\_video\_duration** `number`

入力ビデオの再生時間（秒）。ビデオ入力がない場合は0.0（wan3.0-videoタスク）

**usage.output\_video\_duration** `number`

出力ビデオの再生時間（秒）（wan3.0-videoタスク）

**usage.ratio** `string`

生成されたビデオのアスペクト比（例: 16:9）（wan3.0-videoタスク）

**usage.size** `string`

画像の解像度（T2IおよびI2Iタスク）

**usage.video\_count** `integer`

生成されたビデオの数（T2Vタスク）

**usage.video\_duration** `number`

生成されたビデオの再生時間（秒）（T2Vタスク）

**usage.video\_ratio** `string`

ビデオの解像度比率（T2Vタスク）

**code** `string`

失敗したリクエストのエラーコード。`output` の下ではなく、エンベロープのルートで報告されます（リクエストが成功した場合は返されません）。

**message** `string`

失敗したリクエストの詳細情報。`output` の下ではなく、エンベロープのルートで報告されます（リクエストが成功した場合は返されません）。`output.message` にフォールバックする前に、こちらを確認してください。

## 例

### 入力

```json theme={null}
{
  "input": {
    "prompt": "character1 walks in from the left, turns to the camera and waves, plain orange backdrop",
    "media": [
      {
        "type": "reference_image",
        "url": "https://raw.githubusercontent.com/Comfy-Org/workflow_templates/main/input/pink_robot_front.png"
      }
    ]
  },
  "parameters": {
    "resolution": "720P",
    "duration": 5
  }
}
```

### 出力

```json theme={null}
{
  "output": {
    "task_id": "0385dc79-5ff8-4d82-bcb6-7c1a9f2e4d60",
    "task_status": "SUCCEEDED",
    "submit_time": "2027-01-01T00:00:00.000Z",
    "scheduled_time": "2027-01-01T00:00:01.000Z",
    "end_time": "2027-01-01T00:01:04.000Z",
    "orig_prompt": "character1 walks in from the left, turns to the camera and waves, plain orange backdrop",
    "actual_prompt": "character1 walks in from the left, turns to the camera and waves, plain orange backdrop, even studio lighting, steady medium shot",
    "video_url": "https://.../generated.mp4"
  },
  "request_id": "7574ee8f-38a3-4b1e-9280-11c33ab46e51",
  "usage": {
    "SR": 720,
    "duration": 5
  }
}
```

ビデオの URL は 24 時間有効です。保存しておく必要がある場合は、速やかにビデオをダウンロードしてください。

## 出荷前の確認

SDK は `Idempotency-Key` を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。

リクエストが失敗すると、Router は理由を説明する `X-Comfy-Error-Type` レスポンスヘッダーを送信します。`422` は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味し、`413` はリクエスト本文が Router の受け入れ可能なサイズを超えていたことを意味します。生成されたアセットは [結果 URL の有効期限](https://docs.comfy.org/ja/development/comfy-router/reference.md#結果アセット) があるため、早めにダウンロードしてください。

上記のフィールド説明に記載されているサイズ制限は、プロバイダーの仕様から引用した、そのフィールドに対するプロバイダー自身の上限です。Router はリクエスト本文全体に対して別の上限を適用し、base64 エンコードされたメディアもこれにカウントされます。[リクエスト本文のサイズ](https://docs.comfy.org/ja/development/comfy-router/limitations.md) を参照してください。

このページは、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](https://docs.comfy.org/ja/development/api-development/sdks.md) を参照してください。

> [card] [ヘッダー](https://docs.comfy.org/ja/development/comfy-router/headers.md)
>
> 認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。

> [card] [Router API の利用](https://docs.comfy.org/ja/development/comfy-router/api.md)
>
> モデルの検出、バリデーションエラー、リトライ、課金。

> [card] [制限事項](https://docs.comfy.org/ja/development/comfy-router/limitations.md)
>
> Router が現在対応していないことと、代替手段。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.