通过 Comfy Router 使用 Rigging

meshy/rigging 的 API 参考，由 Comfy Router 提供，来自 Meshy。

快速开始

在你的 Comfy 工作区中创建一个密钥，并将其导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK（pip install comfy-sdk、npm install @comfyorg/sdk）；cURL 代码片段则是通过原始 HTTP 发起的相同调用。 模型 ID： meshy/rigging 端点： POST https://api.comfy.org/v2/models/meshy/rigging

Wait for the result
Queue and collect later

from comfy_sdk import Comfy

# Reads COMFY_API_KEY from the environment.
# The SDK automatically creates an idempotency key and reuses it for automatic retries.
with Comfy() as client:
    result = client.models.run(
        "meshy/rigging",
        {
            "height_meters": 1.8,
            "input_task_id": "0193abcd-0000-0000-0000-000000000000",
        },
    )

print(result)

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

// Reads COMFY_API_KEY from the environment.
// The SDK automatically creates an idempotency key and reuses it for automatic retries.
const { data } = await comfy.models.run("meshy/rigging", {
  height_meters: 1.8,
  input_task_id: "0193abcd-0000-0000-0000-000000000000",
});

console.log(data);

curl https://api.comfy.org/v2/models/meshy/rigging \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"height_meters\": 1.8, \"input_task_id\": \"0193abcd-0000-0000-0000-000000000000\"}"

from comfy_sdk import Comfy

# Reads COMFY_API_KEY from the environment.
# Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
with Comfy() as client:
    handle = client.models.submit(
        "meshy/rigging",
        {
            "height_meters": 1.8,
            "input_task_id": "0193abcd-0000-0000-0000-000000000000",
        },
    )
    print("request_id:", handle.request_id)  # with the model ID, all another process needs

    # Poll until the request completes, waiting the Retry-After the server names.
    for update in handle.iter_events():
        print(update.status, update.queue_position)

    # The provider's own payload, the same value models.run() returns.
    # A request that failed or was cancelled raises the typed Router error here.
    result = handle.get()

print(result)

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

// Reads COMFY_API_KEY from the environment.
// Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
const handle = await comfy.models.submit("meshy/rigging", {
  height_meters: 1.8,
  input_task_id: "0193abcd-0000-0000-0000-000000000000",
});
console.log("requestId:", handle.requestId); // with the model ID, all another process needs

// Poll until the request completes, waiting the Retry-After the server names.
for await (const update of handle.events()) {
  console.log(update.status, update.queuePosition);
}

// The same result models.run() returns. A request that failed or was cancelled rejects here.
const result = await handle.get();

console.log(result.data);

# 1. Submit. Router answers 201 with request_id, status_url, response_url and cancel_url.
curl https://api.comfy.org/v2/models/meshy/rigging/requests \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"height_meters\": 1.8, \"input_task_id\": \"0193abcd-0000-0000-0000-000000000000\"}"

# 2. Poll until status is COMPLETED, waiting the Retry-After seconds each response names.
REQUEST_ID="<request_id from the 201 body>"
curl -i https://api.comfy.org/v2/models/meshy/rigging/requests/$REQUEST_ID/status \
  -H "X-API-Key: $COMFY_API_KEY"

# 3. Collect. 200 with the model's native output, 202 with the status body while it is still running.
curl https://api.comfy.org/v2/models/meshy/rigging/requests/$REQUEST_ID \
  -H "X-API-Key: $COMFY_API_KEY"

Schema

输入

number

默认值:"1.7"

角色模型的大致高度，单位为米。必须为正数。范围：0 到 …

string

需要进行绑定的输入任务。如果未提供 model_url，则此项必填。

string

可公开访问的 URL 或 Data URI，指向带纹理的人形 GLB 文件。如果未提供 input_task_id，则此项必填。

string

模型的 UV 展开基础颜色纹理图像。可公开访问的 URL 或 Data URI。支持 .png 格式。

根据 Router 在 GET /v2/models/meshy/rigging/openapi.json 提供的 schema 生成，这也是请求到达提供商之前，Router 用于校验调用的同一份文档。

输出

integer

任务创建时的时间戳，单位为毫秒。格式：int64

integer

任务结果过期时的时间戳，单位为毫秒。格式：int64

integer

任务完成时的时间戳，单位为毫秒。未完成时为 0。格式：int64

string

必填

任务的唯一标识符。

integer

前置任务的数量。仅在状态为 PENDING 时才有意义。

integer

任务进度（0-100）。未开始时为 0，成功时为 100。范围：0 到 100

object

如果任务 SUCCEEDED，则包含输出资产 URL。

object

包含默认动画的 URL。

string

奔跑动画骨架的 GLB 格式下载 URL。

string

奔跑动画的 FBX 格式下载 URL（含蒙皮）。

string

奔跑动画的 GLB 格式下载 URL（含蒙皮）。

string

行走动画骨架的 GLB 格式下载 URL。

string

行走动画的 FBX 格式下载 URL（含蒙皮）。

string

行走动画的 GLB 格式下载 URL（含蒙皮）。

string

绑定后角色的 FBX 格式下载 URL。

string

绑定后角色的 GLB 格式下载 URL。

integer

任务开始时间的时间戳，单位为毫秒。未开始时为 0。格式：int64

string

必填

可能的值：SUCCEEDED

object

如果任务失败，则包含报错信息的错误对象。

string

详细的报错信息。

string

绑定任务的类型。可能的值：rig

示例

输入

{
  "height_meters": 1.8,
  "input_task_id": "0193abcd-0000-0000-0000-000000000000"
}

输出

{
  "created_at": 1767225600000,
  "expires_at": 1767830400000,
  "finished_at": 1767225712000,
  "id": "018f2c7a-4b1e-7c3d-9a05-6e2f8b41d0c9",
  "progress": 100,
  "result": {
    "basic_animations": {
      "running_glb_url": "https://example.invalid/meshy/rigging/running.glb",
      "walking_glb_url": "https://example.invalid/meshy/rigging/walking.glb"
    },
    "rigged_character_fbx_url": "https://example.invalid/meshy/rigging/character.fbx",
    "rigged_character_glb_url": "https://example.invalid/meshy/rigging/character.glb"
  },
  "started_at": 1767225601000,
  "status": "SUCCEEDED",
  "type": "rig"
}

发布前须知

SDK 会生成 Idempotency-Key 并在自动重试中复用它。手动重试时，请复用原始 key。Router 最长可保持连接 10 分钟。请求失败时，Router 会发送 X-Comfy-Error-Type 响应头说明原因。422 表示 Router 在调用提供商之前就拒绝了输入。生成的资源请及时下载，因为结果链接会过期。

请求头

身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。

使用 Router API

模型发现、校验错误、重试与计费。

限制

Router 目前不支持的功能，以及替代方案。

使用 Comfy 开发

运行工作流

Comfy Router

Comfy CLI

规范

通过 Comfy Router 使用 Rigging

快速开始

Schema

输入

输出

示例

输入

输出

发布前须知

请求头

使用 Router API

限制

​快速开始

​Schema

​输入

​输出

​示例

​输入

​输出

​发布前须知

请求头

使用 Router API

限制

快速开始

Schema

输入

输出

示例

输入

输出

发布前须知