Creative Lab — API แม่เหล็กติดตู้เย็น

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

POST /openapi/creative-lab/fridge-magnet/v1/prototype
POST /openapi/creative-lab/fridge-magnet/v1/build

POST/openapi/creative-lab/fridge-magnet/v1/prototype

สร้างงานต้นแบบแม่เหล็กติดตู้เย็น

สร้างภาพคอนเซ็ปต์ที่ลงสีแล้วหนึ่งภาพจากรูปถ่ายต้นฉบับ ID งานที่ส่งกลับคือสิ่งที่คุณส่งเป็น 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 อักขระ

ส่งคืน

พร็อพเพอร์ตี้ result ของการตอบกลับมี id ของงานต้นแบบแม่เหล็กติดตู้เย็นที่สร้างใหม่ ให้ poll เอนด์พอยต์ รับงาน หรือสมัครรับ 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/fridge-magnet/v1/prototype

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

Prototype example

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

Source landscape photo used as the Creative Lab Fridge Magnet input — Prototype input

Creative Lab Fridge Magnet prototype output generated from the source photo — Prototype output

POST/openapi/creative-lab/fridge-magnet/v1/build

สร้างงานบิลด์แม่เหล็กติดตู้เย็น

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

พารามิเตอร์

Name
input_task_id
Type
string
จำเป็น
Description
ID งานของงานต้นแบบที่สร้างผ่านเอนด์พอยต์ 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
รูปทรงเงาด้านนอกของแม่เหล็กติดตู้เย็น ค่าที่ใช้ได้:
- circle
- rounded-rect (ค่าเริ่มต้น)
- hexagon
- shield
- star
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
เคิร์ฟการแปลงที่แมปค่าของ depth-map ไปเป็นความสูงภาพนูน ค่าที่ใช้ได้:
- linear (ค่าเริ่มต้น)
- gamma
- s-curve
Name
curve_param
Type
number
ค่าเริ่มต้น 1.0
Description
พารามิเตอร์รูปร่างสำหรับเคิร์ฟการแปลง (มีความหมายเฉพาะเมื่อ relief_curve เป็น gamma) ช่วง: (0, 10]
Name
invert_depth
Type
boolean
ค่าเริ่มต้น false
Description
กลับการตีความ depth-map เพื่อให้บริเวณที่เข้มกว่ากลายเป็นภาพนูนที่สูงกว่า
Name
smoothing
Type
number
ค่าเริ่มต้น 0.24
Description
ความแรงของการทำให้เรียบที่ใช้กับ depth map ก่อนการแยกภาพนูน ช่วง: [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 สำหรับค่าของ depth-map; ค่าใดก็ตามที่ต่ำกว่านี้จะถูกจำกัดเป็นศูนย์ ช่วง: [0, 1]
Name
remove_background
Type
boolean
ค่าเริ่มต้น true
Description
ลบพื้นหลังของภาพคอนเซ็ปต์ของต้นแบบโดยอัตโนมัติก่อนทำเป็นภาพนูน
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 เป็น 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
งานต้นแบบที่อ้างอิงไม่มีอยู่ เป็นของผู้ใช้อื่น หรือถูกสร้างผ่านเว็บแอป (เฉพาะงานต้นแบบใน mode API เท่านั้นที่เชื่อมต่อไปยังการบิลด์ได้)
Name
429 - Too Many Requests
Description
คุณได้เกินการจำกัดอัตราของคุณแล้ว

Request

POST

/openapi/creative-lab/fridge-magnet/v1/build

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

Build example

The build task turns the selected prototype image into a 3D-printable fridge magnet model.

Creative Lab Fridge Magnet build model preview — Build model preview

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

ดึงข้อมูลงานแม่เหล็กติดตู้เย็น

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

โปรดดู อ็อบเจ็กต์งาน Prototype แม่เหล็กติดตู้เย็น และ อ็อบเจ็กต์งาน Build แม่เหล็กติดตู้เย็น สำหรับ รูปแบบการตอบกลับ

พารามิเตอร์

Name
id
Type
path
Description
ตัวระบุเฉพาะสำหรับงานแม่เหล็กติดตู้เย็นที่ต้องการดึงข้อมูล

ส่งคืน

การตอบกลับมีอ็อบเจ็กต์งานแม่เหล็กติดตู้เย็น รูปแบบขึ้นอยู่กับว่า มีการร้องขอ stage ใด

Request

GET

/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9

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

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

ลบงานแม่เหล็กติดตู้เย็น

ยกเลิกงานแม่เหล็กติดตู้เย็น หากงานยังคงเป็น 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

DELETE

/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9

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

GET/openapi/creative-lab/fridge-magnet/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/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/stream

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

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

แสดงรายการงานแม่เหล็กติดตู้เย็น

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

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

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

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

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

GET

/openapi/creative-lab/fridge-magnet/v1/prototype

# 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 แบบ k-sortable สำหรับ 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
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 Fridge Magnet Prototype Task Object

{
  "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 ขั้นสุดท้ายจากงานต้นแบบที่ SUCCEEDED การ สร้างจะรันไปป์ไลน์รีลีฟแบบแผนที่ความลึกบนภาพแนวคิดของต้นแบบและ เผยแพร่อาร์ติแฟกต์เมชรายการเดียวในรูปแบบที่ผู้เรียกขอไว้.

Properties

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
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 ของคำขอ build คีย์ตรงกับรูปแบบที่ร้องขอ:
- 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=***"
  }
}