Creative Lab — Figure API

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

  • POST /openapi/creative-lab/figure/v1/prototype
  • POST /openapi/creative-lab/figure/v1/build
POST/openapi/creative-lab/figure/v1/prototype

สร้างงานต้นแบบฟิกเกอร์

สร้างภาพคอนเซ็ปต์สไตล์ชิบิจากภาพต้นฉบับที่ให้มา รหัสงานที่ส่งกลับมาคือสิ่งที่คุณต้องส่งเป็น input_task_id ไปยังเอนด์พอยต์การสร้าง ดูที่ The Figure Prototype Task Object สำหรับรูปแบบการตอบกลับ

พารามิเตอร์

  • 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 ของงานต้นแบบฟิกเกอร์ที่สร้างขึ้นใหม่ ตรวจสอบเอนด์พอยต์ Get a Task หรือสมัครรับข้อมูลจาก stream จนกว่างานจะถึง SUCCEEDED จากนั้นส่งรหัสนั้นไปยังเอนด์พอยต์การสร้าง build endpoint เป็น 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

POST
/openapi/creative-lab/figure/v1/prototype
# Stage 1: generate a chibi-style concept image
curl https://api.meshy.ai/openapi/creative-lab/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"
}
ตัวอย่างต้นแบบ
เริ่มต้นด้วยภาพพอร์ตเทรตต้นฉบับ จากนั้นสร้างภาพต้นแบบที่ใช้ในขั้นตอนการสร้าง
พอร์ตเทรตต้นฉบับที่ใช้เป็นข้อมูลนำเข้า Creative Lab Figure
ข้อมูลนำเข้าต้นแบบ
ภาพต้นแบบฟิกเกอร์สไตล์ชิบิที่สร้างจากภาพต้นฉบับ
ผลลัพธ์ต้นแบบ
POST/openapi/creative-lab/figure/v1/build

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

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

พารามิเตอร์

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

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

    งานต้นแบบที่สร้างผ่านเว็บแอปจะ ไม่ ถูกยอมรับ — เอนด์พอยต์การสร้างยอมรับเฉพาะงานต้นแบบที่ผลิตโดย POST /openapi/creative-lab/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/figure/v1/build
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/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"
}
ตัวอย่างการสร้าง
งานสร้างจะเปลี่ยนภาพต้นแบบที่เลือกเป็นโมเดล 3D ที่สามารถดาวน์โหลดได้ซึ่งมีการติดตั้งพื้นผิว
ตัวอย่างโมเดลการสร้างฟิกเกอร์ใน Creative Lab
ตัวอย่างโมเดลการสร้าง
GET/openapi/creative-lab/figure/v1/(prototype|build)/:id

เรียกดูงานฟิกเกอร์

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

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

พารามิเตอร์

  • Name
    id
    Type
    path
    Description

    ตัวระบุเฉพาะสำหรับงานฟิกเกอร์ที่ต้องการเรียกดู

ผลลัพธ์ที่ได้

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

Request

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

# Build
curl https://api.meshy.ai/openapi/creative-lab/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-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-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": 20,
  "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/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/figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578
curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/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/figure/v1/(prototype|build)/:id/stream

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

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

พารามิเตอร์

  • Name
    id
    Type
    path
    Description

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

ผลลัพธ์ที่ได้

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

Request

GET
/openapi/creative-lab/figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream
curl -N https://api.meshy.ai/openapi/creative-lab/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-figure-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 20,
  "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/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

    ขีดจำกัดขนาดหน้า อนุญาตสูงสุด 50 รายการ

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

    ฟิลด์ที่ใช้ในการจัดเรียง ค่าที่ใช้ได้:

    • +created_at: จัดเรียงตามเวลาที่สร้างในลำดับจากน้อยไปมาก
    • -created_at: จัดเรียงตามเวลาที่สร้างในลำดับจากมากไปน้อย

การคืนค่า

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

Request

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

# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/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-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-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

    ไทม์สแตมป์ของเวลาที่เริ่มงาน ในหน่วยมิลลิวินาที หากงานยังไม่เริ่มต้น คุณสมบัตินี้จะเป็น 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 Figure Prototype Task Object

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

คุณสมบัติ

  • Name
    id
    Type
    string
    Description

    ตัวระบุเฉพาะสำหรับงาน

  • Name
    type
    Type
    string
    Description

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

    URLs สำหรับดาวน์โหลดโมเดล 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 Figure Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-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": 20,
  "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=***"
    }
  ]
}