多圖生成 3D API
多圖生成 3D API 是一項功能,可讓你將 Meshy 的多圖生成 3D 能力整合到你自己的應用程式中。在本節中,你將找到開始使用此 API 所需的所有資訊。
建立 Multi-Image to 3D 任務
此 endpoint 允許您建立一個新的 Multi-Image to 3D 任務。請參閱 Multi-Image to 3D 任務物件 以了解 Multi-Image to 3D 任務物件中包含哪些屬性。
參數
input_task_id 或 image_urls 中只需提供其中一個,必填。如果兩者都提供,則以 input_task_id 為優先。
- Name
- input_task_id
- Type
- string
- 必選
- Description
一個已完成的圖片生成任務的 ID,其輸出(1-4 張圖片)將作為輸入使用。該任務必須是以下任務之一:文字生成圖片、圖片生成圖片、文字生成圖片(多視圖)或圖片生成圖片(多視圖)。此外,該任務必須是透過 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>。
對於
meshy-7.1(或latest),第一張圖片將用作主視圖(正面)。其餘圖片的順序無關緊要。
- Name
- ai_model
- Type
- string
- 預設值 latest
- Description
要使用的模型 ID。
可用值:
meshy-6-lite、meshy-6、meshy-7.1、latest(Meshy 7.1)meshy-7(已棄用):請改用meshy-7.1。
- Name
- geometry_resolution
- Type
- string
- 預設值 standard
- Description
geometry 生成階段。
2k會以 2048³ 解析度執行 Ultra 階段。需要meshy-7.1或latest。可用值:
standard、2k
- 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時還會額外包含發光貼圖,但texture_resolution: 8k時不會。meshy-6-lite、meshy-7.1和latest不會生成發光貼圖。
- Name
- texture_resolution
- Type
- string
- 預設值 2k
- Description
基礎色 texture 解析度。可選
2k(2048×2048)、4k(4096×4096)或8k(8192×8192)。解析度越高,捕捉的表面細節越多。4k和8k需要ai_model為meshy-6、meshy-7.1或latest。在8k時不會生成發光貼圖。
- 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>
如果原始 asset 與上傳圖片之間存在較大的 geometry 差異,圖片 texture 處理可能無法達到最佳效果。
texture_image_url與texture_prompt只能使用其中一個來指導 texture 處理過程。如果兩個參數都提供了,預設會使用texture_prompt對模型進行 texture 處理。
- Name
- texture_image_urls
- Type
- string[]
- Description
提供 1 到 4 張展示同一物體不同視圖的圖片,用於指導 texture 處理。第一張圖片為主視圖(正面);其餘視圖(左、後、右)的順序無關緊要。
每個元素支援與
texture_image_url相同的格式(可公開存取的 URL 或 base64 data URI,.jpg/.jpeg/.png)。這些圖片僅用於指導 texture,與
image_urls相互獨立——兩個列表可以包含不同的圖片及不同數量的圖片。需要
ai_model為meshy-7.1或latest。不能與texture_image_url或texture_prompt結合使用。
- 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
- target_polycount
- Type
- integer
- 預設值 30,000
- Description
指定生成模型中目標多邊形數量。實際多邊形數量可能會因 geometry 的複雜程度而與目標值有所偏差。
有效值範圍因使用者等級不同而有所差異:
- 100 到 300,000(包含邊界值)
- Name
- decimation_mode
- Type
- integer
- Description
透過設置多邊形數量級別來啟用自適應精簡。設置該參數後,
target_polycount將被忽略。可用值:
1:自適應——超高多邊形數量。2:自適應——高多邊形數量。3:自適應——中等多邊形數量。4:自適應——低多邊形數量。
- 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可保留輸入圖片的原始外觀,不進行任何風格處理。僅在
ai_model為meshy-6、meshy-7.1或latest時支援。
- Name
- remove_lighting
- Type
- boolean
- 預設值 true
- Description
從基礎色 texture 中移除高光和陰影,生成更乾淨的結果,在自訂光照設置下效果更佳。
僅在
ai_model為meshy-6、meshy-7.1或latest時支援。
- Name
- moderation
- Type
- boolean
- 預設值 false
- Description
設為
true時,將自動對輸入內容進行潛在有害內容的審核。如果偵測到有害內容,任務將不會進入生成階段。將對
image_urls中的每張圖片以及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 屬性包含新建立的 Multi-Image to 3D 任務的 id。
失敗模式
- Name
400 - Bad Request- Description
請求不可接受。常見原因:
- 缺少參數:必須提供
image_urls或input_task_id之一。 - 輸入任務無效:
input_task_id必須指向一個狀態為SUCCEEDED的文字生成圖片、圖片生成圖片或多視圖變體任務。 - 圖片數量無效:
image_urls必須包含 1 到 4 張圖片,texture_image_urls必須包含 1 到 4 張。 - 圖片格式無效:
image_urls中的一張或多張圖片不是受支援的格式。 - texture 輸入衝突:
texture_image_urls不能與texture_image_url或texture_prompt結合使用,且需要should_texture: true。 - 多視圖 texture 不支援該模型:
texture_image_urls需要ai_model為meshy-7.1或latest。 - URL 無法存取:
image_urls或texture_image_urls中的一個或多個元素無法下載。 - 多圖輸入不支援該解析度:此 endpoint 不支援
geometry_resolution: "4k";請使用2k或standard。
- 缺少參數:必須提供
- Name
401 - Unauthorized- Description
身份驗證失敗。請檢查您的 API 金鑰。
- Name
402 - Payment Required- Description
積分不足,無法執行此任務。
- Name
429 - Too Many Requests- Description
您已超出速率限制。
Request
# 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 Ultra 2K geometry, 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>"
],
"ai_model": "meshy-7.1",
"geometry_resolution": "2k",
"should_texture": true,
"enable_pbr": true,
"target_formats": ["glb"]
}'
Response
{
"result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
檢索 Multi-Image to 3D 任務
此端點允許你根據有效的任務 id 檢索一個 Multi-Image to 3D 任務。
請參閱 多圖生成 3D 任務物件 以了解
多圖生成 3D 任務物件包含哪些屬性。
參數
- Name
- id
- Type
- path
- Description
要檢索的 Multi-Image to 3D 任務的唯一識別碼。
回傳值
回應內容包含 Multi-Image to 3D 任務物件。詳情請參閱 多圖生成 3D 任務物件一節。
Request
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
}
刪除 Multi-Image to 3D 任務
此 endpoint 會永久刪除一個 Multi-Image to 3D 任務,包括所有相關的模型和資料。此操作無法復原。
路徑參數
- Name
- id
- Type
- path
- Description
要刪除的 Multi-Image to 3D 任務的 ID。
任務狀態
仍處於 PENDING 狀態的任務會被刪除,並且建立時消耗的
積分會被退還。
已處於 IN_PROGRESS 狀態的任務無法刪除:請求會被
以 409 Conflict 拒絕,任務會繼續執行。工作處理程序已經開始處理的任務,其
積分不可退還,因此在執行途中刪除該任務會讓你同時損失
積分和結果。請等待其到達
SUCCEEDED、FAILED 或 CANCELED 狀態後再刪除。
處於終止狀態(SUCCEEDED、FAILED 或 CANCELED)的任務會被刪除,
且不會退還積分。
回傳值
成功時回傳 200 OK;當任務處於
IN_PROGRESS 狀態時回傳 409 Conflict。
Request
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
// 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."
}
取得 Multi-Image to 3D 任務列表
此 endpoint 允許您取得 Multi-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:依建立時間降序排序。
回傳值
回傳一個分頁的 Multi-Image to 3D 任務物件 列表。
Request
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
}
]
流式取得 Multi-Image to 3D 任務
此 endpoint 使用 Server-Sent Events(SSE)為多圖生成 3D 任務提供即時更新的串流資料。
參數
- Name
- id
- Type
- path
- Description
要進行串流取得的多圖生成 3D 任務的唯一識別碼。
回傳
以 Server-Sent Events 的形式回傳一個 多圖生成 3D 任務物件 的串流。
對於 PENDING 或 IN_PROGRESS 狀態的任務,回應串流中只會包含必要的 progress 和 status 欄位。
Request
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
}
Multi-Image to 3D 任務物件
Multi-Image to 3D 任務物件是 Meshy 用於追蹤從多張圖片(1 到 4 張,包含端點值)生成 3d 模型的工作單元。這些圖片應為同一物體的圖片,理想情況下應來自不同的視圖或角度。 該物件具有以下屬性:
屬性
- Name
- id
- Type
- string
- Description
任務的唯一識別碼。雖然我們在實作細節上使用 k-可排序的 UUID 作為任務 id,但你不應對 id 的格式做任何假設。
- Name
- type
- Type
- string
- Description
Multi-Image to 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,當存在 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
指向模型檔案的 thumbnail 圖片的可下載 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_urls
- Type
- string[]
- Description
建立任務時使用的 texture 參考圖片的可下載 URL,按提供時的順序排列。僅當任務建立時提供了
texture_image_urls時才會出現。
- Name
- ultra_mode
- Type
- boolean
- ⚠ 已棄用
- Description
已 deprecated;請改為讀取
geometry_resolution。
- Name
- geometry_resolution
- Type
- string
- Description
任務執行所使用的 Ultra 等級(
2k);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 日星期五 GMT 時間 12:00:00 PM 表示為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
指向基礎色貼圖(base color map)圖片的可下載 URL。
- Name
metallic- Type
- string
- Description
指向金屬度貼圖(metallic map)圖片的可下載 URL。
如果任務建立時設定了
enable_pbr: false,則會省略此屬性。
- Name
normal- Type
- string
- Description
指向法線貼圖圖片的可下載 URL。
如果任務建立時設定了
enable_pbr: false,則會省略此屬性。
- Name
roughness- Type
- string
- Description
指向粗糙度貼圖(roughness map)圖片的可下載 URL。
如果任務建立時設定了
enable_pbr: false,則會省略此屬性。
- Name
emission- Type
- string
- Description
指向自發光貼圖(emission map)圖片的可下載 URL。
如果任務建立時設定了
enable_pbr: false,或者ai_model為meshy-6-lite,則會省略此屬性。
- 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 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,
}