> ## 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 2.7 Video Edit

> 用于通过 Comfy Router 以 HTTP 方式调用 wan/wan2.7-videoedit 的 Python、TypeScript 和 cURL 代码片段，以及请求字段和结果结构

Wan 2.7 视频编辑的 API 参考。Wan 2.7 视频编辑可根据文本指令重写已有的视频片段，并可选地由参考图像进行引导。

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

## 快速开始

在[你的 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-videoedit`

**端点：** `POST https://api.comfy.org/v2/models/wan/wan2.7-videoedit`

<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/wan2.7-videoedit",
                  {
                      "input": {
                          "prompt": "restyle the clip as a hand-drawn ink sketch, keep the dancer's movement unchanged",
                          "media": [
                              {
                                  "type": "video",
                                  "url": "https://raw.githubusercontent.com/Comfy-Org/workflow_templates/main/input/street_dancer.mp4",
                              },
                          ],
                      },
                      "parameters": {
                          "resolution": "720P",
                          "audio_setting": "origin",
                      },
                  },
              )

          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-videoedit", {
        input: {
          prompt: "restyle the clip as a hand-drawn ink sketch, keep the dancer's movement unchanged",
          media: [
            {
              type: "video",
              url: "https://raw.githubusercontent.com/Comfy-Org/workflow_templates/main/input/street_dancer.mp4",
            },
          ],
        },
        parameters: {
          resolution: "720P",
          audio_setting: "origin",
        },
      });
      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-videoedit \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"input\": {\"prompt\":\"restyle the clip as a hand-drawn ink sketch, keep the dancer's movement unchanged\",\"media\":[{\"type\":\"video\",\"url\":\"https://raw.githubusercontent.com/Comfy-Org/workflow_templates/main/input/street_dancer.mp4\"}]}, \"parameters\": {\"resolution\":\"720P\",\"audio_setting\":\"origin\"}}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="排队并稍后收集">
    同一个请求体,发送到 `POST https://api.comfy.org/v2/models/wan/wan2.7-videoedit/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/wan2.7-videoedit",
                  {
                      "input": {
                          "prompt": "restyle the clip as a hand-drawn ink sketch, keep the dancer's movement unchanged",
                          "media": [
                              {
                                  "type": "video",
                                  "url": "https://raw.githubusercontent.com/Comfy-Org/workflow_templates/main/input/street_dancer.mp4",
                              },
                          ],
                      },
                      "parameters": {
                          "resolution": "720P",
                          "audio_setting": "origin",
                      },
                  },
              )
              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-videoedit", {
        input: {
          prompt: "restyle the clip as a hand-drawn ink sketch, keep the dancer's movement unchanged",
          media: [
            {
              type: "video",
              url: "https://raw.githubusercontent.com/Comfy-Org/workflow_templates/main/input/street_dancer.mp4",
            },
          ],
        },
        parameters: {
          resolution: "720P",
          audio_setting: "origin",
        },
      });
      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/wan2.7-videoedit/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"input\": {\"prompt\":\"restyle the clip as a hand-drawn ink sketch, keep the dancer's movement unchanged\",\"media\":[{\"type\":\"video\",\"url\":\"https://raw.githubusercontent.com/Comfy-Org/workflow_templates/main/input/street_dancer.mp4\"}]}, \"parameters\": {\"resolution\":\"720P\",\"audio_setting\":\"origin\"}}"

      # 2. 轮询直到状态为 COMPLETED,按每个响应指定的 Retry-After 秒数等待。
      REQUEST_ID="<request_id from the 201 body>"
      curl -i https://api.comfy.org/v2/models/wan/wan2.7-videoedit/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

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

## Schema

### 输入

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

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

<ParamField body="input.img_url" type="string">
  首帧图像 URL 或 Base64 编码数据。wan2.5-i2v-preview 和 wan2.6-i2v 模型必填。
  happyhorse-1.x 的 i2v 拼写不在此处接收其首帧，而是将其作为类型为 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，可以是公开 URL 或 data:\{MIME\_type};base64,... URL。
    driving\_audio（WAV/MP3，2-30 秒，最大 15MB）和 first\_clip（MP4/MOV，2-10
    秒，每边 240-4096 像素，最大 100MB）：公开 HTTP/HTTPS URL；不接受内联
    data: URL。
  * wan2.7-r2v: first\_frame（可选，最多 1 个）、reference\_image、reference\_video。至少
    需要一个 reference\_image 或 reference\_video，且参考图像加上
    参考视频总计最多 5 个。first\_frame 和 reference\_image：JPEG/JPG/PNG/BMP/WEBP
    （不含 alpha 通道），每边 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 秒，
    每边 240-4096 像素，最大 100MB，公开 HTTP/HTTPS URL；不接受内联 data: URL）
    外加可选的 0 到 4 个 reference\_image（JPEG/JPG/PNG/BMP/WEBP，
    每边 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 个片段，总时长 \<= 15s）、
    reference\_audio（最多 5 个片段，总时长 \<= 15s）、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，可以是公开 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:
    文生视频操作。其对应的合作伙伴参考文档未记录任何 media 输入，因此请
    不要设置此字段。
  * wan2.5-i2v-preview, wan2.6-i2v, wan2.6-r2v: 本组件未为这些拼写枚举任何 media
    词汇。wan2.5-i2v-preview 和 wan2.6-i2v 在 img\_url 中接收其首
    帧；wan2.6-r2v 在 reference\_video\_urls 中接收其参考片段。
    上述按模型的计数是合作伙伴的约束，而不是本 schema 的约束：media 上没有
    声明 minItems/maxItems，因为可接受的类型及其上限因模型而异。schema 接受
    并不意味着提供商接受；反过来说，上文按资产给出的“至多 20MB”数值（图像
    输入的上限，也是唯一可以内联发送的输入）是合作伙伴对其最终收到的
    资产设定的上限；当资产是公开 URL 时，这些限制按字面适用，
    因为那些字节从不经过 Comfy。内联的 data:\{MIME\_type};base64,...
    URL 确实会经过 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。这些模型上的任何视频、音频、文件或 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' 等按媒体数组中对应的顺序指代媒体资产。
</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 时也返回 400（无论以 resolution 还是 480P 的 size 形式传入）。

    可选值：`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 仍必须是该代理为该模型接受的值。若 size 为 480P，则在分辨率说明中列为不支持 480P 的每个模型上都会返回 400。
</ParamField>

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

本文档根据 Router 在 `GET /v2/models/wan/wan2.7-videoedit/openapi.json` 提供的 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": "restyle the clip as a hand-drawn ink sketch, keep the dancer's movement unchanged",
    "media": [
      {
        "type": "video",
        "url": "https://raw.githubusercontent.com/Comfy-Org/workflow_templates/main/input/street_dancer.mp4"
      }
    ]
  },
  "parameters": {
    "resolution": "720P",
    "audio_setting": "origin"
  }
}
```

### 输出

```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": "restyle the clip as a hand-drawn ink sketch, keep the dancer's movement unchanged",
    "actual_prompt": "restyle the clip as a hand-drawn ink sketch, keep the dancer's movement unchanged, monochrome linework on paper texture",
    "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.