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

快速开始

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

Schema

输入

preview 变体

string
要运行的 Meshy 模型。在 Comfy Router 路由上,该值由路径(/v2/models/meshy/{model})提供,可以省略或传为 null;Router 会在验证之后将路径中的模型写入此处。在 v1 /proxy 路由上请参见 MeshyTextTo3DPreviewRequest,它将该字段限制为 MeshyAiModel。
string
默认值:"\"realistic\""
描述你所期望的对象艺术风格。可选值:realisticsculpture
boolean
默认值:"false"
弃用。请改用 pose_mode。是否以 A/T 姿态生成模型。
string
必填
创建预览任务时,该字段应设置为 “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"
启用 Ultra 生成,以获得更高保真度的几何体以及更精细的表面细节。仅当 ai_model 为 meshy-7 或 latest 时受支持。

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
boolean
默认值:"false"
当为 true 时,输入内容将被筛查是否存在可能有害的内容。
string
必填
对应的预览任务 id。给定预览任务的状态必须为 SUCCEEDED。
string
提供一个 2D 图像来引导纹理生成过程。支持 .jpg、.jpeg、.png 格式或 base64 编码的数据 URI。
string
提供一个额外的文本提示来引导纹理生成过程。最多 600 个字符。
string
默认值:"\"2k\""
已生成纹理的纹理分辨率。可为 2k、4k 或 8k 之一。4k 和 8k 要求 ai_model 为 meshy-6、meshy-7 或 latest。可选值:2k4k8k
由 Router 在 GET /v2/models/meshy/meshy-5/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
前置任务的数量。仅在状态为 PENDING 时有意义。
integer
任务的进度。未开始时为 0,成功时为 100。范围:0100
string
用于创建任务的未经修改的 prompt。
integer
任务启动时的时间戳,单位为毫秒。未启动时为 0。格式:int64
string
必填
可能的值:SUCCEEDED
object
错误对象,包含任务失败时的报错信息。
string
详细的报错信息。
string
用于引导纹理化过程的纹理图像的可下载 URL。
string
在 refine 阶段提供的、用于引导纹理化过程的附加文本 prompt。
string
为向后兼容而保留的弃用字段。
object[]
由该任务生成的纹理 URL 对象组成的数组。
string
基础颜色贴图图像的可下载 URL。
string
金属度贴图图像的可下载 URL。
string
法线贴图图像的可下载 URL。
string
粗糙度贴图图像的可下载 URL。
string
模型文件缩略图图像的可下载 URL。
string
Text to 3D 任务的类型。可能的值:text-to-3d-previewtext-to-3d-refine
string
弃用字段,返回预览视频的可下载 URL。

示例

输入

输出

发布前须知

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

请求头

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

使用 Router API

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

限制

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