影象生成 3D API

影象生成 3D API 是一項功能,允許您將 Meshy 的影象生成 3D 功能集成到您自己的應用中。在本節中,您將找到開始使用此 API 所需的所有信息。


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

創建影象生成 3D 任務

此端點允許您創建一個新的影象生成 3D 任務。請參閱 影象生成 3D 任務對象 以查看影象生成 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 編碼數據 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-t1meshy-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 設置。
    • meshy-t1:舊的低多邊形模型;不支持使用 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

    提供一個文本提示來指導著色過程。最多600個字符。

  • Name
    texture_image_url
    Type
    string
    Description

    提供一個 2D 影象來指導著色過程。我們目前支持 .jpg.jpeg.png 格式。

    提供影象有兩種方式:

    • 公開可訪問的 URL:可從公共互聯網訪問的 URL
    • Data URI:影象的 base64 編碼數據 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

    指定生成模型的姿勢模式。

    可用值:

    • 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) 的預覽並將其作為 alpha_thumbnail_url 返回在 GET 響應中。現有的 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 或超時)。
    • 無效的 Data URI:base64 字符串格式錯誤。
    • 無效的參數組合enable_pbr 只有在 should_texture 為 true 時支持。
  • Name
    401 - Unauthorized
    Description

    驗證失敗。請檢查您的 API 金鑰。

  • Name
    402 - Payment Required
    Description

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

  • Name
    429 - Too Many Requests
    Description

    您已超出速率限制。

Request

POST
/openapi/v1/image-to-3d
# 簡單請求,僅帶必需參數
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>"
  }'

# 包含重拓扑、PBR 和 A-姿勢
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

獲取影象生成 3D 任務

此端點允許您給定有效的任務 id 獲取影象生成 3D 任務。請參閱 影象生成 3D 任務對象 以查看影象生成 3D 任務對象中包含的屬性。

參數

  • Name
    id
    Type
    path
    Description

    要獲取的影象生成 3D 任務的唯一標識符。

返回

響應包含影象生成 3D 任務對象。查看 影象生成 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 任務

此端點永久刪除影象生成 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

// 成功時返回 200 Ok。

GET/openapi/v1/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/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=***",
      "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
  }
]

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

流影象生成 3D 任務

此端點使用 Server-Sent Events (SSE) 流式傳輸影象生成 3D 任務的實時更新。

參數

  • Name
    id
    Type
    path
    Description

    要流的影象生成 3D 任務的唯一標識符。

返回

返回作為 Server-Sent Events 的影象生成 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 值。僅在明確設置了 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 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
}