Creative Lab — 燈具 API
分兩個階段將一張來源照片轉換成可 3D 列印的燈罩:prototype(原型)階段會產生一張風格化的霧白概念圖,並將其轉換為空心 3D 模型(GLB);隨後 build(構建)階段會在該模型上執行燈具處理器,產生可列印的 STL 零件——一個底部開口、帶有光源燈具底座的燈罩,以及燈具固定件本身。這兩個階段透過 input_task_id 相互關聯。
POST /openapi/creative-lab/lamp/v1/prototypePOST /openapi/creative-lab/lamp/v1/build
建立燈具原型任務
根據參考照片產生一張單色霧白概念圖,並將其轉換為一個中空的 3D 燈罩模型。回應中同時包含概念圖(image_urls)和 3D 模型(model_urls.glb 及其 thumbnail_url)。回傳的任務 ID 即是您在呼叫構建 endpoint 時需要傳入的 input_task_id。回應結構請參閱
燈具原型任務物件。
參數
- Name
- image_url
- Type
- string
- 必選
- Description
Meshy 用作燈罩視覺參考的來源照片。目前支援
.jpg、.jpeg、.png和.webp格式。提供圖片的方式有兩種:
- 公開可存取的 URL:可透過公共網際網路存取的 URL。
- Data URI:圖片的 base64 編碼 data URI。data URI 範例:
data:image/jpeg;base64,<your base64-encoded image data>。
- Name
- image_subject
- Type
- string
- 預設值 character
- Description
用於選擇風格化 prompt 的主體類別提示。可選值:
character(預設)— 單一角色/物體主體(人偶、動物、吉祥物等)。landscape— 戶外場景/全景主體(山脈、城市景觀、森林等)。
- Name
- name
- Type
- string
- Description
可選的任務名稱,用於顯示。最多 100 個字元。
- Name
- remove_background
- Type
- boolean
- 預設值 false
- Description
設為
true時,原型圖片將以去除背景的透明 RGBA PNG 格式回傳,方便您將主體合成到任意背景上。
回傳值
回應中的 result 屬性包含新建立的燈具原型任務的任務 id。請輪詢取得任務 endpoint 或訂閱串流介面,直到任務狀態變為 SUCCEEDED,然後將該 ID 作為 input_task_id 傳遞給構建 endpoint。
失敗模式
- Name
400 - Bad Request- Description
請求無法被接受。常見原因:
- 缺少參數:
image_url為必填項目。 - 圖片格式無效:提供的
image_url不是受支援的格式(.jpg、.jpeg、.png、.webp)。 - 圖片尺寸超出範圍:圖片過小、超過最大檔案大小或超過最大像素數。
- URL 無法存取:無法下載
image_url(404 或 timeout)。 - Data URI 無效:base64 字串格式有誤。
- 內容被標記:輸入圖片被 NSFW 或智慧財產權 moderation 標記。
image_subject無效:不是character/landscape之一。
- 缺少參數:
- Name
401 - Unauthorized- Description
身份驗證失敗。請檢查您的 API key。
- Name
402 - Payment Required- Description
credits 不足,無法執行此任務。
- Name
429 - Too Many Requests- Description
您已超出速率限制。
Request
# Stage 1: concept image + hollow 3D lampshade model from a source photo
curl https://api.meshy.ai/openapi/creative-lab/lamp/v1/prototype \
-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>",
"image_subject": "character"
}'
Response
{
"result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}


創建燈具建置任務
從一個成功的原型任務生成最終的可 3D 列印部件。
建置過程會在原型的 3D 模型上執行燈具處理器:將模型縮放到
diameter_mm,按 cut_amount_percent 削平底部,
以 thickness_mm 進行空心化處理,打開底部,並且——當選擇了
fixture 預設時——加入帶有 fixture 孔的底板以及一個獨立的
光源安裝座。回應結構請參閱
燈具建置任務物件。
參數
- Name
- input_task_id
- Type
- string
- 必選
- Description
透過此相同 OpenAPI 端點建立的原型任務的任務 ID。該原型必須使用相同的 API 金鑰建立,必須已達到
SUCCEEDED狀態,且必須已生成 3D 模型。透過網頁應用建立的原型任務不被接受——建置端點僅接受由
POST /openapi/creative-lab/lamp/v1/prototype生成的原型任務,並會以404拒絕任何其他來源。
- Name
- name
- Type
- string
- Description
用於顯示的可選任務名稱。最多 100 個字元。
options
燈罩幾何體的可選調校參數。每個欄位都有合理的預設值——只需傳送你想覆寫的欄位。
- Name
- diameter_mm
- Type
- number
- 預設值 150
- Description
燈罩包圍盒的目標最大尺寸,單位為毫米。網格會被統一縮放以符合該尺寸。範圍:
[50, 400]。
- Name
- thickness_mm
- Type
- number
- 預設值 1
- Description
空心燈罩的壁厚,單位為毫米。範圍:
(0, 10]。
- Name
- cut_amount_percent
- Type
- number
- 預設值 1
- Description
底部被削平的模型高度百分比,以便燈罩能平放在列印床上,並為 fixture 留出開口。範圍:
[1, 100]。
- Name
- light_source_preset
- Type
- string
- 預設值 bambu_mh001_60mm
- Description
決定底部建置方式的光源 fixture 預設。可用值:
bambu_mh001_60mm(預設)——開底燈罩加上帶有 60 mm fixture 孔的底板,兩者都在model_urls.lamp_stl中,fixture 安裝座則作為model_urls.base_stl。none—— 單個密封燈罩,位於model_urls.lamp_stl中;此時省略model_urls.base_stl。
- Name
- fixture_offset_x_mm
- Type
- number
- 預設值 0
- Description
底板上 fixture 孔相對於燈罩中心的 X 軸偏移量,單位為毫米。僅當
light_source_preset≠none時有意義。範圍:[-80, 80]。
- Name
- fixture_offset_z_mm
- Type
- number
- 預設值 0
- Description
底板上 fixture 孔相對於燈罩中心的 Z 軸(深度)偏移量,單位為毫米。僅當
light_source_preset≠none時有意義。範圍:[-80, 80]。
- Name
- rotate_x_deg
- Type
- number
- 預設值 0
- Description
處理前對模型施加的繞 X 軸的旋轉,單位為度。三個旋轉以 XYZ 尤拉角的形式繞模型中心依序施加。範圍:
[-360, 360]。
- Name
- rotate_y_deg
- Type
- number
- 預設值 0
- Description
處理前對匯入的網格施加的繞 Y 軸的旋轉,單位為度。範圍:
[-360, 360]。
- Name
- rotate_z_deg
- Type
- number
- 預設值 0
- Description
處理前對匯入的網格施加的繞 Z 軸的旋轉,單位為度。範圍:
[-360, 360]。
- Name
- include_result_json
- Type
- boolean
- 預設值 false
- Description
當為
true且output.format為zip時,會在壓縮包中包含燈具處理器的result.json(管線名稱、警告資訊以及產物路徑)。當output.format為stl時該欄位會被忽略。
output
可選的輸出格式選擇器。預設為 stl。
- Name
- format
- Type
- string
- 預設值 stl
- Description
建置回傳的產物包。可用值:
stl(預設)——回傳model_urls.lamp_stl(燈罩,以及在設定了 fixture 預設時隨附的底板),並在light_source_preset≠none時額外回傳model_urls.base_stl。zip—— 將處理器輸出的所有產物(lamp.stl、可選的base.stl、可選的result.json)打包為單一 zip 檔案,並透過model_urls.bundle_zip回傳。
回傳值
回應中的 result 屬性包含新建立的燈具建置任務的任務 id。輪詢 取得任務 端點或訂閱 串流,直到任務達到 SUCCEEDED 狀態,然後從 model_urls 下載產物。
失敗模式
- Name
400 - Bad Request- Description
請求不可接受。常見原因:
- 缺少參數:
input_task_id為必填項。 - UUID 無效:
input_task_id不是有效的 UUID。 - 父任務未成功:所引用的原型任務尚未達到
SUCCEEDED狀態。 - 無模型:原型任務已成功,但未生成 3D 模型。
- 選項超出範圍:
options中的某個欄位超出了允許的範圍或列舉取值集合。
- 缺少參數:
- Name
401 - Unauthorized- Description
身份驗證失敗。請檢查你的 API 金鑰。
- Name
402 - Payment Required- Description
積分不足,無法執行此任務。
- Name
404 - Not Found- Description
所引用的原型任務不存在、屬於其他使用者,或是透過網頁應用建立的(只有 API 模式下的原型任務才能連結到建置任務)。
- Name
429 - Too Many Requests- Description
你已超出速率限制。
Request
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/lamp/v1/build \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"options": {
"diameter_mm": 120,
"thickness_mm": 2,
"light_source_preset": "bambu_mh001_60mm",
"cut_amount_percent": 30
},
"output": {
"format": "stl"
}
}'
Response
{
"result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}

取得燈具任務
根據有效的任務 id 取得原型或建構任務。URL 路徑必須與任務所處的階段相符——透過
/prototype/:id 取得的建構任務會回傳 404,反之亦然。
參數
- Name
- id
- Type
- path
- Description
要取得的燈具任務的唯一識別碼。
回傳值
回應內容為燈具任務物件,其具體結構取決於所請求的階段。
Request
# Prototype
curl https://api.meshy.ai/openapi/creative-lab/lamp/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
# Build
curl https://api.meshy.ai/openapi/creative-lab/lamp/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Prototype Response
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "creative-lab-lamp-prototype",
"name": "",
"status": "SUCCEEDED",
"progress": 100,
"created_at": 1729123456000,
"started_at": 1729123460000,
"finished_at": 1729123486000,
"expires_at": 1729382686000,
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 30,
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
"image_urls": [
"https://assets.meshy.ai/***/concept.png?Expires=***"
]
}
Build Response
{
"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
"type": "creative-lab-lamp-build",
"name": "",
"status": "SUCCEEDED",
"progress": 100,
"created_at": 1729123500000,
"started_at": 1729123510000,
"finished_at": 1729123535000,
"expires_at": 1729382735000,
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 6,
"model_urls": {
"lamp_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/lamp.stl?Expires=***",
"base_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/base.stl?Expires=***"
}
}
刪除燈具任務
取消一個燈具任務。如果任務仍處於 PENDING 狀態,建立時消耗的
積分將被退還。已經處於 IN_PROGRESS 狀態的任務會被取消,但不會退款
(工作處理程序可能已經在消耗資源)。已經達到終止狀態
(SUCCEEDED、FAILED、CANCELED)的任務無法取消。
URL 路徑必須與任務所處的階段相符 —— 對
/prototype/:buildId 執行 DELETE 會回傳 404。
路徑參數
- Name
- id
- Type
- path
- Description
要取消的燈具任務的唯一識別碼。
回傳值
成功時回傳 204 No Content,回應內容為空。
失敗模式
- Name
400 - Bad Request- Description
該任務已處於終止狀態,無法取消。
- Name
404 - Not Found- Description
該任務不存在、屬於其他使用者,或其所處階段與 URL 路徑不符。
Request
curl --request DELETE \
--url https://api.meshy.ai/openapi/creative-lab/lamp/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
// Returns 204 No Content on success (empty body).
串流取得燈具任務
透過伺服器發送事件(SSE)串流取得燈具任務的即時更新。
URL 路徑必須與任務所處的階段相符——在
/prototype/:buildId/stream 開啟串流會發出一則 status_code: 404 的
單一 event: error 請求體,隨後關閉該串流。
參數
- Name
- id
- Type
- path
- Description
要進行串流傳輸的燈具任務的唯一識別碼。
回傳值
以 Server-Sent Events 的形式回傳一個包含 Lamp Prototype
或 Lamp Build 任務物件的串流。
對於 PENDING 或 IN_PROGRESS 狀態的任務,回應串流中只會包含
必要的 progress 和 status 欄位。
Request
curl -N https://api.meshy.ai/openapi/creative-lab/lamp/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response Stream
// Error event example (wrong stage or task not found)
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": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
"progress": 0,
"status": "PENDING"
}
event: message
data: {
"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
"type": "creative-lab-lamp-build",
"status": "SUCCEEDED",
"progress": 100,
"created_at": 1729123500000,
"started_at": 1729123510000,
"finished_at": 1729123535000,
"expires_at": 1729382735000,
"task_error": null,
"consumed_credits": 6,
"model_urls": {
"lamp_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/lamp.stl?Expires=***",
"base_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/base.stl?Expires=***"
}
}
取得燈具任務清單
取得單一階段的燈具任務分頁清單。URL 路徑決定所選階段——/prototype
回傳原型任務;/build 回傳建構任務。另一階段的任務不會包含在任一回應中。
路徑參數
- Name
- stage
- Type
- path
- 必選
- Description
prototype或build之一。此集合僅回傳階段與 URL 相符的任務——取得/prototype永遠不會回傳建構任務,反之亦然。
查詢參數
- Name
- page_num
- Type
- integer
- 預設值 1
- Description
用於分頁的頁碼。
- Name
- page_size
- Type
- integer
- 預設值 10
- Description
每頁數量限制。允許的最大值為
50項。
- Name
- sort_by
- Type
- string
- 預設值 -created_at
- Description
排序所依據的欄位。可用值:
+created_at:依建立時間升冪排列。-created_at:依建立時間降冪排列。
回傳值
回傳對應階段的任務物件分頁清單——列出 /prototype 時回傳
燈具原型任務物件,
列出 /build 時回傳
燈具建構任務物件。
Request
# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/lamp/v1/prototype?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/lamp/v1/build?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response (List Prototype Tasks)
[
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "creative-lab-lamp-prototype",
"name": "",
"status": "SUCCEEDED",
"progress": 100,
"created_at": 1729123456000,
"started_at": 1729123460000,
"finished_at": 1729123486000,
"expires_at": 1729382686000,
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 30,
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
"image_urls": [
"https://assets.meshy.ai/***/concept.png?Expires=***"
]
}
]
燈具原型任務物件
燈具原型任務物件是 Meshy 用於追蹤的一個工作單元,用於根據來源照片生成風格化的霧面白色概念圖,並將其轉換為空心的3D 模型。此階段的輸出會透過 input_task_id 連結到建構階段。
屬性
- Name
- id
- Type
- string
- Description
任務的唯一識別碼。雖然我們在實作細節上使用 k 可排序的 UUID 作為任務 id,但你不應對 id 的格式做任何假設。
- Name
- type
- Type
- string
- Description
任務的類型。該值為
creative-lab-lamp-prototype。
- Name
- name
- Type
- string
- Description
建立任務時提供的任務名稱。如果未提供名稱,則為空字串。
- Name
- status
- Type
- string
- Description
任務的狀態。可能的值為
PENDING、IN_PROGRESS、SUCCEEDED、FAILED、CANCELED中的一個。
- Name
- progress
- Type
- integer
- Description
任務的 progress。如果任務尚未開始,此屬性將為
0。任務成功後,此值將變為100。
- Name
- created_at
- Type
- timestamp
- Description
任務建立時的時間戳,以毫秒為單位。
時間戳表示自 1970 年 1 月 1 日 UTC 起經過的毫秒數,遵循 RFC 3339
標準。 例如,2023 年 9 月 1 日星期五 GMT 時間中午 12:00:00 表示為1693569600000。這適用於 Meshy API 中的所有時間戳。
- Name
- started_at
- Type
- timestamp
- Description
任務開始時的時間戳,以毫秒為單位。如果任務尚未開始,此屬性將為
0。
- Name
- finished_at
- Type
- timestamp
- Description
任務完成時的時間戳,以毫秒為單位。如果任務尚未完成,此屬性將為
0。
- Name
- expires_at
- Type
- timestamp
- Description
任務結果過期時的時間戳,以毫秒為單位。
- 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(失敗時積分會被退還)。
- Name
- model_urls
- Type
- object
- Description
從概念圖生成的 3D 模型的可下載 URL。任務成功後會顯示此值;在此之前為
{}。- Name
glb- Type
- string
- Description
GLB 格式的空心霧面白色燈罩模型的可下載 URL。這是建構階段所處理的模型。
- Name
- thumbnail_url
- Type
- string
- Description
3D 模型渲染預覽圖的可下載 URL。任務成功之前為空字串。
- Name
- image_urls
- Type
- array of strings
- Description
此原型任務生成的概念圖候選項的可下載 URL。目前 API 始終只回傳一個候選項;此欄位為陣列,是為了讓未來的版本能夠在不產生破壞性變更的情況下呈現多個候選項。
Example Lamp Prototype Task Object
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "creative-lab-lamp-prototype",
"name": "",
"status": "SUCCEEDED",
"progress": 100,
"created_at": 1729123456000,
"started_at": 1729123460000,
"finished_at": 1729123486000,
"expires_at": 1729382686000,
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 30,
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
"image_urls": [
"https://assets.meshy.ai/***/concept.png?Expires=***"
]
}
燈具構建任務物件
燈具構建任務物件是 Meshy 用於追蹤工作單元的物件,用於從已成功的原型任務生成最終的可 3D 列印燈罩。構建過程會在原型的 3D 模型上執行燈具處理器,對其進行抽殼、拉平並打開底部,並(在使用固定裝置預設的情況下)加入底板和固定裝置安裝座。
屬性
- Name
- id
- Type
- string
- Description
任務的唯一識別碼。
- Name
- type
- Type
- string
- Description
任務的類型。該值為
creative-lab-lamp-build。
- Name
- name
- Type
- string
- Description
建立任務時提供的任務名稱。如果未提供名稱,則為空字串。
- Name
- status
- Type
- string
- Description
任務的狀態。可能的值為
PENDING、IN_PROGRESS、SUCCEEDED、FAILED、CANCELED之一。
- Name
- progress
- Type
- integer
- Description
任務的 progress。如果任務尚未開始,此屬性為
0。任務成功後,將變為100。
- Name
- created_at
- Type
- timestamp
- Description
任務建立時間的時間戳,以毫秒為單位。
- Name
- started_at
- Type
- timestamp
- Description
任務開始時間的時間戳,以毫秒為單位。
- Name
- finished_at
- Type
- timestamp
- Description
任務完成時間的時間戳,以毫秒為單位。
- Name
- expires_at
- Type
- timestamp
- Description
任務結果過期時間的時間戳,以毫秒為單位。
- Name
- preceding_tasks
- Type
- integer
- Description
排在前面的任務數量。僅當狀態為
PENDING時才有意義。
- Name
- task_error
- Type
- object
- Description
失敗任務的錯誤詳情。有關完整的
task_error物件參考,請參閱 錯誤。
- Name
- consumed_credits
- Type
- integer
- Description
此任務消耗的 consumed_credits 數量。對於
FAILED任務,返回0(失敗時會退還積分)。
- Name
- model_urls
- Type
- object
- Description
生成產物的可下載 URL,以產物名稱作為鍵。鍵的集合取決於
output.format和options.light_source_preset:- Name
lamp_stl- Type
- string
- Description
指向
lamp.stl的可下載 URL:即帶有固定裝置孔的開底燈罩及底板,或者在options.light_source_preset為none時為單一密封燈罩。當output.format為stl(預設值)時會出現此項。
- Name
base_stl- Type
- string
- Description
指向
base.stl的可下載 URL,即光源固定裝置安裝座。當output.format為stl且options.light_source_preset不為none時會出現此項。當固定裝置預設為none時,此項會被省略。
- Name
bundle_zip- Type
- string
- Description
指向包含處理器生成的所有產物(
lamp.stl、可選的base.stl,以及在options.include_result_json為true時的result.json)的壓縮包的可下載 URL。當output.format為zip時會出現此項。當存在bundle_zip時,將省略lamp_stl/base_stl。
Example Lamp Build Task Object
{
"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
"type": "creative-lab-lamp-build",
"name": "",
"status": "SUCCEEDED",
"progress": 100,
"created_at": 1729123500000,
"started_at": 1729123510000,
"finished_at": 1729123535000,
"expires_at": 1729382735000,
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 6,
"model_urls": {
"lamp_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/lamp.stl?Expires=***",
"base_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/base.stl?Expires=***"
}
}