Auto Split API
Pisahkan model 3D menjadi bagian-bagian yang dapat dicetak secara terpisah — secara otomatis, berdasarkan bagian yang Anda beri nama, atau berdasarkan wilayah warna — dengan konektor opsional; wilayah tipis yang tersisa akibat pemotongan selalu diperkuat sehingga setiap bagian tercetak padat.
Auto Split saat ini hanya mendukung model tanpa tekstur. Untuk Gambar ke 3D dan Multi-Gambar ke 3D, buat input dengan should_texture diatur ke false. Input yang bertekstur akan ditolak dengan 400. Dukungan untuk tekstur sedang dalam progress.
Create an Auto Split Task
Endpoint ini membuat tugas Auto Split baru. Tugas ini memotong model dari tugas sebelumnya menjadi beberapa bagian yang dapat dicetak secara terpisah dan mengembalikan model yang telah disegmentasi, dengan setiap bagian sebagai objeknya sendiri dalam file.
Parameter
- Name
- input_task_id
- Type
- string
- Wajib
- Description
ID dari tugas yang berhasil yang modelnya ingin dipisah. Jenis tugas yang didukung: Gambar ke 3D, Multi-Gambar ke 3D, Teks ke 3D (preview), Remesh, Konversi, dan Ubah ukuran. Tugas tersebut harus berstatus
SUCCEEDED, dan modelnya harus dihasilkan dengan Meshy 6 atau Meshy 7 (ai_modelmeshy-6,meshy-7, ataulatest). Model low-poly dan Smart Topology (meshy-t2) tidak didukung.
- Name
- mode
- Type
- string
- default auto
- Description
Cara model dibagi menjadi beberapa bagian.
Nilai yang tersedia:
auto: Meshy yang menentukan pemotongan.promptdiabaikan.by_parts: Memotong sesuai dengan bagian struktural yang Anda sebutkan dalamprompt, seperti kepala, lengan, dan badan.by_color: Memotong sesuai dengan wilayah warna yang Anda sebutkan dalamprompt. Memerlukan input yang dihasilkan dari gambar yang diunggah (Gambar ke 3D atau Multi-Gambar ke 3D); input lain akan ditolak dengan400.
mode = by_parts or by_color- Name
- prompt
- Type
- string
- Wajib
- Description
Mendeskripsikan bagian-bagian yang akan dipisahkan, dalam bahasa apa pun. Meshy membaca 1 hingga 10 nama bagian darinya, jadi sebutkan nama bagian-bagiannya alih-alih mendeskripsikan modelnya — misalnya
split into the figure and the base, atauhead, torso, left arm, right arm, legs. Maksimum 600 karakter. Ada dua mode kegagalan: deskripsi yang terbaca seperti perintah pemisahan tetapi hanya menyebutkan kurang dari dua bagian (misalnyasplit into individual parts) akan ditolak dengan400dan tidak ada biaya yang dikenakan; deskripsi yang sama sekali tidak dapat dibaca oleh Meshy akan kembali keauto, tugas tetap berjalan dan dikenakan biaya, dan responsnya membawaprompt_ignored: true.
- Name
- target_formats
- Type
- array
- default ["glb"]
- Description
Format untuk mengekspor model yang telah dipisah. Setiap bagian adalah objek terpisah dalam setiap format.
glbselalu dihasilkan dan dikembalikan dalammodel_urls; cantumkan format lain yang Anda inginkan sebagai tambahan.Nilai yang tersedia:
glb,obj,fbx,usdz,blend,3mf.3mfditulis untuk slicer: satu objek per bagian, masing-masing pada slot filamen sendiri, sehingga Bambu Studio membuka file tersebut sebagai bagian-bagian yang berwarna secara individual dan dapat dipilih secara terpisah (arsip tersebut membawa konfigurasi proyek Bambu Studio; slicer lain membaca geometrinya). Seperti format cetak Meshy lainnya, satuannya dalam milimeter dan, karena endpoint ini tidak menerima ukuran target, seluruh model diskalakan sehingga sisi terpanjangnya menjadi 150 mm — batas yang sama yang digunakan oleh ekspor format cetak lainnya, dipilih agar sesuai dengan semua build plate mainstream. Denganlayout: "on_plate", batas tersebut berlaku untuk keseluruhan plate yang sudah ditata, sehingga file siap untuk di-slice; denganassembled, bagian-bagian tersebut tetap berada di posisi seperti pada model sumber dan Anda mengaturnya sendiri di slicer.stltidak didukung karena format tersebut tidak dapat membawa bagian-bagian yang terpisah.
- Name
- layout
- Type
- string
- default assembled
- Description
Cara bagian-bagian diatur dalam setiap format output, dan dalam thumbnail.
Nilai yang tersedia:
assembled: Bagian-bagian tetap berada di posisi seperti pada model sumber.on_plate: Bagian-bagian diletakkan mendatar dan disebarkan di build plate, siap untuk di-slice — susunan yang sama seperti tampilan On Plate pada aplikasi web.
Pada kedua layout tersebut, file yang diekspor hanya berisi satu objek per bagian dan tidak ada yang lain: potongan tipis atau bagian menyerupai titik yang tersisa dari suatu pemotongan akan dihapus sebelum ekspor, sehingga setiap objek yang Anda temukan dalam file tersebut dapat dicetak.
- Name
- connectors
- Type
- boolean
- default false
- Description
Menambahkan konektor mortise-and-tenon pada setiap pemotongan sehingga bagian-bagian yang dicetak dapat saling terpasang.
connectors = true- Name
- connector_type
- Type
- string
- default cube
- Description
Bentuk konektor pada setiap permukaan potongan.
Nilai yang tersedia:
cube,cylinder.
- Name
- connector_size
- Type
- number
- default 0.5
- Description
Ukuran konektor relatif terhadap permukaan potongan.
Rentang yang valid:
0.1hingga0.8.
- Name
- connector_height
- Type
- number
- default 0.1
- Description
Seberapa jauh konektor menonjol dari permukaan potongan, relatif terhadap permukaan potongan.
Rentang yang valid:
0.1hingga0.8.
Hasil yang Dikembalikan
Properti result pada respons berisi id dari tugas Auto Split yang baru dibuat.
Mode Kegagalan
- Name
400 - Bad Request- Description
Permintaan tidak dapat diterima. Penyebab umum:
- Prompt tidak ada:
promptdiperlukan ketikamodeadalahby_partsatauby_color. - Prompt menyebutkan kurang dari dua bagian:
by_parts/by_colormemerlukan setidaknya dua bagian bernama (misalnyahead, torso, base); instruksi generik sepertisplit into individual partsakan ditolak. Tidak ada biaya yang dikenakan. - Tugas input tidak didukung:
input_task_idharus merujuk pada tugas yang berhasil dengan jenis yang didukung, yang dihasilkan dengan Meshy 6 atau Meshy 7. - Input bertekstur: Model input memiliki texture. Untuk saat ini, hanya model tanpa texture yang didukung.
- Tidak ada gambar referensi:
by_colormemerlukan input yang dihasilkan dari gambar yang diunggah. - Format tidak didukung:
target_formatsberisistl. - Konektor di luar rentang:
connector_sizeatauconnector_heightberada di luar0.1hingga0.8.
- Prompt tidak ada:
- Name
401 - Unauthorized- Description
Autentikasi gagal. Silakan periksa kunci API Anda.
- Name
402 - Payment Required- Description
Kredit tidak mencukupi untuk melakukan tugas ini.
- Name
404 - Not Found- Description
input_task_idtidak ditemukan atau tidak dimiliki oleh akun Anda.
- Name
429 - Too Many Requests- Description
Anda telah melampaui batas laju Anda. Permintaan
by_partsdanby_colorjuga berbagi batas parsing prompt sebanyak 12 permintaan per menit per akun.
- Name
503 - Service Unavailable- Description
Pemisahan berbasis prompt (
by_partsdanby_color) untuk sementara tidak tersedia. Coba lagi nanti, atau gunakanmode: "auto", yang tidak terpengaruh. Tidak ada biaya yang dikenakan.
Request
# Simple request: let Meshy choose the cuts
curl https://api.meshy.ai/openapi/v1/print/split \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578"
}'
# Advanced request: name the parts, add connectors, export glb and obj
curl https://api.meshy.ai/openapi/v1/print/split \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"mode": "by_parts",
"prompt": "split into the figure and the base",
"target_formats": ["glb", "obj"],
"layout": "on_plate",
"connectors": true,
"connector_type": "cylinder",
"connector_size": 0.4
}'
Response
{
"result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}
Mengambil Task Auto Split
Endpoint ini mengambil task Auto Split berdasarkan ID-nya.
Parameter
- Name
- id
- Type
- path
- Description
ID dari task Auto Split yang akan diambil.
Returns
Objek Task Auto Split.
Request
curl https://api.meshy.ai/openapi/v1/print/split/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
{
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "print-split",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
"part_count": 4,
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000082000,
"task_error": null,
"consumed_credits": 10
}
Delete an Auto Split Task
Endpoint ini menghapus permanen sebuah tugas Auto Split, termasuk semua model dan data yang terkait. Tindakan ini tidak dapat dibatalkan.
Path Parameters
- Name
- id
- Type
- path
- Description
ID dari tugas Auto Split yang akan dihapus.
Returns
Mengembalikan 200 OK jika berhasil.
Request
curl --request DELETE \
--url https://api.meshy.ai/openapi/v1/print/split/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
// Returns 200 Ok on success.
List Auto Split Tasks
Endpoint ini memungkinkan Anda untuk mengambil daftar tugas Auto Split.
Parameter
Atribut opsional
- Name
- page_num
- Type
- integer
- Description
Nomor halaman untuk paginasi. Dimulai dan defaultnya adalah
1.
- Name
- page_size
- Type
- integer
- Description
Batas ukuran halaman. Defaultnya
10item. Maksimum yang diizinkan adalah100item; nilai yang lebih besar akan dibatasi menjadi100.
- Name
- sort_by
- Type
- string
- Description
Kolom untuk pengurutan. Nilai yang tersedia:
+created_at: Urutkan berdasarkan waktu pembuatan secara ascending.-created_at: Urutkan berdasarkan waktu pembuatan secara descending.
Returns
Mengembalikan daftar berpaginasi dari The Auto Split Task Objects.
Request
curl https://api.meshy.ai/openapi/v1/print/split?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
[
{
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "print-split",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
"part_count": 4,
"progress": 100,
"status": "SUCCEEDED",
"preceding_tasks": 0,
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000082000,
"task_error": null,
"consumed_credits": 10
}
]
Streaming Tugas Auto Split
Endpoint ini melakukan streaming pembaruan secara real-time untuk tugas Auto Split menggunakan Server-Sent Events (SSE).
Parameter
- Name
- id
- Type
- path
- Description
Pengidentifikasi unik untuk tugas Auto Split yang akan di-stream.
Returns
Mengembalikan stream dari Objek Tugas Auto Split sebagai Server-Sent Events.
Setiap event message membawa objek tugas lengkap seperti yang dikembalikan oleh Retrieve an Auto Split Task, termasuk consumed_credits, stempel waktu, dan prompt_ignored; selama tugas berstatus PENDING atau IN_PROGRESS, kolom yang berubah antar frame adalah progress, status, started_at, dan preceding_tasks, sedangkan model_urls, thumbnail_url, part_count, dan parts muncul begitu tugas mencapai status SUCCEEDED. Event error hanya membawa status_code dan message, jadi lakukan percabangan berdasarkan nama event sebelum membaca status.
Request
curl -N https://api.meshy.ai/openapi/v1/print/split/a43b5c6d-7e8f-901a-234b-567c890d1e2f/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 (other task fields omitted here for brevity;
// each frame is the full task object).
event: message
data: {
"id": "a43b5c6d-7e8f-901a-234b-567c890d1e2f",
"progress": 0,
"status": "PENDING"
}
event: message
data: {
"id": "a43b5c6d-7e8f-901a-234b-567c890d1e2f",
"type": "print-split",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/a43b5c6d-7e8f-901a-234b-567c890d1e2f/output/model.glb?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/a43b5c6d-7e8f-901a-234b-567c890d1e2f/output/preview.png?Expires=***",
"part_count": 4,
"progress": 100,
"status": "SUCCEEDED",
"preceding_tasks": 0,
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000082000,
"task_error": null,
"consumed_credits": 10
}
Objek Task Auto Split
Task Auto Split hanya membawa properti di bawah ini. Kolom prompt-generasi yang dimiliki objek task lain (name, object_prompt, texture_prompt, dan sebagainya), model_url tunggal, dan texture_urls tidak pernah terisi untuk split dan tidak dikembalikan. Properti yang terisi seiring berjalannya task (thumbnail_url, model_urls, stempel waktu) selalu ada, kosong hingga memiliki nilai, sehingga kumpulan key tidak berubah antara PENDING dan SUCCEEDED.
- Name
- id
- Type
- string
- Description
Pengenal unik untuk task tersebut. Meskipun kami menggunakan UUID yang dapat diurutkan-k untuk id task sebagai detail implementasi, Anda tidak boleh membuat asumsi apa pun tentang format id tersebut.
- Name
- type
- Type
- string
- Description
Tipe dari task tersebut. Nilainya adalah
print-split.
- Name
- model_urls
- Type
- object
- Description
URL yang dapat diunduh untuk model hasil split, satu per format yang diminta. Setiap bagian merupakan objek terpisah dalam file. Properti untuk suatu format akan dihilangkan jika format tersebut tidak diminta.
- Name
glb- Type
- string
- Description
URL yang dapat diunduh untuk model hasil split dalam format GLB.
- Name
obj- Type
- string
- Description
URL yang dapat diunduh untuk model hasil split dalam format OBJ.
- Name
fbx- Type
- string
- Description
URL yang dapat diunduh untuk model hasil split dalam format FBX.
- Name
usdz- Type
- string
- Description
URL yang dapat diunduh untuk model hasil split dalam format USDZ.
- Name
blend- Type
- string
- Description
URL yang dapat diunduh untuk model hasil split dalam format Blender.
- Name
3mf- Type
- string
- Description
URL yang dapat diunduh untuk model hasil split dalam format 3MF: satu objek per bagian, masing-masing pada slot filamen tersendiri, dalam milimeter, diskalakan sehingga sisi terpanjang berukuran 150 mm, dengan konfigurasi proyek Bambu Studio.
- Name
- thumbnail_url
- Type
- string
- Description
URL yang dapat diunduh untuk pratinjau hasil render model split, dengan setiap bagian dalam warna berbeda, sesuai
layoutyang diminta.
- Name
- prompt_ignored
- Type
- boolean
- Description
trueketikapromptpada permintaanby_partsatauby_colortidak menyebutkan nama bagian apa pun, sehingga Meshy melakukan split model secara otomatis — nama bagian pada hasilnya adalah milik Meshy, bukan milik Anda. Muncul sejakPENDING. Dihilangkan untuk taskautodan setiap kali prompt diikuti.
- Name
- part_count
- Type
- integer
- Description
Jumlah bagian yang dapat dicetak dalam model hasil split — satu per objek dalam file yang diekspor. Serpihan-serpihan kecil yang tidak dapat diubah menjadi bagian yang dapat dicetak oleh segmentasi akan dihapus dari file sebelum diekspor dan tidak dihitung.
- Name
- progress
- Type
- integer
- Description
Progress dari task tersebut. Jika task belum dimulai, properti ini bernilai
0. Setelah task berhasil, nilainya akan menjadi100.
- Name
- status
- Type
- string
- Description
Status dari task tersebut. Nilai yang mungkin adalah salah satu dari
PENDING,IN_PROGRESS,SUCCEEDED,FAILED,CANCELED.
- Name
- preceding_tasks
- Type
- integer
- Description
Jumlah task yang mendahului.
Nilai kolom ini hanya bermakna jika status task adalah
PENDING.
- Name
- created_at
- Type
- timestamp
- Description
Stempel waktu saat task dibuat, dalam milidetik.
- Name
- started_at
- Type
- timestamp
- Description
Stempel waktu saat task dimulai, dalam milidetik. Jika task belum dimulai, properti ini bernilai
0.
- Name
- finished_at
- Type
- timestamp
- Description
Stempel waktu saat task selesai, dalam milidetik. Jika task belum selesai, properti ini bernilai
0.
- Name
- task_error
- Type
- object
- Description
Detail kesalahan untuk task yang gagal. Lihat Kesalahan untuk referensi lengkap objek
task_error.
- Name
- consumed_credits
- Type
- integer
- Description
Jumlah kredit yang digunakan oleh task ini. Selalu ada:
10setelah task diterima, dan0untuk taskFAILEDkarena biaya dikembalikan saat gagal. Menghapus task yang masih berstatusPENDINGjuga akan mengembalikan biayanya.
The Auto Split Task Object
{
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "print-split",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
"part_count": 4,
"progress": 100,
"status": "SUCCEEDED",
"preceding_tasks": 0,
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000082000,
"task_error": null,
"consumed_credits": 10
}