多圖生成 3D API

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


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

建立 Multi-Image to 3D 任務

此 endpoint 允許您建立一個新的 Multi-Image to 3D 任務。請參閱 The Multi-Image to 3D Task Object 以查看 Multi-Image to 3D 任務物件包含哪些屬性。

參數

  • Name
    input_task_id
    Type
    string
    必選
    Description

    一個已完成的影像生成任務的 ID,其輸出(1-4 張影像)將用作輸入。此任務必須是以下任務之一:文字生成影像、影像生成影像、Text to Image Multi-View 或 Image to Image Multi-View。此外,它必須是透過 API 執行的,並且狀態為 SUCCEEDED

  • Name
    image_urls
    Type
    array
    必選
    Description

    提供 1 至 4 張影像供 Meshy 用於模型建立。我們目前支援 .jpg.jpeg.png 格式。為獲得最佳效果,所有影像應從不同角度描繪同一物體。

    提供每張影像有兩種方式:

    • 公開可存取的 URL:可從公共網際網路存取的 URL。
    • Data URI:影像的 base64 編碼 data URI。data URI 範例:data:image/jpeg;base64,<your base64-encoded image data>
  • Name
    ai_model
    Type
    string
    預設值 latest
    Description

    要使用的模型 ID。可用值:meshy-5meshy-6meshy-7latest(Meshy 7)。

  • Name
    ultra_mode
    Type
    boolean
    預設值 false
    Description

    啟用 Ultra 生成,以獲得更高保真度的 geometry 和更精細的表面細節。

  • Name
    should_texture
    Type
    boolean
    預設值 true
    Description

    決定是否生成 texture。設定為 false 會跳過 texture 階段,提供不帶 texture 的 mesh。

僅當 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

    基礎顏色 texture 的解析度。可選 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 以指導 texture 生成過程。最多 800 個字元。

  • Name
    texture_image_url
    Type
    string
    Description

    提供一張 2D 影像以指導 texture 生成過程。我們目前支援 .jpg.jpeg.png 格式。

    提供影像有兩種方式:

    • 公開可存取的 URL:可從公共網際網路存取的 URL
    • Data URI:影像的 base64 編碼 data URI。data URI 範例:data:image/jpeg;base64,<your base64-encoded image data>
  • Name
    texture_image_urls
    Type
    string[]
    Description

    提供 1 至 4 張展示同一物體不同視角的影像,以指導 texture 生成。第一張影像為主(正面)視圖;其餘視圖(左、後、右)的順序無關緊要。

    每個元素支援與 texture_image_url 相同的格式(公開可存取的 URL 或 base64 data URI,.jpg/.jpeg/.png)。

    這些影像僅用於指導 texture,與 image_urls 相互獨立——兩個清單可以包含不同的影像及不同數量的影像。

  • Name
    should_remesh
    Type
    boolean
    預設值 false (meshy-6), true (others)
    Description

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

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

    指定生成模型的 topology。

    可用值:

    • quad:生成以四邊形為主的 mesh。
    • triangle:生成經過抽減的三角形 mesh。
  • Name
    target_polycount
    Type
    integer
    預設值 30,000
    Description

    指定生成模型中目標的多邊形數量。實際的多邊形數量可能會因 geometry 的複雜程度而與目標有所偏差。

    有效值範圍因 使用者等級 而異:

    • 100 至 300,000(含邊界值)
  • 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
    symmetry_mode
    Type
    string
    已棄用
    預設值 auto
    Description

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

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

    有效值為:

    • off:停用 symmetry。
    • auto:根據輸入 geometry 自動判定並套用 symmetry。
    • on:在生成過程中強制啟用 symmetry。
  • 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

    從基礎顏色 texture 中移除高光和陰影,從而生成更純淨的結果,更適合在自訂光照設定下使用。

  • Name
    moderation
    Type
    boolean
    預設值 false
    Description

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

    image_urls 中的每張影像以及 texture_prompt 中的文字都將被審查。

  • Name
    target_formats
    Type
    string[]
    Description

    指定輸出中應包含哪些 3D 檔案格式。僅會生成並回傳所請求的格式,這可以縮短任務完成時間。

    可用值:glbobjfbxstlusdz3mf

  • 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 欄位保持不變,仍指向正面視圖,因此不會影響現有用戶端。

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

    啟用 auto_size 時 origin 的位置。可用值:bottomcenter

回傳值

回應的 result 屬性包含新建立的 Multi-Image to 3D 任務的 id

失敗模式

  • Name
    400 - Bad Request
    Description

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

    • 缺少 參數:必須提供 image_urlsinput_task_id 之一。
    • 輸入任務無效input_task_id 必須指向一個狀態為 SUCCEEDED 的文字生成影像、影像生成影像或多視圖變體任務。
    • 影像數量無效image_urls 必須包含 1 到 4 張影像,texture_image_urls 必須包含 1 到 4 張影像。
    • 影像格式無效image_urls 中的一張或多張影像格式不受支援。
    • texture 輸入衝突texture_image_urls 不能與 texture_image_urltexture_prompt 一起使用,且需要 should_texture: true
    • 多視圖 texture 不支援該模型texture_image_urls 需要 ai_modelmeshy-7latest
    • URL 無法存取image_urlstexture_image_urls 中的一個或多個元素無法下載。
  • Name
    401 - Unauthorized
    Description

    身份驗證失敗。請檢查您的 API key。

  • Name
    402 - Payment Required
    Description

    credits 不足,無法執行此任務。

  • Name
    429 - Too Many Requests
    Description

    您已超出 速率限制。

Request

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

# With PBR texturing and GLB format
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_urls": [
      "<your publicly accessible image url or base64-encoded data URI>",
      "<your second publicly accessible image url or base64-encoded data URI>"
    ],
    "should_texture": true,
    "enable_pbr": true,
    "target_formats": ["glb"]
  }'

Response

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

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

取得 Multi-Image to 3D 任務

此 endpoint 允許您透過有效的任務 id 取得 Multi-Image to 3D 任務。 請參閱Multi-Image to 3D 任務物件,了解 Multi-Image to 3D 任務物件包含哪些屬性。

參數

  • Name
    id
    Type
    path
    Description

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

回傳

回應中包含 Multi-Image to 3D 任務物件。詳情請查看 Multi-Image to 3D 任務物件章節。

Request

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "multi-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/multi-image-to-3d/:id

刪除多圖生成 3D 任務

此 endpoint 將永久刪除一個多圖生成 3D 任務,包括所有關聯的模型和資料。此操作不可復原。

路徑參數

  • Name
    id
    Type
    path
    Description

    要刪除的多圖生成 3D 任務的 ID。

返回值

成功時返回 200 OK

Request

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

Response

// Returns 200 Ok on success.

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

取得多圖生成 3D 任務列表

此端點允許您取得多圖生成 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:按建立時間降序排列。

回傳

回傳分頁後的 多圖生成 3D 任務物件 列表。

Request

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

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "multi-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/multi-image-to-3d/:id/stream

流式獲取 Multi-Image to 3D 任務

此 endpoint 使用 Server-Sent Events(SSE)串流傳輸 Multi-Image to 3D 任務的即時更新。

參數

  • Name
    id
    Type
    path
    Description

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

回傳值

以 Server-Sent Events 形式回傳 Multi-Image to 3D 任務物件 的串流。

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

Request

GET
/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream
curl -N https://api.meshy.ai/openapi/v1/multi-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": "multi-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 用來追蹤從多張圖片(1 到 4 張,包含兩端)生成 3D 模型的工作單元。這些圖片應為同一物體,最好是不同視角或角度拍攝的。 該物件具有以下屬性:

屬性

  • Name
    id
    Type
    string
    Description

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

  • Name
    type
    Type
    string
    Description

    多圖生成 3D 任務的類型。該值為 multi-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。每個值都是一個簽名 URL,指向使用與 thumbnail_url 相同材質和光照渲染的 512×512 PNG 圖片。適用於在批次處理流程中從多個角度預覽模型,而無需下載 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_urls
    Type
    string[]
    Description

    用於建立該任務的貼圖參考圖片的可下載 URL,按提供時的順序排列。僅當任務建立時使用了 texture_image_urls 時才會出現。

  • Name
    ultra_mode
    Type
    boolean
    Description

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

  • 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 物件參考請參見 錯誤

  • Name
    consumed_credits
    Type
    integer
    Description

    該任務消耗的積分數量。當任務狀態為 PENDINGIN_PROGRESSSUCCEEDED 時會出現該欄位。對於 FAILED 任務回傳 0(失敗時會退還積分)。

Example Multi-Image to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "multi-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,
}