Skip to main content
meshy/meshy-7.1 的 API 参考,由 Comfy Router 从 Meshy 提供。

快速开始

你的 Comfy 工作区中创建一个密钥,并将其导出为 COMFY_API_KEY。Python、TypeScript 和 Swift 片段使用 Comfy SDK(pip install comfy-sdknpm install @comfyorg/sdk 以及 ComfySwiftSDK Swift 包);cURL 片段是同样的调用,只是走原始 HTTP。 模型 ID: meshy/meshy-7.1 端点: POST https://api.comfy.org/v2/models/meshy/meshy-7.1

Schema

输入

preview 变体

string
要运行的 Meshy 模型。在 Comfy Router 路由上,该值由路径提供(/v2/models/meshy/{model}),可以省略或传为 null;Router 在验证之后会将路径中的模型写入此处。在 v1 /proxy 路由上请参见 MeshyTextTo3DPreviewRequest,它将其约束为 MeshyAiModel。
string
默认值:"\"realistic\""
描述你希望该物体呈现的艺术风格。可选值:realisticsculpture
string
默认值:"\"standard\""
已生成网格的几何分辨率。2k 和 4k 会运行 Ultra 通道以获得更精细的表面细节。2k 需要 ai_model 为 meshy-7、meshy-7.1 或 latest;4k 需要 meshy-7.1 或 latest。可选值:standard2k4k
boolean
默认值:"false"
弃用。请改用 pose_mode。是否以 A/T 姿势生成模型。
string
必填
创建 preview 任务时,此字段应设置为 “preview”。可选值:preview
boolean
默认值:"false"
当为 true 时,输入内容将被筛查是否包含潜在有害内容。
string
指定已生成模型的姿势模式。可选值:a-poset-pose、“
string
必填
描述该 3D 模型是什么类型的物体。最多 600 个字符。
boolean
默认值:"true"
控制是否启用重网格(remesh)阶段。当为 false 时,返回最高精度的三角网格。
string
默认值:"\"auto\""
控制模型生成期间的对称行为。可选值:offautoon
integer
默认值:"30000"
指定已生成模型的目标多边形数量。有效范围为 100 到 300,000。范围:100300000
string
默认值:"\"triangle\""
指定已生成模型的拓扑结构。可选值:quadtriangle
boolean
默认值:"false"
弃用。请改用 geometry_resolution;是为时等同于 geometry_resolution 2k。仅当 ai_model 为 meshy-7、meshy-7.1 或 latest 时受支持。

refine 变体

string
要运行的 Meshy 模型。在 Comfy Router 路由上,该值由路径提供(/v2/models/meshy/{model}),可以省略或传为 null;Router 在验证之后会将路径中的模型写入此处。在 v1 /proxy 路由上请参见 MeshyTextTo3DRefineRequest,它将其约束为 MeshyAiModel。
boolean
默认值:"false"
除基础颜色外,还生成 PBR 贴图(metallic、roughness、normal)。注意在使用 Sculpture 风格时,enable_pbr 应设置为 false。
string
必填
创建 refine 任务时,此字段应设置为 “refine”。可选值:refine
boolean
默认值:"false"
当为 true 时,输入内容将被筛查是否包含潜在有害内容。
string
必填
对应的 preview 任务 id。所给 preview 任务的状态必须为 SUCCEEDED。
string
提供一张 2D 图像以引导贴图过程。支持 .jpg、.jpeg、.png 格式或 base64 编码的数据 URI。
string
提供一段额外的文本提示词以引导贴图过程。最多 600 个字符。
string
默认值:"\"2k\""
已生成纹理的纹理分辨率。为 2k、4k 或 8k 之一。4k 和 8k 需要 ai_model 为 meshy-6、meshy-7、meshy-7.1 或 latest。可选值:2k4k8k
根据 Router 在 GET /v2/models/meshy/meshy-7.1/openapi.json 提供的 schema 生成,该文档也是它在请求到达提供商之前用于验证调用的同一份文档。

输出

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。范围:0100
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
文本转 3D 任务的类型。可能的值:text-to-3d-previewtext-to-3d-refine
string
返回预览视频可下载 URL 的弃用字段。

示例

输入

输出

发布前须知

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.workflowsclient.assetsclient.jobs。请参阅 Comfy SDKs

请求头

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

使用 Router API

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

限制

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