将 Meshy 7.1 与 Comfy Router 配合使用
通过 Comfy Router 调用 meshy/meshy-7.1:端点、请求结构以及 Router 返回的响应。
将 Meshy 7.1 与 Comfy Router 配合使用
通过 Comfy Router 调用 meshy/meshy-7.1:端点、请求结构以及 Router 返回的响应。
meshy/meshy-7.1 的 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-7.1
端点: POST https://api.comfy.org/v2/models/meshy/meshy-7.1
[tab] 等待结果 ``python Python theme={null} from comfy_sdk import Comfy # 从环境变量读取 COMFY_API_KEY。 # SDK 会自动创建幂等键,并在自动重试时复用它。 with Comfy() as client: result = client.models.run( "meshy/meshy-7.1", { "art_style": "realistic", "mode": "preview", "prompt": "a red cube", }, ) print(result)``typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量读取 COMFY_API_KEY。 // SDK 会自动创建幂等键,并在自动重试时复用它。 const { data } = await comfy.models.run("meshy/meshy-7.1", { art_style: "realistic", mode: "preview", prompt: "a red cube", }); console.log(data);``bash cURL theme={null} curl https://api.comfy.org/v2/models/meshy/meshy-7.1 \ -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\"}"``
[tab] 排队并稍后收集 相同的请求体,发送到POST https://api.comfy.org/v2/models/meshy/meshy-7.1/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/meshy-7.1", { "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())``typescript TypeScript theme={null} import { comfy } from "@comfyorg/sdk"; // 从环境变量读取 COMFY_API_KEY。 // 每次 submit() 调用都会生成自己的 Idempotency-Key,并在自动重试时复用它。 const handle = await comfy.models.submit("meshy/meshy-7.1", { 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() 返回的结果相同。失败或已取消的请求会在此处 reject。 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/meshy-7.1/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-7.1/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" # 3. 收集。完成时返回 200 及模型的原始输出,仍在运行时返回 202 及状态正文。 curl https://api.comfy.org/v2/models/meshy/meshy-7.1/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY"``
Schema
输入
preview 变体
ai\_model string
要运行的 Meshy 模型。在 Comfy Router 路由上,该值由路径提供(/v2/models/meshy/{model}),可以省略或传为 null;Router 在验证之后会将路径中的模型写入此处。在 v1 /proxy 路由上请参见 MeshyTextTo3DPreviewRequest,它将其约束为 MeshyAiModel。
art\_style string (default: "realistic")
描述你希望该物体呈现的艺术风格。
可选值:realistic、sculpture
geometry\_resolution string (default: "standard")
已生成网格的几何分辨率。2k 和 4k 会运行 Ultra 通道以获得更精细的表面细节。2k 和 4k 需要 ai\_model 为 meshy-7.1 或 latest。
可选值:standard、2k、4k
is\_a\_t\_pose boolean (default: false)
弃用。请改用 pose\_mode。是否以 A/T 姿势生成模型。
mode string required
创建 preview 任务时,此字段应设置为 "preview"。
可选值:preview
moderation boolean (default: false)
当为 true 时,输入内容将被筛查是否包含潜在有害内容。
pose\_mode string
指定已生成模型的姿势模式。
可选值:a-pose、t-pose、\\
prompt string required
描述该 3D 模型是什么类型的物体。最多 800 个字符。
should\_remesh boolean (default: false)
控制是否启用重网格化阶段。当为 false 时,返回最高精度的三角网格。Meshy 5 默认为 true,Meshy 6 和 7 默认为 false。
symmetry\_mode string (default: "auto")
控制模型生成期间的对称行为。
可选值:off、auto、on
target\_polycount integer (default: 30000)
指定已生成模型的目标多边形数量。有效范围为 100 到 300,000。
范围:100 到 300000
topology string (default: "triangle")
指定已生成模型的拓扑结构。
可选值:quad、triangle
ultra\_mode boolean (default: 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 变体
ai\_model string
要运行的 Meshy 模型。在 Comfy Router 路由上,该值由路径提供(/v2/models/meshy/{model}),可以省略或传为 null;Router 在验证之后会将路径中的模型写入此处。在 v1 /proxy 路由上请参见 MeshyTextTo3DRefineRequest,它将其约束为 MeshyAiModel。
enable\_pbr boolean (default: false)
除基础颜色外,还生成 PBR 贴图(metallic、roughness、normal)。注意在使用 Sculpture 风格时,enable\_pbr 应设置为 false。
mode string required
创建 refine 任务时,此字段应设置为 "refine"。
可选值:refine
moderation boolean (default: false)
当为 true 时,输入内容将被筛查是否包含潜在有害内容。
preview\_task\_id string required
对应的 preview 任务 id。所给 preview 任务的状态必须为 SUCCEEDED。
texture\_image\_url string
提供一张 2D 图像以引导贴图过程。支持 .jpg、.jpeg、.png 格式或 base64 编码的数据 URI。
texture\_prompt string
提供一段额外的文本提示词以引导贴图过程。最多 800 个字符。
texture\_resolution string (default: "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-7.1/openapi.json 提供的 schema 生成,该文档也是它在请求到达提供商之前用于验证调用的同一份文档。
输出
art\_style string
用于创建预览任务的未经修改的 art\_style。
created\_at integer
任务创建时的时间戳,单位为毫秒。
格式:int64
finished\_at integer
任务完成时的时间戳,单位为毫秒。如果未完成则为 0。
格式:int64
id string required
任务的唯一标识符。
model\_urls object
由 Meshy 生成的带纹理 3D 模型文件的可下载 URL。
model\_urls.fbx string
FBX 文件的可下载 URL。
model\_urls.glb string
GLB 文件的可下载 URL。
model\_urls.mtl string
MTL 文件的可下载 URL。
model\_urls.obj string
OBJ 文件的可下载 URL。
model\_urls.usdz string
USDZ 文件的可下载 URL。
negative\_prompt string
为向后兼容而保留的弃用字段。
preceding\_tasks integer
前面任务的数量。仅当 status 为 PENDING 时才有意义。
progress integer
任务的进度。未开始时为 0,成功时为 100。
范围:0 到 100
prompt string
用于创建任务的未经修改的提示词。
started\_at integer
任务启动时的时间戳,单位为毫秒。如果未启动则为 0。
格式:int64
status string required
可能的值:SUCCEEDED
task\_error object
如果任务失败,则包含报错信息的错误对象。
task\_error.message string
详细的报错信息。
texture\_image\_url string
用于指导纹理化过程的纹理图像的可下载 URL。
texture\_prompt string
在精修阶段为指导纹理化过程而提供的额外文本提示词。
texture\_richness string
为向后兼容而保留的弃用字段。
texture\_urls object[]
由该任务生成的纹理 URL 对象组成的数组。
texture\_urls\[].base\_color string
基础颜色贴图图像的可下载 URL。
texture\_urls\[].metallic string
金属度贴图图像的可下载 URL。
texture\_urls\[].normal string
法线贴图图像的可下载 URL。
texture\_urls\[].roughness string
粗糙度贴图图像的可下载 URL。
thumbnail\_url string
模型文件缩略图图像的可下载 URL。
type string
文本转 3D 任务的类型。
可能的值:text-to-3d-preview、text-to-3d-refine
video\_url 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。
[card] 请求头 身份验证、幂等性、请求 ID、错误分类、重试节奏、消费限额。
[card] 使用 Router API 模型发现、验证错误、重试与计费。
[card] 限制 Router 目前不支持的功能,以及替代方案。