API Gambar ke 3D adalah fitur yang memungkinkan Anda mengintegrasikan kemampuan Gambar ke 3D dari Meshy ke dalam aplikasi Anda sendiri. Di bagian ini, Anda akan menemukan semua informasi
yang Anda butuhkan untuk memulai dengan API ini.
Endpoint ini memungkinkan Anda membuat task Gambar ke 3D baru. Lihat
The Image to 3D Task Object untuk melihat properti apa saja yang termasuk dalam objek task Gambar ke 3D.
Parameter
Hanya salah satu dari input_task_id atau image_url yang wajib diisi. Jika keduanya diberikan, input_task_id akan diprioritaskan.
Name
input_task_id
Type
string
Wajib
Description
ID dari task pembuatan gambar yang telah selesai, yang hasilnya akan digunakan sebagai gambar input. Task ini harus berupa salah satu dari task berikut: Teks ke Gambar atau Gambar ke Gambar. Selain itu, task tersebut harus dijalankan melalui API, memiliki status SUCCEEDED, dan menghasilkan tepat satu gambar.
Name
image_url
Type
string
Wajib
Description
Berikan gambar untuk digunakan Meshy dalam pembuatan model. Saat ini kami mendukung format .jpg, .jpeg, dan .png.
Ada dua cara untuk memberikan gambar:
URL yang dapat diakses publik: URL yang dapat diakses dari internet publik.
Data URI: Data URI gambar yang dienkode base64. Contoh data URI: data:image/jpeg;base64,<data gambar terenkode base64 Anda>.
Name
model_type
Type
string
default standard
Description
Tentukan jenis pembuatan mesh 3D.
Nilai yang tersedia:
standard: Pembuatan mesh 3D detail tinggi biasa.
smart-topology: Pilih model Smart Topology dengan ai_model (meshy-t2).
lowpoly (usang): Menghasilkan mesh low-poly yang dioptimalkan untuk poligon yang lebih bersih. Kami merekomendasikan menggunakan smart-topology sebagai gantinya.
Ketika smart-topology dipilih, topology, should_remesh, dan save_pre_remeshed_model akan diabaikan.
Ketika lowpoly dipilih, ai_model, topology, target_polycount, should_remesh, dan save_pre_remeshed_model akan diabaikan.
Name
ai_model
Type
string
default latest
Description
ID model yang akan digunakan. Nilai yang tersedia bergantung pada model_type.
meshy-t2 (default): model Smart Topology — topology yang lebih bersih, bagian yang terpisah secara native, output segitiga, dan jumlah wajah yang dapat Anda atur dengan target_polycount.
Name
geometry_resolution
Type
string
default standard
Description
Tahap pembuatan geometri. 2k menjalankan tahap Ultra pada 2048³; 4k menjalankannya pada 4096³ untuk
detail permukaan terbaik.
Nilai yang tersedia: standard, 2k, 4k
Membutuhkan meshy-7.1 atau latest.
Name
ultra_mode
Type
boolean
⚠ usang
default false
Description
Gunakan geometry_resolution sebagai gantinya. ultra_mode: true setara dengan geometry_resolution: "2k".
Name
should_texture
Type
boolean
default true
Description
Menentukan apakah tekstur dihasilkan. Menyetelnya ke false akan melewati tahap tekstur, sehingga menghasilkan mesh tanpa tekstur.
Hanya berlaku ketika should_texture = true
Name
enable_pbr
Type
boolean
default false
Description
Menghasilkan peta PBR (metallic, roughness, normal) selain warna dasar. Peta emisi juga disertakan ketika ai_model adalah meshy-6, kecuali pada texture_resolution: 8k. meshy-6-lite, meshy-7.1, dan latest tidak menghasilkan peta emisi.
Name
texture_resolution
Type
string
default 2k
Description
Resolusi tekstur warna dasar. Salah satu dari 2k (2048×2048), 4k (4096×4096), atau 8k (8192×8192). Resolusi yang lebih tinggi menangkap lebih banyak detail permukaan.
4k dan 8k tidak tersedia dengan ai_modelmeshy-6-lite. Pada 8k, tidak ada peta emisi yang dihasilkan.
Name
hd_texture
Type
boolean
⚠ usang
default false
Description
Gunakan texture_resolution sebagai gantinya — setara dengan texture_resolution: "4k". Jika keduanya diatur, texture_resolution yang diprioritaskan.
Name
texture_prompt
Type
string
Description
Berikan prompt teks untuk memandu proses pembuatan tekstur. Maksimum 800 karakter.
Name
texture_image_url
Type
string
Description
Berikan gambar 2d untuk memandu proses pembuatan tekstur. Saat ini kami mendukung format .jpg, .jpeg, dan .png.
Ada dua cara untuk memberikan gambar:
URL yang dapat diakses publik: URL yang dapat diakses dari internet publik
Data URI: Data URI gambar yang dienkode base64. Contoh data URI: data:image/jpeg;base64,<data gambar terenkode base64 Anda>
Pembuatan tekstur gambar mungkin tidak bekerja secara optimal jika terdapat perbedaan geometri yang signifikan antara aset asli dan gambar yang diunggah. Hanya salah satu dari texture_image_url atau texture_prompt yang boleh digunakan untuk memandu proses pembuatan tekstur. Jika kedua parameter diberikan, maka texture_prompt akan digunakan secara default untuk membuat tekstur model. Pembuatan tekstur baik melalui teks maupun gambar akan dikenakan biaya 10 kredit per task.
Name
should_remesh
Type
boolean
default false (Meshy 6 and Meshy 7 models), true (others)
Description
Mengontrol apakah akan mengaktifkan tahap remesh. Untuk model dengan kualitas tertinggi, kami merekomendasikan untuk menyetel should_remesh ke false.
Hanya berlaku ketika should_remesh = true
Name
topology
Type
string
default triangle
Description
Tentukan topology dari model yang dihasilkan.
Nilai yang tersedia:
quad: Menghasilkan mesh yang didominasi quad.
triangle: Menghasilkan mesh segitiga yang telah didesimasi.
Name
decimation_mode
Type
integer
Description
Mengaktifkan desimasi adaptif dengan menyetel level jumlah poligon. Jika disetel, target_polycount akan diabaikan.
Nilai yang tersedia:
1: Adaptif — jumlah poligon ultra.
2: Adaptif — jumlah poligon tinggi.
3: Adaptif — jumlah poligon sedang.
4: Adaptif — jumlah poligon rendah.
Name
save_pre_remeshed_model
Type
boolean
default false
Description
Jika disetel ke true, Meshy juga menyimpan file GLB tambahan sebelum tahap remesh selesai.
Name
target_polycount
Type
integer
Description
Jumlah target poligon (wajah) pada output. Jumlah aktual dapat menyimpang dari target tergantung pada geometri.
target_polycount berlaku dalam dua kasus independen:
Remesh — dengan should_remesh: true pada model standard. Mesh akan di-remesh (didesimasi) menjadi kira-kira sejumlah ini. Rentang 100 hingga 300.000, default 30.000. Jika decimation_mode disetel, nilai tersebut diprioritaskan dan target_polycount diabaikan.
Smart Topology — dengan model_type: smart-topology dan ai_model: meshy-t2. Model dihasilkan langsung dengan jumlah wajah ini; tidak ada remesh yang dijalankan dan should_remesh tidak diperlukan. Rentang 100 hingga 15.000, default 4.000.
Name
symmetry_mode
Type
string
⚠ usang
default auto
Description
Usang. Parameter ini tidak lagi memengaruhi output.
Field symmetry_mode mengontrol perilaku simetri selama proses pembuatan model.
Nilai yang valid adalah:
off: Menonaktifkan simetri.
auto: Secara otomatis menentukan dan menerapkan simetri berdasarkan geometri input.
on: Memaksakan simetri selama pembuatan.
Name
pose_mode
Type
string
default ""
Description
Tentukan mode pose untuk model yang dihasilkan.
Nilai yang tersedia:
a-pose: Menghasilkan model dalam pose A.
t-pose: Menghasilkan model dalam pose T.
"" (string kosong): Tidak ada pose khusus yang diterapkan.
Name
is_a_t_pose
Type
boolean
⚠ usang
default false
Description
Gunakan pose_mode sebagai gantinya. Apakah akan menghasilkan model dalam pose A/T.
Name
image_enhancement
Type
boolean
default true
Description
Mengoptimalkan gambar input untuk hasil yang lebih baik. Setel ke false untuk mempertahankan tampilan gambar input yang persis tanpa pemrosesan gaya apa pun.
Hanya didukung ketika ai_model adalah meshy-6, meshy-7.1, atau latest.
Name
remove_lighting
Type
boolean
default true
Description
Menghapus highlight dan bayangan dari tekstur warna dasar, menghasilkan hasil yang lebih bersih yang bekerja lebih baik dengan pengaturan pencahayaan kustom.
Hanya didukung ketika ai_model adalah meshy-6.
Name
moderation
Type
boolean
default false
Description
Jika disetel ke true, konten input akan secara otomatis diperiksa untuk konten yang berpotensi berbahaya. Jika konten berbahaya terdeteksi, task tidak akan dilanjutkan ke proses pembuatan.
Konten dari input image_url, texture_image_url, dan texture_prompt akan diperiksa.
Name
target_formats
Type
string[]
Description
Menentukan format file 3D mana yang akan disertakan dalam output. Hanya format yang diminta yang akan dihasilkan dan dikembalikan, yang dapat mengurangi waktu penyelesaian task. Jika dihilangkan, semua format yang didukung akan disertakan.
Nilai yang tersedia: glb, obj, fbx, stl, usdz, 3mf
Jika dihilangkan, semua format kecuali 3mf akan dihasilkan. 3mf hanya disertakan jika ditentukan secara eksplisit.
Name
auto_size
Type
boolean
default false
Description
Jika disetel ke true, layanan menggunakan AI vision untuk secara otomatis memperkirakan tinggi objek di dunia nyata dan mengubah ukuran model sesuai dengan itu. Titik asal akan default ke bottom kecuali origin_at disetel secara eksplisit.
Name
alpha_thumbnail
Type
boolean
default false
Description
Jika disetel ke true, task juga akan merender versi latar belakang transparan (RGBA) dari pratinjau dan mengembalikannya sebagai alpha_thumbnail_url pada respons GET. Field thumbnail_url yang sudah ada tidak berubah.
Name
multi_view_thumbnails
Type
boolean
default false
Description
Jika disetel ke true, task juga akan merender empat thumbnail tampilan kardinal (depan, kanan, belakang, kiri) dan mengembalikannya di bawah thumbnail_urls pada respons GET. Field thumbnail_url yang sudah ada tidak berubah dan tetap menunjuk ke tampilan depan, sehingga klien yang sudah ada tidak terpengaruh.
Menambah sekitar 3 detik pada latensi task.
Hanya berlaku ketika auto_size = true
Name
origin_at
Type
string
default bottom
Description
Posisi titik asal ketika auto_size diaktifkan.
Nilai yang tersedia: bottom, center.
Hasil
Properti result pada respons berisi id task dari task Gambar ke 3D yang baru dibuat.
Mode Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak dapat diterima. Penyebab umum:
Parameter hilang: Salah satu dari image_url atau input_task_id harus diberikan.
Task input tidak valid: input_task_id harus merujuk pada task Teks ke Gambar atau Gambar ke Gambar dengan status SUCCEEDED yang menghasilkan tepat satu gambar.
Format gambar tidak valid: image_url yang diberikan bukan format yang didukung (.jpg, .jpeg, .png).
URL tidak dapat dijangkau: image_url tidak dapat diunduh (404 atau timeout).
Data URI tidak valid: String base64 tidak valid.
Kombinasi parameter tidak valid: enable_pbr hanya didukung ketika should_texture bernilai true.
Model tidak didukung untuk low poly: ai_model: "meshy-6-lite" tidak mendukung model_type: "lowpoly".
Model tidak didukung untuk Ultra: geometry_resolution membutuhkan meshy-7.1 atau latest.
Name
401 - Unauthorized
Description
Autentikasi gagal. Silakan periksa kunci API Anda.
Name
402 - Payment Required
Description
Kredit tidak cukup untuk melakukan task ini.
Name
429 - Too Many Requests
Description
Anda telah melampaui batas laju Anda.
Request
POST
/openapi/v1/image-to-3d
# Simple request with required paramscurlhttps://api.meshy.ai/openapi/v1/image-to-3d \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_url": "<your publicly accessible image url or base64-encoded data URI>" }'# With Ultra 4K geometry, remesh, PBR, and A-posecurlhttps://api.meshy.ai/openapi/v1/image-to-3d \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_url": "<your publicly accessible image url or base64-encoded data URI>", "ai_model": "meshy-7.1", "geometry_resolution": "4k", "enable_pbr": true, "should_remesh": true, "target_polycount": 100000, "should_texture": true, "pose_mode": "a-pose", "target_formats": ["glb"] }'
Endpoint ini memungkinkan Anda mengambil task Gambar ke 3D dengan id task yang valid.
Lihat The Image to 3D Task Object untuk mengetahui
properti apa saja yang disertakan dalam objek task Gambar ke 3D.
Parameter
Name
id
Type
path
Description
Pengenal unik untuk task Gambar ke 3D yang akan diambil.
Endpoint ini secara permanen menghapus task Gambar ke 3D, termasuk semua model dan data terkait. Tindakan ini tidak dapat dibatalkan.
Parameter Path
Name
id
Type
path
Description
ID dari task Gambar ke 3D yang akan dihapus.
Status Task
Task yang masih berstatus PENDING akan dihapus dan kredit yang digunakan
saat pembuatan akan dikembalikan.
Task yang sudah IN_PROGRESS tidak dapat dihapus: permintaan akan ditolak
dengan 409 Conflict dan task tetap berjalan. Kredit untuk task yang sudah
mulai dikerjakan oleh worker tidak dapat dikembalikan, sehingga menghapusnya
di tengah proses akan membuat Anda kehilangan kredit sekaligus hasilnya.
Tunggu hingga mencapai status SUCCEEDED, FAILED, atau CANCELED,
kemudian hapus.
Task dengan status akhir (SUCCEEDED, FAILED, atau CANCELED) akan
dihapus tanpa pengembalian kredit.
Returns
Mengembalikan 200 OK jika berhasil, atau 409 Conflict jika task
berstatus IN_PROGRESS.
// 200 OK on success, with an empty body.//// 409 Conflict when the task is IN_PROGRESS — the task is left 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."}
Objek Task Gambar ke 3D adalah unit kerja yang dilacak oleh Meshy untuk menghasilkan model 3D dari input gambar.
Objek ini memiliki properti berikut:
Properti
Name
id
Type
string
Description
Pengenal unik untuk task. Meskipun kami menggunakan UUID yang dapat diurutkan-k (k-sortable) sebagai
detail implementasi untuk id task, Anda tidak boleh membuat asumsi apa pun tentang format id tersebut.
Name
type
Type
string
Description
Jenis task Gambar ke 3D. Nilainya adalah image-to-3d.
Name
model_urls
Type
object
Description
URL yang dapat diunduh untuk file model 3D bertekstur yang dihasilkan oleh Meshy. Properti untuk suatu format akan dihilangkan jika format tersebut tidak dihasilkan, alih-alih mengembalikan string kosong.
Name
glb
Type
string
Description
URL yang dapat diunduh untuk file GLB.
Name
fbx
Type
string
Description
URL yang dapat diunduh untuk file FBX.
Name
obj
Type
string
Description
URL yang dapat diunduh untuk file OBJ.
Name
usdz
Type
string
Description
URL yang dapat diunduh untuk file USDZ.
Name
mtl
Type
string
Description
URL yang dapat diunduh untuk file MTL, dikembalikan bersama ekspor OBJ ketika tekstur tersedia.
Name
stl
Type
string
Description
URL yang dapat diunduh untuk file STL.
Name
3mf
Type
string
Description
URL yang dapat diunduh untuk file 3MF. Hanya muncul ketika 3mf diminta melalui target_formats.
Name
pre_remeshed_glb
Type
string
Description
URL yang dapat diunduh untuk output GLB asli sebelum remesh.
Hanya tersedia ketika task dibuat dengan should_remesh: true dan save_pre_remeshed_model: true sekaligus.
Name
thumbnail_url
Type
string
Description
URL yang dapat diunduh untuk gambar thumbnail dari file model. Setara dengan thumbnail_urls.front jika tersedia, dipertahankan untuk kompatibilitas mundur.
Name
alpha_thumbnail_url
Type
string
Description
URL yang dapat diunduh untuk versi latar belakang transparan (RGBA) dari thumbnail_url. Hanya muncul ketika task dibuat dengan alpha_thumbnail: true dan pratinjau transparan berhasil dirender; jika tidak, kolom ini akan dihilangkan.
Name
thumbnail_urls
Type
object
Description
URL yang dapat diunduh untuk empat thumbnail tampilan kardinal dari model 3D yang dihasilkan. Setiap nilai adalah URL bertanda tangan ke PNG 512×512 yang dirender dengan material dan pencahayaan yang sama seperti thumbnail_url. Berguna untuk melihat pratinjau model dari berbagai sudut dalam alur kerja batch tanpa perlu mengunduh GLB.
Hanya muncul ketika task dibuat dengan multi_view_thumbnails: true dan telah mencapai SUCCEEDED. Task lama dan task yang dibuat tanpa opsi ini tidak akan menyertakan kolom ini.
Name
front
Type
string
Description
Tampilan depan, rotasi 0° di sekitar sumbu vertikal (sesuai dengan thumbnail_url).
Name
right
Type
string
Description
Tampilan kanan, rotasi 90°.
Name
back
Type
string
Description
Tampilan belakang, rotasi 180°.
Name
left
Type
string
Description
Tampilan kiri, rotasi 270°.
Name
texture_prompt
Type
string
Description
Prompt teks yang digunakan untuk memandu proses tekstur.
Name
texture_image_url
Type
string
Description
URL yang dapat diunduh untuk gambar tekstur yang digunakan untuk memandu proses tekstur.
Name
ultra_mode
Type
boolean
⚠ usang
Description
Usang; gunakan geometry_resolution sebagai gantinya.
Name
geometry_resolution
Type
string
Description
Tingkat Ultra tempat task dijalankan (2k atau 4k); dihilangkan untuk standard.
Name
progress
Type
integer
Description
Progress dari task. Jika task belum dimulai, properti ini akan bernilai 0. Setelah task berhasil, ini akan menjadi 100.
Name
started_at
Type
timestamp
Description
Stempel waktu saat task dimulai, dalam milidetik. Jika task belum dimulai, properti ini akan bernilai 0.
Stempel waktu merepresentasikan jumlah milidetik yang telah berlalu sejak 1 Januari 1970 UTC, mengikuti
standar RFC 3339.
Sebagai contoh, Jumat, 1 September 2023 12:00:00 PM GMT direpresentasikan sebagai 1693569600000. Ini berlaku
untuk semua stempel waktu di Meshy API.
Name
created_at
Type
timestamp
Description
Stempel waktu saat task dibuat, dalam milidetik.
Name
expires_at
Type
timestamp
Description
Stempel waktu saat hasil task kedaluwarsa, dalam milidetik.
Name
finished_at
Type
timestamp
Description
Stempel waktu saat task selesai, dalam milidetik. Jika task belum selesai, properti ini akan bernilai 0.
Name
status
Type
string
Description
Status dari task. Nilai yang mungkin adalah salah satu dari PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Sebuah array objek URL tekstur yang dihasilkan dari task. Biasanya ini hanya berisi satu objek URL tekstur. Setiap URL tekstur memiliki properti berikut:
Name
base_color
Type
string
Description
URL yang dapat diunduh untuk gambar peta warna dasar (base color map).
Name
metallic
Type
string
Description
URL yang dapat diunduh untuk gambar peta metallic.
Jika task dibuat dengan enable_pbr: false, properti ini akan dihilangkan.
Name
normal
Type
string
Description
URL yang dapat diunduh untuk gambar normal map.
Jika task dibuat dengan enable_pbr: false, properti ini akan dihilangkan.
Name
roughness
Type
string
Description
URL yang dapat diunduh untuk gambar peta roughness.
Jika task dibuat dengan enable_pbr: false, properti ini akan dihilangkan.
Name
emission
Type
string
Description
URL yang dapat diunduh untuk gambar peta emission.
Jika task dibuat dengan enable_pbr: false, atau ai_model adalah meshy-6-lite, meshy-7.1, atau latest, properti ini akan dihilangkan.
Name
preceding_tasks
Type
integer
Description
Jumlah task yang mendahului.
Nilai kolom ini hanya bermakna jika status task adalah PENDING.
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. Muncul ketika status task adalah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk task FAILED (kredit dikembalikan jika gagal).