Image to 3D API

Image to 3D API 是一项功能，允许您将 Meshy 的 Image to 3D 能力集成到您自己的应用程序中。在本节中，您将找到开始使用此 API 所需的全部信息。

POST/openapi/v1/image-to-3d

Create an Image to 3D Task

此 endpoint 允许你创建一个新的 Image to 3D 任务。参阅 The Image to 3D Task Object 以查看 Image to 3D 任务对象包含哪些属性。

参数

input_task_id 和 image_url 中只有一个是必需的。如果两者都提供，则 input_task_id 具有更高优先顺序。

Name
input_task_id
Type
string
必选
Description
已完成的图像生成任务的 ID，其输出将用作输入图像。该任务必须是以下任务之一：文字生成影像或影像生成影像。此外，该任务必须是通过 API 运行的，状态为 SUCCEEDED，并且只生成一张图像。

Name
image_url
Type
string
必选
Description
提供一张图像供 Meshy 用于模型创建。目前支持 .jpg、.jpeg 和 .png 格式。
提供图像的方式有两种：
- 可公开访问的 URL：可从公共互联网访问的 URL。
- Data URI：图像的 base64 编码的 data URI。Data URI 示例：data:image/jpeg;base64,<your base64-encoded image data>。

Name
model_type
Type
string
默认值 standard
Description
指定 3D 网格生成的类型。
可用值：
- standard：常规的高细节 3D 网格生成。
- smart-topology：搭配 ai_model（meshy-t2）选择 Smart Topology 模型。
- lowpoly（deprecated）：生成经过优化、多边形更简洁的 low-poly 网格。我们建议改用 smart-topology。
选择 smart-topology 时，将忽略 topology、should_remesh 和 save_pre_remeshed_model。
选择 lowpoly 时，将忽略 ai_model、topology、target_polycount、should_remesh 和 save_pre_remeshed_model。
Name
ai_model
Type
string
默认值 latest
Description
要使用的模型 ID。可用值取决于 model_type。
标准生成（model_type: standard）：
- meshy-6-lite、meshy-6、meshy-7.1、latest（Meshy 7.1）
- meshy-7（deprecated）：请改用 meshy-7.1。
Smart Topology 生成（model_type: smart-topology）：
- meshy-t2（默认）：Smart Topology 模型 —— 具有更简洁的 topology、原生分离的部件、三角形输出，以及可通过 target_polycount 设置的面数。
Name
geometry_resolution
Type
string
默认值 standard
Description
geometry 生成阶段。2k 以 2048³ 运行 Ultra 阶段；4k 以 4096³ 运行，以获得最精细的表面细节。
可用值：standard、2k、4k
需要 meshy-7.1 或 latest。
Name
ultra_mode
Type
boolean
⚠ 已弃用
默认值 false
Description
请改用 geometry_resolution。ultra_mode: true 等同于 geometry_resolution: "2k"。
Name
should_texture
Type
boolean
默认值 true
Description
决定是否生成 texture。设置为 false 会跳过 texture 阶段，得到没有 texture 的 mesh。

仅当 should_texture = true

Name
enable_pbr
Type
boolean
默认值 false
Description
除基础颜色外，还生成 PBR 贴图（金属度、粗糙度、法线）。当 ai_model 为 meshy-6 时，还会包含一张 emission map，但 texture_resolution: 8k 时除外。meshy-6-lite、meshy-7.1 和 latest 不会生成 emission map。
Name
texture_resolution
Type
string
默认值 2k
Description
基础颜色 texture 的分辨率。可选 2k（2048×2048）、4k（4096×4096）或 8k（8192×8192）。分辨率越高，捕捉到的表面细节越多。
4k 和 8k 不适用于 ai_model 为 meshy-6-lite 的情况。使用 8k 时，不会生成 emission map。
Name
hd_texture
Type
boolean
⚠ 已弃用
默认值 false
Description
请改用 texture_resolution —— 等同于 texture_resolution: "4k"。当两者都设置时，texture_resolution 具有更高优先顺序。
Name
texture_prompt
Type
string
Description
提供一个文本 prompt 以指导 texture 生成过程。最多 800 个字符。
Name
texture_image_url
Type
string
Description
提供一张二维图像以指导 texture 生成过程。目前支持 .jpg、.jpeg 和 .png 格式。
提供图像的方式有两种：
- 可公开访问的 URL：可从公共互联网访问的 URL
- Data URI：图像的 base64 编码的 data URI。Data URI 示例：data:image/jpeg;base64,<your base64-encoded image data>
如果原始 asset 与上传图像之间存在较大的 geometry 差异，图像 texture 生成可能无法达到最佳效果。指导 texture 生成过程时，texture_image_url 和 texture_prompt 只能使用其中一个。如果两个参数都提供，则默认使用 texture_prompt 为模型生成 texture。无论通过文本还是图像生成 texture，每个任务都将花费 10 credits。

Name
should_remesh
Type
boolean
默认值 false (Meshy 6 and Meshy 7 models), true (others)
Description
控制是否启用 remesh 阶段。为获得最高质量的模型，我们建议将 should_remesh 设置为 false。

仅当 should_remesh = true

Name
topology
Type
string
默认值 triangle
Description
指定生成模型的 topology。
可用值：
- quad：生成以四边形为主的 mesh。
- triangle：生成经过简化的三角形 mesh。
Name
decimation_mode
Type
integer
Description
通过设置 polycount 级别启用自适应简化。设置该参数后，target_polycount 将被忽略。
可用值：
- 1：自适应 —— 超高 polycount。
- 2：自适应 —— 高 polycount。
- 3：自适应 —— 中等 polycount。
- 4：自适应 —— 低 polycount。
Name
save_pre_remeshed_model
Type
boolean
默认值 false
Description
设置为 true 时，Meshy 还会在 remesh 阶段完成前额外存储一个 GLB 文件。

Name
target_polycount
Type
integer
Description
输出中多边形（面）的目标数量。实际数量可能会因 geometry 情况而与目标值有所偏差。
target_polycount 在两种独立的情况下生效：
- Remesh —— 在 standard 模型上设置 should_remesh: true。mesh 将被 remesh（简化）至大约此数量。范围为 100 到 300,000，默认值为 30,000。如果设置了 decimation_mode，则该参数具有更高优先顺序，target_polycount 将被忽略。
- Smart Topology —— 设置 model_type: smart-topology 和 ai_model: meshy-t2。模型将直接以此面数生成；不会运行 remesh，也不需要 should_remesh。范围为 100 到 15,000，默认值为 4,000。

Name
symmetry_mode
Type
string
⚠ 已弃用
默认值 auto
Description
已 deprecated。此参数不再影响输出。
symmetry_mode 字段控制模型生成过程中的 symmetry 行为。
有效值为：
- off：禁用 symmetry。
- auto：根据输入 geometry 自动判断并应用 symmetry。
- on：在生成过程中强制应用 symmetry。
Name
pose_mode
Type
string
默认值 ""
Description
指定生成模型的姿态 mode。
可用值：
- a-pose：以 A pose 生成模型。
- t-pose：以 T pose 生成模型。
- ""（空字符串）：不应用特定姿态。
Name
is_a_t_pose
Type
boolean
⚠ 已弃用
默认值 false
Description
请改用 pose_mode。是否以 A/T pose 生成模型。
Name
image_enhancement
Type
boolean
默认值 true
Description
优化输入图像以获得更好的效果。设置为 false 可保留输入图像的原始外观，不做任何风格处理。
仅在 ai_model 为 meshy-6、meshy-7.1 或 latest 时支持。
Name
remove_lighting
Type
boolean
默认值 true
Description
从基础颜色 texture 中移除高光和阴影，得到更干净的效果，在自定义光照设置下表现更好。
仅在 ai_model 为 meshy-6 时支持。
Name
moderation
Type
boolean
默认值 false
Description
设置为 true 时，将自动对输入内容进行潜在有害内容筛查。如果检测到有害内容，任务将不会进入生成阶段。
将对 image_url、texture_image_url 和 texture_prompt 输入的内容进行筛查。
Name
target_formats
Type
string[]
Description
指定输出中要包含的 3D 文件格式。仅生成并返回请求的格式，这样可以缩短任务完成时间。若省略此参数，则包含所有支持的格式。
可用值：glb、obj、fbx、stl、usdz、3mf
若省略此参数，将生成除 3mf 之外的所有格式。3mf 仅在明确指定时才会包含。
Name
auto_size
Type
boolean
默认值 false
Description
设置为 true 时，服务将使用 AI 视觉自动估算物体的真实高度，并相应地调整模型尺寸。除非显式设置 origin_at，否则 origin 将默认为 bottom。
Name
alpha_thumbnail
Type
boolean
默认值 false
Description
设置为 true 时，任务将额外渲染预览图的透明背景（RGBA）版本，并在 GET 响应中以 alpha_thumbnail_url 返回。现有的 thumbnail_url 字段保持不变。
Name
multi_view_thumbnails
Type
boolean
默认值 false
Description
设置为 true 时，任务将额外渲染四个主要视角的缩略图（正面、右侧、背面、左侧），并在 GET 响应中通过 thumbnail_urls 返回。现有的 thumbnail_url 字段保持不变，依旧指向正面视图，因此不会影响现有客户端。
会为任务延迟增加约 3 秒。

仅当 auto_size = true

Name
origin_at
Type
string
默认值 bottom
Description
启用 auto_size 时 origin 的位置。
可用值：bottom、center。

返回内容

响应的 result 属性包含新创建的 Image to 3D 任务的 id。

失败模式

Name
400 - Bad Request
Description
请求无法被接受。常见原因：
- 缺少参数：必须提供 image_url 或 input_task_id 之一。
- 输入任务无效：input_task_id 必须指向状态为 SUCCEEDED 的文字生成影像或影像生成影像任务，且该任务只生成了一张图像。
- 图像格式无效：提供的 image_url 不是受支持的格式（.jpg、.jpeg、.png）。
- URL 无法访问：无法下载 image_url（404 或 timeout）。
- Data URI 无效：base64 字符串格式有误。
- 参数组合无效：enable_pbr 仅在 should_texture 为 true 时受支持。
- 不支持该模型用于 low poly：ai_model: "meshy-6-lite" 不支持 model_type: "lowpoly"。
- 不支持该模型用于 Ultra：geometry_resolution 需要 meshy-7.1 或 latest。
Name
401 - Unauthorized
Description
Authentication 失败。请检查你的 API key。
Name
402 - Payment Required
Description
credits 不足，无法执行此任务。
Name
429 - Too Many Requests
Description
你已超出速率限制。

Request

POST

/openapi/v1/image-to-3d

# Simple request with required params
curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>"
  }'

# With Ultra 4K geometry, remesh, PBR, and A-pose
curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>",
    "ai_model": "meshy-7.1",
    "geometry_resolution": "4k",
    "enable_pbr": true,
    "should_remesh": true,
    "target_polycount": 100000,
    "should_texture": true,
    "pose_mode": "a-pose",
    "target_formats": ["glb"]
  }'

Response

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

GET/openapi/v1/image-to-3d/:id

检索 Image to 3D 任务

此 endpoint 允许你根据有效的任务 id 检索 Image to 3D 任务。请参阅 The Image to 3D Task Object 查看 Image to 3D 任务对象中包含哪些属性。

参数

Name
id
Type
path
Description
要检索的 Image to 3D 任务的唯一标识符。

返回值

响应中包含 Image to 3D 任务对象。详情请查看 The Image to 3D Task Object 部分。

Request

GET

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "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=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "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",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {
    "message": ""
  },
  "consumed_credits": 30
}

DELETE/openapi/v1/image-to-3d/:id

删除 Image to 3D 任务

该 endpoint 会永久删除一个 Image to 3D 任务，包括所有相关的模型和数据。此操作不可撤销。

路径参数

Name
id
Type
path
Description
要删除的 Image to 3D 任务的 ID。

任务状态

仍处于 PENDING 状态的任务会被删除，并且创建时消耗的 credits 会被退还。

已经处于 IN_PROGRESS 状态的任务无法删除：该请求会被拒绝，并返回 409 Conflict，任务会继续运行。工作节点已经开始处理的任务所消耗的 credits 不可退还，因此在运行过程中删除它会让你同时损失 credits 和结果。请等待其变为 SUCCEEDED、FAILED 或 CANCELED 状态后再删除。

处于终止状态（SUCCEEDED、FAILED 或 CANCELED）的任务将被删除，且不会退还 credits。

返回值

成功时返回 200 OK，当任务处于 IN_PROGRESS 状态时返回 409 Conflict。

Request

DELETE

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -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 is left 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."
}

GET/openapi/v1/image-to-3d

获取 Image to 3D 任务列表

此 endpoint 允许你获取 Image to 3D 任务的列表。

参数

可选属性

Name
page_num
Type
integer
Description
用于分页的页码。起始值和默认值均为 1。
Name
page_size
Type
integer
Description
每页数量限制。默认值为 10 项。最大允许值为 100 项。
Name
sort_by
Type
string
Description
用于排序的字段。可用值：
- +created_at：按创建时间升序排列。
- -created_at：按创建时间降序排列。

返回值

返回一个分页的 Image to 3D 任务对象列表。

Request

GET

/openapi/v1/image-to-3d

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

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "image-to-3d",
    "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=***",
      "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "thumbnail_urls": {
      "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
      "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
      "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
      "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
    },
    "texture_prompt": "",
    "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",
        "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {
      "message": ""
    },
    "consumed_credits": 30
  }
]

GET/openapi/v1/image-to-3d/:id/stream

流式获取 Image to 3D 任务

此 endpoint 使用 Server-Sent Events（SSE）流式传输 Image to 3D 任务的实时更新。

参数

Name
id
Type
path
Description
要进行流式传输的 Image to 3D 任务的唯一标识符。

以 Server-Sent Events 的形式返回一系列 Image to 3D 任务对象。

对于 PENDING 或 IN_PROGRESS 状态的任务，响应流中只会包含必要的 progress 和 status 字段。

Request

GET

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/image-to-3d/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.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "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=***",
  "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
  "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "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",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {
    "message": ""
  },
  "consumed_credits": 30
}

Image to 3D 任务对象

Image to 3D 任务对象是 Meshy 用于跟踪从图像输入生成 3D 模型的工作单元。该对象具有以下属性：

属性

Name
id
Type
string
Description
任务的唯一标识符。虽然我们在实现细节中使用 k-sortable UUID 作为任务 id，但你不应对 id 的格式做任何假设。
Name
type
Type
string
Description
Image to 3D 任务的类型。该值为 image-to-3d。
Name
model_urls
Type
object
Description
Meshy 生成的带纹理 3D 模型文件的可下载 URL。如果某个格式未生成，该格式对应的属性将被省略，而不是返回空字符串。
- Name
  glb
  Type
  string
  Description
  GLB 文件的可下载 URL。
- Name
  fbx
  Type
  string
  Description
  FBX 文件的可下载 URL。
- Name
  obj
  Type
  string
  Description
  OBJ 文件的可下载 URL。
- Name
  usdz
  Type
  string
  Description
  USDZ 文件的可下载 URL。
- Name
  mtl
  Type
  string
  Description
  MTL 文件的可下载 URL，当存在 texture 时会随 OBJ 导出一起返回。
- Name
  stl
  Type
  string
  Description
  STL 文件的可下载 URL。
- Name
  3mf
  Type
  string
  Description
  3MF 文件的可下载 URL。仅当通过 target_formats 请求了 3mf 时才会出现。
- Name
  pre_remeshed_glb
  Type
  string
  Description
  remesh 之前原始 GLB 输出的可下载 URL。
  仅当任务创建时同时设置了 should_remesh: true 和 save_pre_remeshed_model: true 时才可用。
Name
thumbnail_url
Type
string
Description
模型文件缩略图的可下载 URL。存在时等同于 thumbnail_urls.front，保留此字段是为了向后兼容。
Name
alpha_thumbnail_url
Type
string
Description
thumbnail_url 的透明背景（RGBA）版本的可下载 URL。仅当任务创建时设置了 alpha_thumbnail: true 且透明预览成功渲染时才会出现；否则该字段将被省略。
Name
thumbnail_urls
Type
object
Description
所生成 3D 模型的四个基本视角 thumbnail 的可下载 URL。每个值都是一个指向 512×512 PNG 图像的签名 URL，该图像使用与 thumbnail_url 相同的材质和光照渲染。适用于在批处理流程中从多个角度预览模型，而无需下载 GLB。
仅当任务创建时设置了 multi_view_thumbnails: true 且已达到 SUCCEEDED 状态时才会出现。较旧的任务以及未启用该选项创建的任务不会包含此字段。
- Name
  front
  Type
  string
  Description
  正视图，绕垂直轴旋转 0°（与 thumbnail_url 一致）。
- Name
  right
  Type
  string
  Description
  右视图，旋转 90°。
- Name
  back
  Type
  string
  Description
  后视图，旋转 180°。
- Name
  left
  Type
  string
  Description
  左视图，旋转 270°。
Name
texture_prompt
Type
string
Description
用于指导 texture 处理过程的文本 prompt。
Name
texture_image_url
Type
string
Description
用于指导 texture 处理过程的 texture 图像的可下载 URL。
Name
ultra_mode
Type
boolean
⚠ 已弃用
Description
已 deprecated；请改为读取 geometry_resolution。
Name
geometry_resolution
Type
string
Description
任务运行所使用的 Ultra 档位（2k 或 4k）；standard 时省略。
Name
progress
Type
integer
Description
任务的 progress。如果任务尚未开始，此属性为 0。任务成功后，此值将变为 100。
Name
started_at
Type
timestamp
Description
任务开始时的 timestamp，以毫秒为单位。如果任务尚未开始，此属性为 0。
timestamp 表示自 1970 年 1 月 1 日 UTC 起经过的毫秒数，遵循 RFC 3339 标准。例如，2023 年 9 月 1 日星期五格林尼治标准时间中午 12:00:00 表示为 1693569600000。这适用于 Meshy API 中的所有 timestamp。
Name
created_at
Type
timestamp
Description
任务创建时的 timestamp，以毫秒为单位。
Name
expires_at
Type
timestamp
Description
任务结果过期时的 timestamp，以毫秒为单位。
Name
finished_at
Type
timestamp
Description
任务完成时的 timestamp，以毫秒为单位。如果任务尚未完成，此属性为 0。
Name
status
Type
string
Description
任务的状态。可能的值为 PENDING、IN_PROGRESS、SUCCEEDED、FAILED、CANCELED 之一。
Name
texture_urls
Type
array
Description
任务生成的 texture URL 对象数组。通常只包含一个 texture URL 对象。每个 texture URL 具有以下属性：
- Name
  base_color
  Type
  string
  Description
  基础颜色贴图图像的可下载 URL。
- Name
  metallic
  Type
  string
  Description
  金属度贴图图像的可下载 URL。
  如果任务创建时设置了 enable_pbr: false，此属性将被省略。
- Name
  normal
  Type
  string
  Description
  法线贴图图像的可下载 URL。
  如果任务创建时设置了 enable_pbr: false，此属性将被省略。
- Name
  roughness
  Type
  string
  Description
  粗糙度贴图图像的可下载 URL。
  如果任务创建时设置了 enable_pbr: false，此属性将被省略。
- Name
  emission
  Type
  string
  Description
  自发光贴图图像的可下载 URL。
  如果任务创建时设置了 enable_pbr: false，或 ai_model 为 meshy-6-lite、meshy-7.1 或 latest，此属性将被省略。
Name
preceding_tasks
Type
integer
Description
排在前面的任务数量。
该字段的值仅在任务状态为 PENDING 时才有意义。
Name
task_error
Type
object
Description
失败任务的错误详情。完整的 task_error 对象参考请参见 Errors。
Name
consumed_credits
Type
integer
Description
此任务消耗的 credits 数量。当任务状态为 PENDING、IN_PROGRESS 或 SUCCEEDED 时会出现该字段。对于 FAILED 任务返回 0（失败时 credits 会被退回）。

Example Image to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "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=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "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",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {
    "message": ""
  },
  "consumed_credits": 30
}