将 Meshy 5 与 Comfy Router 配合使用

meshy/meshy-5 的 API 参考，由 Comfy Router 从 Meshy 提供。 输入： 文本 · 输出： 3D

快速开始

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

等待结果
排队并稍后收集

from comfy_sdk import Comfy

# 从环境中读取 COMFY_API_KEY。
# SDK 会自动创建幂等键，并在自动重试时复用。
with Comfy() as client:
    result = client.models.run(
        "meshy/meshy-5",
        {
            "art_style": "realistic",
            "mode": "preview",
            "prompt": "a red cube",
        },
    )

print(result)

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

// 从环境中读取 COMFY_API_KEY。
// SDK 会自动创建幂等键，并在自动重试时复用。
const { data } = await comfy.models.run("meshy/meshy-5", {
  art_style: "realistic",
  mode: "preview",
  prompt: "a red cube",
});

console.log(data);

curl https://api.comfy.org/v2/models/meshy/meshy-5 \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"art_style\": \"realistic\", \"mode\": \"preview\", \"prompt\": \"a red cube\"}"

将相同的请求体发送到 POST https://api.comfy.org/v2/models/meshy/meshy-5/requests。运行被受理后，Router 会立即返回 201 和 request_id；结果就绪后，即可从本进程或其他进程收集。队列投递介绍了状态、取消与收集的完整流程。

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/meshy-5",
            {
                "art_style": "realistic",
                "mode": "preview",
                "prompt": "a red cube",
            },
        )
        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())

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

// 从环境中读取 COMFY_API_KEY。
// 每次 submit() 调用都会生成自己的 Idempotency-Key，并在自动重试时复用。
const handle = await comfy.models.submit("meshy/meshy-5", {
  art_style: "realistic",
  mode: "preview",
  prompt: "a red cube",
});
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);

# 1. 提交。Router 返回 201，并附带 request_id、status_url、response_url 和 cancel_url。
curl https://api.comfy.org/v2/models/meshy/meshy-5/requests \
  -H "X-API-Key: $COMFY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d "{\"art_style\": \"realistic\", \"mode\": \"preview\", \"prompt\": \"a red cube\"}"

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

# 3. 收集。返回 200 和模型的原始输出；仍在运行时返回 202 和状态响应体。
curl https://api.comfy.org/v2/models/meshy/meshy-5/requests/$REQUEST_ID \
  -H "X-API-Key: $COMFY_API_KEY"

Schema

输入

`preview` 变体

string

要运行的 Meshy 模型。在 Comfy Router 路由上，该值由路径（/v2/models/meshy/{model}）提供，可以省略或发送为 null；Router 会在验证之后将路径中的模型写入此处。在 v1 /proxy 路由上，请参见 MeshyTextTo3DPreviewRequest，它将此值约束为 MeshyAiModel。

string

默认值:"\"realistic\""

描述你希望该物体呈现的艺术风格。可选值：realistic、sculpture

string

默认值:"\"standard\""

已生成网格的几何分辨率。2k 和 4k 会运行 Ultra 通道，以获得更精细的表面细节。2k 和 4k 要求 ai_model 为 meshy-7.1 或 latest。可选值：standard、2k、4k

boolean

默认值:"false"

弃用。请改用 pose_mode。是否以 A/T 姿势生成模型。

string

必填

创建预览任务时，此字段应设为 “preview”。可选值：preview

boolean

默认值:"false"

当为 true 时，输入内容会被筛查，以识别可能有害的内容。

string

指定已生成模型的姿势模式。可选值：a-pose、t-pose、“

string

必填

描述该 3D 模型是什么类型的物体。最多 800 个字符。

boolean

默认值:"false"

控制是否启用重网格（remesh）阶段。为 false 时，返回最高精度的三角网格。Meshy 5 默认为 true，Meshy 6 和 7 默认为 false。

string

默认值:"\"auto\""

控制模型生成过程中的对称行为。可选值：off、auto、on

integer

默认值:"30000"

指定已生成模型的目标多边形数量。有效范围为 100 到 300,000。范围：100 到 300000

string

默认值:"\"triangle\""

指定已生成模型的拓扑结构。可选值：quad、triangle

boolean

默认值:"false"

弃用。请改用 geometry_resolution；true 等效于 geometry_resolution 2k。仅在 ai_model 为 meshy-7、meshy-7.1 或 latest 时受支持。meshy-7 是例外：geometry_resolution 2k 要求 meshy-7.1 或 latest，因此在 meshy-7 上，将 ultra_mode 设为 true 才是请求 Ultra 通道的方式。

`refine` 变体

string

要运行的 Meshy 模型。在 Comfy Router 路由上，该值由路径（/v2/models/meshy/{model}）提供，可以省略或发送为 null；Router 会在验证之后将路径中的模型写入此处。在 v1 /proxy 路由上，请参见 MeshyTextTo3DRefineRequest，它将此值约束为 MeshyAiModel。

boolean

默认值:"false"

在基础颜色之外，额外生成 PBR 贴图（金属度、粗糙度、法线）。注意，使用 Sculpture 风格时，enable_pbr 应设为 false。

string

必填

创建 refine 任务时，此字段应设为 “refine”。可选值：refine

boolean

默认值:"false"

当为 true 时，输入内容会被筛查，以识别可能有害的内容。

string

必填

对应的预览任务 ID。指定的预览任务状态必须为 SUCCEEDED。

string

提供一张 2D 图像来引导贴图生成过程。支持 .jpg、.jpeg、.png 格式，或 base64 编码的 data URI。

string

提供一个额外的文本提示词来引导贴图生成过程。最多 800 个字符。

string

默认值:"\"2k\""

已生成纹理的纹理分辨率。可取 2k、4k 或 8k 之一。4k 和 8k 要求 ai_model 为 meshy-6、meshy-7、meshy-7.1 或 latest。可选值：2k、4k、8k

本文档根据 Router 在 GET /v2/models/meshy/meshy-5/openapi.json 提供的 schema 生成，Router 在请求到达提供商之前，正是依据同一份文档对调用进行验证。

输出

string

用于创建预览任务的未经修改的 art_style。

integer

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

integer

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

string

必填

任务的唯一标识符。

object

Meshy 生成的带纹理 3D 模型文件的可下载 URL。

string

FBX 文件的可下载 URL。

string

GLB 文件的可下载 URL。

string

MTL 文件的可下载 URL。

string

OBJ 文件的可下载 URL。

string

USDZ 文件的可下载 URL。

string

为向后兼容而保留的弃用字段。

integer

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

integer

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

string

用于创建任务的未经修改的提示词。

integer

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

string

必填

可能的值：SUCCEEDED

object

错误对象，在任务失败时包含报错信息。

string

详细的报错信息。

string

用于指导纹理贴图过程的纹理图像的可下载 URL。

string

在精修阶段为指导纹理贴图过程而提供的额外文本提示词。

string

为向后兼容而保留的弃用字段。

object[]

由该任务生成的纹理 URL 对象数组。

string

基础颜色贴图图像的可下载 URL。

string

金属度贴图图像的可下载 URL。

string

法线贴图图像的可下载 URL。

string

粗糙度贴图图像的可下载 URL。

string

模型文件缩略图图像的可下载 URL。

string

Text to 3D 任务的类型。可能的值：text-to-3d-preview、text-to-3d-refine

string

返回预览视频可下载 URL 的弃用字段。

示例

输入

{
  "art_style": "realistic",
  "mode": "preview",
  "prompt": "a red cube"
}

输出

{
  "art_style": "realistic",
  "created_at": 1767225600000,
  "finished_at": 1767225719000,
  "id": "018f2c7a-4b1e-7c3d-9a05-6e2f8b41d0c9",
  "model_urls": {
    "fbx": "https://example.invalid/meshy/text-to-3d/model.fbx",
    "glb": "https://example.invalid/meshy/text-to-3d/model.glb",
    "mtl": "https://example.invalid/meshy/text-to-3d/model.mtl",
    "obj": "https://example.invalid/meshy/text-to-3d/model.obj",
    "usdz": "https://example.invalid/meshy/text-to-3d/model.usdz"
  },
  "progress": 100,
  "prompt": "a red cube",
  "started_at": 1767225601000,
  "status": "SUCCEEDED",
  "thumbnail_url": "https://example.invalid/meshy/text-to-3d/thumbnail.png",
  "type": "text-to-3d-preview"
}

发布前须知

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。

请求头

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

使用 Router API

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

限制

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

使用 Comfy 开发

运行工作流

Comfy Router

Comfy CLI

规范

Demo Apps

将 Meshy 5 与 Comfy Router 配合使用

快速开始

Schema

输入

`preview` 变体

`refine` 变体

输出

示例

输入

输出

发布前须知

请求头

使用 Router API

限制

​快速开始

​Schema

​输入

​preview 变体

​refine 变体

​输出

​示例

​输入

​输出

​发布前须知

请求头

使用 Router API

限制

快速开始

Schema

输入

`preview` 变体

`refine` 变体

输出

示例

输入

输出

发布前须知