Creative Lab — Brick Figure API

เปลี่ยนภาพถ่ายต้นฉบับให้เป็นฟิกเกอร์ 3D ขนาดเล็กที่สะสมได้ในสไตล์อิฐในสองขั้นตอน: ต้นแบบ สร้างภาพแนวคิดที่มีสไตล์จากภาพถ่ายต้นฉบับของคุณ จากนั้น ประกอบ เปลี่ยนภาพแนวคิดนั้นให้เป็นโมเดล 3D ที่มี texture ขั้นตอนทั้งสองเชื่อมโยงกันผ่าน input_task_id.

  • POST /openapi/creative-lab/brick-figure/v1/prototype
  • POST /openapi/creative-lab/brick-figure/v1/build
POST/openapi/creative-lab/brick-figure/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 ตัวอักษร

  • Name
    remove_background
    Type
    boolean
    ค่าเริ่มต้น false
    Description

    เมื่อกำหนดเป็น true ภาพต้นแบบจะถูกส่งกลับเป็น PNG แบบโปร่งใส RGBA โดยที่พื้นหลังถูกลบออก เพื่อให้คุณสามารถนำวัตถุไปวางบนพื้นหลังใดก็ได้

การตอบกลับ

คุณสมบัติ result ของการตอบกลับจะมี ID งานของงานต้นแบบฟิกเกอร์อิฐที่สร้างขึ้นใหม่ ตรวจสอบเอนด์พอยต์ รับงาน หรือสมัครรับข้อมูล stream จนกว่างานจะถึง SUCCEEDED จากนั้นส่ง ID นั้นไปยัง เอนด์พอยต์การสร้าง เป็น 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
    403 - Forbidden
    Description

    ภาพต้นฉบับถูกตั้งค่าสถานะว่าละเมิดทรัพย์สินทางปัญญา

  • Name
    429 - Too Many Requests
    Description

    คุณได้เกินการจำกัดอัตราของคุณ

Request

POST
/openapi/creative-lab/brick-figure/v1/prototype
# Stage 1: generate a brick-style concept image
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/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"
}
POST/openapi/creative-lab/brick-figure/v1/build

สร้างงานสร้างฟิกเกอร์อิฐ

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

พารามิเตอร์

  • Name
    input_task_id
    Type
    string
    จำเป็น
    Description

    รหัสงานของงานต้นแบบที่สร้างผ่านเอนด์พอยต์ OpenAPI นี้ งานต้นแบบต้องถูกสร้างด้วย API คีย์เดียวกัน ต้องถึงสถานะ SUCCEEDED และต้องสร้างรูปภาพผู้สมัครเพียงหนึ่งภาพเท่านั้น

    งานต้นแบบที่สร้างผ่านเว็บแอป ไม่ ได้รับการยอมรับ — เอนด์พอยต์การสร้างยอมรับเฉพาะงานต้นแบบที่ผลิตโดย POST /openapi/creative-lab/brick-figure/v1/prototype และปฏิเสธแหล่งอื่นด้วย 404

  • Name
    name
    Type
    string
    Description

    ชื่องานที่เป็นทางเลือกสำหรับการแสดงผล สูงสุด 100 ตัวอักษร

การคืนค่า

คุณสมบัติ result ของการตอบสนองประกอบด้วยรหัสงาน id ของงานสร้างฟิกเกอร์อิฐที่สร้างขึ้นใหม่ ตรวจสอบเอนด์พอยต์ รับงาน หรือสมัครสมาชิก สตรีม จนกว่างานจะถึงสถานะ SUCCEEDED จากนั้นดาวน์โหลด GLB ที่มีการติดตั้งพื้นผิวจาก model_urls.glb (หรือคู่ OBJ + MTL จาก model_urls.obj และ model_urls.mtl หากกระบวนการปลายน้ำของคุณต้องการ OBJ)

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

  • Name
    400 - Bad Request
    Description

    คำขอไม่เป็นที่ยอมรับ สาเหตุทั่วไป:

    • พารามิเตอร์ที่ขาดหาย: ต้องการ input_task_id
    • UUID ไม่ถูกต้อง: input_task_id ไม่ใช่ UUID ที่ถูกต้อง
    • ต้นแบบไม่สำเร็จ: งานต้นแบบที่อ้างอิงยังไม่ถึงสถานะ SUCCEEDED
    • ไม่มีผู้สมัคร: งานต้นแบบสำเร็จแต่ไม่ได้สร้างรูปภาพผู้สมัคร
  • Name
    401 - Unauthorized
    Description

    การยืนยันตัวตนล้มเหลว กรุณาตรวจสอบ API คีย์ของคุณ

  • Name
    402 - Payment Required
    Description

    เครดิตไม่เพียงพอในการดำเนินงานนี้

  • Name
    404 - Not Found
    Description

    งานต้นแบบที่อ้างอิงไม่มีอยู่ เป็นของผู้ใช้คนอื่น หรือถูกสร้างผ่านเว็บแอป (เฉพาะงานต้นแบบในโหมด API เท่านั้นที่เชื่อมต่อกับการสร้าง)

  • Name
    429 - Too Many Requests
    Description

    คุณได้เกินการจำกัดอัตราของคุณแล้ว

Request

POST
/openapi/creative-lab/brick-figure/v1/build
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578"
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}
GET/openapi/creative-lab/brick-figure/v1/(prototype|build)/:id

ดึงข้อมูลงานฟิกเกอร์อิฐ

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

ดูที่ วัตถุงานต้นแบบฟิกเกอร์อิฐ และ วัตถุงานสร้างฟิกเกอร์อิฐ สำหรับ รูปแบบการตอบกลับ

พารามิเตอร์

  • Name
    id
    Type
    path
    Description

    ตัวระบุเฉพาะสำหรับงานฟิกเกอร์อิฐที่จะดึงข้อมูล

การส่งคืน

การตอบกลับประกอบด้วยวัตถุงานฟิกเกอร์อิฐ รูปแบบขึ้นอยู่กับขั้นตอนที่ร้องขอ

Request

GET
/openapi/creative-lab/brick-figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578
# Prototype
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-brick-figure-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-brick-figure-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": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}
DELETE/openapi/creative-lab/brick-figure/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/brick-figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578
curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/brick-figure/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/brick-figure/v1/(prototype|build)/:id/stream

สตรีมงานฟิกเกอร์อิฐ

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

พารามิเตอร์

  • Name
    id
    Type
    path
    Description

    ตัวระบุเฉพาะสำหรับงานฟิกเกอร์อิฐที่จะสตรีม

การส่งคืน

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

Request

GET
/openapi/creative-lab/brick-figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream
curl -N https://api.meshy.ai/openapi/creative-lab/brick-figure/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-brick-figure-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}
GET/openapi/creative-lab/brick-figure/v1/(prototype|build)

รายการงานฟิกเกอร์อิฐ

ดึงรายการงานฟิกเกอร์อิฐที่แบ่งหน้าในแต่ละขั้นตอน 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

    ขีดจำกัดขนาดหน้า จำนวนสูงสุดที่อนุญาตคือ 100 รายการ

  • Name
    sort_by
    Type
    string
    ค่าเริ่มต้น -created_at
    Description

    ฟิลด์สำหรับการจัดเรียง ค่าใช้ได้:

    • +created_at: จัดเรียงตามเวลาสร้างในลำดับเพิ่มขึ้น
    • -created_at: จัดเรียงตามเวลาสร้างในลำดับลดลง

การคืนค่า

คืนรายการงานต่อขั้นตอนที่แบ่งหน้า — ไม่ว่าจะเป็น วัตถุงานต้นแบบฟิกเกอร์อิฐ เมื่อแสดงรายการ /prototype หรือ วัตถุงานสร้างฟิกเกอร์อิฐ เมื่อ แสดงรายการ /build

Request

GET
/openapi/creative-lab/brick-figure/v1/prototype
# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-brick-figure-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-brick-figure-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

    ไทม์สแตมป์เมื่อเริ่มงานในหน่วยมิลลิวินาที ถ้างานยังไม่เริ่ม คุณสมบัตินี้จะเป็น null

  • Name
    finished_at
    Type
    timestamp
    Description

    ไทม์สแตมป์เมื่อสิ้นสุดงานในหน่วยมิลลิวินาที ถ้างานยังไม่สิ้นสุด คุณสมบัตินี้จะเป็น null

  • 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 Brick Figure Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-brick-figure-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 ที่มีเท็กซ์เจอร์ จากงานต้นแบบที่สำเร็จแล้ว มันใช้กระบวนการแปลงรูปภาพเป็น 3D เดียวกันกับที่ใช้โดย รูปภาพเป็น 3D ดังนั้นฟิลด์ผลลัพธ์จึงสะท้อนถึง วัตถุงาน ของเอนด์พอยต์นั้น

คุณสมบัติ

  • Name
    id
    Type
    string
    Description

    ตัวระบุที่ไม่ซ้ำกันสำหรับงาน

  • Name
    type
    Type
    string
    Description

    ประเภทของงาน ค่าคือ creative-lab-brick-figure-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
    prompt
    Type
    string
    Description

    ว่างเปล่าสำหรับการสร้างฟิกเกอร์อิฐเสมอ มีเพื่อความเข้ากันได้ข้ามเอนด์พอยต์กับรูปแบบ V2ImageTo3DTaskResponse ที่ใช้โดย รูปภาพเป็น 3D

  • Name
    negative_prompt
    Type
    string
    Description

    ว่างเปล่าสำหรับการสร้างฟิกเกอร์อิฐเสมอ มีเพื่อความเข้ากันได้ข้ามเอนด์พอยต์

  • Name
    texture_prompt
    Type
    string
    Description

    ว่างเปล่าสำหรับการสร้างฟิกเกอร์อิฐเสมอ มีเพื่อความเข้ากันได้ข้ามเอนด์พอยต์

  • Name
    texture_image_url
    Type
    string
    Description

    ว่างเปล่าสำหรับการสร้างฟิกเกอร์อิฐเสมอ มีเพื่อความเข้ากันได้ข้ามเอนด์พอยต์

  • Name
    model_urls
    Type
    object
    Description

    URL ที่สามารถดาวน์โหลดได้สำหรับโมเดล 3D ที่สร้างขึ้น การสร้างฟิกเกอร์อิฐจะปล่อย GLB ที่มีเท็กซ์เจอร์พร้อมกับคู่ OBJ + MTL สำหรับกระบวนการที่ชอบ Wavefront OBJ รูปแบบฟิลด์ตรงกับวัตถุ model_urls รูปภาพเป็น 3D ดังนั้นการเพิ่มรูปแบบในอนาคตจะไม่ทำให้เกิดการเปลี่ยนแปลงที่ทำให้เกิดข้อผิดพลาด

    • Name
      glb
      Type
      string
      Description

      URL ที่สามารถดาวน์โหลดได้สำหรับไฟล์ GLB ที่มีเท็กซ์เจอร์

    • Name
      obj
      Type
      string
      Description

      URL ที่สามารถดาวน์โหลดได้สำหรับไฟล์ Wavefront OBJ (จีออเมทรี + UV)

    • Name
      mtl
      Type
      string
      Description

      URL ที่สามารถดาวน์โหลดได้สำหรับไฟล์แมททีเรียล MTL ที่เป็นคู่กับ OBJ จับคู่กับ obj และรายการจาก texture_urls[0].base_color

  • Name
    thumbnail_url
    Type
    string
    Description

    URL ที่สามารถดาวน์โหลดได้สำหรับภาพย่อของไฟล์โมเดล

  • Name
    texture_urls
    Type
    array
    Description

    อาร์เรย์ของวัตถุ URL เท็กซ์เจอร์ที่สร้างโดยงานนี้ ปัจจุบันมีวัตถุเดียวที่มีแผนที่สีพื้นฐาน

    • Name
      base_color
      Type
      string
      Description

      URL ที่สามารถดาวน์โหลดได้สำหรับภาพแผนที่สีพื้นฐาน

Example Brick Figure Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-brick-figure-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": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}