รีเท็กซ์เจอร์ API

สร้างเท็กซ์เจอร์ใหม่สำหรับโมเดล 3D ที่มีอยู่แล้วจาก prompt ข้อความหรือภาพอ้างอิง โมเดลสามารถมาจากงาน Meshy อื่นหรือจากไฟล์โมเดลก็ได้

POST/openapi/v1/retexture

สร้างงาน Retexture

สร้างงาน Retexture งานนี้จะทำงานในพื้นหลัง สำหรับระยะเวลาที่งานมักใช้ ดูที่ Processing times

Request

POST

/openapi/v1/retexture

# Retexture with text prompt
curl https://api.meshy.ai/openapi/v1/retexture \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "model_url": "https://cdn.meshy.ai/model/example_model_2.glb",
    "text_style_prompt": "red fangs, Samurai outfit that fused with japanese batik style",
    "enable_original_uv": true,
    "enable_pbr": true
  }'

# Retexture with image style and PBR
curl https://api.meshy.ai/openapi/v1/retexture \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "model_url": "https://cdn.meshy.ai/model/example_model_2.glb",
    "image_style_url": "<your publicly accessible image url or base64-encoded data URI>",
    "ai_model": "latest",
    "enable_pbr": true,
    "enable_original_uv": true
  }'

# Retexture with Meshy N1 from front and back views
curl https://api.meshy.ai/openapi/v1/retexture \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "model_url": "https://cdn.meshy.ai/model/example_model_2.glb",
    "ai_model": "meshy-n1",
    "multiview_image_urls": [
      "<your front view image url or data URI>",
      "<your back view image url or data URI>"
    ]
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

พารามิเตอร์

Name
input_task_id
Type
string
จำเป็น
Description
จำเป็นต้องระบุ เว้นแต่คุณจะส่ง model_url คือ ID ของงานที่สร้างโมเดล 3D เพื่อนำมาใส่เท็กซ์เจอร์ เช่น งานข้อความเป็น 3D, รูปภาพเป็น 3D, รีเมช หรือรีเท็กซ์เจอร์ งานนั้นต้องเป็นงานที่คุณสร้างด้วย API และมีสถานะ SUCCEEDED Meshy จะใส่เท็กซ์เจอร์ให้กับไฟล์ GLB ของงานนั้น
เมื่อใช้ meshy-n1 โมเดลของงานนั้นสามารถมีได้สูงสุด 7,999,999 หน้า นับเป็นสามเหลี่ยม (สี่เหลี่ยมนับเป็น 2)

Name
model_url
Type
string
จำเป็น
Description
จำเป็นต้องระบุ เว้นแต่คุณจะส่ง input_task_id คือโมเดลที่จะใส่เท็กซ์เจอร์ โดยเป็น URL สาธารณะหรือ data URI หากคุณส่งทั้งสองอย่าง Meshy จะใช้ input_task_id
โมเดลต้องเป็นไฟล์ GLB, glTF, OBJ, FBX หรือ STL ขนาดไม่เกิน 400 MB จาก URL แบบ http หรือ https หรือไม่เกิน 100 MB ในรูปแบบ data URI สำหรับ data URI ให้ใช้ MIME type application/octet-stream เช่น data:application/octet-stream;base64,<your base64-encoded model data>
ไฟล์ที่มีขนาดเกิน 100 MB ต้องเป็นไปตามกฎเหล่านี้ด้วย:
- ไฟล์ GLB, glTF, FBX หรือ OBJ สามารถมีได้สูงสุด 10,000,000 หน้า Meshy นับหน้าเป็นสามเหลี่ยม ดังนั้นสี่เหลี่ยมนับเป็น 2 และเมชที่ถูกวาดมากกว่าหนึ่งครั้งจะนับหนึ่งครั้งต่อสำเนา
- ไฟล์ FBX ต้องเป็น binary FBX 7.1 ขึ้นไป
- ไฟล์ GLB หรือ glTF ต้องไม่ใช้การบีบอัดแบบ Draco
เมื่อใช้ meshy-n1 โมเดลสามารถมีได้สูงสุด 7,999,999 หน้า นับเป็นสามเหลี่ยม (สี่เหลี่ยมนับเป็น 2) ไม่ว่าขนาดไฟล์จะเป็นเท่าใด

ส่งอินพุตสไตล์หนึ่งอย่างจากสามอย่างนี้

Name
text_style_prompt
Type
string
จำเป็น
Description
จำเป็นต้องระบุ เว้นแต่คุณจะส่ง image_style_url หรือ multiview_image_urls คือข้อความที่อธิบายเท็กซ์เจอร์ที่คุณต้องการ ความยาวสูงสุด 800 ตัวอักษร ข้อความที่ยาวกว่านี้จะคืนค่า 400 เมื่อใช้ meshy-n1 การส่งค่านี้โดยไม่มี image_style_url จะคืนค่า 400

Name
image_style_url
Type
string
จำเป็น
Description
จำเป็นต้องระบุ เว้นแต่คุณจะส่ง text_style_prompt หรือ multiview_image_urls คือภาพ 2D ที่เท็กซ์เจอร์จะใช้สไตล์ตาม โดยเป็น URL สาธารณะหรือ data URI (data:image/jpeg;base64,<your base64-encoded image data>) หากคุณส่งทั้ง text_style_prompt และ image_style_url Meshy จะใช้ image_style_url
ภาพต้องเป็นไฟล์ .jpg, .jpeg, .png หรือ .webp ขนาดไม่เกิน 20 MB และมีขนาดอย่างน้อย 32 พิกเซลในแต่ละด้าน
เท็กซ์เจอร์อาจไม่เข้ากันดีเมื่อวัตถุในภาพมีรูปทรงที่แตกต่างจากโมเดลมาก เมื่อใช้ meshy-n1 Meshy จะถือว่าภาพนั้นเป็นมุมมองด้านหน้า

Name
multiview_image_urls
Type
string[]
จำเป็น
Description
จำเป็นต้องระบุ เว้นแต่คุณจะส่ง text_style_prompt หรือ image_style_url คือภาพหนึ่งถึงสี่ภาพของวัตถุเดียวกันจากมุมมองที่ต่างกัน ภาพแรกคือมุมมองหลัก (ด้านหน้า) ลำดับของมุมมองอื่น ๆ (ซ้าย หลัง ขวา) ไม่สำคัญ อาร์เรย์ว่างเปล่า หรือมากกว่าสี่ภาพ จะคืนค่า 400
แต่ละภาพเป็นไปตามรูปแบบและกฎขนาดเดียวกับ image_style_url คือไม่เกิน 20 MB ต่อภาพ คุณไม่สามารถใช้ multiview_image_urls ร่วมกับ text_style_prompt หรือ image_style_url ได้
multiview_image_urls ต้องระบุ ai_model อย่างชัดเจนเป็น meshy-7 หรือ meshy-n1 ai_model อื่นใด รวมถึงค่าเริ่มต้น latest จะคืนค่า 400

Name
ai_model
Type
string
ค่าเริ่มต้น latest
Description
โมเดล AI ที่สร้างเท็กซ์เจอร์
ค่าที่ใช้ได้:
- meshy-6-lite
- meshy-6
- meshy-7
- meshy-n1: เท็กซ์เจอร์สีพื้นฐาน 2K จากภาพอ้างอิงเท่านั้น ไม่มี text prompt ไม่มี PBR แมป ไม่มี 4K หรือ 8K สูงสุด 7,999,999 หน้า
- latest: Meshy 7
Name
enable_original_uv
Type
boolean
ค่าเริ่มต้น false
Description
กำหนดว่าจะคงเลย์เอาต์ UV ของโมเดลไว้แทนที่จะสร้างใหม่หรือไม่
- สำหรับโมเดลที่ Meshy สร้างขึ้น จาก input_task_id หรือ model_url ที่ชี้ไปยังผลลัพธ์ของ Meshy ให้ใช้ true เพื่อนำเลย์เอาต์ UV ที่ปรับให้เหมาะสมแล้วกลับมาใช้ใหม่
- สำหรับโมเดลที่คุณอัปโหลดจากที่อื่น ให้ใช้ true เพื่อคง UV ที่ดีอยู่แล้วไว้ ปล่อยให้เป็น false เพื่อให้ Meshy สร้าง UV ใหม่ ซึ่งเหมาะสำหรับโมเดลที่ไม่มีการแมป UV ที่เหมาะสม
Name
enable_pbr
Type
boolean
ค่าเริ่มต้น false
Description
กำหนดว่าจะสร้าง PBR แมป (metallic, roughness และ normal) พร้อมกับสีพื้นฐานด้วยหรือไม่ เมื่อใช้ meshy-6 Meshy จะสร้างแมป emission ด้วย ยกเว้นที่ texture_resolution เป็น 8k meshy-6-lite, meshy-7 และ latest จะไม่สร้างแมป emission เมื่อใช้ meshy-n1 การส่งค่า true จะคืนค่า 400
Name
texture_resolution
Type
string
ค่าเริ่มต้น 2k
Description
ขนาดของเท็กซ์เจอร์สีพื้นฐาน ความละเอียดที่สูงกว่าจะจับรายละเอียดพื้นผิวได้มากกว่า
ค่าที่ใช้ได้:
- 2k: 2048 × 2048 พิกเซล
- 4k: 4096 × 4096 พิกเซล
- 8k: 8192 × 8192 พิกเซล
4k และ 8k ต้องใช้ ai_model เป็น meshy-6, meshy-7 หรือ latest เมื่อใช้ meshy-6-lite หรือ meshy-n1 ค่าดังกล่าวจะคืนค่า 400 ที่ 8k Meshy จะไม่สร้างแมป emission
Name
hd_texture
Type
boolean
⚠ เลิกใช้แล้ว
ค่าเริ่มต้น false
Description
ใช้ texture_resolution แทน true มีความหมายเหมือนกับ texture_resolution: "4k" หากคุณส่งทั้งสองอย่าง Meshy จะใช้ texture_resolution
Name
remove_lighting
Type
boolean
ค่าเริ่มต้น true
Description
กำหนดว่าจะลบไฮไลต์และเงาออกจากเท็กซ์เจอร์สีพื้นฐานหรือไม่ ผลลัพธ์จะทำงานได้ดีกว่าภายใต้แสงของคุณเอง
Meshy จะใช้เฉพาะกับ meshy-6 ที่ texture_resolution เป็น 2k หรือ 4k เมื่อใช้ meshy-7 หรือ latest หรือที่ 8k Meshy จะรับค่านี้แต่ไม่นำไปใช้ เมื่อใช้ meshy-6-lite หรือ meshy-n1 การส่งค่านี้ไม่ว่าค่าใดจะคืนค่า 400
Name
target_formats
Type
string[]
Description
รูปแบบไฟล์ที่จะสร้าง Meshy จะสร้างเฉพาะรูปแบบที่คุณระบุไว้เท่านั้น ซึ่งอาจช่วยลดระยะเวลาของงานได้ หากคุณไม่ระบุ Meshy จะสร้างทุกรูปแบบยกเว้น 3mf
ค่าที่ใช้ได้:
- glb
- obj
- fbx
- stl
- usdz
- 3mf
Name
alpha_thumbnail
Type
boolean
ค่าเริ่มต้น false
Description
กำหนดว่าจะเรนเดอร์ภาพตัวอย่างที่มีพื้นหลังโปร่งใส (RGBA) ด้วยหรือไม่ โดยจะส่งกลับใน alpha_thumbnail_url เมื่อคุณดึงข้อมูลงาน thumbnail_url จะไม่เปลี่ยนแปลง

ผลลัพธ์

ฟิลด์ result ของการตอบกลับเก็บ ID ของงาน Retexture ใหม่

รูปแบบความล้มเหลว

Name
400 - Bad Request
Description
คำขอไม่สามารถทำงานได้ ข้อความแสดงข้อผิดพลาดจะระบุปัญหาที่พบ ตัวอย่างเช่น:
- ขาดพารามิเตอร์: ไม่ได้ส่งทั้ง model_url และ input_task_id
- ขาดสไตล์: ไม่ได้ส่ง text_style_prompt, image_style_url หรือ multiview_image_urls เลย
- อินพุตสไตล์ขัดแย้งกัน: ส่ง multiview_image_urls พร้อมกับ text_style_prompt หรือ image_style_url
- โมเดลไม่รองรับมุมมองหลายด้าน: ส่ง multiview_image_urls โดยไม่ได้ระบุ ai_model อย่างชัดเจนเป็น meshy-7 หรือ meshy-n1
- ตัวเลือกไม่รองรับสำหรับ Meshy N1: ส่ง meshy-n1 พร้อมกับ enable_pbr: true, remove_lighting, texture_resolution เป็น 4k หรือ 8k, hd_texture: true โดยไม่มี texture_resolution, หรือ text_style_prompt โดยไม่มี image_style_url
- สามเหลี่ยมมากเกินไปสำหรับ Meshy N1: เมื่อใช้ meshy-n1 โมเดล 3D มีสามเหลี่ยมมากกว่า 7,999,999 ชิ้น ให้ลดจำนวนสามเหลี่ยม หรือใช้ ai_model อื่น
- โมเดลซับซ้อนเกินไปสำหรับ Meshy N1: เมื่อใช้ meshy-n1 ไฟล์ model_url ซับซ้อนเกินกว่าที่ Meshy จะนับจำนวนสามเหลี่ยมได้ ให้ลดจำนวนสามเหลี่ยมแล้วส่งไฟล์อีกครั้ง
- การนับสามเหลี่ยมหมดเวลา: เมื่อใช้ meshy-n1 การนับสามเหลี่ยมของไฟล์ model_url ใช้เวลานานเกินไป ให้ลองใหม่ หรือลดขนาดโมเดล
- งานอินพุตไม่ถูกต้อง: input_task_id ไม่ใช่งานที่สำเร็จของประเภทที่รองรับ
- รูปแบบโมเดลไม่ถูกต้อง: ไฟล์ model_url มีนามสกุลที่ไม่รองรับ
- URL ไม่สามารถเข้าถึงได้: Meshy ไม่สามารถดาวน์โหลดไฟล์ model_url, ภาพ image_style_url หรือภาพ multiview_image_urls ได้
- ไฟล์โมเดลใหญ่เกินไป: ไฟล์ model_url มีขนาดเกิน 400 MB จาก URL แบบ http หรือ https หรือเกิน 100 MB ในรูปแบบ data URI
- หน้ามากเกินไป: ไฟล์ model_url มีขนาดเกิน 100 MB และมีมากกว่า 10,000,000 หน้า ให้ลดจำนวนหน้าแล้วส่งไฟล์อีกครั้ง
- ASCII FBX ขนาดเกิน 100 MB: ไฟล์ model_url เป็น ASCII FBX ที่มีขนาดเกิน 100 MB ให้ส่งเป็น binary FBX หรือ GLB แทน
- ไฟล์โมเดลอ่านไม่ได้: ไฟล์ model_url มีขนาดเกิน 100 MB และ Meshy ไม่สามารถอ่านส่วนหัวของไฟล์ได้ เช่น เป็น GLB หรือ glTF ที่บีบอัดแบบ Draco หรือ binary FBX ที่เก่ากว่า 7.1
- ส่วนหัวของโมเดลซับซ้อนเกินไป: ไฟล์ model_url มีขนาดเกิน 100 MB และส่วนหัวมีเมช, โหนด หรือเรคคอร์ดมากเกินกว่าจะตรวจสอบได้ ให้ลดจำนวนวัตถุในไฟล์แล้วส่งอีกครั้ง
- ภาพใหญ่เกินไป: ภาพ image_style_url หรือภาพ multiview_image_urls มีขนาดเกิน 20 MB
เมื่อใช้ meshy-n1 โมเดลที่ Meshy ไม่สามารถตรวจสอบได้ก่อนเริ่มงาน เช่น ไฟล์ STL จะไม่ถูกปฏิเสธในขั้นตอนนี้ หากมีสามเหลี่ยมมากกว่า 7,999,999 ชิ้น งานจะล้มเหลว และ Meshy จะคืนเครดิตให้
แก้ไขคำขอ แล้วส่งอีกครั้ง ดูที่ ข้อผิดพลาด
Name
401 - Unauthorized
Description
API คีย์หายไปหรือไม่ถูกต้อง ตรวจสอบส่วนหัว Authorization
Name
402 - Payment Required
Description
ตัวอย่างเช่น:
- เครดิตไม่เพียงพอ: บัญชีมีเครดิตไม่เพียงพอสำหรับงานนี้ หรือบัญชีถึงขีดจำกัดเครดิตแล้ว ตรวจสอบยอดคงเหลือเครดิตของคุณ แล้วลองใหม่
- แผนฟรี: การสร้างงานต้องใช้แผนแบบชำระเงิน อัปเกรดแผนของคุณในการตั้งค่าการสมัครสมาชิก แล้วลองใหม่
Name
403 - Forbidden
Description
กรณีใดกรณีหนึ่งต่อไปนี้:
- ระบบ moderation เนื้อหาได้บล็อก prompt หรือภาพอินพุต เปลี่ยนอินพุต แล้วลองใหม่
- input_task_id เป็นโมเดลแบบ bas-relief ซึ่งเอนด์พอยต์นี้ไม่สามารถรีเท็กซ์เจอร์ได้ ข้อความคือ This model type does not support this operation ส่งโมเดลอื่นแทน
Name
404 - Not Found
Description
input_task_id ไม่ตรงกับงานใด ๆ ของคุณ ตรวจสอบ ID งาน แล้วส่งคำขออีกครั้ง
Name
429 - Too Many Requests
Description
คุณเกินการจำกัดอัตราของคุณแล้ว รอสักครู่ แล้วลองใหม่ ดูที่ การจำกัดอัตรา

GET/openapi/v1/retexture/:id

ดึงข้อมูลงาน Retexture

คืนค่างาน Retexture ตามรหัส ID ของมัน

Request

GET

/openapi/v1/retexture/018a210d-8ba4-705c-b111-1f1776f7f578

curl https://api.meshy.ai/openapi/v1/retexture/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "retexture",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "text_style_prompt": "red fangs, Samurai outfit that fused with japanese batik style",
  "texture_image_url": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX"
    }
  ],
  "task_error": null,

  "consumed_credits": 10
}

พารามิเตอร์

Name
id
Type
path
Description
รหัสงาน (task ID) จากการตอบกลับการสร้างงาน

ค่าที่ส่งกลับ

อ็อบเจ็กต์งาน Retexture

DELETE/openapi/v1/retexture/:id

ลบงาน รีเท็กซ์เจอร์

ลบงาน รีเท็กซ์เจอร์ อย่างถาวร รวมถึงโมเดลและข้อมูลของงานนั้น คุณไม่สามารถยกเลิกการลบได้

Request

DELETE

/openapi/v1/retexture/a43b5c6d-7e8f-901a-234b-567c890d1e2f

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/retexture/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS. The task keeps running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}

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

Name
id
Type
path
Description
ID ของงานที่ต้องการลบ

สถานะของงาน

การลบงานที่มีสถานะ PENDING จะคืนเครดิตที่ใช้ไปตอนสร้างงานนั้น

งานที่มีสถานะ IN_PROGRESS ไม่สามารถลบได้ คำขอจะส่งคืน 409 Conflict และงานจะยังคงทำงานต่อไป Meshy จะไม่คืนเครดิตให้กับงานที่เริ่มทำงานไปแล้ว ดังนั้นการลบงานนั้นจะทำให้คุณเสียทั้งเครดิตและผลลัพธ์ ให้รอจนกว่างาน จะมีสถานะ SUCCEEDED, FAILED, หรือ CANCELED แล้วจึงค่อยลบ

การลบงานที่มีสถานะสุดท้าย (SUCCEEDED, FAILED, หรือ CANCELED) จะไม่คืนเครดิต

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

200 OK เมื่อลบงานสำเร็จ หรือ 409 Conflict เมื่องานมีสถานะ IN_PROGRESS

GET/openapi/v1/retexture

List Retexture tasks

ส่งคืนรายการงานรีเท็กซ์เจอร์ของคุณ

Request

GET

/openapi/v1/retexture

curl https://api.meshy.ai/openapi/v1/retexture?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "retexture",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "text_style_prompt": "red fangs, Samurai outfit that fused with japanese batik style",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "expires_at": 1692771679037,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
        "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
        "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
        "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX"
      }
    ],
    "task_error": null,

    "consumed_credits": 10
  }
]

พารามิเตอร์

Name
page_num
Type
integer
ค่าเริ่มต้น 1
Description
หมายเลขหน้าที่จะส่งคืน สูงสุด 255 ค่าที่มากกว่านี้จะส่งคืน 400
Name
page_size
Type
integer
ค่าเริ่มต้น 10
Description
จำนวนงานต่อหน้า สูงสุด 100
Name
sort_by
Type
string
Description
ลำดับการเรียง
ค่าที่ใช้ได้:
- +created_at: เก่าที่สุดก่อน
- -created_at: ใหม่ที่สุดก่อน

ส่งคืน

รายการแบบแบ่งหน้าของ อ็อบเจ็กต์งานรีเท็กซ์เจอร์

GET/openapi/v1/retexture/:id/stream

สตรีมงานรีเท็กซ์เจอร์

สตรีมการอัปเดตของงานรีเท็กซ์เจอร์ในรูปแบบ Server-Sent Events (SSE)

Request

GET

/openapi/v1/retexture/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/retexture/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// These examples are shortened. Each event holds the full task object.
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 50,
  "status": "IN_PROGRESS"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "retexture",
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1692771650657,
  "started_at": 1692771667037,
  "finished_at": 1692771669037,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  },
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX"
    }
  ],
  "task_error": null,

  "consumed_credits": 10
}

พารามิเตอร์

Name
id
Type
path
Description
ไอดีของงานจากการตอบกลับของการสร้าง

ค่าที่ส่งกลับ

สตรีมของ ออบเจ็กต์งานรีเท็กซ์เจอร์ ในรูปแบบ Server-Sent Events

แต่ละอีเวนต์จะมีออบเจ็กต์งานฉบับเต็ม ในรูปแบบเดียวกับที่เอนด์พอยต์ Get ส่งกลับมา ในขณะที่งานยังอยู่ในสถานะ PENDING หรือ IN_PROGRESS ฟิลด์ผลลัพธ์ของงานนั้นจะยังไม่มีค่า

อ็อบเจกต์งาน Retexture

อ็อบเจกต์งาน Retexture อธิบายการรีเท็กซ์เจอร์โมเดล 3D หนึ่งครั้ง โดยเก็บสถานะ progress และไฟล์โมเดลกับเท็กซ์เจอร์เมื่องานสำเร็จ

คุณสมบัติ

Example Retexture Task Model

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "retexture",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***"
  },
  "text_style_prompt": "red fangs, Samurai outfit that fused with japanese batik style",
  "image_style_url": "https://assets.meshy.ai/***/image/example_image.jpg?Expires=***",
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX"
    }
  ],
  "task_error": null,

  "consumed_credits": 10
}

Name
id
Type
string
Description
ไอดีของงาน ให้ถือว่าเป็นสตริงทึบ (opaque string) และอย่าอิงกับรูปแบบของมัน
Name
type
Type
string
Description
ประเภทของงาน ซึ่งเป็น retexture เสมอ
Name
model_urls
Type
object
Description
URL สำหรับดาวน์โหลดโมเดล 3D ที่ใส่เท็กซ์เจอร์แล้ว แยกตามรูปแบบไฟล์
- Name
  glb
  Type
  string
  Description
  ไฟล์ GLB
- Name
  fbx
  Type
  string
  Description
  ไฟล์ FBX
- Name
  obj
  Type
  string
  Description
  ไฟล์ OBJ
- Name
  usdz
  Type
  string
  Description
  ไฟล์ USDZ
- Name
  mtl
  Type
  string
  Description
  ไฟล์ MTL ซึ่ง Meshy จะส่งคืนมาพร้อมกับไฟล์ OBJ เมื่อโมเดลมีเท็กซ์เจอร์
- Name
  stl
  Type
  string
  Description
  ไฟล์ STL
- Name
  3mf
  Type
  string
  Description
  ไฟล์ 3MF จะปรากฏเฉพาะเมื่อ target_formats มี 3mf รวมอยู่ด้วย
Name
text_style_prompt
Type
string
Description
prompt ที่เป็นข้อความซึ่งคุณใช้สร้างงานนี้
Name
image_style_url
Type
string
Description
รูปภาพสไตล์ที่คุณใช้สร้างงานนี้
Name
multiview_image_urls
Type
string[]
Description
URL สำหรับดาวน์โหลดรูปภาพอ้างอิงมุมมองหลายด้าน (Multi-View) ที่คุณใช้สร้างงานนี้ จะปรากฏเฉพาะเมื่อคุณสร้างงานด้วย multiview_image_urls
Name
thumbnail_url
Type
string
Description
URL สำหรับดาวน์โหลดภาพย่อของโมเดล
Name
alpha_thumbnail_url
Type
string
Description
URL สำหรับดาวน์โหลดเวอร์ชันของ thumbnail_url ที่มีพื้นหลังโปร่งใส (RGBA) จะปรากฏเฉพาะเมื่อคุณสร้างงานด้วย alpha_thumbnail: true และ Meshy เรนเดอร์ภาพตัวอย่างแบบโปร่งใสแล้ว
Name
progress
Type
integer
Description
งานเสร็จไปเท่าไหร่แล้ว คิดเป็นเปอร์เซ็นต์ โดยจะเป็น 0 จนกว่างานจะเริ่ม และเป็น 100 เมื่องานสำเร็จ
Name
started_at
Type
timestamp
Description
เวลาที่งานเริ่ม เป็นหน่วยมิลลิวินาทีแบบ Unix โดยจะเป็น 0 จนกว่างานจะเริ่ม
Name
created_at
Type
timestamp
Description
เวลาที่สร้างงาน เป็นหน่วยมิลลิวินาทีแบบ Unix
Name
expires_at
Type
timestamp
Description
เวลาที่ผลลัพธ์ของงานจะหมดอายุ เป็นหน่วยมิลลิวินาทีแบบ Unix
Name
finished_at
Type
timestamp
Description
เวลาที่งานเสร็จสิ้น เป็นหน่วยมิลลิวินาทีแบบ Unix โดยจะเป็น 0 จนกว่างานจะเสร็จสิ้น
Name
status
Type
string
Description
สถานะของงาน ซึ่งเป็นหนึ่งใน PENDING, IN_PROGRESS, SUCCEEDED, FAILED, หรือ CANCELED
Name
texture_urls
Type
array
Description
URL สำหรับดาวน์โหลดเท็กซ์เจอร์ที่สร้างขึ้น ในรูปแบบอาร์เรย์ของอ็อบเจกต์ โดยปกติอาร์เรย์จะมีอ็อบเจกต์เดียว แต่ละอ็อบเจกต์มีฟิลด์เหล่านี้:
- Name
  base_color
  Type
  string
  Description
  URL สำหรับดาวน์โหลดแผนที่สีพื้นฐาน (base color map)
- Name
  metallic
  Type
  string
  Description
  URL สำหรับดาวน์โหลดแผนที่ความเป็นโลหะ (metallic map) Meshy จะไม่ใส่ฟิลด์นี้เมื่อคุณสร้างงานด้วย enable_pbr: false
- Name
  normal
  Type
  string
  Description
  URL สำหรับดาวน์โหลดนอร์มัลแมป Meshy จะไม่ใส่ฟิลด์นี้เมื่อคุณสร้างงานด้วย enable_pbr: false
- Name
  roughness
  Type
  string
  Description
  URL สำหรับดาวน์โหลดแผนที่ความขรุขระ (roughness map) Meshy จะไม่ใส่ฟิลด์นี้เมื่อคุณสร้างงานด้วย enable_pbr: false
- Name
  emission
  Type
  string
  Description
  URL สำหรับดาวน์โหลดแผนที่การเปล่งแสง (emission map) Meshy จะไม่ใส่ฟิลด์นี้เมื่อคุณสร้างงานด้วยเงื่อนไขอย่างใดอย่างหนึ่งต่อไปนี้:
  
  enable_pbr: false
  
  ai_model เป็น meshy-6-lite, meshy-7, หรือ latest
  
  texture_resolution: 8k
Name
preceding_tasks
Type
integer
Description
จำนวนงานที่อยู่ก่อนหน้างานนี้ในคิว จะปรากฏเฉพาะขณะที่งานมีสถานะ PENDING เท่านั้น โดยฟิลด์นี้จะถูกตัดออกเมื่อค่าเป็น 0
Name
task_error
Type
object
Description
รายละเอียดข้อผิดพลาดเมื่องานล้มเหลว ดู ข้อผิดพลาด
Name
consumed_credits
Type
integer
Description
จำนวนเครดิตที่งานนี้ใช้ไป จะปรากฏเมื่อสถานะเป็น PENDING, IN_PROGRESS, หรือ SUCCEEDED โดยจะเป็น 0 สำหรับงานที่ FAILED เนื่องจาก Meshy จะคืนเครดิตให้เมื่องานล้มเหลว