多圖像轉 3D API
多圖像轉 3D API 是一項功能,允許您將 Meshy 的多圖像轉 3D 能力整合到您自己的應用程式中。在本節中,您將找到開始使用此 API 所需的所有資訊。
建立多圖像轉 3D 任務
此端點允許您建立一個新的多圖像轉 3D 任務。請參閱多圖像轉 3D 任務對象以查看多圖像轉 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 張圖片用於模型生成。當前支援
.jpg、.jpeg和.png格式。所有圖片應為同一物體的不同角度以獲得最佳效果。每張圖片有兩種提供方式:
- 公網可訪問的 URL:一個可以從公網訪問的圖片連結。
- Data URI:圖片的 base64 編碼 data URI。例如:
data:image/jpeg;base64,<your base64-encoded image data>。
對
meshy-7(或latest)而言,第一張圖片作為主(正面)視圖;其餘圖片的順序無關緊要。
- Name
- ai_model
- Type
- string
- 預設值 latest
- Description
要使用的模型 ID。可選值:
meshy-5、meshy-6、meshy-7、latest(Meshy 7)。
- Name
- should_texture
- Type
- boolean
- 預設值 true
- Description
決定是否生成貼圖。設定為
false時跳過貼圖階段,僅生成網格。
should_texture = true- Name
- enable_pbr
- Type
- boolean
- 預設值 false
- Description
生成 PBR 貼圖(金屬度、粗糙度、法線)以及基礎色。當
ai_model為meshy-6時,還會額外生成自發光貼圖;但在texture_resolution: 8k下不會生成自發光貼圖。meshy-7和latest不會生成自發光貼圖。
- Name
- texture_resolution
- Type
- string
- 預設值 2k
- Description
基礎色貼圖的解析度。可選值為
2k(2048×2048)、4k(4096×4096)或8k(8192×8192)。解析度越高,捕捉的表面細節越豐富。4k和8k需要ai_model為meshy-6、meshy-7或latest。在8k下不會生成自發光貼圖。
- 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:一個可以從公網訪問的圖片連結
- Data URI:圖片的 base64 編碼 data URI。例如:
data:image/jpeg;base64,<your base64-encoded image data>
如果原始資產與上傳圖像之間存在較大的幾何差異,圖像貼圖的效果可能不佳。
texture_image_url和texture_prompt只能使用其中一個來引導貼圖。如果兩者都提供,則預設使用texture_prompt。
- Name
- should_remesh
- Type
- boolean
- 預設值 false (meshy-6), true (others)
- Description
控制是否啟用重建網格階段。為獲得最高品質的模型,我們建議將
should_remesh設置為false。
should_remesh = true- Name
- topology
- Type
- string
- 預設值 triangle
- Description
指定生成模型的拓樸結構。
可選值:
quad:生成以四邊形為主的網格。triangle:生成簡化的三角網格。
- Name
- target_polycount
- Type
- integer
- 預設值 30,000
- Description
指定生成模型的目標面數。實際面數可能會根據幾何複雜度有所偏差。
有效取值範圍: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時,會在重建網格階段之前額外儲存一份原始 GLB 結果。
- Name
- symmetry_mode
- Type
- string
- ⚠ 已棄用
- 預設值 auto
- Description
已棄用。該參數不再影響輸出。
控制生成過程中對稱性的行為。
有效值:
off:關閉對稱。auto:根據輸入幾何自動判斷並應用對稱。on:強制應用對稱。
- Name
- pose_mode
- Type
- string
- 預設值 ""
- Description
指定生成模型的姿態模式。
可選值:
a-pose:生成 A Pose 的模型。t-pose:生成 T Pose 的模型。""(空字串):不應用特定姿態。
- Name
- is_a_t_pose
- Type
- boolean
- ⚠ 已棄用
- 預設值 false
- Description
請使用
pose_mode代替。是否生成 A/T Pose 的模型。
- Name
- image_enhancement
- Type
- boolean
- 預設值 true
- Description
對輸入圖片進行優化以獲得更好的生成效果。設定為
false時,忠實還原輸入圖片的原始外觀。僅當
ai_model為meshy-6、meshy-7或latest時支援。
- Name
- remove_lighting
- Type
- boolean
- 預設值 true
- Description
移除基礎色貼圖中的高光和陰影,在自訂光照設定下表現更佳。
僅當
ai_model為meshy-6、meshy-7或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 視覺自動估算物體的真實高度並調整模型大小。原點默認為bottom,除非顯式設置origin_at。
- Name
- alpha_thumbnail
- Type
- boolean
- 預設值 false
- Description
當設置為
true時,任務會額外渲染一張透明背景(RGBA)的預覽圖,並在 GET 回應的alpha_thumbnail_url字段中返回。原有thumbnail_url字段保持不變。
- Name
- multi_view_thumbnails
- Type
- boolean
- 預設值 false
- Description
當設置為
true時,任務會額外渲染四個固定視角縮略圖(front、right、back、left),並在 GET 回應的thumbnail_urls字段中返回。原有thumbnail_url字段保持不變,仍指向 front 視角,舊客戶端不受影響。會使任務耗時增加約 3 秒。
auto_size = true- Name
- origin_at
- Type
- string
- 預設值 bottom
- Description
當
auto_size啟用時的原點位置。可選值:bottom、center。
返回值
回應的 result 字段包含新建多圖像轉 3D 任務的任務 id。
失敗模式
- Name
400 - Bad Request- Description
請求不合法。常見原因:
- 缺少參數:必須提供
image_urls或input_task_id其中之一。 - 輸入任務無效:
input_task_id必須引用一個狀態為SUCCEEDED的文字轉圖像、圖像轉圖像或其多視圖變體任務。 - 圖片數量無效:
image_urls必須包含 1 到 4 張圖片。 - 圖片格式無效:
image_urls中的一張或多張圖片不是支援的格式。 - URL 不可訪問:
image_urls中的一個或多個 URL 無法下載。
- 缺少參數:必須提供
- Name
401 - Unauthorized- Description
認證失敗。請檢查您的 API 金鑰。
- Name
402 - Payment Required- Description
積分不足,無法執行此任務。
- Name
429 - Too Many Requests- Description
您已超出請求頻率限制。
請求
# 簡單請求
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>"
]
}'
# 啟用 PBR 貼圖和 GLB 格式
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"]
}'
響應
{
"result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
獲取多圖像轉 3D 任務
此端點允許您透過有效的任務 id 獲取多圖像轉 3D 任務。
請參考多圖像轉 3D 任務對象查看多圖像轉 3D 任務對象包含的屬性。
參數
- Name
- id
- Type
- path
- Description
要獲取的多圖像轉 3D 任務的唯一標識符。
返回
回應包含多圖像轉 3D 任務對象。查看多圖像轉 3D 任務對象部分了解詳情。
請求
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
響應
{
"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 任務,包括所有相關的模型和數據。此操作不可逆。
路徑參數
- Name
- id
- Type
- path
- Description
要刪除的多圖像轉 3D 任務的 ID。
返回值
成功則返回 200 OK。
請求
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}"
響應
// 成功則返回 200 Ok。
列出多圖像轉 3D 任務
此端點允許您獲取多圖像轉 3D 任務列表。
參數
可選屬性
- Name
- page_num
- Type
- integer
- Description
分頁頁碼。從
1開始,默認為1。
- Name
- page_size
- Type
- integer
- Description
每頁大小限制。默認為
10項。最大允許50項。
- Name
- sort_by
- Type
- string
- Description
排序字段。可用值:
+created_at: 按建立時間升序排序。-created_at: 按建立時間降序排序。
返回
返回多圖像轉 3D 任務對象的分頁列表。
請求
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
響應
[
{
"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
}
]
流式多圖像轉 3D 任務
此端點使用伺服器發送事件(SSE)流式傳輸多圖像轉 3D 任務的即時更新。
參數
- Name
- id
- Type
- path
- Description
要流式傳輸的多圖像轉 3D 任務的唯一標識符。
返回
以伺服器發送事件的形式返回多圖像轉 3D 任務對象的流。
對於 PENDING 或 IN_PROGRESS 狀態的任務,回應流將只包含必要的 progress 和 status 字段。
請求
curl -N https://api.meshy.ai/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"
響應流
// 錯誤事件示例
event: error
data: {
"status_code": 404,
"message": "任務未找到"
}
// 訊息事件示例說明任務進度
// 對於PENDING或IN_PROGRESS狀態的任務,響應流不會包含所有字段
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
當生成OBJ且包含貼圖時返回的MTL文件下載連結。
- Name
stl- Type
- string
- Description
STL 文件的可下載連結。
- Name
3mf- Type
- string
- Description
3MF 文件的可下載連結。僅在透過
target_formats請求3mf時返回。
- Name
pre_remeshed_glb- Type
- string
- Description
重建網格前的原始GLB下載連結。
僅當任務建立時同時設置
should_remesh: true和save_pre_remeshed_model: true時才會提供。
- Name
- thumbnail_url
- Type
- string
- Description
模型文件縮略圖的可下載URL。當
thumbnail_urls存在時,等同於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,指向一張 512×512 的 PNG,其材質和光照與
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
用於指導紋理生成過程的文字提示。
- Name
- progress
- Type
- integer
- Description
任務的進度。如果任務尚未開始,此屬性將為
0。一旦任務成功,這將變為100。
- Name
- started_at
- Type
- timestamp
- Description
任務開始的時間戳,以毫秒為單位。如果任務尚未開始,此屬性將為
0。時間戳表示自 1970 年 1 月 1 日 UTC 以來的毫秒數,遵循 RFC 3339 標準。 例如,2023 年 9 月 1 日星期五 12:00:00 PM GMT 表示為
1693569600000。這適用於 Meshy API 中的所有時間戳。
- Name
- created_at
- Type
- timestamp
- Description
任務建立的時間戳,以毫秒為單位。
- Name
- expires_at
- Type
- timestamp
- Description
任務結果過期的時間戳,以毫秒為單位。
- Name
- finished_at
- Type
- timestamp
- Description
任務完成的時間戳,以毫秒為單位。如果任務尚未完成,此屬性將為
0。
- Name
- status
- Type
- string
- Description
任務的狀態。可能的值包括:
PENDING(等待中)、IN_PROGRESS(進行中)、SUCCEEDED(成功)、FAILED(失敗)、CANCELED(已取消)。
- Name
- texture_urls
- Type
- array
- Description
由任務生成的紋理 URL 對象數組。通常只包含一個紋理 URL 對象。每個紋理 URL 具有以下屬性:
- Name
base_color- Type
- string
- Description
基礎顏色貼圖的可下載URL。
- Name
metallic- Type
- string
- Description
金屬度貼圖的可下載URL。
如果任務建立時設置
enable_pbr: false,此屬性將被省略。
- Name
normal- Type
- string
- Description
法線貼圖的可下載URL。
如果任務建立時設置
enable_pbr: false,此屬性將被省略。
- Name
roughness- Type
- string
- Description
粗糙度貼圖的可下載URL。
如果任務建立時設置
enable_pbr: false,此屬性將被省略。
- Name
emission- Type
- string
- Description
自發光貼圖的可下載URL。
如果任務建立時
enable_pbr: false,或ai_model為meshy-5,則不會返回該屬性。
- Name
- preceding_tasks
- Type
- integer
- Description
前置任務的數量。
僅當任務狀態為
PENDING時,該字段的值才有意義。
- Name
- task_error
- Type
- object
- Description
失敗任務的錯誤詳情。完整
task_error對象參考請查看錯誤處理。
- Name
- consumed_credits
- Type
- integer
- Description
該任務消耗的積分數。當任務狀態為
PENDING、IN_PROGRESS或SUCCEEDED時返回。對於FAILED任務返回0(失敗時積分會被退還)。
多圖像生成 3D 任務對象示例
{
"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,
}