Multi-Image to 3D API adalah fitur yang memungkinkan Anda untuk mengintegrasikan kemampuan Multi-Image to 3D dari Meshy ke dalam aplikasi Anda sendiri. Dalam bagian ini, Anda akan menemukan semua informasi yang Anda butuhkan untuk memulai dengan API ini.
Endpoint ini memungkinkan Anda untuk membuat tugas Multi-Gambar ke 3D baru. Lihat
Objek Tugas Multi-Gambar ke 3D untuk melihat properti apa saja yang termasuk dalam objek tugas Multi-Gambar ke 3D.
Parameter
Hanya satu dari input_task_id atau image_urls yang diperlukan. Jika keduanya diberikan, input_task_id memiliki prioritas.
Name
input_task_id
Type
string
Wajib
Description
ID dari tugas penghasil gambar yang telah selesai yang outputnya (1-4 gambar) harus digunakan sebagai input. Tugas ini harus merupakan salah satu tugas berikut: Teks ke Gambar, Gambar ke Gambar, Teks ke Gambar Multi-Tampilan, atau Gambar ke Gambar Multi-Tampilan. Selain itu, harus dijalankan melalui API dan memiliki status SUCCEEDED.
Name
image_urls
Type
array
Wajib
Description
Berikan 1 sampai 4 gambar untuk digunakan Meshy dalam pembuatan model. Saat ini kami mendukung format .jpg, .jpeg, dan .png. Semua gambar harus menggambarkan objek yang sama dari sudut yang berbeda untuk hasil terbaik.
Ada dua cara untuk menyampaikan setiap gambar:
URL dapat diakses publik: URL yang dapat diakses dari internet publik.
Data URI: Data URI yang dienkripsi base64 dari gambar tersebut. Contoh data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Untuk meshy-7 (atau terbaru), gambar pertama digunakan sebagai tampilan utama (depan). Urutan gambar yang lain tidak masalah.
Name
ai_model
Type
string
default terbaru
Description
ID dari model yang akan digunakan. Nilai yang tersedia: meshy-5, meshy-6, meshy-7, terbaru (Meshy 7).
Name
should_texture
Type
boolean
default true
Description
Menentukan apakah tekstur dihasilkan. Mengaturnya ke false akan melewatkan fase tekstur, memberikan mesh tanpa tekstur.
Hanya berlaku ketika should_texture = true
Name
enable_pbr
Type
boolean
default false
Description
Menghasilkan PBR Maps (metallic, roughness, normal) selain dari warna dasar. Peta emisi juga termasuk ketika ai_model adalah meshy-6, kecuali pada texture_resolution: 8k. meshy-7 dan terbaru 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 memerlukan ai_modelmeshy-6, meshy-7 atau terbaru. 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". Ketika keduanya diatur, texture_resolution memiliki prioritas.
Name
texture_prompt
Type
string
Description
Berikan prompt teks untuk membimbing proses pembentukan tekstur. Maksimal 600 karakter.
Name
texture_image_url
Type
string
Description
Berikan gambar 2D untuk membimbing proses pembentukan tekstur. Saat ini kami mendukung format .jpg, .jpeg, dan .png.
Ada dua cara untuk menyampaikan gambar:
URL dapat diakses publik: URL yang dapat diakses dari internet publik
Data URI: Data URI yang dienkripsi base64 dari gambar tersebut. Contoh data URI: data:image/jpeg;base64,<your base64-encoded image data>
Pembentukan tekstur gambar mungkin tidak bekerja maksimal jika ada perbedaan geometri yang besar antara asset asli dan gambar yang diunggah. Hanya satu dari texture_image_url atau texture_prompt yang dapat digunakan untuk membimbing proses pembentukan tekstur. Jika kedua parameter diberikan, maka texture_prompt akan digunakan untuk membentuk tekstur model secara default.
Name
should_remesh
Type
boolean
default false (meshy-6), true (lainnya)
Description
Mengontrol apakah akan mengaktifkan fase remesh. Untuk model dengan kualitas tertinggi, kami merekomendasikan mengatur should_remesh ke false.
Hanya berlaku ketika should_remesh = true
Name
topology
Type
string
default segitiga
Description
Tentukan topologi dari model yang dihasilkan.
Nilai yang tersedia:
quad: Menghasilkan mesh dominan quad.
triangle: Menghasilkan mesh segitiga yang dihitung.
Name
target_polycount
Type
integer
default 30.000
Description
Tentukan jumlah target poligon dalam model yang dihasilkan. Jumlah poligon aktual dapat menyimpang dari target tergantung pada kompleksitas geometri.
Nilai rentang yang valid berbeda berdasarkan tingkat pengguna:
100 hingga 300.000 (inklusif)
Name
decimation_mode
Type
integer
Description
Aktifkan pengurangan adaptif dengan menetapkan tingkat jumlah poligon. Ketika diterapkan, 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. Parameter ini tidak lagi mempengaruhi output.
Field symmetry_mode mengontrol perilaku simetri selama proses pembangkitan model.
Nilai yang valid adalah:
off: Menonaktifkan simetri.
auto: Secara otomatis menentukan dan menerapkan simetri berdasarkan geometri input.
on: Memaksa simetri selama pembangkitan.
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 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. Diatur ke false untuk mempertahankan tampilan asli gambar input tanpa pemrosesan gaya.
Hanya didukung ketika ai_model adalah meshy-6, meshy-7 atau terbaru.
Name
remove_lighting
Type
boolean
default true
Description
Menghapus sorotan dan bayangan dari tekstur warna dasar, menghasilkan hasil yang lebih bersih yang bekerja lebih baik di bawah pengaturan pencahayaan khusus.
Hanya didukung ketika ai_model adalah meshy-6, meshy-7 atau terbaru.
Name
moderation
Type
boolean
default false
Description
Ketika diatur ke true, konten input secara otomatis akan di-screening untuk konten yang berpotensi berbahaya. Jika konten berbahaya terdeteksi, tugas tidak akan dilanjutkan.
Setiap gambar dari image_urls dan teks dari texture_prompt akan di-screening.
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 tugas.
Nilai yang tersedia: glb, obj, fbx, stl, usdz, 3mf
Ketika dihilangkan, semua format kecuali 3mf dihasilkan. 3mf hanya termasuk ketika ditentukan secara eksplisit.
Name
auto_size
Type
boolean
default false
Description
Ketika diatur ke true, layanan menggunakan visi AI untuk memperkirakan tinggi dunia nyata dari objek secara otomatis dan mengubah ukuran model sesuai. Titik asal akan default ke bottom kecuali origin_at ditetapkan 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 respon GET. Field thumbnail_url yang sudah 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 respon GET. Field thumbnail_url yang sudah ada tidak berubah dan tetap mengarah 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 respon berisi id tugas dari tugas Multi-Gambar ke 3D yang baru dibuat.
Mode Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak dapat diterima. Penyebab umum:
Parameter hilang: Baik image_urls atau input_task_id harus diberikan.
Tugas input tidak valid: input_task_id harus merujuk ke Teks ke Gambar, Gambar ke Gambar, atau varian multi-tampilan SUCCEEDED.
Jumlah gambar tidak valid: image_urls harus berisi antara 1 dan 4 gambar.
Format gambar tidak valid: Satu atau lebih gambar dalam image_urls bukan format yang didukung.
URL tidak dapat dijangkau: Satu atau lebih image_urls tidak dapat diunduh.
Name
401 - Unauthorized
Description
Autentikasi gagal. Harap periksa kunci API Anda.
Name
402 - Payment Required
Description
Kredit tidak cukup untuk melaksanakan tugas ini.
Name
429 - Too Many Requests
Description
Anda telah melampaui batas laju.
Permintaan
POST
/openapi/v1/multi-image-to-3d
# Permintaan sederhanacurlhttps://api.meshy.ai/openapi/v1/multi-image-to-3d \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_urls": [ "<your publicly accessible image url or base64-encoded data URI>", "<your second publicly accessible image url or base64-encoded data URI>" ] }'# Dengan tekstur PBR dan format GLBcurlhttps://api.meshy.ai/openapi/v1/multi-image-to-3d \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_urls": [ "<your publicly accessible image url or base64-encoded data URI>", "<your second publicly accessible image url or base64-encoded data URI>" ], "should_texture": true, "enable_pbr": true, "target_formats": ["glb"] }'
Endpoint ini memungkinkan Anda untuk mendapatkan tugas Multi-Gambar ke 3D yang diberikan ID tugas yang valid.
Lihat Objek Tugas Multi-Gambar ke 3D untuk melihat properti apa saja yang termasuk dalam objek tugas Multi-Gambar ke 3D.
Parameter
Name
id
Type
path
Description
Pengidentifikasi unik untuk mendapatkan tugas Multi-Gambar ke 3D.
Objek Tugas Multi-Gambar ke 3D adalah unit kerja yang dilacak oleh Meshy untuk menghasilkan model 3D dari beberapa gambar (antara 1 sampai 4 inklusif). Gambar-gambar ini harus dari objek yang sama, idealnya dari tampilan atau sudut yang berbeda. Objek ini memiliki properti berikut:
Properti
Name
id
Type
string
Description
Pengidentifikasi unik untuk tugas tersebut. Meskipun kami menggunakan UUID k-sorted untuk id tugas sebagai detail implementasi, Anda tidak boleh membuat asumsi apapun tentang format id tersebut.
Name
type
Type
string
Description
Tipe dari tugas Multi-Gambar ke 3D. Nilainya adalah multi-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 bersama 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 yang lebih lama.
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, field 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 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 yang lebih lama dan tugas yang dibuat tanpa opt-in tidak akan menyertakan field ini.
Name
front
Type
string
Description
Tampilan depan, rotasi 0° di sekitar axis vertikal (sesuai 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 pembentukan tekstur.
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 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.
Contohnya, 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 saat tugas dibuat, dalam milidetik.
Name
expires_at
Type
timestamp
Description
Stempel waktu saat hasil tugas berakhir, 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 dari tugas tersebut. 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 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 metallic.
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 peta roughness.
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, properti ini akan dihilangkan.
Name
preceding_tasks
Type
integer
Description
Jumlah dari tugas sebelumya.
Nilai dari field ini hanya bermakna jika status tugas adalah PENDING.
Name
task_error
Type
object
Description
Rincian 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. Hadir ketika status tugas adalah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugas FAILED (kredit dikembalikan jika gagal).