> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-matt-router-pricing-pika-and-guard.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 通过 Comfy Router 使用 Wan 3.0 Video

> 通过 Comfy Router 以 HTTP 方式调用 wan/wan3.0-video 的 Python、TypeScript 和 cURL 代码片段，以及请求字段和返回结果的形状

Wan 3.0 Video 的 API 参考。Wan 3.0 Video 既可以仅根据提示词生成，也可以根据由首帧和末帧、参考图像、视频和音频组成的媒体列表生成；在提示词中分别以 Image 1、Video 1 和 Audio 1 来引用。

**输入：** 文本, 图像, 视频, 音频 · **输出：** 视频 + 音频

## 快速开始

在[你的 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/wan3.0-video`

**端点：** `POST https://api.comfy.org/v2/models/wan/wan3.0-video`

<Tabs defaultTabIndex={1}>
  <Tab title="等待结果">
    <CodeGroup>
      ```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/wan3.0-video",
                  {
                      "input": {
                          "prompt": "the robot lowers its raised arm and steps toward the camera, the flat orange backdrop holds steady",
                          "media": [
                              {
                                  "type": "first_frame",
                                  "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/wan3.0-video", {
        input: {
          prompt: "the robot lowers its raised arm and steps toward the camera, the flat orange backdrop holds steady",
          media: [
            {
              type: "first_frame",
              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/wan3.0-video \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"input\": {\"prompt\":\"the robot lowers its raised arm and steps toward the camera, the flat orange backdrop holds steady\",\"media\":[{\"type\":\"first_frame\",\"url\":\"https://raw.githubusercontent.com/Comfy-Org/workflow_templates/main/input/pink_robot_front.png\"}]}, \"parameters\": {\"resolution\":\"720P\",\"duration\":5}}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="队列并稍后收集">
    同一个请求体，发送至 `POST https://api.comfy.org/v2/models/wan/wan3.0-video/requests`。运行一经接纳，Router 就返回 `201` 和 `request_id`；结果就绪后，可从当前进程或另一个进程收集。[队列投递](/zh/development/comfy-router/queue) 完整介绍了状态查询、取消与收集。

    <CodeGroup>
      ```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/wan3.0-video",
                  {
                      "input": {
                          "prompt": "the robot lowers its raised arm and steps toward the camera, the flat orange backdrop holds steady",
                          "media": [
                              {
                                  "type": "first_frame",
                                  "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/wan3.0-video", {
        input: {
          prompt: "the robot lowers its raised arm and steps toward the camera, the flat orange backdrop holds steady",
          media: [
            {
              type: "first_frame",
              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 返回 201，以及 request_id、status_url、response_url 和 cancel_url。
      curl https://api.comfy.org/v2/models/wan/wan3.0-video/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"input\": {\"prompt\":\"the robot lowers its raised arm and steps toward the camera, the flat orange backdrop holds steady\",\"media\":[{\"type\":\"first_frame\",\"url\":\"https://raw.githubusercontent.com/Comfy-Org/workflow_templates/main/input/pink_robot_front.png\"}]}, \"parameters\": {\"resolution\":\"720P\",\"duration\":5}}"

      # 2. 轮询直到 status 为 COMPLETED，按每个响应给出的 Retry-After 秒数等待。
      REQUEST_ID="<request_id from the 201 body>"
      curl -i https://api.comfy.org/v2/models/wan/wan3.0-video/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

      # 3. 收集。200 返回模型的原始输出，仍在运行时 202 返回状态响应体。
      curl https://api.comfy.org/v2/models/wan/wan3.0-video/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## 服务提供商

除非请求中指定了其他提供商，否则该模型由 Comfy Router 直接提供服务。下列提供商也可通过同一端点和相同的模型 ID 提供该模型，并使用 `model_provider` 查询参数进行选择。

* **Comfy**（默认）：`POST https://api.comfy.org/v2/models/wan/wan3.0-video`
* **Higgsfield**，作为 `higgsfield/higgsfield-wan-3`：`POST https://api.comfy.org/v2/models/wan/wan3.0-video?model_provider=higgsfield`

`strict_mode` 默认为 false，因此 Router 会将本页记录的原始请求体转换为提供商自己的 schema，并将响应转换回来。请参阅 API 参考中的 [`model_provider`、`strict_mode` 和 `fallback_provider`](/zh/development/comfy-router/reference#post-v2modelsprovidermodel)，以及 [服务提供商](/zh/development/comfy-router/providers)，了解所有以这种方式路由的模型。

## Schema

### 输入

<ParamField body="input" type="object" required>
  输入基本信息，例如提示词等。
</ParamField>

<ParamField body="input.audio_url" type="string">
  音频文件下载网址。支持的格式：mp3 和 wav。不能与 reference\_video\_urls 一起使用。
</ParamField>

<ParamField body="input.img_url" type="string">
  首帧图像网址或 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。
</ParamField>

<ParamField body="input.media" type="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，每边 240-8000 像素，宽高比在 1:8 到 8:1 之间，最多 20MB，可以是公开网址或 data:\{MIME\_type};base64,... 网址。driving\_audio（WAV/MP3，2-30 秒，最多 15MB）和 first\_clip（MP4/MOV，2-10 秒，每边 240-4096 像素，最多 100MB）：公开 HTTP/HTTPS 网址；不接受内联 data: 网址。
  * wan2.7-r2v：first\_frame（可选，最大值 1）、reference\_image、reference\_video。至少需要一个 reference\_image 或 reference\_video，且参考图像加参考视频总共最多 5 个。first\_frame 和 reference\_image：JPEG/JPG/PNG/BMP/WEBP（无透明度通道），每边 240-8000 像素，宽高比在 1:8 到 8:1 之间，最多 20MB，可以是公开网址或 data:\{MIME\_type};base64,... 网址。reference\_video：公开 HTTP/HTTPS 网址；不接受内联 data: 网址。
  * wan2.7-videoedit：video（恰好 1 个，即正在编辑的片段：MP4/MOV，2-10 秒，每边 240-4096 像素，最多 100MB，公开 HTTP/HTTPS 网址；不接受内联 data: 网址），外加可选的 0 到 4 个 reference\_image（JPEG/JPG/PNG/BMP/WEBP，每边 240-8000 像素，宽高比在 1:8 到 8:1 之间，最多 20MB，可以是公开网址或 data:\{MIME\_type};base64,... 网址）。
  * 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，每边 240-8000 像素，宽高比最大 8:1，最多 20MB，可以是公开网址或 data:\{MIME\_type};base64,... 网址。reference\_video、reference\_audio、file 和 link：公开 HTTP/HTTPS 网址；不接受内联 data: 网址。
  * 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，可以是公开网址或 data:\{MIME\_type};base64,... 网址。
  * happyhorse-1.0-r2v、happyhorse-1.1-r2v：仅 reference\_image，1 到 9 个。这是该模型唯一的参考输入。最短边至少 400 像素，JPEG/JPG/PNG/WEBP，最多 20MB，可以是公开网址或 data:\{MIME\_type};base64,... 网址。reference\_video 不是此操作的输入类型。
  * happyhorse-1.0-video-edit：video（恰好 1 个，即正在编辑的片段：MP4/MOV，3-60 秒，长边最大 4096 像素，短边至少 360 像素，宽高比在 1:2.5 到 2.5:1 之间，最多 100MB，公开 HTTP/HTTPS 网址；不接受内联 data: 网址），外加可选的 0 到 5 个 reference\_image（JPEG/JPG/PNG/WEBP，至少 300x300 像素，宽高比在 1:2.5 到 2.5:1 之间，最多 20MB，可以是公开网址或 data:\{MIME\_type};base64,... 网址）。
  * 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 中接收其参考片段。
    上述各模型的数量是合作伙伴的约束，而非本 schema 的约束：media 上未声明 minItems/maxItems，因为可接受的类型及其上限因模型而异。Schema 接受并不意味着提供商接受。反过来说，上述每个资产的“最多 20MB”数值（图像输入的上限，也是唯一可以内联发送的输入）是合作伙伴对其最终获得的资产所设的上限，当资产是公开网址时，这些数值按字面适用，因为这些字节从不经过 Comfy。内联 data:\{MIME\_type};base64,... 网址确实会经过 Comfy，并且也会遇到传输上限：Comfy Router POST 请求体总计上限为 100 MiB，超过则返回 413，而 base64 会使负载膨胀约 4/3，因此任何单个内联资产只要超过约 75 MB，就会在触达此处任何合作伙伴规则之前被拒绝。在该大小下，单个资产在合作伙伴自身的20MB 上限可轻松容纳内联数据，因此对于单个资产而言，真正起约束作用的是合作伙伴规则；而在多个资产的情况下，起约束作用的则是传输上限，因为 100 MiB 的 Router 上限约束的是整个请求，而不是每个元素。任何接近这些上限的内容，请以公开 URL 的形式发送。
</ParamField>

<ParamField body="input.media[].type" type="string" required>
  媒体资产类型

  可选值：`first_frame`、`last_frame`、`driving_audio`、`first_clip`、`reference_image`、`reference_video`、`reference_audio`、`video`、`file`、`link`
</ParamField>

<ParamField body="input.media[].url" type="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，只能针对上传它的阿里云账号解析；Comfy 使用自己的密钥发起模型调用且不提供上传路由，因此调用方自己的 oss\:// URL 或 asset\_id 并非受支持的输入。此字段不校验 URL 协议，因此这样的值会原样转发给合作伙伴，而不会在此处被拒绝。有关各模型的大小和像素限制，以及以整体方式约束内联负载的 100 MiB Router 请求体上限，请参见 `media` 描述。
</ParamField>

<ParamField body="input.negative_prompt" type="string">
  反向提示词用于描述你不希望在视频画面中出现的内容
</ParamField>

<ParamField body="input.prompt" type="string">
  文本提示词。支持中文和英文，长度不超过 800 个字符（wan3.0-video 最多 20,000 个字符；超出限制的内容会被截断）。
  对于带有多个参考视频的 wan2.6-r2v，请使用 'character1'、'character2' 等，按参考视频的顺序来指代主体。示例："Character1 sings on the roadside, Character2 dances beside it"
  对于 wan3.0-video 参考模式，请使用 'Image 1'、'Video 1'、'Audio 1' 等，来指代 media 数组中对应顺序的媒体资产。
</ParamField>

<ParamField body="input.reference_video_urls" type="string[]">
  仅用于 wan2.6-r2v 模型的参考视频 URL。由 1-3 个视频 URL 组成的数组。
  输入限制：

  * 格式：mp4、mov
  * 数量：1-3 个视频
  * 单个视频长度：2-30 秒
  * 单个文件大小：最大 30MB
  * 不能与 audio\_url 一起使用
    参考时长：单个视频最大 5 秒，两个视频各最大 2.5 秒，三个视频按比例更短。
    计费：按实际使用的参考时长计算。
</ParamField>

<ParamField body="input.template" type="string">
  视频效果模板名称。可选。目前支持：squish、flying、carousel。使用时，prompt 参数会被忽略。
</ParamField>

<ParamField body="model" type="string">
  要调用的模型 ID。在此组件上不受约束：Comfy Router 会从 `POST /v2/models/wan/{model}` 的 `{model}` 路径段填充它，因此 Router 调用方会省略该字段。直接对 `POST /proxy/wan/api/v1/services/aigc/video-generation/video-synthesis` 发起 v1 调用时则必须提供它，其可接受拼写的枚举定义在该操作自己的组件 `WanVideoGenerationRequest` 上。
</ParamField>

<ParamField body="parameters" type="object">
  视频处理参数
</ParamField>

<ParamField body="parameters.audio" type="boolean" default="true">
  是否为视频添加音频。仅支持 wan3.0-video 和 wan3.0-video-prime；提供商未为其他 wan 模型记录此类切换。
</ParamField>

<ParamField body="parameters.audio_setting" type="string" default="&#x22;auto&#x22;">
  wan2.7-videoedit 模型的视频音频设置。

  * auto（默认）：模型根据提示词内容智能判断
  * origin：强制保留输入视频中的原始音频

    可选值：`auto`、`origin`
</ParamField>

<ParamField body="parameters.duration" type="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`
</ParamField>

<ParamField body="parameters.prompt_extend" type="boolean" default="true">
  是否启用提示词智能改写。默认为 true
</ParamField>

<ParamField body="parameters.ratio" type="string">
  已生成视频的宽高比。仅适用于 wan2.7 和 wan3.0 模型。
  对于 wan2.7 模型，若未提供，则根据分辨率档位取默认值。
  对于 wan3.0-video，adaptive（默认值）会根据输入媒体的比例和意图自动推荐合适的宽高比。

  可选值：`adaptive`、`16:9`、`9:16`、`1:1`、`4:3`、`3:4`
</ParamField>

<ParamField body="parameters.resolution" type="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`
</ParamField>

<ParamField body="parameters.seed" type="integer">
  随机数种子，用于控制模型生成内容的随机性

  范围: `0` 到 `2147483647`
</ParamField>

<ParamField body="parameters.shot_type" type="string" default="&#x22;single&#x22;">
  智能多镜头控制。仅在启用 prompt\_extend 时生效。适用于 wan2.6 和 wan2.7-r2v 模型。

  * single: 单镜头视频（默认）
  * multi: 多镜头视频

    可选值: `multi`, `single`
</ParamField>

<ParamField body="parameters.size" type="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 仍必须是该代理针对该模型接受的值。在任何被 resolution 描述列为不支持 480P 的模型上，480P 的 size 都会返回 400。
</ParamField>

<ParamField body="parameters.watermark" type="boolean" default="false">
  是否添加水印标识，水印位于右下角
</ParamField>

由 Router 在 `GET /v2/models/wan/wan3.0-video/openapi.json` 提供的 schema 生成，该 schema 也是它在请求到达提供商之前用于校验调用的同一份文档。

### 输出

<ResponseField name="output" type="object" required />

<ResponseField name="output.actual_prompt" type="string">
  智能改写后的实际提示词（用于视频任务）
</ResponseField>

<ResponseField name="output.check_audio" type="string">
  带音频生成的 I2V 任务的音频 URL
</ResponseField>

<ResponseField name="output.code" type="string">
  失败请求的错误码（请求成功时不返回）
</ResponseField>

<ResponseField name="output.end_time" type="string">
  任务完成时间
</ResponseField>

<ResponseField name="output.message" type="string">
  失败请求的详细信息（请求成功时不返回）
</ResponseField>

<ResponseField name="output.orig_prompt" type="string">
  原始输入提示词（用于视频任务）
</ResponseField>

<ResponseField name="output.results" type="object[]">
  图像生成任务的结果列表
</ResponseField>

<ResponseField name="output.results[].actual_prompt" type="string">
  智能改写后的实际提示词（若已启用）
</ResponseField>

<ResponseField name="output.results[].code" type="string">
  图像错误码（部分任务失败时返回）
</ResponseField>

<ResponseField name="output.results[].message" type="string">
  图像错误信息（部分任务失败时返回）
</ResponseField>

<ResponseField name="output.results[].orig_prompt" type="string">
  原始输入提示词
</ResponseField>

<ResponseField name="output.results[].url" type="string">
  已生成图像的网址
</ResponseField>

<ResponseField name="output.scheduled_time" type="string">
  任务执行时间
</ResponseField>

<ResponseField name="output.submit_time" type="string">
  任务提交时间
</ResponseField>

<ResponseField name="output.task_id" type="string" required>
  任务 ID
</ResponseField>

<ResponseField name="output.task_metrics" type="object">
  图像生成任务的结果统计
</ResponseField>

<ResponseField name="output.task_metrics.FAILED" type="integer">
  失败的任务数
</ResponseField>

<ResponseField name="output.task_metrics.SUCCEEDED" type="integer">
  成功的任务数
</ResponseField>

<ResponseField name="output.task_metrics.TOTAL" type="integer">
  任务总数
</ResponseField>

<ResponseField name="output.task_status" type="string" required>
  任务状态

  可能的取值：`PENDING`、`RUNNING`、`SUCCEEDED`、`FAILED`、`CANCELED`、`UNKNOWN`
</ResponseField>

<ResponseField name="output.video_url" type="string">
  已完成的视频生成任务的视频 URL。链接有效期 24 小时
</ResponseField>

<ResponseField name="request_id" type="string" required>
  唯一的请求标识符
</ResponseField>

<ResponseField name="usage" type="object">
  输出信息统计。仅统计成功的结果
</ResponseField>

<ResponseField name="usage.SR" type="integer">
  视频分辨率等级（I2V 与 wan3.0-video 任务）
</ResponseField>

<ResponseField name="usage.duration" type="number">
  已生成视频的时长，单位为秒（I2V 与 wan3.0-video 任务）
</ResponseField>

<ResponseField name="usage.fps" type="integer">
  已生成视频的帧率（wan3.0-video 任务）
</ResponseField>

<ResponseField name="usage.image_count" type="integer">
  已生成图像的数量（T2I 与 I2I 任务）
</ResponseField>

<ResponseField name="usage.input_video_duration" type="number">
  输入视频的时长，单位为秒，无视频输入时为 0.0（wan3.0-video 任务）
</ResponseField>

<ResponseField name="usage.output_video_duration" type="number">
  输出视频的时长，单位为秒（wan3.0-video 任务）
</ResponseField>

<ResponseField name="usage.ratio" type="string">
  已生成视频的宽高比，例如 16:9（wan3.0-video 任务）
</ResponseField>

<ResponseField name="usage.size" type="string">
  图像分辨率（T2I 与 I2I 任务）
</ResponseField>

<ResponseField name="usage.video_count" type="integer">
  已生成视频的数量（T2V 任务）
</ResponseField>

<ResponseField name="usage.video_duration" type="number">
  已生成视频的时长，单位为秒（T2V 任务）
</ResponseField>

<ResponseField name="usage.video_ratio" type="string">
  视频分辨率比例（T2V 任务）
</ResponseField>

<ResponseField name="code" type="string">
  失败请求的错误码，在响应信封的根层级而非 `output` 下返回（请求成功时不返回）。
</ResponseField>

<ResponseField name="message" type="string">
  失败请求的详细信息，在响应信封的根层级而非 `output` 下返回（请求成功时不返回）。在回退到 `output.message` 之前请先读取此项。
</ResponseField>

## 示例

### 输入

```json theme={null}
{
  "input": {
    "prompt": "the robot lowers its raised arm and steps toward the camera, the flat orange backdrop holds steady",
    "media": [
      {
        "type": "first_frame",
        "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": "the robot lowers its raised arm and steps toward the camera, the flat orange backdrop holds steady",
    "actual_prompt": "the robot lowers its raised arm and steps toward the camera, the flat orange backdrop holds steady, smooth studio lighting, subtle camera push in",
    "video_url": "https://.../generated.mp4"
  },
  "request_id": "7574ee8f-38a3-4b1e-9280-11c33ab46e51",
  "usage": {
    "SR": 720,
    "duration": 5
  }
}
```

视频 URL 的有效期为 24 小时。如需保留视频，请及时下载。

## 发布前须知

SDK 会生成 `Idempotency-Key` 并在自动重试中复用它。手动重试时，请复用原始 key。Router 最长可保持连接 10 分钟。

请求失败时，Router 会发送 `X-Comfy-Error-Type` 响应头说明原因。`422` 表示 Router 在调用提供商之前就拒绝了输入，`413` 表示请求体超出了 Router 可接受的大小。已生成的资源请及时下载，因为[结果 URL 会过期](/zh/development/comfy-router/reference#结果资产)。

上文任何字段描述中提到的尺寸限制，都是提供商对该字段自身的限定，引自提供商的规范。Router 会对整个请求体另行设置上限，base64 编码的媒体内容也计入其中：参见[请求体大小](/zh/development/comfy-router/limitations)。

本页记录的是通过 Comfy Router 调用的某一个合作伙伴模型。同一个 `comfy-sdk` / `@comfyorg/sdk` 包还提供第二个客户端，用于在 Comfy Cloud 上运行完整的 ComfyUI 工作流图：`Comfy(api_key=...)` / `new Comfy({ apiKey })`，并带有 `client.workflows`、`client.assets` 和 `client.jobs`。请参阅 [Comfy SDKs](/zh/development/api-development/sdks)。

<CardGroup cols={3}>
  <Card title="请求头" icon="list" href="/zh/development/comfy-router/headers">
    身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
  </Card>

  <Card title="使用 Router API" icon="code" href="/zh/development/comfy-router/api">
    模型发现、验证错误、重试与计费。
  </Card>

  <Card title="限制" icon="triangle-exclamation" href="/zh/development/comfy-router/limitations">
    Router 目前不支持的功能，以及替代方案。
  </Card>
</CardGroup>


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