API Gambar ke 3D adalah fitur yang memungkinkan Anda untuk 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 outputnya akan digunakan sebagai gambar input. Task ini harus merupakan 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 sebuah gambar agar Meshy dapat menggunakannya dalam pembuatan model. Kami saat ini mendukung format .jpg, .jpeg, dan .png.
Ada dua cara untuk menyediakan gambar tersebut:
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 Anda yang dienkode base64>.
Name
model_type
Type
string
default standard
Description
Tentukan jenis pembuatan mesh 3D.
Nilai yang tersedia:
standard: Pembuatan mesh 3D reguler dengan detail tinggi.
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.
Saat smart-topology dipilih, topology, should_remesh, dan save_pre_remeshed_model diabaikan.
Saat lowpoly dipilih, ai_model, topology, target_polycount, should_remesh, dan save_pre_remeshed_model 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 triangle, dan jumlah face yang dapat Anda atur dengan target_polycount.
Name
ultra_mode
Type
boolean
default false
Description
Mengaktifkan pembuatan Ultra untuk geometri dengan fidelitas lebih tinggi dan detail permukaan yang lebih halus.
Hanya didukung saat ai_model adalah meshy-7 (atau latest).
Name
should_texture
Type
boolean
default true
Description
Menentukan apakah tekstur dibuat. Mengatur ini 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 emission juga disertakan saat ai_model adalah meshy-6, kecuali pada texture_resolution: 8k. meshy-7 dan latest tidak menghasilkan peta emission.
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_model: meshy-5. Pada 8k, tidak ada peta emission 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 pemberian tekstur. Maksimal 800 karakter.
Name
texture_image_url
Type
string
Description
Berikan gambar 2d untuk memandu proses pemberian tekstur. Kami saat ini mendukung format .jpg, .jpeg, dan .png.
Ada dua cara untuk menyediakan gambar tersebut:
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 Anda yang dienkode base64>
Pemberian tekstur gambar mungkin tidak berfungsi optimal jika terdapat perbedaan geometri yang signifikan antara asset asli dan gambar yang diunggah. Hanya salah satu dari texture_image_url atau texture_prompt yang dapat digunakan untuk memandu proses pemberian tekstur. Jika kedua parameter diberikan, maka texture_prompt akan digunakan secara default untuk memberi tekstur pada model. Pemberian tekstur melalui teks maupun gambar akan dikenakan biaya 10 kredit per task.
Name
should_remesh
Type
boolean
default false (meshy-6, meshy-7), true (others)
Description
Mengontrol apakah tahap remesh diaktifkan. Untuk model dengan kualitas tertinggi, kami merekomendasikan mengatur should_remesh ke false.
Hanya berlaku ketika should_remesh = true
Name
topology
Type
string
default triangle
Description
Tentukan topology model yang dihasilkan.
Nilai yang tersedia:
quad: Menghasilkan mesh yang didominasi quad.
triangle: Menghasilkan mesh triangle yang telah didesimasi.
Name
decimation_mode
Type
integer
Description
Aktifkan desimasi adaptif dengan mengatur level jumlah poligon. Jika diatur, target_polycount akan diabaikan.
Nilai yang tersedia:
1: Adaptif — jumlah poligon ultra.
2: Adaptif — jumlah poligon tinggi.
3: Adaptif — jumlah poligon menengah.
4: Adaptif — jumlah poligon rendah.
Name
save_pre_remeshed_model
Type
boolean
default false
Description
Jika diatur ke true, Meshy juga menyimpan file GLB tambahan sebelum tahap remesh selesai.
Name
target_polycount
Type
integer
Description
Jumlah poligon (face) target pada output. Jumlah sebenarnya bisa berbeda dari target tergantung pada geometri.
target_polycount berlaku pada dua kasus independen:
Remesh — dengan should_remesh: true pada model standard. Mesh akan di-remesh (didesimasi) hingga mendekati jumlah ini. Rentang 100 hingga 300.000, default 30.000. Jika decimation_mode diatur, itu akan diprioritaskan dan target_polycount diabaikan.
Smart Topology — dengan model_type: smart-topology dan ai_model: meshy-t2. Model dihasilkan langsung dengan jumlah face ini; tidak ada proses 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 spesifik 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. Atur ke false untuk mempertahankan tampilan persis dari gambar input tanpa pemrosesan gaya apa pun.
Hanya didukung saat ai_model adalah meshy-6, meshy-7, 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 pada pengaturan pencahayaan kustom.
Hanya didukung saat ai_model adalah meshy-6.
Name
moderation
Type
boolean
default false
Description
Jika diatur ke true, konten input akan secara otomatis diperiksa untuk konten yang berpotensi berbahaya. Jika konten berbahaya terdeteksi, task tidak akan dilanjutkan ke tahap 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 diatur 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 menggunakan nilai default bottom kecuali origin_at diatur secara eksplisit.
Name
alpha_thumbnail
Type
boolean
default false
Description
Jika diatur ke true, task juga akan me-render versi pratinjau dengan latar belakang transparan (RGBA) dan mengembalikannya sebagai alpha_thumbnail_url pada respons GET. Field thumbnail_url yang sudah ada tetap tidak berubah.
Name
multi_view_thumbnails
Type
boolean
default false
Description
Jika diatur ke true, task juga akan me-render empat thumbnail tampilan utama (depan, kanan, belakang, kiri) dan mengembalikannya di bawah thumbnail_urls pada respons GET. Field thumbnail_url yang sudah ada tetap tidak berubah dan tetap mengarah 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 saat auto_size diaktifkan.
Nilai yang tersedia: bottom, center.
Returns
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 disediakan.
Task input tidak valid: input_task_id harus mengacu 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 berbentuk baik (malformed).
Kombinasi parameter tidak valid: enable_pbr hanya didukung saat should_texture bernilai true.
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 melebihi 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 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>", "enable_pbr": true, "should_remesh": true, "target_polycount": 100000, "should_texture": true, "pose_mode": "a-pose", "target_formats": ["glb"] }'
Endpoint ini memungkinkan Anda untuk mengambil tugas Gambar ke 3D dengan memberikan id tugas yang valid.
Lihat Objek Tugas Gambar ke 3D untuk melihat properti apa saja yang disertakan dengan objek tugas Gambar ke 3D.
Parameter
Name
id
Type
path
Description
Pengidentifikasi unik untuk tugas Gambar ke 3D yang akan diambil.
Mengembalikan
Respon berisi objek tugas Gambar ke 3D. Periksa
bagian Objek Tugas Gambar ke 3D untuk detailnya.
Objek Tugas Gambar ke 3D adalah unit kerja yang dilacak oleh Meshy untuk menghasilkan model 3D dari input gambar. Objek ini memiliki properti sebagai berikut:
Properti
Name
id
Type
string
Description
Pengenal unik untuk tugas. Meskipun kami menggunakan UUID yang dapat diurutkan secara k untuk id tugas sebagai detail implementasi, Anda tidak boleh membuat asumsi apapun tentang format id.
Name
type
Type
string
Description
Jenis tugas Gambar ke 3D. Nilainya adalah image-to-3d.
Name
model_urls
Type
object
Description
URL yang dapat diunduh ke file model 3D bertekstur yang dihasilkan oleh Meshy. Properti untuk format akan dihilangkan jika format tidak dihasilkan alih-alih mengembalikan string kosong.
Name
glb
Type
string
Description
URL yang dapat diunduh ke file GLB.
Name
fbx
Type
string
Description
URL yang dapat diunduh ke file FBX.
Name
obj
Type
string
Description
URL yang dapat diunduh ke file OBJ.
Name
usdz
Type
string
Description
URL yang dapat diunduh ke file USDZ.
Name
mtl
Type
string
Description
URL yang dapat diunduh ke file MTL, dikembalikan bersamaan dengan ekspor OBJ ketika tekstur ada.
Name
stl
Type
string
Description
URL yang dapat diunduh ke file STL.
Name
3mf
Type
string
Description
URL yang dapat diunduh ke file 3MF. Hanya ada ketika 3mf diminta melalui target_formats.
Name
pre_remeshed_glb
Type
string
Description
URL yang dapat diunduh ke output GLB asli sebelum remeshing.
Tersedia hanya ketika tugas dibuat dengan should_remesh: true dan save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
URL yang dapat diunduh ke gambar thumbnail dari file model. Setara dengan thumbnail_urls.front ketika ada, disimpan untuk kompatibilitas ke belakang.
Name
alpha_thumbnail_url
Type
string
Description
URL yang dapat diunduh ke versi latar belakang transparan (RGBA) dari thumbnail_url. Hanya ada ketika tugas dibuat dengan alpha_thumbnail: true dan pratinjau transparan berhasil dirender; jika tidak, bidang ini 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 yang ditandatangani ke PNG 512×512 yang dirender dengan bahan dan pencahayaan yang sama seperti thumbnail_url. Berguna untuk melihat pratinjau model dari berbagai sudut dalam pipeline batch tanpa mengunduh GLB.
Hanya ada ketika tugas dibuat dengan multi_view_thumbnails: true dan telah mencapai SUCCEEDED. Tugas lama dan tugas yang dibuat tanpa opt-in tidak akan menyertakan bidang 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 pemberian tekstur.
Name
texture_image_url
Type
string
Description
URL yang dapat diunduh ke gambar tekstur yang digunakan untuk memandu proses pemberian tekstur.
Name
ultra_mode
Type
boolean
Description
Menggemakan nilai ultra_mode yang dibuat dengan tugas. Hanya ada untuk tugas meshy-7 (atau latest) yang secara eksplisit mengatur ultra_mode; jika tidak, dihilangkan.
Name
progress
Type
integer
Description
Kemajuan dari tugas. Jika tugas belum dimulai, properti ini akan menjadi 0. Setelah tugas berhasil, ini akan menjadi 100.
Name
started_at
Type
timestamp
Description
Stempel waktu ketika tugas dimulai, dalam milidetik. Jika tugas belum dimulai, properti ini akan menjadi 0.
Stempel waktu mewakili jumlah milidetik yang berlalu sejak 1 Januari 1970 UTC, mengikuti standar RFC 3339. Sebagai contoh, Jumat, 1 September 2023 12:00:00 PM GMT diwakili sebagai 1693569600000. Ini berlaku untuk semua stempel waktu dalam Meshy API.
Name
created_at
Type
timestamp
Description
Stempel waktu ketika tugas dibuat, dalam milidetik.
Name
expires_at
Type
timestamp
Description
Stempel waktu ketika hasil tugas kedaluwarsa, dalam milidetik.
Name
finished_at
Type
timestamp
Description
Stempel waktu ketika tugas selesai, dalam milidetik. Jika tugas belum selesai, properti ini akan menjadi 0.
Name
status
Type
string
Description
Status dari tugas. Nilai yang mungkin adalah salah satu dari PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Array dari objek URL tekstur yang dihasilkan dari tugas. Biasanya ini hanya berisi satu objek URL tekstur. Setiap URL tekstur memiliki properti berikut:
Name
base_color
Type
string
Description
URL yang dapat diunduh ke gambar peta warna dasar.
Name
metallic
Type
string
Description
URL yang dapat diunduh ke gambar peta metalik.
Jika tugas dibuat dengan enable_pbr: false, properti ini akan dihilangkan.
Name
normal
Type
string
Description
URL yang dapat diunduh ke gambar peta normal.
Jika tugas dibuat dengan enable_pbr: false, properti ini akan dihilangkan.
Name
roughness
Type
string
Description
URL yang dapat diunduh ke gambar peta kekasaran.
Jika tugas dibuat dengan enable_pbr: false, properti ini akan dihilangkan.
Name
emission
Type
string
Description
URL yang dapat diunduh ke gambar peta emisi.
Jika tugas dibuat dengan enable_pbr: false, atau ai_model adalah meshy-5, meshy-7, atau latest, properti ini akan dihilangkan.
Name
preceding_tasks
Type
integer
Description
Jumlah tugas sebelumnya.
Nilai dari bidang ini bermakna hanya jika status tugas adalah PENDING.
Name
task_error
Type
object
Description
Detail kesalahan untuk tugas yang gagal. Lihat Kesalahan untuk referensi lengkap objek task_error.
Name
consumed_credits
Type
integer
Description
Jumlah kredit yang dikonsumsi oleh tugas ini. Ada ketika status tugas adalah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugas FAILED (kredit dikembalikan pada kegagalan).