lowpoly 将于 2026年10月30日 下线。 meshy-7 作为 3D 生成模型将于 2026年12月31日 下线;作为贴图模型仍可使用。 请在这些日期前切换模型,以免请求报错。 查看所有弃用信息

Retexture API

根据文本 prompt 或参考图像,为现有的 3D 模型生成新的纹理。该模型可以来自另一个 Meshy 任务,也可以来自模型文件。


POST/openapi/v1/retexture

创建 Retexture 任务

创建一个 Retexture 任务。该任务在后台运行。关于任务通常需要多长时间,请参阅处理时间。

Request

POST
/openapi/v1/retexture
# Retexture with text prompt
curl https://api.meshy.ai/openapi/v1/retexture \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "model_url": "https://cdn.meshy.ai/model/example_model_2.glb",
    "text_style_prompt": "red fangs, Samurai outfit that fused with japanese batik style",
    "enable_original_uv": true,
    "enable_pbr": true
  }'

# Retexture with image style and PBR
curl https://api.meshy.ai/openapi/v1/retexture \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "model_url": "https://cdn.meshy.ai/model/example_model_2.glb",
    "image_style_url": "<your publicly accessible image url or base64-encoded data URI>",
    "ai_model": "latest",
    "enable_pbr": true,
    "enable_original_uv": true
  }'

# Retexture with Meshy N1 from front and back views
curl https://api.meshy.ai/openapi/v1/retexture \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "model_url": "https://cdn.meshy.ai/model/example_model_2.glb",
    "ai_model": "meshy-n1",
    "multiview_image_urls": [
      "<your front view image url or data URI>",
      "<your back view image url or data URI>"
    ]
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

参数

  • Name
    input_task_id
    Type
    string
    必选
    Description

    除非你发送 model_url,否则此参数为必填项。产出了待处理 3D 模型的任务的 ID,例如 Text to 3D、Image to 3D、Remesh 或 Retexture 任务。该任务必须是你通过 API 创建、且状态为 SUCCEEDED 的任务。Meshy 会为该任务的 GLB 生成 texture。

    使用 meshy-n1 时,该任务的模型最多可包含 7,999,999 个面(以三角形计数,一个四边形计为 2 个)。

  • Name
    model_url
    Type
    string
    必选
    Description

    除非你发送 input_task_id,否则此参数为必填项。要添加 texture 的模型,可以是公开 URL 或 data URI。如果两者都发送,Meshy 会使用 input_task_id。

    该模型必须是 GLB、glTF、OBJ、FBX 或 STL 文件,若通过 http 或 https URL 提供,大小不超过 400 MB;若作为 data URI 提供,不超过 100 MB。对于 data URI,请使用 MIME type application/octet-stream,例如 data:application/octet-stream;base64,<你的 base64 编码模型数据>。

    超过 100 MB 的文件还必须遵循以下规则:

    • GLB、glTF、FBX 或 OBJ 文件最多可包含 10,000,000 个面。Meshy 以三角形计数面,因此一个四边形计为 2 个,且被多次绘制的 mesh 每个副本计一次。
    • FBX 文件必须是 7.1 或更高版本的二进制 FBX。
    • GLB 或 glTF 文件不得使用 Draco 压缩。

    使用 meshy-n1 时,无论文件大小如何,模型最多可包含 7,999,999 个面(以三角形计数,一个四边形计为 2 个)。

请发送以下三种样式输入之一。

  • Name
    text_style_prompt
    Type
    string
    必选
    Description

    除非你发送 image_style_url 或 multiview_image_urls,否则此参数为必填项。描述你想要的 texture 的文本,最多 800 个字符。文本过长会返回 400。使用 meshy-n1 时,若不同时发送 image_style_url,发送该参数会返回 400。

  • Name
    image_style_url
    Type
    string
    必选
    Description

    除非你发送 text_style_prompt 或 multiview_image_urls,否则此参数为必填项。texture 所遵循风格的 2D 图像,可以是公开 URL 或 data URI(data:image/jpeg;base64,<你的 base64 编码图像数据>)。如果同时发送 text_style_prompt 和 image_style_url,Meshy 会使用 image_style_url。

    图像必须是 .jpg、.jpeg、.png 或 .webp 文件,大小不超过 20 MB,且每边至少为 32 像素。

    当图像中的物体与模型形状差异很大时,texture 可能无法很好地贴合。使用 meshy-n1 时,Meshy 会将该图像视为正面视图。

  • Name
    multiview_image_urls
    Type
    string[]
    必选
    Description

    除非你发送 text_style_prompt 或 image_style_url,否则此参数为必填项。同一物体从不同视角拍摄的一到四张图像。第一张图像是主(正面)视图。其他视图(左、后、右)的顺序不重要。空数组或超过四张图像会返回 400。

    每张图像都遵循与 image_style_url 相同的格式和大小规则,每张图像最多 20 MB。你不能将 multiview_image_urls 与 text_style_prompt 或 image_style_url 一起使用。

    multiview_image_urls 需要显式指定 ai_model 为 meshy-7 或 meshy-n1。使用其他任何 ai_model(包括默认值 latest)都会返回 400。

  • Name
    ai_model
    Type
    string
    默认值 latest
    Description

    生成 texture 所用的 AI 模型。

    可用值:

    • meshy-6-lite
    • meshy-6
    • meshy-7
    • meshy-n1:仅根据参考图像生成 2K 基础色 texture。不支持文本 prompt、不生成 PBR 贴图,也不支持 4K 或 8K。最多 7,999,999 个面。
    • latest:Meshy 7
  • Name
    enable_original_uv
    Type
    boolean
    默认值 false
    Description

    是否保留模型的 UV 布局,而不生成新的布局。

    • 对于 Meshy 生成的模型,无论是来自 input_task_id 还是指向 Meshy 输出结果的 model_url,使用 true 可复用其已优化的 UV 布局。
    • 对于你从其他地方上传的模型,若其 UV 已经良好,使用 true 以保留它们。保持 false 可让 Meshy 生成新的 UV,这适用于没有合适 UV 映射的模型。
  • Name
    enable_pbr
    Type
    boolean
    默认值 false
    Description

    是否在生成基础色的同时也生成 PBR 贴图(金属度、粗糙度和法线)。使用 meshy-6 时,Meshy 还会生成一张自发光贴图,但在 texture_resolution 为 8k 时除外。meshy-6-lite、meshy-7 和 latest 不会生成自发光贴图。使用 meshy-n1 时,设为 true 会返回 400。

  • Name
    texture_resolution
    Type
    string
    默认值 2k
    Description

    基础色 texture 的尺寸。分辨率越高,捕捉到的表面细节越多。

    可用值:

    • 2k:2048 × 2048 像素
    • 4k:4096 × 4096 像素
    • 8k:8192 × 8192 像素

    4k 和 8k 需要 ai_model 为 meshy-6、meshy-7 或 latest。使用 meshy-6-lite 或 meshy-n1 时会返回 400。在 8k 下,Meshy 不会生成自发光贴图。

  • Name
    hd_texture
    Type
    boolean
    ⚠ 已弃用
    默认值 false
    Description

    请改用 texture_resolution。true 等同于 texture_resolution: "4k"。如果两者都发送,Meshy 会使用 texture_resolution。

  • Name
    remove_lighting
    Type
    boolean
    默认值 true
    Description

    是否从基础色 texture 中移除高光和阴影。该效果在你自己的光照下表现更好。

    Meshy 仅在 meshy-6、且 texture_resolution 为 2k 或 4k 时应用此参数。使用 meshy-7 或 latest,或在 8k 下,Meshy 会接受该参数但忽略它。使用 meshy-6-lite 或 meshy-n1 时,无论发送什么值都会返回 400。

  • Name
    target_formats
    Type
    string[]
    Description

    要生成的文件格式。Meshy 只会生成你列出的格式,这可以缩短任务时间。如果省略该参数,Meshy 会生成除 3mf 之外的所有格式。

    可用值:

    • glb
    • obj
    • fbx
    • stl
    • usdz
    • 3mf
  • Name
    alpha_thumbnail
    Type
    boolean
    默认值 false
    Description

    是否同时渲染一张带透明背景(RGBA)的预览图,在获取任务时通过 alpha_thumbnail_url 返回。thumbnail_url 不会改变。

返回值

响应的 result 字段保存新建 Retexture 任务的 ID。

失败模式

  • Name
    400 - Bad Request
    Description

    请求无法运行。错误消息会说明发现的问题。例如:

    • 缺少参数:既未发送 model_url,也未发送 input_task_id。
    • 缺少样式:text_style_prompt、image_style_url 和 multiview_image_urls 均未发送。
    • 样式输入冲突:multiview_image_urls 与 text_style_prompt 或 image_style_url 一起发送。
    • 多视图不支持该模型:发送了 multiview_image_urls,但未显式指定 ai_model 为 meshy-7 或 meshy-n1。
    • Meshy N1 不支持该选项:meshy-n1 与 enable_pbr: true、remove_lighting、texture_resolution 为 4k 或 8k、未指定 texture_resolution 的 hd_texture: true,或没有 image_style_url 的 text_style_prompt 一起发送。
    • Meshy N1 三角形数量过多:使用 meshy-n1 时,3D 模型的三角形数量超过 7,999,999。请减少三角形数量,或使用其他 ai_model。
    • 模型对 Meshy N1 而言过于复杂:使用 meshy-n1 时,model_url 文件过于复杂,Meshy 无法统计其三角形数量。请减少三角形数量后再次发送该文件。
    • 三角形计数超时:使用 meshy-n1 时,统计 model_url 文件的三角形数量耗时过长。请重试,或减小模型大小。
    • 输入任务无效:input_task_id 不是受支持类型的成功任务。
    • 模型格式无效:model_url 文件的扩展名不受支持。
    • URL 不可访问:Meshy 无法下载 model_url 文件、image_style_url 图像或 multiview_image_urls 中的图像。
    • 模型文件过大:model_url 文件通过 http 或 https URL 提供时超过 400 MB,或作为 data URI 提供时超过 100 MB。
    • 面数过多:model_url 文件超过 100 MB 且面数超过 10,000,000。请减少面数后再次发送该文件。
    • ASCII FBX 超过 100 MB:model_url 文件是超过 100 MB 的 ASCII FBX。请将其作为二进制 FBX 或 GLB 发送。
    • 模型文件无法读取:model_url 文件超过 100 MB,且 Meshy 无法读取其头信息。例如,它是经过 Draco 压缩的 GLB 或 glTF,或是早于 7.1 版本的二进制 FBX。
    • 模型头信息过于复杂:model_url 文件超过 100 MB,且其头信息中包含过多需要检查的 mesh、节点或记录。请减少文件中的对象数量后再次发送。
    • 图像过大:image_style_url 图像或 multiview_image_urls 中的某张图像超过 20 MB。

    使用 meshy-n1 时,对于 Meshy 在任务开始前无法检查的模型(例如 STL 文件),此处不会拒绝该请求。如果该模型的三角形数量超过 7,999,999,任务将失败,Meshy 会退还相应的积分。

    请修正请求后再次发送。参见 Errors。

  • Name
    401 - Unauthorized
    Description

    API key 缺失或无效。请检查 Authorization 请求头。

  • Name
    402 - Payment Required
    Description

    例如:

    • 积分不足:账户没有足够的积分来完成此任务,或账户已达到积分限额。请检查你的积分余额,然后重试。
    • 免费套餐:创建任务需要付费套餐。请在订阅设置中升级你的套餐,然后重试。
  • Name
    403 - Forbidden
    Description

    以下情况之一:

    • 内容审核拦截了该 prompt 或某张输入图像。请更改输入内容,然后重试。
    • input_task_id 是一个浮雕模型,该 endpoint 无法对其进行 Retexture。错误消息为 This model type does not support this operation。请发送其他模型。
  • Name
    404 - Not Found
    Description

    input_task_id 与你的任何任务都不匹配。请检查任务 ID,然后重新发送请求。

  • Name
    429 - Too Many Requests
    Description

    你超出了速率限制。请稍候后重试。参见速率限制。


GET/openapi/v1/retexture/:id

获取 Retexture 任务

根据 ID 返回一个 Retexture 任务。

Request

GET
/openapi/v1/retexture/018a210d-8ba4-705c-b111-1f1776f7f578
curl https://api.meshy.ai/openapi/v1/retexture/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "retexture",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "text_style_prompt": "red fangs, Samurai outfit that fused with japanese batik style",
  "texture_image_url": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX"
    }
  ],
  "task_error": null,

  "consumed_credits": 10
}

参数

  • Name
    id
    Type
    path
    Description

    创建响应中返回的任务 ID。

返回值

Retexture 任务对象。


DELETE/openapi/v1/retexture/:id

删除 Retexture 任务

永久删除一个 Retexture 任务,包括其模型和数据。删除后无法撤销。

Request

DELETE
/openapi/v1/retexture/a43b5c6d-7e8f-901a-234b-567c890d1e2f
curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/retexture/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS. The task keeps running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}

路径参数

  • Name
    id
    Type
    path
    Description

    要删除的任务的 ID。

任务状态

删除一个 PENDING 任务会退还创建该任务时所使用的积分。

IN_PROGRESS 任务无法被删除。该请求将返回 409 Conflict, 且任务会继续运行。对于已经开始的任务,Meshy 不会退还积分, 因此删除它会让你同时损失积分和结果。请等待任务达到 SUCCEEDED、FAILED 或 CANCELED 状态后再删除它。

删除处于最终状态(SUCCEEDED、FAILED 或 CANCELED)的任务 不会退还其积分。

返回值

当任务被删除时返回 200 OK;当任务处于 IN_PROGRESS 状态时返回 409 Conflict。


GET/openapi/v1/retexture

获取 Retexture 任务列表

返回你的 Retexture 任务列表。

Request

GET
/openapi/v1/retexture
curl https://api.meshy.ai/openapi/v1/retexture?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "retexture",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "text_style_prompt": "red fangs, Samurai outfit that fused with japanese batik style",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "expires_at": 1692771679037,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
        "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
        "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
        "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX"
      }
    ],
    "task_error": null,

    "consumed_credits": 10
  }
]

参数

  • Name
    page_num
    Type
    integer
    默认值 1
    Description

    要返回的页码,最大为 255。更大的值会返回 400。

  • Name
    page_size
    Type
    integer
    默认值 10
    Description

    每页的任务数量,最大为 100。

  • Name
    sort_by
    Type
    string
    Description

    排序方式。

    可用值:

    • +created_at:最早的排在前面
    • -created_at:最新的排在前面

返回值

一个分页的 Retexture 任务对象列表。


GET/openapi/v1/retexture/:id/stream

流式获取 Retexture 任务

以 Server-Sent Events (SSE) 的形式流式获取 Retexture 任务的更新。

Request

GET
/openapi/v1/retexture/018a210d-8ba4-705c-b111-1f1776f7f578/stream
curl -N https://api.meshy.ai/openapi/v1/retexture/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// These examples are shortened. Each event holds the full task object.
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 50,
  "status": "IN_PROGRESS"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "retexture",
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1692771650657,
  "started_at": 1692771667037,
  "finished_at": 1692771669037,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  },
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX"
    }
  ],
  "task_error": null,

  "consumed_credits": 10
}

参数

  • Name
    id
    Type
    path
    Description

    创建响应中返回的任务 ID。

返回

以 Server-Sent Events 形式返回的 Retexture 任务对象 流。

每个事件都包含完整的任务对象,其结构与 Get endpoint 返回的相同。当任务处于 PENDING 或 IN_PROGRESS 状态时,其结果字段尚无值。


The Retexture task object

一个 Retexture 任务对象描述了一次 3D 模型的 retexture 操作。它保存了任务的状态、进度,以及任务成功后的模型和 texture 文件。

属性

Example Retexture Task Model

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "retexture",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***"
  },
  "text_style_prompt": "red fangs, Samurai outfit that fused with japanese batik style",
  "image_style_url": "https://assets.meshy.ai/***/image/example_image.jpg?Expires=***",
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX"
    }
  ],
  "task_error": null,

  "consumed_credits": 10
}
  • Name
    id
    Type
    string
    Description

    任务 ID。请将其视为一个不透明的字符串,不要依赖其格式。

  • Name
    type
    Type
    string
    Description

    任务类型,始终为 retexture。

  • Name
    model_urls
    Type
    object
    Description

    带 texture 的 3D 模型的下载链接,每种文件格式对应一个。

    • Name
      glb
      Type
      string
      Description

      GLB 文件。

    • Name
      fbx
      Type
      string
      Description

      FBX 文件。

    • Name
      obj
      Type
      string
      Description

      OBJ 文件。

    • Name
      usdz
      Type
      string
      Description

      USDZ 文件。

    • Name
      mtl
      Type
      string
      Description

      MTL 文件。当模型带有 texture 时,Meshy 会随 OBJ 文件一起返回该文件。

    • Name
      stl
      Type
      string
      Description

      STL 文件。

    • Name
      3mf
      Type
      string
      Description

      3MF 文件。仅当 target_formats 包含 3mf 时才会出现。

  • Name
    text_style_prompt
    Type
    string
    Description

    你创建任务时使用的文本 prompt。

  • Name
    image_style_url
    Type
    string
    Description

    你创建任务时使用的风格图片。

  • Name
    multiview_image_urls
    Type
    string[]
    Description

    你创建任务时使用的多视图参考图片的下载链接。仅当你使用 multiview_image_urls 创建任务时才会出现。

  • Name
    thumbnail_url
    Type
    string
    Description

    模型 thumbnail 图片的下载链接。

  • Name
    alpha_thumbnail_url
    Type
    string
    Description

    thumbnail_url 的透明背景(RGBA)版本的下载链接。仅当你使用 alpha_thumbnail: true 创建任务,且 Meshy 渲染了透明预览图时才会出现。

  • Name
    progress
    Type
    integer
    Description

    任务完成的百分比。任务开始前为 0,成功后为 100。

  • Name
    started_at
    Type
    timestamp
    Description

    任务开始的时间,单位为 Unix 毫秒。任务开始前为 0。

  • Name
    created_at
    Type
    timestamp
    Description

    任务创建的时间,单位为 Unix 毫秒。

  • Name
    expires_at
    Type
    timestamp
    Description

    任务结果过期的时间,单位为 Unix 毫秒。

  • Name
    finished_at
    Type
    timestamp
    Description

    任务完成的时间,单位为 Unix 毫秒。任务完成前为 0。

  • Name
    status
    Type
    string
    Description

    任务状态,取值为 PENDING、IN_PROGRESS、SUCCEEDED、FAILED 或 CANCELED 之一。

  • Name
    texture_urls
    Type
    array
    Description

    生成的 texture 的下载链接,是一个对象数组。该数组通常只包含一个对象。每个对象包含以下字段:

    • Name
      base_color
      Type
      string
      Description

      基础颜色贴图的下载链接。

    • Name
      metallic
      Type
      string
      Description

      金属度贴图的下载链接。当你使用 enable_pbr: false 创建任务时,Meshy 不会返回该字段。

    • Name
      normal
      Type
      string
      Description

      法线贴图的下载链接。当你使用 enable_pbr: false 创建任务时,Meshy 不会返回该字段。

    • Name
      roughness
      Type
      string
      Description

      粗糙度贴图的下载链接。当你使用 enable_pbr: false 创建任务时,Meshy 不会返回该字段。

    • Name
      emission
      Type
      string
      Description

      自发光贴图的下载链接。当你使用以下任一条件创建任务时,Meshy 不会返回该字段:

      • enable_pbr: false
      • ai_model 为 meshy-6-lite、meshy-7 或 latest
      • texture_resolution: 8k
  • Name
    preceding_tasks
    Type
    integer
    Description

    队列中排在此任务之前的任务数量。仅在任务处于 PENDING 状态时出现;当值为 0 时该字段会被省略。

  • Name
    task_error
    Type
    object
    Description

    任务失败时的错误详情。请参阅Errors。

  • Name
    consumed_credits
    Type
    integer
    Description

    任务消耗的积分数量。当状态为 PENDING、IN_PROGRESS 或 SUCCEEDED 时出现。对于 FAILED 的任务,该值为 0,因为 Meshy 会在任务失败时退还积分。