Creative Lab — แม่เหล็กติดตู้เย็น API
เปลี่ยนรูปถ่ายของคุณให้เป็นแม่เหล็กติดตู้เย็นแบบกำหนดเอง — รูปทรงสี่เหลี่ยมผืนผ้ามุมมนที่มีสีสันพร้อมพื้นหลังแม่เหล็กเรียบ ขนาดพอดีกับตู้เย็น — ในสองขั้นตอน: ต้นแบบ สร้างภาพแนวคิดที่มีสีสันจากรูปถ่ายของคุณ จากนั้น สร้าง เปลี่ยนภาพแนวคิดนั้นให้เป็นโมเดล 3D แบบนูนลึก สองขั้นตอนนี้เชื่อมโยงกันผ่าน input_task_id.
POST /openapi/creative-lab/fridge-magnet/v1/prototypePOST /openapi/creative-lab/fridge-magnet/v1/build
สร้างงานต้นแบบแม่เหล็กติดตู้เย็น
สร้างภาพแนวคิดที่มีสีสันจากภาพต้นฉบับที่ให้มา รหัสงานที่ส่งกลับมาคือสิ่งที่คุณต้องส่งผ่านเป็น input_task_id ไปยังเอนด์พอยต์การสร้าง ดูที่
วัตถุงานต้นแบบแม่เหล็กติดตู้เย็น
สำหรับรูปแบบการตอบกลับ
พารามิเตอร์
- Name
- image_url
- Type
- string
- จำเป็น
- Description
ภาพต้นฉบับสำหรับ Meshy เพื่อทำให้เป็นภาพแนวคิดที่พร้อมสำหรับแม่เหล็กติดตู้เย็น ปัจจุบันเรารองรับรูปแบบ
.jpg,.jpeg,.png, และ.webpมีสองวิธีในการให้ภาพ:
- URL ที่เข้าถึงได้สาธารณะ: URL ที่สามารถเข้าถึงได้จากอินเทอร์เน็ตสาธารณะ
- Data URI: Data URI ที่เข้ารหัส base64 ของภาพ ตัวอย่างของ Data URI:
data:image/jpeg;base64,<your base64-encoded image data>
- Name
- name
- Type
- string
- Description
ชื่องานที่เป็นทางเลือกสำหรับการแสดงผล สูงสุด 100 ตัวอักษร
- Name
- remove_background
- Type
- boolean
- ค่าเริ่มต้น false
- Description
เมื่อกำหนดเป็น
trueภาพต้นแบบจะถูกส่งกลับมาเป็น PNG แบบ RGBA โปร่งใสพร้อมพื้นหลังที่ถูกลบออก เพื่อให้คุณสามารถประกอบวัตถุลงบนพื้นหลังใดก็ได้สิ่งนี้ควบคุมเฉพาะภาพที่เอนด์พอยต์นี้ส่งกลับมา มันแยกจากตัวเลือกการสร้างที่มีชื่อเดียวกัน (ค่าเริ่มต้น
true) ซึ่งควบคุมการลบพื้นหลังก่อนการสร้างภาพนูน
การส่งกลับ
คุณสมบัติ result ของการตอบกลับประกอบด้วยรหัสงาน id ของงานต้นแบบแม่เหล็กติดตู้เย็นที่สร้างขึ้นใหม่ ตรวจสอบเอนด์พอยต์ รับงาน หรือสมัครรับ stream จนกว่างานจะถึง SUCCEEDED จากนั้นส่งรหัสนั้นไปยัง เอนด์พอยต์การสร้าง เป็น input_task_id
โหมดความล้มเหลว
- Name
400 - Bad Request- Description
คำขอไม่เป็นที่ยอมรับ สาเหตุทั่วไป:
- พารามิเตอร์ที่ขาดหายไป:
image_urlจำเป็นต้องมี - รูปแบบภาพไม่ถูกต้อง:
image_urlที่ให้มาไม่ใช่รูปแบบที่รองรับ (.jpg,.jpeg,.png,.webp) - ขนาดภาพเกินขอบเขต: ภาพมีขนาดเล็กเกินไป เกินขนาดไฟล์สูงสุด หรือเกินจำนวนพิกเซลสูงสุด
- URL ที่ไม่สามารถเข้าถึงได้: ไม่สามารถดาวน์โหลด
image_urlได้ (404 หรือ timeout) - Data URI ไม่ถูกต้อง: สตริง base64 ผิดรูปแบบ
- เนื้อหาถูกตั้งค่าสถานะ: ภาพที่ป้อนเข้ามาถูกตั้งค่าสถานะโดย moderation NSFW หรือทรัพย์สินทางปัญญา
- พารามิเตอร์ที่ขาดหายไป:
- Name
401 - Unauthorized- Description
การยืนยันตัวตนล้มเหลว กรุณาตรวจสอบ API คีย์ของคุณ
- Name
402 - Payment Required- Description
เครดิตไม่เพียงพอในการดำเนินการนี้
- Name
429 - Too Many Requests- Description
คุณได้เกินการจำกัดอัตราของคุณแล้ว
Request
# Stage 1: generate a colorized fridge magnet concept image
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/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>"
}'
Response
{
"result": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9"
}
สร้างงานสร้างแม่เหล็กติดตู้เย็น
สร้างแม่เหล็กติดตู้เย็นที่สามารถพิมพ์ 3 มิติได้จากงานต้นแบบที่สำเร็จแล้ว งานสร้างจะทำการประมวลผลภาพแนวลึกบนภาพแนวคิดที่มีสีของต้นแบบและส่งออกเมชอาร์ติแฟกต์เพียงชิ้นเดียวในรูปแบบที่คุณต้องการ ดูรายละเอียดเพิ่มเติมได้ที่ The Fridge Magnet Build Task Object สำหรับรูปแบบการตอบกลับ
พารามิเตอร์
- Name
- input_task_id
- Type
- string
- จำเป็น
- Description
รหัสงานของงานต้นแบบที่สร้างผ่านเอนด์พอยต์ OpenAPI นี้ งานต้นแบบต้องถูกสร้างด้วย API คีย์เดียวกัน ต้องถึงสถานะ
SUCCEEDEDและต้องผลิตภาพผู้สมัครเพียงภาพเดียวงานต้นแบบที่สร้างผ่านเว็บแอป ไม่ ได้รับการยอมรับ — เอนด์พอยต์สร้างรับเฉพาะงานต้นแบบที่ผลิตโดย
POST /openapi/creative-lab/fridge-magnet/v1/prototypeและปฏิเสธแหล่งอื่นด้วย404.
- Name
- name
- Type
- string
- Description
ชื่องานที่เป็นทางเลือกสำหรับการแสดงผล สูงสุด 100 ตัวอักษร
options
พารามิเตอร์การปรับแต่งที่เป็นทางเลือกสำหรับจีออเมทรีนูน ทุกฟิลด์มีค่าเริ่มต้นที่เหมาะสม — ส่งเฉพาะฟิลด์ที่คุณต้องการเปลี่ยนแปลง
- Name
- badge_shape
- Type
- string
- ค่าเริ่มต้น rounded-rect
- Description
รูปทรงเงาของแม่เหล็กติดตู้เย็น ค่าที่มีให้เลือก:
circlerounded-rect(ค่าเริ่มต้น)hexagonshieldstar
- Name
- size_mm
- Type
- number
- ค่าเริ่มต้น 60
- Description
ความยาวขอบของแม่เหล็กติดตู้เย็นในหน่วยมิลลิเมตร ช่วง:
(0, 400].
- Name
- relief_height_mm
- Type
- number
- ค่าเริ่มต้น 3.3
- Description
ความสูงสูงสุดของนูนเหนือฐานในหน่วยมิลลิเมตร ช่วง:
[0, 20].
- Name
- relief_offset_mm
- Type
- number
- ค่าเริ่มต้น 0
- Description
การเลื่อนแนวตั้งที่ใช้กับนูนก่อนการอัดในหน่วยมิลลิเมตร ช่วง:
[0, 20].
- Name
- base_thickness_mm
- Type
- number
- ค่าเริ่มต้น 2.0
- Description
ความหนาของแผ่นฐานเรียบหลังนูนในหน่วยมิลลิเมตร ค่าเริ่มต้นของแม่เหล็กติดตู้เย็นคือฐานหนา 2 มม. — ให้แม่เหล็กมีตัวพอที่จะยึดตู้เย็นได้โดยไม่ทำให้นูนรู้สึกเปราะ ช่วง:
[0, 20].
- Name
- has_closed_back
- Type
- boolean
- ค่าเริ่มต้น true
- Description
ด้านหลังของแม่เหล็กติดตู้เย็นถูกปิดเป็นพื้นผิวปิดหรือไม่ (ด้านที่คุณติดแม่เหล็ก) ตั้งค่าเป็น
falseสำหรับเปลือกเปิด
- Name
- relief_curve
- Type
- string
- ค่าเริ่มต้น linear
- Description
เส้นโอนค่าที่จับคู่ค่าภาพแนวลึกกับความสูงของนูน ค่าที่มีให้เลือก:
linear(ค่าเริ่มต้น)gammas-curve
- Name
- curve_param
- Type
- number
- ค่าเริ่มต้น 1.0
- Description
พารามิเตอร์รูปทรงสำหรับเส้นโอน (มีความหมายเฉพาะเมื่อ
relief_curveเป็นgamma) ช่วง:(0, 10].
- Name
- invert_depth
- Type
- boolean
- ค่าเริ่มต้น false
- Description
กลับการตีความภาพแนวลึกเพื่อให้บริเวณที่มืดกว่าสูงขึ้น
- Name
- smoothing
- Type
- number
- ค่าเริ่มต้น 0.24
- Description
ความแรงของการทำให้เรียบที่ใช้กับภาพแนวลึกก่อนการสกัดนูน ช่วง:
[0, 10].
- Name
- relief_scale
- Type
- number
- ค่าเริ่มต้น 1.0
- Description
ตัวคูณสเกลแนวตั้งที่ใช้เพิ่มเติมบน
relief_height_mmช่วง:(0, 10].
- Name
- depth_threshold
- Type
- number
- ค่าเริ่มต้น 0.1
- Description
เกณฑ์การกรองค่าต่ำสำหรับค่าภาพแนวลึก; อะไรก็ตามที่ต่ำกว่านี้จะถูกหนีบเป็นศูนย์ ช่วง:
[0, 1].
- Name
- remove_background
- Type
- boolean
- ค่าเริ่มต้น true
- Description
ลบพื้นหลังของภาพแนวคิดของต้นแบบโดยอัตโนมัติก่อนการนูน
แยกจากพารามิเตอร์ต้นแบบที่มีชื่อเดียวกัน (ค่าเริ่มต้น
false) ซึ่งควบคุมว่าภาพต้นแบบเองจะถูกส่งคืนด้วยความโปร่งใสหรือไม่
- Name
- export_resolution
- Type
- integer
- ค่าเริ่มต้น 512
- Description
ความละเอียดของเมชที่ใช้สำหรับการส่งออก ช่วง:
[64, 2048].
output
ตัวเลือกการเลือกฟอร์แมตสายไฟที่เป็นทางเลือก ค่าเริ่มต้นเป็น glb.
- Name
- format
- Type
- string
- ค่าเริ่มต้น glb
- Description
ชุดอาร์ติแฟกต์ที่ส่งคืนโดยการสร้าง ค่าที่มีให้เลือก:
glb(ค่าเริ่มต้น) — ส่งคืนmodel.glbเพียงชิ้นเดียวภายใต้model_urls.glb.obj— บีบอัดmodel.obj+model.mtl+texture.pngและส่งคืนชุดภายใต้model_urls.obj.zip— บีบอัดทุกอาร์ติแฟกต์ที่ตัวสร้างส่งออกและส่งคืนชุดภายใต้model_urls.bundle_zip.
การส่งคืน
คุณสมบัติ result ของการตอบกลับประกอบด้วยรหัสงาน id ของงานสร้างแม่เหล็กติดตู้เย็นที่สร้างขึ้นใหม่ ตรวจสอบเอนด์พอยต์ Get a Task หรือสมัครรับข้อมูลจาก stream จนกว่างานจะถึงสถานะ SUCCEEDED จากนั้นดาวน์โหลดอาร์ติแฟกต์จากรายการเดียวใน model_urls.
โหมดความล้มเหลว
- Name
400 - Bad Request- Description
คำขอไม่สามารถยอมรับได้ สาเหตุทั่วไป:
- พารามิเตอร์ที่ขาดหายไป:
input_task_idเป็นสิ่งจำเป็น - UUID ไม่ถูกต้อง:
input_task_idไม่ใช่ UUID ที่ถูกต้อง - ต้นแบบไม่สำเร็จ: งานต้นแบบที่อ้างอิงยังไม่ถึงสถานะ
SUCCEEDED - ไม่มีผู้สมัคร: งานต้นแบบสำเร็จแต่ไม่ได้ผลิตภาพผู้สมัคร
- ตัวเลือกนอกช่วง: หนึ่งในฟิลด์
optionsอยู่นอกช่วงที่อนุญาตหรือชุด enum
- พารามิเตอร์ที่ขาดหายไป:
- 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/fridge-magnet/v1/build \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"input_task_id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
"options": {
"badge_shape": "rounded-rect",
"size_mm": 60,
"relief_height_mm": 3.3
},
"output": {
"format": "glb"
}
}'
Response
{
"result": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0"
}
ดึงข้อมูลงานแม่เหล็กติดตู้เย็น
ดึงข้อมูลงานต้นแบบหรือสร้างงานที่กำหนดโดย id ของงานที่ถูกต้อง เส้นทาง URL
ต้องตรงกับขั้นตอนของงาน — งานสร้างที่ถูกดึงผ่าน
/prototype/:id จะคืนค่า 404 และในทางกลับกัน
ดูที่ วัตถุงานต้นแบบแม่เหล็กติดตู้เย็น และ วัตถุงานสร้างแม่เหล็กติดตู้เย็น สำหรับ รูปแบบการตอบกลับ
พารามิเตอร์
- Name
- id
- Type
- path
- Description
ตัวระบุเฉพาะสำหรับงานแม่เหล็กติดตู้เย็นที่จะดึงข้อมูล
การคืนค่า
การตอบกลับจะประกอบด้วยวัตถุงานแม่เหล็กติดตู้เย็น รูปแบบขึ้นอยู่กับขั้นตอนที่ร้องขอ
Request
# Prototype
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
# Build
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Prototype Response
{
"id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
"type": "creative-lab-fridge-magnet-prototype",
"name": "",
"status": "SUCCEEDED",
"progress": 100,
"created_at": 1729543210000,
"started_at": 1729543215000,
"finished_at": 1729543242000,
"expires_at": 1729802442000,
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 6,
"image_urls": [
"https://assets.meshy.ai/***/concept.png?Expires=***"
]
}
Build Response
{
"id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
"type": "creative-lab-fridge-magnet-build",
"name": "",
"status": "SUCCEEDED",
"progress": 100,
"created_at": 1729543250000,
"started_at": 1729543258000,
"finished_at": 1729543285000,
"expires_at": 1729802485000,
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 20,
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
}
}
ลบงานแม่เหล็กติดตู้เย็น
ยกเลิกงานแม่เหล็กติดตู้เย็น หากงานยังอยู่ในสถานะ PENDING เครดิตที่ใช้ไปในขณะสร้างจะถูกคืน งานที่อยู่ในสถานะ IN_PROGRESS จะถูกยกเลิกโดยไม่มีการคืนเงิน (เนื่องจากผู้ปฏิบัติงานอาจกำลังใช้แหล่งข้อมูลอยู่) งานที่ได้เข้าสู่สถานะสุดท้ายแล้ว (SUCCEEDED, FAILED, CANCELED) จะไม่สามารถยกเลิกได้
เส้นทาง URL ต้องตรงกับขั้นตอนของงาน — DELETE บน
/prototype/:buildId จะส่งคืน 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/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
// Returns 204 No Content on success (empty body).
สตรีมงานแม่เหล็กติดตู้เย็น
สตรีมการอัปเดตแบบเรียลไทม์สำหรับงานแม่เหล็กติดตู้เย็นผ่าน Server-Sent Events (SSE) เส้นทาง URL ต้องตรงกับขั้นตอนของงาน — การเปิดสตรีมที่ /prototype/:buildId/stream จะส่ง event: error เพย์โหลดเดียวพร้อม status_code: 404 และปิดสตรีม
พารามิเตอร์
- Name
- id
- Type
- path
- Description
ตัวระบุเฉพาะสำหรับงานแม่เหล็กติดตู้เย็นที่จะสตรีม
ผลลัพธ์ที่ได้
ส่งคืนสตรีมของวัตถุงาน Fridge Magnet Prototype หรือ Fridge Magnet Build เป็น Server-Sent Events สำหรับงานที่อยู่ในสถานะ PENDING หรือ IN_PROGRESS สตรีมการตอบสนองจะรวมเฉพาะฟิลด์ progress และ status ที่จำเป็นเท่านั้น
Request
curl -N https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/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": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
"progress": 0,
"status": "PENDING"
}
event: message
data: {
"id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
"type": "creative-lab-fridge-magnet-build",
"status": "SUCCEEDED",
"progress": 100,
"created_at": 1729543250000,
"started_at": 1729543258000,
"finished_at": 1729543285000,
"expires_at": 1729802485000,
"task_error": null,
"consumed_credits": 20,
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?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/fridge-magnet/v1/prototype?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response (List Prototype Tasks)
[
{
"id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
"type": "creative-lab-fridge-magnet-prototype",
"name": "",
"status": "SUCCEEDED",
"progress": 100,
"created_at": 1729543210000,
"started_at": 1729543215000,
"finished_at": 1729543242000,
"expires_at": 1729802442000,
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 6,
"image_urls": [
"https://assets.meshy.ai/***/concept.png?Expires=***"
]
}
]
วัตถุงานต้นแบบแม่เหล็กติดตู้เย็น
วัตถุงานต้นแบบแม่เหล็กติดตู้เย็นเป็นหน่วยงานที่ Meshy ติดตามเพื่อสร้าง ภาพแนวคิด ที่มีสีสันจากภาพถ่ายต้นฉบับ ผลลัพธ์ของขั้นตอนนี้จะถูกเชื่อมโยงไปยัง ขั้นตอนการสร้าง ผ่าน input_task_id
คุณสมบัติ
- Name
- id
- Type
- string
- Description
ตัวระบุเฉพาะสำหรับงานนี้ แม้ว่าเราจะใช้ UUID ที่สามารถเรียงลำดับได้สำหรับ id ของงานเป็นรายละเอียดการดำเนินการ คุณไม่ควรทำการสันนิษฐานใดๆ เกี่ยวกับรูปแบบของ id
- Name
- type
- Type
- string
- Description
ประเภทของงาน ค่าคือ
creative-lab-fridge-magnet-prototype
- Name
- name
- Type
- string
- Description
ชื่อของงานที่ถูกระบุเมื่อสร้างงาน หากไม่มีการระบุชื่อจะเป็นสตริงว่าง
- Name
- status
- Type
- string
- Description
สถานะของงาน ค่าที่เป็นไปได้คือหนึ่งใน
PENDING,IN_PROGRESS,SUCCEEDED,FAILED,CANCELED
- Name
- progress
- Type
- integer
- Description
ความคืบหน้าของงาน หากงานยังไม่เริ่มต้น คุณสมบัตินี้จะเป็น
0เมื่อใดที่งานสำเร็จแล้ว ค่านี้จะกลายเป็น100
- Name
- created_at
- Type
- timestamp
- Description
ไทม์สแตมป์ของเวลาที่งานถูกสร้างขึ้นในหน่วยมิลลิวินาที
ไทม์สแตมป์แสดงถึงจำนวนมิลลิวินาทีที่ผ่านไปตั้งแต่วันที่ 1 มกราคม 1970 UTC ตามมาตรฐาน RFC 3339 ตัวอย่างเช่น วันศุกร์ที่ 1 กันยายน 2023 เวลา 12:00:00 PM GMT จะแสดงเป็น
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คืนค่า0สำหรับงานFAILED(เครดิตจะถูกคืนเมื่อเกิดความล้มเหลว)
- Name
- image_urls
- Type
- array of strings
- Description
URLs ที่สามารถดาวน์โหลดได้สำหรับภาพแนวคิดที่สร้างขึ้นโดยงานต้นแบบนี้ ปัจจุบัน API จะคืนค่าเพียงหนึ่งตัวเลือกเสมอ ฟิลด์นี้เป็นอาร์เรย์เพื่อให้การปรับปรุงในอนาคตสามารถแสดงตัวเลือกหลายตัวโดยไม่ทำให้เกิดการเปลี่ยนแปลงที่ทำให้เกิดความเสียหาย
ตัวอย่างวัตถุงานต้นแบบแม่เหล็กติดตู้เย็น
{
"id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
"type": "creative-lab-fridge-magnet-prototype",
"name": "",
"status": "SUCCEEDED",
"progress": 100,
"created_at": 1729543210000,
"started_at": 1729543215000,
"finished_at": 1729543242000,
"expires_at": 1729802442000,
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 6,
"image_urls": [
"https://assets.meshy.ai/***/concept.png?Expires=***"
]
}
วัตถุงานสร้างแม่เหล็กติดตู้เย็น
วัตถุงานสร้างแม่เหล็กติดตู้เย็นเป็นหน่วยงานที่ Meshy ใช้ติดตามเพื่อสร้างเมชแม่เหล็กติดตู้เย็น 3D สุดท้ายจากงานต้นแบบที่ประสบความสำเร็จ การสร้างจะทำงานผ่านกระบวนการแผนที่ความลึกบนภาพแนวคิดของต้นแบบและเผยแพร่สิ่งประดิษฐ์เมชเดียวในรูปแบบที่ผู้เรียกร้องขอ
คุณสมบัติ
- Name
- id
- Type
- string
- Description
ตัวระบุเฉพาะสำหรับงาน
- Name
- type
- Type
- string
- Description
ประเภทของงาน ค่าคือ
creative-lab-fridge-magnet-build
- Name
- name
- Type
- string
- Description
ชื่องานที่ให้เมื่อสร้างงาน ถ้าไม่มีการให้ชื่อจะเป็นสตริงว่าง
- Name
- status
- Type
- string
- Description
สถานะของงาน ค่าที่เป็นไปได้คือหนึ่งใน
PENDING,IN_PROGRESS,SUCCEEDED,FAILED,CANCELED
- Name
- progress
- Type
- integer
- Description
ความคืบหน้าของงาน ถ้างานยังไม่เริ่ม คุณสมบัตินี้จะเป็น
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
จำนวนเครดิตที่ใช้โดยงานนี้ คืนค่า
0สำหรับงานFAILED(เครดิตจะถูกคืนเมื่อเกิดความล้มเหลว)
- Name
- model_urls
- Type
- object
- Description
URL ที่สามารถดาวน์โหลดได้สำหรับสิ่งประดิษฐ์ที่สร้างขึ้น โดยมีคีย์ตามชื่อสิ่งประดิษฐ์ มีรายการเดียวเสมอ — รูปแบบที่ขอผ่าน
output.formatของคำขอสร้าง คีย์ตรงกับรูปแบบที่ขอ:- Name
glb- Type
- string
- Description
URL ที่สามารถดาวน์โหลดได้สำหรับไฟล์ GLB มีเมื่อ
output.formatเป็นglb(ค่าเริ่มต้น)
- Name
obj- Type
- string
- Description
URL ที่สามารถดาวน์โหลดได้สำหรับไฟล์ zip ที่มี
model.obj,model.mtl, และtexture.pngมีเมื่อoutput.formatเป็นobj
- Name
bundle_zip- Type
- string
- Description
URL ที่สามารถดาวน์โหลดได้สำหรับไฟล์ zip ของทุกสิ่งประดิษฐ์ที่ตัวสร้างปล่อยออกมา มีเมื่อ
output.formatเป็นzip
Example Fridge Magnet Build Task Object
{
"id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
"type": "creative-lab-fridge-magnet-build",
"name": "",
"status": "SUCCEEDED",
"progress": 100,
"created_at": 1729543250000,
"started_at": 1729543258000,
"finished_at": 1729543285000,
"expires_at": 1729802485000,
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 20,
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
}
}