> ## 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.

# HappyHorse 1.1 R2V を Comfy Router で使用する

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

HappyHorse 1.1 R2V の API リファレンスです。HappyHorse 1.1 の参照から動画は、最大9枚の参照画像に写る被写体を新しいシーン全体で一貫させます。プロンプト内では 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/happyhorse-1.1-r2v`

**エンドポイント:** `POST https://api.comfy.org/v2/models/wan/happyhorse-1.1-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/happyhorse-1.1-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/happyhorse-1.1-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/happyhorse-1.1-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/happyhorse-1.1-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/happyhorse-1.1-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/happyhorse-1.1-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() が返すのと同じ結果です。失敗またはキャンセル済みのリクエストはここで拒否されます。
> 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/happyhorse-1.1-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/happyhorse-1.1-r2v/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 収集。完了時はモデルのネイティブ出力とともに 200、まだ実行中の場合はステータスボディとともに 202 を返します。
> curl https://api.comfy.org/v2/models/wan/happyhorse-1.1-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 を参照）。
また、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つ必要で、reference\_image と
  reference\_video を合わせて最大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 の type
  と first\_frame/last\_frame の type は、同じリクエスト内では同時に使用できません。
  配列の順序は、プロンプト内でのアセットの参照順（画像1、ビデオ1、オーディオ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/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 が宣言されていません。許容される type とその上限が
  モデルごとに異なるためです。スキーマが受け付けることは、プロバイダーが受け付けることを意味しません。また逆に、
  上記のアセットごとの「最大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。これらのモデルのいずれにおいても、ビデオ、オーディオ、ファイル、リンクの入力はインラインの 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`

ネガティブプロンプトは、ビデオ画面に表示したくないコンテンツを記述するために使用します。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 の参照モードでは、'Image 1'、'Video 1'、'Audio 1' などを使用して、media 配列内の対応する順序でメディアアセットを参照します。

**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 呼び出しでは必ず指定する必要があり、受け付けられる表記の enum はその操作自身のコンポーネント `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] の範囲外の duration に対して 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 を大文字化し、大文字化した値を転送します。この enum にない値には 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`

幅*高さ形式のビデオ解像度。サポートされる解像度はモデルによって異なります:
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 は、解像度の説明で 480P 非サポートとされているすべてのモデルで 400 を返します。

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

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

`GET /v2/models/wan/happyhorse-1.1-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.