API Gambar ke 3D adalah fitur yang memungkinkan Anda mengintegrasikan kemampuan Gambar ke 3D Meshy ke dalam aplikasi Anda sendiri. Di bagian ini, Anda akan menemukan semua informasi
yang Anda perlukan untuk memulai dengan API ini.
Endpoint ini memungkinkan Anda membuat tugas Gambar ke 3D baru. Lihat
Objek Tugas Gambar ke 3D untuk melihat properti
yang disertakan dengan objek tugas Gambar ke 3D.
Parameter
Hanya salah satu dari input_task_id atau image_url yang wajib. Jika keduanya disediakan, input_task_id memiliki prioritas.
Name
input_task_id
Type
string
Wajib
Description
ID dari tugas pembuatan gambar yang sudah selesai yang outputnya harus digunakan sebagai gambar input. Tugas ini harus berupa salah satu dari tugas berikut: Teks ke Gambar atau Gambar ke Gambar. Selain itu, tugas tersebut harus dijalankan melalui API, memiliki status SUCCEEDED, dan menghasilkan tepat satu gambar.
Name
image_url
Type
string
Wajib
Description
Sediakan gambar untuk digunakan Meshy dalam pembuatan model. Saat ini kami mendukung format .jpg, .jpeg, dan .png.
Ada dua cara untuk menyediakan gambar:
URL yang dapat diakses publik: URL yang dapat diakses dari internet publik.
Data URI: Data URI gambar yang dikodekan base64. Contoh data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
model_type
Type
string
default standard
Description
Tentukan jenis pembuatan mesh 3D.
Nilai yang tersedia:
standard: Pembuatan mesh 3D ber-detail tinggi reguler.
lowpoly: Menghasilkan mesh low-poly yang dioptimalkan untuk poligon yang lebih bersih.
Ketika lowpoly dipilih, ai_model, topology, target_polycount, should_remesh, save_pre_remeshed_model diabaikan.
Name
ai_model
Type
string
default latest
Description
ID model yang akan digunakan. Nilai yang tersedia: meshy-5, meshy-6, latest (Meshy 6).
Name
should_texture
Type
boolean
default true
Description
Menentukan apakah tekstur dihasilkan. Mengaturnya ke false akan melewati fase tekstur, menyediakan 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 ketika ai_model adalah meshy-6 atau latest.
Name
hd_texture
Type
boolean
default false
Description
Menghasilkan tekstur warna dasar pada resolusi 4K (4096×4096) untuk detail yang lebih tinggi.
Hanya didukung ketika ai_model adalah meshy-6 atau latest. Peta PBR selalu dihasilkan pada 2K.
Name
texture_prompt
Type
string
Description
Sediakan prompt teks untuk memandu proses pemberian tekstur. Maksimum 600 karakter.
Name
texture_image_url
Type
string
Description
Sediakan gambar 2D untuk memandu proses pemberian tekstur. Saat ini kami mendukung format .jpg, .jpeg, dan .png.
Ada dua cara untuk menyediakan gambar:
URL yang dapat diakses publik: URL yang dapat diakses dari internet publik
Data URI: Data URI gambar yang dikodekan base64. Contoh data URI: data:image/jpeg;base64,<your base64-encoded image data>
Pemberian tekstur berbasis gambar mungkin tidak bekerja optimal jika ada perbedaan geometri yang substansial antara aset 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 disediakan, maka texture_prompt akan digunakan untuk memberi tekstur pada model secara default. Pemberian tekstur melalui teks atau gambar akan dikenakan biaya 10 kredit per tugas.
Name
should_remesh
Type
boolean
default false (meshy-6), true (others)
Description
Mengontrol apakah fase Remesh diaktifkan. Ketika diatur ke false, API mengembalikan mesh segitiga dengan presisi tertinggi.
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 segitiga yang telah didecimate.
Name
target_polycount
Type
integer
default 30,000
Description
Tentukan target jumlah poligon dalam model yang dihasilkan. Jumlah poligon aktual dapat menyimpang dari target tergantung pada kompleksitas geometri.
Rentang nilai yang valid bervariasi tergantung pada tingkat pengguna:
100 hingga 300.000 (inklusif)
Name
decimation_mode
Type
integer
Description
Aktifkan decimation adaptif dengan mengatur level jumlah poligon. Ketika diatur, target_polycount 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
Ketika diatur ke true, Meshy juga menyimpan file GLB tambahan sebelum fase Remesh selesai.
Name
symmetry_mode
Type
string
⚠ usang
default auto
Description
Usang (deprecated). 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 pose_mode 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 gambar input tanpa pemrosesan gaya apa pun.
Hanya didukung ketika ai_model adalah meshy-6 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 di bawah pengaturan pencahayaan kustom.
Hanya didukung ketika ai_model adalah meshy-6 atau latest.
Name
moderation
Type
boolean
default false
Description
Ketika diatur ke true, konten input akan secara otomatis disaring untuk konten yang berpotensi berbahaya. Jika konten berbahaya terdeteksi, tugas tidak akan dilanjutkan ke pembuatan.
Konten dari input image_url, texture_image_url, dan texture_prompt akan disaring.
Name
target_formats
Type
string[]
Description
Menentukan format file 3D mana yang disertakan dalam output. Hanya format yang diminta yang akan dihasilkan dan dikembalikan, yang dapat mengurangi waktu penyelesaian tugas. Ketika dihilangkan, semua format yang didukung disertakan.
Nilai yang tersedia: glb, obj, fbx, stl, usdz, 3mf
Ketika dihilangkan, semua format kecuali 3mf dihasilkan. 3mf hanya disertakan ketika ditentukan secara eksplisit.
Name
auto_size
Type
boolean
default false
Description
Ketika diatur ke true, layanan menggunakan AI vision untuk secara otomatis memperkirakan tinggi dunia nyata objek dan mengubah ukuran model sesuai dengan itu. Titik asal akan default ke bottom kecuali origin_at diatur secara eksplisit.
Name
alpha_thumbnail
Type
boolean
default false
Description
Ketika diatur ke true, tugas juga merender versi latar belakang transparan (RGBA) dari pratinjau dan mengembalikannya sebagai alpha_thumbnail_url pada respons GET. Field thumbnail_url yang ada tidak berubah.
Name
multi_view_thumbnails
Type
boolean
default false
Description
Ketika diatur ke true, tugas juga merender empat thumbnail tampilan kardinal (depan, kanan, belakang, kiri) dan mengembalikannya di bawah thumbnail_urls pada respons GET. Field thumbnail_url yang ada tidak berubah dan tetap menunjuk ke tampilan depan, sehingga klien yang ada tidak terpengaruh.
Menambahkan sekitar 3 detik ke latensi tugas.
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.
Pengembalian
Properti result dari respons berisi id tugas dari tugas 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.
Tugas input tidak valid: input_task_id harus merujuk ke tugas Teks ke Gambar atau Gambar ke Gambar dengan status SUCCEEDED yang menghasilkan tepat satu gambar.
Format gambar tidak valid: image_url yang disediakan 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.
Name
401 - Unauthorized
Description
Autentikasi gagal. Silakan periksa kunci API Anda.
Name
402 - Payment Required
Description
Kredit tidak mencukupi untuk melakukan tugas ini.
Name
429 - Too Many Requests
Description
Anda telah melebihi batas laju Anda.
Request
POST
/openapi/v1/image-to-3d
# Simple request with required paramscurl https://api.meshy.ai/openapi/v1/image-to-3d \ -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>" }'# With remesh, PBR, and A-posecurl https://api.meshy.ai/openapi/v1/image-to-3d \ -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>", "enable_pbr": true, "should_remesh": true, "target_polycount": 100000, "should_texture": true, "pose_mode": "a-pose", "target_formats": ["glb"] }'
endpoint ini memungkinkan Anda mengambil tugas Gambar ke 3D dengan id yang valid.
Lihat Objek Tugas Gambar ke 3D untuk melihat
properti yang disertakan dalam objek tugas Gambar ke 3D.
Parameter
Name
id
Type
path
Description
Pengidentifikasi unik untuk tugas Gambar ke 3D yang akan diambil.
Pengembalian
Respons 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 berikut:
Properti
Name
id
Type
string
Description
Pengidentifikasi unik untuk tugas. Meskipun kami menggunakan UUID k-sortable untuk id tugas sebagai
detail implementasi, Anda tidak boleh membuat asumsi apa pun 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 suatu format akan dihilangkan jika format tersebut 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 bersama ekspor OBJ ketika tekstur tersedia.
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 keluaran GLB asli sebelum remesh.
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, dipertahankan untuk kompatibilitas mundur.
Name
alpha_thumbnail_url
Type
string
Description
URL yang dapat diunduh ke versi berlatar 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 thumbnail empat 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 mempratinjau model dari beberapa 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 (cocok 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
progress
Type
integer
Description
Progress 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 saat 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.
Misalnya, 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 tugas dibuat, dalam milidetik.
Name
expires_at
Type
timestamp
Description
Stempel waktu saat hasil tugas kedaluwarsa, dalam milidetik.
Name
finished_at
Type
timestamp
Description
Stempel waktu saat tugas selesai, dalam milidetik. Jika tugas belum selesai, properti ini akan menjadi 0.
Name
status
Type
string
Description
Status tugas. Nilai yang mungkin adalah salah satu dari PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Array 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 base color map.
Name
metallic
Type
string
Description
URL yang dapat diunduh ke gambar metallic map.
Jika tugas dibuat dengan enable_pbr: false, properti ini akan dihilangkan.
Name
normal
Type
string
Description
URL yang dapat diunduh ke gambar normal map.
Jika tugas dibuat dengan enable_pbr: false, properti ini akan dihilangkan.
Name
roughness
Type
string
Description
URL yang dapat diunduh ke gambar roughness map.
Jika tugas dibuat dengan enable_pbr: false, properti ini akan dihilangkan.
Name
emission
Type
string
Description
URL yang dapat diunduh ke gambar emission map.
Jika tugas dibuat dengan enable_pbr: false, atau ai_model adalah meshy-5, properti ini akan dihilangkan.
Name
preceding_tasks
Type
integer
Description
Jumlah tugas sebelumnya.
Nilai 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 saat gagal).