Image to 3D API

影象生成 3D API 是一項功能,可讓你將 Meshy 的影象生成 3D 能力整合到自己的應用程式中。在本節中,你將找到開始使用此 API 所需的所有資訊。


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

Create an Image to 3D Task

此 endpoint 允許你建立一個新的 影象生成 3D 任務。請參閱 The Image to 3D Task Object 以瞭解 影象生成 3D 任務物件包含哪些屬性。

參數

  • 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_modelmeshy-t2)選擇 Smart Topology 模型。
    • lowpoly(已棄用):生成經過最佳化、多邊形更簡潔的 低多邊形 網格。我們建議改用 smart-topology
  • Name
    ai_model
    Type
    string
    預設值 latest
    Description

    要使用的模型 ID。可用值取決於 model_type

    標準生成(model_type: standard):

    • meshy-5meshy-6meshy-7latest(Meshy 7)

    Smart Topology 生成(model_type: smart-topology):

    • meshy-t2(預設):Smart Topology 模型 —— 更簡潔的 topology、原生分離的部件、三角形輸出,以及可透過 target_polycount 設定的面數。
  • Name
    ultra_mode
    Type
    boolean
    預設值 false
    Description

    啟用 Ultra 生成,獲得更高保真度的 幾何體 及更精細的表面細節。

  • Name
    should_texture
    Type
    boolean
    預設值 true
    Description

    決定是否生成 紋理。設定為 false 會跳過 紋理 階段,提供不帶 紋理 的 網格。

僅當 should_texture = true
  • Name
    enable_pbr
    Type
    boolean
    預設值 false
    Description

    除了基礎色之外,還生成 PBR 貼圖(金屬度、粗糙度、法線)。當 ai_modelmeshy-6 時也會包含自發光貼圖,但 texture_resolution: 8k 除外。meshy-7latest 不會生成自發光貼圖。

  • Name
    texture_resolution
    Type
    string
    預設值 2k
    Description

    基礎色 紋理 解析度。可選 2k(2048×2048)、4k(4096×4096)或 8k(8192×8192)。解析度越高,捕捉到的表面細節越多。

  • Name
    hd_texture
    Type
    boolean
    已棄用
    預設值 false
    Description

    請改用 texture_resolution —— 等效於 texture_resolution: "4k"。當兩者都設定時,以 texture_resolution 為準。

  • Name
    texture_prompt
    Type
    string
    Description

    提供文字 prompt 以指導 紋理 生成過程。最多 800 個字元。

  • Name
    texture_image_url
    Type
    string
    Description

    提供一張 2D 圖像以指導 紋理 生成過程。目前支援 .jpg.jpeg.png 格式。

    提供圖像有兩種方式:

    • 可公開存取的 URL:可從公共網際網路存取的 URL
    • Data URI:圖像的 base64 編碼 data URI。Data URI 範例:data:image/jpeg;base64,<your base64-encoded image data>
  • Name
    should_remesh
    Type
    boolean
    預設值 false (meshy-6, meshy-7), true (others)
    Description

    控制是否啟用 重構網格 階段。為獲得最高品質的模型,我們建議將 should_remesh 設定為 false

僅當 should_remesh = true
  • Name
    topology
    Type
    string
    預設值 triangle
    Description

    指定生成模型的 topology。

    可用值:

    • quad:生成以四邊形為主的 網格。
    • triangle:生成經過簡化的三角形 網格。
  • Name
    decimation_mode
    Type
    integer
    Description

    透過設定 面數 級別啟用自適應簡化。設定後,target_polycount 將被忽略。

    可用值:

    • 1:自適應 —— 超高 面數。
    • 2:自適應 —— 高 面數。
    • 3:自適應 —— 中等 面數。
    • 4:自適應 —— 低 面數。
  • Name
    save_pre_remeshed_model
    Type
    boolean
    預設值 false
    Description

    設定為 true 時,Meshy 還會在 重構網格 階段完成之前儲存一個額外的 GLB 檔案。

  • Name
    target_polycount
    Type
    integer
    Description

    輸出中多邊形(面)的目標數量。實際數量可能因 幾何體 而與目標值有所偏差。

    target_polycount 在兩種獨立情況下生效:

    • Remesh —— 當 standard 模型設定 should_remesh: true 時。網格 將被 重構網格(簡化)到大約此數量。範圍為 100 到 300,000,預設 30,000。如果設定了 decimation_mode,則以其為準,target_polycount 將被忽略。
    • Smart Topology —— 當 model_type: smart-topologyai_model: meshy-t2 時。模型將直接以此面數生成;不會執行 重構網格,也無需設定 should_remesh。範圍為 100 到 15,000,預設 4,000。
  • Name
    symmetry_mode
    Type
    string
    已棄用
    預設值 auto
    Description

    已棄用。此參數不再影響輸出。

    symmetry_mode 欄位控制模型生成過程中的 對稱 行為。

    有效值為:

    • off:停用 對稱。
    • auto:根據輸入 幾何體 自動判斷並套用 對稱。
    • on:在生成過程中強制啟用 對稱。
  • Name
    pose_mode
    Type
    string
    預設值 ""
    Description

    指定生成模型的姿態 mode。

    可用值:

    • a-pose:以 A 字形姿態生成模型。
    • t-pose:以 T 字形姿態生成模型。
    • ""(空字串):不套用特定姿態。
  • Name
    is_a_t_pose
    Type
    boolean
    已棄用
    預設值 false
    Description

    請改用 pose_mode。是否以 A/T 姿態生成模型。

  • Name
    image_enhancement
    Type
    boolean
    預設值 true
    Description

    最佳化輸入圖像以獲得更好的效果。設定為 false 可保留輸入圖像的原始外觀,不進行任何風格化處理。

  • Name
    remove_lighting
    Type
    boolean
    預設值 true
    Description

    從基礎色 紋理 中移除高光和陰影,生成更乾淨的結果,在自訂燈光設定下效果更佳。

  • Name
    moderation
    Type
    boolean
    預設值 false
    Description

    設定為 true 時,將自動對輸入內容進行潛在有害內容的審核。如果偵測到有害內容,任務將不會進入生成階段。

    將會審核來自 image_urltexture_image_urltexture_prompt 輸入的內容。

  • Name
    target_formats
    Type
    string[]
    Description

    指定輸出中要包含哪些 3D 檔案格式。只有請求的格式才會被生成並傳回,這可以縮短任務完成時間。省略時,將包含所有支援的格式。

    可用值:glbobjfbxstlusdz3mf

  • Name
    auto_size
    Type
    boolean
    預設值 false
    Description

    設定為 true 時,服務將使用 AI 視覺自動估算物體的真實世界高度,並相應地調整模型尺寸。除非明確設定了 origin_at,否則 原點 預設設為 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 欄位保持不變,仍指向正面視圖,因此不會影響現有客戶端。

僅當 auto_size = true
  • Name
    origin_at
    Type
    string
    預設值 bottom
    Description

    啟用 auto_size 時 原點 的位置。

    可用值:bottomcenter

傳回值

回應的 result 屬性包含新建立的 影象生成 3D 任務的任務 id

失敗模式

  • Name
    400 - Bad Request
    Description

    請求不可接受。常見原因:

    • 缺少參數:必須提供 image_urlinput_task_id 其中之一。
    • 輸入任務無效input_task_id 必須引用一個狀態為 SUCCEEDED 且只生成一張圖像的文字生成影像或影像生成影像任務。
    • 圖像格式無效:提供的 image_url 不是受支援的格式(.jpg、.jpeg、.png)。
    • URL 不可存取:無法下載 image_url(404 或 timeout)。
    • Data URI 無效:base64 字串格式有誤。
    • 參數組合無效:僅當 should_texture 為 true 時才支援 enable_pbr
  • Name
    401 - Unauthorized
    Description

    身份驗證 失敗。請檢查你的 API 金鑰。

  • Name
    402 - Payment Required
    Description

    積分 不足,無法執行此任務。

  • 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 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>",
    "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 任務。 請參閱 Image to 3D 任務物件 以檢視 Image to 3D 任務物件包含哪些屬性。

參數

  • Name
    id
    Type
    path
    Description

    要取得的 Image to 3D 任務的唯一識別碼。

回傳值

回應中包含 Image to 3D 任務物件。詳情請參閱 Image to 3D 任務物件 部分。

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

刪除一個影象生成 3D 任務

此 endpoint 會永久刪除一個影象生成 3D 任務,包括所有相關的模型和資料。此操作不可逆。

路徑參數

  • Name
    id
    Type
    path
    Description

    要刪除的影象生成 3D 任務的 ID。

回傳值

成功時回傳 200 OK

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

// Returns 200 Ok on success.

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 項。最大允許值為 50 項。

  • 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 任務

此端點使用伺服器發送事件(SSE)串流傳輸 Image to 3D 任務的即時更新。

參數

  • Name
    id
    Type
    path
    Description

    要進行串流傳輸的 Image to 3D 任務的唯一識別碼。

回傳

以伺服器發送事件的形式回傳一個 Image to 3D 任務物件 的串流。

對於 PENDINGIN_PROGRESS 狀態的任務,回應串流中只會包含必要的 progressstatus 欄位。

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
}

影象生成 3D 任務物件

影象生成 3D 任務物件是 Meshy 用來追蹤從圖片輸入生成 3D 模型的工作單元。 該物件具有以下屬性:

屬性

  • Name
    id
    Type
    string
    Description

    任務的唯一識別碼。雖然我們在實作細節上使用 k-sortable UUID 作為任務 id,但你不應對 id 的格式做任何假設。

  • Name
    type
    Type
    string
    Description

    影象生成 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,當存在貼圖時會隨 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

      指向重拓撲之前的原始 GLB 輸出檔案的可下載 URL。

  • 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 模型的四個主視角縮圖的可下載 URL。每個值都是一個指向 512×512 PNG 圖片的簽章 URL,該圖片使用與 thumbnail_url 相同的材質和光照渲染而成。可用於在批次處理流程中從多個角度預覽模型,而無需下載 GLB。

    • 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

    用於指導貼圖處理過程的文字提示詞。

  • Name
    texture_image_url
    Type
    string
    Description

    指向用於指導貼圖處理過程的貼圖圖片的可下載 URL。

  • Name
    ultra_mode
    Type
    boolean
    Description

    回顯任務建立時使用的 ultra_mode 值。僅當 meshy-7(或 latest)任務明確設定了 ultra_mode 時才會出現;否則會省略。

  • Name
    progress
    Type
    integer
    Description

    任務的進度。如果任務尚未開始,此屬性將為 0。一旦任務成功完成,該值將變為 100

  • Name
    started_at
    Type
    timestamp
    Description

    任務開始時的時間戳,單位為毫秒。如果任務尚未開始,此屬性將為 0

  • Name
    created_at
    Type
    timestamp
    Description

    任務建立時的時間戳,單位為毫秒。

  • Name
    expires_at
    Type
    timestamp
    Description

    任務結果過期時的時間戳,單位為毫秒。

  • Name
    finished_at
    Type
    timestamp
    Description

    任務完成時的時間戳,單位為毫秒。如果任務尚未完成,此屬性將為 0

  • Name
    status
    Type
    string
    Description

    任務的狀態。可能的值為 PENDINGIN_PROGRESSSUCCEEDEDFAILEDCANCELED 之一。

  • Name
    texture_urls
    Type
    array
    Description

    該任務生成的貼圖 URL 物件陣列。通常只包含一個貼圖 URL 物件。每個貼圖 URL 具有以下屬性:

    • Name
      base_color
      Type
      string
      Description

      指向基礎色貼圖圖片的可下載 URL。

    • Name
      metallic
      Type
      string
      Description

      指向金屬度貼圖圖片的可下載 URL。

    • Name
      normal
      Type
      string
      Description

      指向法線貼圖圖片的可下載 URL。

    • Name
      roughness
      Type
      string
      Description

      指向粗糙度貼圖圖片的可下載 URL。

    • Name
      emission
      Type
      string
      Description

      指向自發光貼圖圖片的可下載 URL。

  • Name
    preceding_tasks
    Type
    integer
    Description

    排在此任務之前的任務數量。

  • Name
    task_error
    Type
    object
    Description

    失敗任務的錯誤詳情。完整的 task_error 物件說明請參閱 Errors

  • Name
    consumed_credits
    Type
    integer
    Description

    此任務消耗的 credits 數量。當任務狀態為 PENDINGIN_PROGRESSSUCCEEDED 時會出現該欄位。對於 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
}