Creative Lab — API พวงกุญแจ

เปลี่ยนภาพถ่ายต้นทางให้เป็นเหรียญพวงกุญแจที่พร้อมพิมพ์ 3D — ภาพนูนความลึก แบบลงสีทรงป้าย — ในสองขั้นตอน: prototype สร้างภาพแนวคิดแบบลงสี จากภาพถ่ายอินพุตของคุณ จากนั้น build เปลี่ยนภาพแนวคิดนั้น ให้เป็นโมเดล 3D แบบนูน ทั้งสองขั้นตอนเชื่อมโยงกันผ่าน input_task_id

POST /openapi/creative-lab/keychain/v1/prototype
POST /openapi/creative-lab/keychain/v1/build

POST/openapi/creative-lab/keychain/v1/prototype

สร้างงานต้นแบบพวงกุญแจ

สร้างภาพคอนเซปต์แบบลงสีภาพเดียวจากภาพถ่ายต้นฉบับ task ID ที่ส่งกลับมาคือค่าที่คุณส่งเป็น input_task_id ไปยังเอนด์พอยต์ build โปรดดู อ็อบเจ็กต์งานต้นแบบพวงกุญแจ สำหรับรูปแบบการตอบกลับ

พารามิเตอร์

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 อักขระ

ส่งคืน

พร็อพเพอร์ตี result ของการตอบกลับมี id ของงานต้นแบบพวงกุญแจที่สร้างขึ้นใหม่ ให้ polling เอนด์พอยต์ รับงาน หรือสมัครรับ stream จนกว่างานจะถึงสถานะ SUCCEEDED จากนั้นส่ง ID นั้นไปยัง เอนด์พอยต์ build เป็น input_task_id

โหมดความล้มเหลว

Name
400 - Bad Request
Description
คำขอไม่สามารถยอมรับได้ สาเหตุที่พบบ่อย:
- พารามิเตอร์ขาดหาย: ต้องระบุ image_url
- รูปแบบรูปภาพไม่ถูกต้อง: image_url ที่ระบุไม่ใช่รูปแบบที่รองรับ (.jpg, .jpeg, .png, .webp)
- ขนาดรูปภาพอยู่นอกช่วง: รูปภาพมีขนาดเล็กเกินไป เกินขนาดไฟล์สูงสุด หรือเกินจำนวนพิกเซลสูงสุด
- URL เข้าถึงไม่ได้: ไม่สามารถดาวน์โหลด image_url ได้ (404 หรือ timeout)
- Data URI ไม่ถูกต้อง: สตริง base64 มีรูปแบบไม่ถูกต้อง
- เนื้อหาถูกตั้งค่าสถานะ: รูปภาพอินพุตถูกตั้งค่าสถานะโดย NSFW หรือ moderation ด้านทรัพย์สินทางปัญญา
Name
401 - Unauthorized
Description
การยืนยันตัวตนล้มเหลว โปรดตรวจสอบ API คีย์ของคุณ
Name
402 - Payment Required
Description
เครดิตไม่เพียงพอสำหรับดำเนินงานนี้
Name
429 - Too Many Requests
Description
คุณเกินการจำกัดอัตราของคุณแล้ว

Request

POST

/openapi/creative-lab/keychain/v1/prototype

# 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"
}

Prototype example

Start with a source photo, then generate the prototype image used by the keychain build stage.

ภาพถ่ายต้นฉบับที่ใช้เป็นอินพุต Creative Lab พวงกุญแจ — Prototype input

เอาต์พุตต้นแบบ Creative Lab พวงกุญแจที่สร้างจากภาพถ่ายต้นฉบับ — Prototype output

POST/openapi/creative-lab/keychain/v1/build

สร้างงานบิลด์พวงกุญแจ

สร้างเหรียญพวงกุญแจขั้นสุดท้ายที่พิมพ์ 3D ได้จากงานต้นแบบที่สำเร็จแล้ว การบิลด์จะรันไปป์ไลน์ relief จากแผนที่ความลึกบนรูปภาพแนวคิดที่ลงสีแล้วของ ต้นแบบ และส่งอาร์ติแฟกต์เมชเดี่ยวในรูปแบบที่คุณระบุ ดู ออบเจ็กต์งานบิลด์พวงกุญแจ สำหรับ รูปแบบการตอบกลับ

พารามิเตอร์

Name
input_task_id
Type
string
จำเป็น
Description
ID งานของงานต้นแบบที่สร้างผ่านเอนด์พอยต์ OpenAPI เดียวกันนี้ ต้นแบบต้องถูกสร้างด้วย API คีย์เดียวกัน ต้องถึงสถานะ SUCCEEDED แล้ว และต้องสร้างรูปภาพตัวเลือกเพียงหนึ่งรูปเท่านั้น
งานต้นแบบที่สร้างผ่านเว็บแอปจะ ไม่ ได้รับการยอมรับ — เอนด์พอยต์บิลด์ยอมรับเฉพาะงานต้นแบบที่สร้างโดย POST /openapi/creative-lab/keychain/v1/prototype และจะปฏิเสธแหล่งที่มาอื่นด้วย 404
Name
name
Type
string
Description
ชื่องานแบบไม่บังคับสำหรับใช้แสดงผล สูงสุด 100 ตัวอักษร

`options`

พารามิเตอร์ปรับแต่งแบบไม่บังคับสำหรับจีออเมทรี relief ทุกฟิลด์มีค่าเริ่มต้นที่เหมาะสม — ส่งเฉพาะฟิลด์ที่คุณต้องการแทนที่

Name
badge_shape
Type
string
ค่าเริ่มต้น circle
Description
รูปทรงเส้นขอบของเหรียญพวงกุญแจ ค่าที่ใช้ได้:
- circle (ค่าเริ่มต้น)
- rounded-rect
- hexagon
- shield
- star
Name
size_mm
Type
number
ค่าเริ่มต้น 40
Description
ความยาวด้านของกรอบสี่เหลี่ยมจัตุรัสที่ครอบพวงกุญแจ หน่วยเป็นมิลลิเมตร ช่วง: (0, 400]
Name
relief_height_mm
Type
number
ค่าเริ่มต้น 2.2
Description
ความสูง relief สูงสุดเหนือฐาน หน่วยเป็นมิลลิเมตร ช่วง: [0, 20]
Name
relief_offset_mm
Type
number
ค่าเริ่มต้น 0
Description
ออฟเซ็ตแนวตั้งที่ใช้กับ relief ก่อนการอัดขึ้นรูป หน่วยเป็นมิลลิเมตร ช่วง: [0, 20]
Name
base_thickness_mm
Type
number
ค่าเริ่มต้น 0.1
Description
ความหนาของแผ่นฐานแบนด้านหลัง relief หน่วยเป็นมิลลิเมตร ช่วง: [0, 20]
Name
has_closed_back
Type
boolean
ค่าเริ่มต้น true
Description
กำหนดว่าด้านหลังของเหรียญจะถูกปิดผนึกเป็นพื้นผิวปิดหรือไม่ ตั้งเป็น false สำหรับเปลือกแบบเปิด
Name
relief_curve
Type
string
ค่าเริ่มต้น linear
Description
เส้นโค้งการถ่ายโอนที่แมปค่าแผนที่ความลึกกับความสูง relief ค่าที่ใช้ได้:
- linear (ค่าเริ่มต้น)
- gamma
- s-curve
Name
curve_param
Type
number
ค่าเริ่มต้น 1.0
Description
พารามิเตอร์รูปร่างสำหรับเส้นโค้งการถ่ายโอน (มีความหมายเฉพาะเมื่อ relief_curve เป็น gamma) ช่วง: (0, 10]
Name
invert_depth
Type
boolean
ค่าเริ่มต้น false
Description
กลับการตีความแผนที่ความลึกเพื่อให้บริเวณที่มืดกว่ากลายเป็น relief ที่สูงกว่า
Name
smoothing
Type
number
ค่าเริ่มต้น 0.24
Description
ความแรงของการปรับให้เรียบที่ใช้กับแผนที่ความลึกก่อนการสกัด relief ช่วง: [0, 10]
Name
relief_scale
Type
number
ค่าเริ่มต้น 1.0
Description
ตัวคูณสเกลแนวตั้งที่ใช้เพิ่มเติมจาก relief_height_mm ช่วง: (0, 10]
Name
depth_threshold
Type
number
ค่าเริ่มต้น 0.1
Description
ค่าเกณฑ์แบบ low-pass สำหรับค่าแผนที่ความลึก; ค่าใดก็ตามที่ต่ำกว่านี้จะถูกจำกัดเป็นศูนย์ ช่วง: [0, 1]
Name
remove_background
Type
boolean
ค่าเริ่มต้น true
Description
ลบพื้นหลังของรูปภาพแนวคิดของต้นแบบโดยอัตโนมัติก่อนทำ relief
Name
export_resolution
Type
integer
ค่าเริ่มต้น 512
Description
ความละเอียดของเมชที่ใช้สำหรับการส่งออก ช่วง: [64, 2048]

`output`

ตัวเลือก wire-format แบบไม่บังคับ ค่าเริ่มต้นคือ glb

Name
format
Type
string
ค่าเริ่มต้น glb
Description
ชุดอาร์ติแฟกต์ที่ส่งกลับโดยการบิลด์ ค่าที่ใช้ได้:
- glb (ค่าเริ่มต้น) — ส่งกลับ model.glb เดี่ยวภายใต้ model_urls.glb
- obj — บีบอัด model.obj + model.mtl + texture.png เป็น zip และส่งกลับชุดภายใต้ model_urls.obj
- zip — บีบอัดทุกอาร์ติแฟกต์ที่ตัวสร้างปล่อยออกมาเป็น zip และส่งกลับชุดภายใต้ model_urls.bundle_zip

ส่งกลับ

พร็อพเพอร์ตี result ของการตอบกลับมี id งานของงานบิลด์พวงกุญแจที่สร้างใหม่ โพลเอนด์พอยต์ รับงาน หรือสมัครรับข้อมูล สตรีม จนกว่างานจะถึง 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-mode เท่านั้นที่เชื่อมต่อเข้าสู่การบิลด์)
Name
429 - Too Many Requests
Description
คุณใช้เกินการจำกัดอัตราของคุณแล้ว

Request

POST

/openapi/creative-lab/keychain/v1/build

# 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"
}

Build example

The build task converts the selected prototype image into a 3D-printable keychain model.

Creative Lab Keychain build model preview — Build model preview

GET/openapi/creative-lab/keychain/v1/(prototype|build)/:id

ดึงข้อมูลงานพวงกุญแจ

ดึงข้อมูลงานต้นแบบหรือบิลด์ด้วย id ของงานที่ถูกต้อง เส้นทาง URL ต้องตรงกับขั้นตอนของงาน — งานบิลด์ที่ดึงผ่าน /prototype/:id จะส่งคืน 404 และในทางกลับกันก็เช่นกัน

โปรดดู ออบเจ็กต์งานต้นแบบพวงกุญแจ และ ออบเจ็กต์งานบิลด์พวงกุญแจ สำหรับ รูปแบบการตอบกลับ

พารามิเตอร์

Name
id
Type
path
Description
ตัวระบุที่ไม่ซ้ำกันสำหรับงานพวงกุญแจที่ต้องการดึงข้อมูล

ส่งคืน

การตอบกลับประกอบด้วยออบเจ็กต์งานพวงกุญแจ รูปแบบจะขึ้นอยู่กับว่า มีการร้องขอขั้นตอนใด

Request

GET

/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578

# 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=***"
  }
}

DELETE/openapi/creative-lab/keychain/v1/(prototype|build)/:id

ลบงานพวงกุญแจ

ยกเลิกงานพวงกุญแจ หากงานยังคงเป็น PENDING เครดิต ที่ใช้ไปในเวลาสร้างจะได้รับการคืน งานที่เป็น IN_PROGRESS อยู่แล้วจะถูกยกเลิกโดยไม่มีการคืนเงิน (worker อาจกำลัง ใช้ทรัพยากรอยู่แล้ว) งานที่เข้าสู่สถานะสิ้นสุดแล้ว (SUCCEEDED, FAILED, CANCELED) ไม่สามารถยกเลิกได้

พาธ URL ต้องตรงกับ stage ของงาน — DELETE บน /prototype/:buildId จะคืนค่า 404

พารามิเตอร์พาธ

Name
id
Type
path
Description
ตัวระบุเฉพาะสำหรับงานพวงกุญแจที่จะยกเลิก

การส่งคืน

ส่งคืน 204 No Content เมื่อสำเร็จพร้อม body ว่าง

โหมดความล้มเหลว

Name
400 - Bad Request
Description
งานอยู่ในสถานะสิ้นสุดแล้วและไม่สามารถยกเลิกได้
Name
404 - Not Found
Description
งานไม่มีอยู่ เป็นของผู้ใช้อื่น หรือ stage ของงานไม่ตรงกับพาธ URL

Request

DELETE

/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578

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).

GET/openapi/creative-lab/keychain/v1/(prototype|build)/:id/stream

สตรีมงานพวงกุญแจ

สตรีมการอัปเดตแบบเรียลไทม์สำหรับงานพวงกุญแจผ่าน Server-Sent Events (SSE). พาธ URL ต้องตรงกับขั้นตอนของงาน — การเปิดสตรีมที่ /prototype/:buildId/stream จะปล่อยเพย์โหลด event: error เพียงรายการเดียวพร้อม status_code: 404 และปิดสตรีม

พารามิเตอร์

Name
id
Type
path
Description
ตัวระบุเฉพาะสำหรับงานพวงกุญแจที่จะสตรีม

ผลลัพธ์ที่ส่งคืน

ส่งคืนสตรีมของออบเจ็กต์งาน พวงกุญแจต้นแบบ หรือ บิลด์พวงกุญแจ เป็น Server-Sent Events สำหรับงาน PENDING หรือ IN_PROGRESS สตรีมการตอบกลับ จะมีเฉพาะฟิลด์ progress และ status ที่จำเป็นเท่านั้น

Request

GET

/openapi/creative-lab/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream

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=***"
  }
}

GET/openapi/creative-lab/keychain/v1/(prototype|build)

แสดงรายการงานพวงกุญแจ

ดึงรายการงานพวงกุญแจของคุณแบบแบ่งหน้าสำหรับขั้นตอนเดียว เส้นทาง URL จะเลือกขั้นตอน — /prototype จะส่งคืนงาน prototype; /build จะส่งคืนงาน build งานจากขั้นตอนอื่นจะไม่ถูกรวมอยู่ใน การตอบกลับใด ๆ

พารามิเตอร์เส้นทาง

Name
stage
Type
path
จำเป็น
Description
เป็นได้ทั้ง prototype หรือ build คอลเลกชันจะส่งคืนเฉพาะงาน ที่ขั้นตอนตรงกับ URL — การดึง /prototype จะไม่ส่งคืน งาน build และในทางกลับกัน

พารามิเตอร์คิวรี

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 ของพวงกุญแจ เมื่อแสดงรายการ /prototype หรือ ออบเจ็กต์งาน build ของพวงกุญแจ เมื่อ แสดงรายการ /build

Request

GET

/openapi/creative-lab/keychain/v1/prototype

# 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 แบบ k-sortable สำหรับ 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
ค่า progress ของงาน หากงานยังไม่เริ่ม คุณสมบัตินี้จะเป็น 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
URL ที่ดาวน์โหลดได้สำหรับรูปภาพแนวคิดตัวเลือกที่สร้างโดยงานต้นแบบนี้ ปัจจุบัน 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 ขั้นสุดท้ายจากงานต้นแบบที่ SUCCEEDED การสร้างจะรันไปป์ไลน์รีลีฟแบบแผนที่ความลึกบนภาพคอนเซ็ปต์ของต้นแบบ และ เผยแพร่อาร์ติแฟกต์เมชเดียวในรูปแบบที่ผู้เรียกใช้ร้องขอ

คุณสมบัติ

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
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
จำนวนเครดิตที่งานนี้ใช้ ส่งคืน 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=***"
  }
}