将 Animations 与 Comfy Router 配合使用
通过 Comfy Router 调用 meshy/animations:端点、请求结构以及 Router 返回的响应。
将 Animations 与 Comfy Router 配合使用
通过 Comfy Router 调用 meshy/animations:端点、请求结构以及 Router 返回的响应。
meshy/animations 的 API 参考文档,由 Comfy Router 从 Meshy 提供。
输入: 3D · 输出: 3D
快速开始
在你的 Comfy 工作区中创建一个密钥,并将其导出为 COMFY_API_KEY。Python 和 TypeScript 代码片段使用 Comfy SDK(pip install comfy-sdk 和 npm install @comfyorg/sdk);cURL 代码片段则是通过原始 HTTP 发起的相同调用。
模型 ID: meshy/animations
端点: POST https://api.comfy.org/v2/models/meshy/animations
[tab] 等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境变量中读取 COMFY_API_KEY。 # SDK 会自动创建幂等键,并在自动重试时复用它。 with Comfy() as client: result = client.models.run( "meshy/animations", { "action_id": 92, "post_process": { "fps": 60, "operation_type": "change_fps", }, "rig_task_id": "0193abcd-0000-0000-0000-000000000000", }, ) print(result)``typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // SDK 会自动创建幂等键,并在自动重试时复用它。 const { data } = await comfy.models.run("meshy/animations", { action_id: 92, post_process: { fps: 60, operation_type: "change_fps", }, rig_task_id: "0193abcd-0000-0000-0000-000000000000", }); console.log(data);``bash cURL theme={null} curl https://api.comfy.org/v2/models/meshy/animations \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"action_id\": 92, \"post_process\": {\"fps\":60,\"operation_type\":\"change_fps\"}, \"rig_task_id\": \"0193abcd-0000-0000-0000-000000000000\"}"``
[tab] 排队并稍后收集 将相同的请求体发送到POST https://api.comfy.org/v2/models/meshy/animations/requests。运行被受理后,Router 会立即返回201和request_id;结果就绪后,可以从本进程或其他进程收集。状态、取消与收集的说明见 队列投递。 ``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( "meshy/animations", { "action_id": 92, "post_process": { "fps": 60, "operation_type": "change_fps", }, "rig_task_id": "0193abcd-0000-0000-0000-000000000000", }, ) 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(result) asyncio.run(main())``typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量中读取 COMFY_API_KEY。 // 每次 submit() 调用都会生成自己的 Idempotency-Key,并在自动重试时复用它。 const handle = await comfy.models.submit("meshy/animations", { action_id: 92, post_process: { fps: 60, operation_type: "change_fps", }, rig_task_id: "0193abcd-0000-0000-0000-000000000000", }); 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(); console.log(result.data);``bash cURL theme={null} # 1. 提交。Router 返回 201,并附带 request_id、status_url、response_url 和 cancel_url。 curl https://api.comfy.org/v2/models/meshy/animations/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"action_id\": 92, \"post_process\": {\"fps\":60,\"operation_type\":\"change_fps\"}, \"rig_task_id\": \"0193abcd-0000-0000-0000-000000000000\"}" # 2. 轮询直到状态为 COMPLETED,每次等待响应中指定的 Retry-After 秒数。 REQUEST_ID="<request_id from the 201 body>" curl -i https://api.comfy.org/v2/models/meshy/animations/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。返回 200 时附带模型的原生输出;仍在运行时返回 202 和状态响应体。 curl https://api.comfy.org/v2/models/meshy/animations/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY"``
Schema
输入
action\_id integer required
要应用的动画动作的标识符。
post\_process object
动画文件后处理的参数。
post\_process.fps integer (default: 30)
目标帧率。默认为 30。仅在 operation\_type 为 change\_fps 时适用。
可选值:24、25、30、60
post\_process.operation\_type string required
要执行的操作类型。
可选值:change_fps、fbx2usdz、extract_armature
rig\_task\_id string required
成功完成的绑定任务的 id(来自 POST /openapi/v1/rigging)。该任务中的角色将用于生成动画。
此内容由 Router 在 GET /v2/models/meshy/animations/openapi.json 提供的 schema 生成,与请求到达提供商之前用于校验调用的文档为同一份。
输出
created\_at integer
任务创建时的时间戳,单位为毫秒。
格式:int64
expires\_at integer
任务结果过期时的时间戳,单位为毫秒。
格式:int64
finished\_at integer
任务完成时的时间戳,单位为毫秒。未完成时为 0。
格式:int64
id string required
任务的唯一标识符。
preceding\_tasks integer
前置任务的数量。仅在状态为 PENDING 时有意义。
progress integer
任务进度(0-100)。
范围:0 到 100
result object
如果任务 SUCCEEDED,则包含输出的动画 URL。
result.animation\_fbx\_url string
FBX 格式动画的可下载 URL。
result.animation\_glb\_url string
GLB 格式动画的可下载 URL。
result.processed\_animation\_fps\_fbx\_url string
已更改 FPS 的 FBX 格式动画的可下载 URL。
result.processed\_armature\_fbx\_url string
处理后的 FBX 格式骨架的可下载 URL。
result.processed\_usdz\_url string
处理后的 USDZ 格式动画的可下载 URL。
started\_at integer
任务开始时的时间戳,单位为毫秒。未开始时为 0。
格式:int64
status string required
可选值:SUCCEEDED
task\_error object
如果任务失败,则包含报错信息的错误对象。
task\_error.message string
详细的报错信息。
type string
动画任务的类型。
可选值:animate
示例
输入
{
"action_id": 92,
"post_process": {
"fps": 60,
"operation_type": "change_fps"
},
"rig_task_id": "0193abcd-0000-0000-0000-000000000000"
}
输出
{
"created_at": 1767225600000,
"expires_at": 1767830400000,
"finished_at": 1767225648000,
"id": "018f2c7a-4b1e-7c3d-9a05-6e2f8b41d0c9",
"progress": 100,
"result": {
"animation_fbx_url": "https://example.invalid/meshy/animations/animation.fbx",
"animation_glb_url": "https://example.invalid/meshy/animations/animation.glb"
},
"started_at": 1767225601000,
"status": "SUCCEEDED",
"type": "animate"
}
发布前须知
SDK 会生成 Idempotency-Key 并在自动重试中复用它。手动重试时,请复用原始 key。Router 最长可保持连接 10 分钟。
请求失败时,Router 会发送 X-Comfy-Error-Type 响应头说明原因。422 表示 Router 在调用提供商之前就拒绝了输入,413 表示请求体超出了 Router 可接受的大小。已生成的资源请及时下载,因为结果 URL 会过期。
上文任何字段描述中提到的尺寸限制,都是提供商对该字段自身的限定,引自提供商的规范。Router 会对整个请求体另行设置上限,base64 编码的媒体内容也计入其中:参见请求体大小。
本页记录的是通过 Comfy Router 调用的某一个合作伙伴模型。同一个 comfy-sdk / @comfyorg/sdk 包还提供第二个客户端,用于在 Comfy Cloud 上运行完整的 ComfyUI 工作流图:Comfy(api_key=...) / new Comfy({ apiKey }),并带有 client.workflows、client.assets 和 client.jobs。请参阅 Comfy SDKs。
[card] 请求头 身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
[card] 使用 Router API 模型发现、验证错误、重试与计费。
[card] 限制 Router 目前不支持的功能,以及替代方案。