Creative Lab — Keychain API
เปลี่ยนภาพถ่ายต้นฉบับให้เป็นพวงกุญแจที่พิมพ์ 3 มิติได้ — เหรียญตรารูปแบบลึกที่มีสีสัน — ในสองขั้นตอน: ต้นแบบ สร้างภาพแนวคิดที่มีสีสันจากภาพถ่ายต้นฉบับของคุณ จากนั้น สร้าง เปลี่ยนภาพแนวคิดนั้นให้เป็นโมเดล 3 มิติแบบนูน สองขั้นตอนนี้เชื่อมโยงกันผ่าน input_task_id.
POST /openapi/creative-lab/keychain/v1/prototypePOST /openapi/creative-lab/keychain/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) ซึ่งควบคุมการลบพื้นหลังก่อนการทำ relief
การส่งกลับ
คุณสมบัติ 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 key ของคุณ
- Name
402 - Payment Required- Description
เครดิตไม่เพียงพอในการดำเนินการนี้
- Name
429 - Too Many Requests- Description
คุณได้เกินการจำกัดอัตราของคุณแล้ว
Request
# Stage 1: generate a colorized keychain concept image
curl https://api.meshy.ai/openapi/creative-lab/keychain/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": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
สร้างงานสร้างพวงกุญแจ
สร้างเหรียญพวงกุญแจ 3D ที่สามารถพิมพ์ได้จากงานต้นแบบที่สำเร็จแล้ว งานสร้างจะทำการประมวลผลแผนที่ความลึกบนภาพแนวคิดที่มีสีของต้นแบบและส่งออกวัตถุเมชเพียงชิ้นเดียวในรูปแบบที่คุณต้องการ ดูที่ The Keychain Build Task Object สำหรับรูปแบบการตอบกลับ
พารามิเตอร์
- Name
- input_task_id
- Type
- string
- จำเป็น
- Description
รหัสงานของงานต้นแบบที่สร้างผ่านเอนด์พอยต์ OpenAPI นี้ งานต้นแบบต้องถูกสร้างด้วย API คีย์เดียวกัน ต้องถึงสถานะ
SUCCEEDEDและต้องสร้างภาพผู้สมัครเพียงภาพเดียวงานต้นแบบที่สร้างผ่านเว็บแอปจะ ไม่ ถูกยอมรับ — เอนด์พอยต์สร้างจะยอมรับเฉพาะงานต้นแบบที่สร้างโดย
POST /openapi/creative-lab/keychain/v1/prototypeและปฏิเสธแหล่งอื่นด้วย404
- Name
- name
- Type
- string
- Description
ชื่อของงานที่แสดงผลได้ตามต้องการ สูงสุด 100 ตัวอักษร
options
พารามิเตอร์ปรับแต่งเพิ่มเติมสำหรับจีออเมทรีนูน ทุกฟิลด์มีค่าเริ่มต้นที่เหมาะสม — ส่งเฉพาะฟิลด์ที่คุณต้องการเปลี่ยนแปลง
- Name
- badge_shape
- Type
- string
- ค่าเริ่มต้น circle
- Description
รูปเงาของเหรียญพวงกุญแจ ค่าที่ใช้ได้:
circle(ค่าเริ่มต้น)rounded-recthexagonshieldstar
- Name
- size_mm
- Type
- number
- ค่าเริ่มต้น 40
- Description
ความยาวขอบของสี่เหลี่ยมที่ครอบพวงกุญแจ, หน่วยเป็นมิลลิเมตร ช่วง:
(0, 400].
- Name
- relief_height_mm
- Type
- number
- ค่าเริ่มต้น 2.2
- Description
ความสูงนูนสูงสุดเหนือฐาน, หน่วยเป็นมิลลิเมตร ช่วง:
[0, 20].
- Name
- relief_offset_mm
- Type
- number
- ค่าเริ่มต้น 0
- Description
การเลื่อนแนวตั้งที่ใช้กับนูนก่อนการอัด, หน่วยเป็นมิลลิเมตร ช่วง:
[0, 20].
- Name
- base_thickness_mm
- Type
- number
- ค่าเริ่มต้น 0.1
- Description
ความหนาของแผ่นฐานราบหลังนูน, หน่วยเป็นมิลลิเมตร ช่วง:
[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/keychain/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": {
"badge_shape": "circle",
"size_mm": 40,
"relief_height_mm": 2.5
},
"output": {
"format": "glb"
}
}'
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/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
# Build
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Prototype Response
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "creative-lab-keychain-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": 6,
"image_urls": [
"https://assets.meshy.ai/***/concept.png?Expires=***"
]
}
Build Response
{
"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
"type": "creative-lab-keychain-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": 20,
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/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/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
-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
ตัวระบุเฉพาะสำหรับงานพวงกุญแจที่จะสตรีม
ผลลัพธ์ที่ได้
ส่งคืนสตรีมของวัตถุงาน Keychain Prototype หรือ Keychain Build เป็น Server-Sent Events สำหรับงานที่มีสถานะ PENDING หรือ IN_PROGRESS สตรีมการตอบสนองจะรวมเฉพาะฟิลด์ progress และ status ที่จำเป็นเท่านั้น
Request
curl -N https://api.meshy.ai/openapi/creative-lab/keychain/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-keychain-build",
"status": "SUCCEEDED",
"progress": 100,
"created_at": 1729123500000,
"started_at": 1729123510000,
"finished_at": 1729123535000,
"expires_at": 1729382735000,
"task_error": null,
"consumed_credits": 20,
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/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/keychain/v1/prototype?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/build?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response (List Prototype Tasks)
[
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "creative-lab-keychain-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": 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-keychain-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 จะคืนค่าผู้สมัครเพียงหนึ่งคนเสมอ ฟิลด์นี้เป็นอาเรย์เพื่อให้การปรับปรุงในอนาคตสามารถแสดงผู้สมัครหลายคนได้โดยไม่เกิดการเปลี่ยนแปลงที่ทำให้เกิดข้อผิดพลาด
Example Keychain Prototype Task Object
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "creative-lab-keychain-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": 6,
"image_urls": [
"https://assets.meshy.ai/***/concept.png?Expires=***"
]
}
วัตถุงานสร้างพวงกุญแจ
วัตถุงานสร้างพวงกุญแจเป็นหน่วยงานที่ Meshy ติดตามเพื่อสร้างเมชพวงกุญแจ 3D สุดท้ายจากงานต้นแบบที่สำเร็จแล้ว การสร้างจะรันกระบวนการแผนที่ความลึกบนภาพแนวคิดของต้นแบบและเผยแพร่เมชอาร์ติแฟกต์เดียวในรูปแบบที่ผู้เรียกร้องขอ
คุณสมบัติ
- Name
- id
- Type
- string
- Description
ตัวระบุเฉพาะสำหรับงาน
- Name
- type
- Type
- string
- Description
ประเภทของงาน ค่านี้คือ
creative-lab-keychain-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 Keychain Build Task Object
{
"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
"type": "creative-lab-keychain-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": 20,
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
}
}