Imej ke 3D API adalah ciri yang membolehkan anda mengintegrasikan keupayaan Imej ke 3D Meshy ke dalam aplikasi anda sendiri. Dalam bahagian ini, anda akan menemui semua maklumat yang anda perlukan untuk memulakan dengan API ini.
Endpoint ini membolehkan anda mencipta tugas Imej ke 3D baharu. Rujuk
The Image to 3D Task Object untuk melihat
ciri-ciri yang disertakan dengan objek tugas Imej ke 3D.
Parameter
Hanya satu daripada input_task_id atau image_url yang diperlukan. Jika kedua-duanya disediakan, input_task_id diberi keutamaan.
Name
input_task_id
Type
string
Diperlukan
Description
ID tugas penjanaan imej yang telah selesai, yang outputnya patut digunakan sebagai imej input. Tugas ini mestilah salah satu daripada tugas berikut: Teks ke Imej atau Imej ke Imej. Selain itu, ia mesti telah dijalankan melalui API, mempunyai status SUCCEEDED, dan menghasilkan tepat satu imej.
Name
image_url
Type
string
Diperlukan
Description
Berikan imej untuk Meshy gunakan dalam penciptaan model. Kami kini menyokong format .jpg, .jpeg, dan .png.
Terdapat dua cara untuk menyediakan imej:
URL yang boleh diakses secara umum: URL yang boleh diakses dari internet umum.
Data URI: Data URI yang dikodkan base64 bagi imej tersebut. Contoh data URI: data:image/jpeg;base64,<data imej anda yang dikodkan base64>.
Name
model_type
Type
string
lalai standard
Description
Nyatakan jenis penjanaan jejaring 3D.
Nilai yang tersedia:
standard: Penjanaan jejaring 3D berperincian tinggi yang biasa.
smart-topology: Pilih model Smart Topology dengan ai_model (meshy-t2).
lowpoly (lapuk): Menjana jejaring low-poly yang dioptimumkan untuk poligon yang lebih kemas. Kami mengesyorkan menggunakan smart-topology sebagai gantinya.
Apabila smart-topology dipilih, topology, should_remesh, dan save_pre_remeshed_model diabaikan.
Apabila lowpoly dipilih, ai_model, topology, target_polycount, should_remesh, dan save_pre_remeshed_model diabaikan.
Name
ai_model
Type
string
lalai latest
Description
ID model yang akan digunakan. Nilai yang tersedia bergantung pada model_type.
meshy-t2 (lalai): model Smart Topology — topology yang lebih kemas, bahagian yang dipisahkan secara semula jadi, output segi tiga, dan bilangan segi yang dapat anda tetapkan dengan target_polycount.
Name
ultra_mode
Type
boolean
lalai false
Description
Membolehkan penjanaan Ultra untuk geometri kesetiaan lebih tinggi dengan perincian permukaan yang lebih halus.
Hanya disokong apabila ai_model ialah meshy-7 (atau latest).
Name
should_texture
Type
boolean
lalai true
Description
Menentukan sama ada tekstur dijana. Menetapkannya kepada false melangkau fasa tekstur, memberikan jejaring tanpa tekstur.
Hanya berlaku apabila should_texture = true
Name
enable_pbr
Type
boolean
lalai false
Description
Jana peta PBR (metallic, roughness, normal) selain warna asas. Peta emisi juga disertakan apabila ai_model ialah meshy-6, kecuali pada texture_resolution: 8k. meshy-7 dan latest tidak menghasilkan peta emisi.
Name
texture_resolution
Type
string
lalai 2k
Description
Resolusi tekstur warna asas. Salah satu daripada 2k (2048×2048), 4k (4096×4096), atau 8k (8192×8192). Resolusi yang lebih tinggi merakam lebih banyak perincian permukaan.
4k dan 8k tidak tersedia dengan ai_model: meshy-5. Pada 8k, tiada peta emisi dihasilkan.
Name
hd_texture
Type
boolean
⚠ lapuk
lalai false
Description
Gunakan texture_resolution sebagai gantinya — bersamaan dengan texture_resolution: "4k". Apabila kedua-duanya ditetapkan, texture_resolution diberi keutamaan.
Name
texture_prompt
Type
string
Description
Berikan prompt teks untuk membimbing proses pembuatan tekstur. Maksimum 800 aksara.
Name
texture_image_url
Type
string
Description
Berikan imej 2d untuk membimbing proses pembuatan tekstur. Kami kini menyokong format .jpg, .jpeg, dan .png.
Terdapat dua cara untuk menyediakan imej:
URL yang boleh diakses secara umum: URL yang boleh diakses dari internet umum
Data URI: Data URI yang dikodkan base64 bagi imej tersebut. Contoh data URI: data:image/jpeg;base64,<data imej anda yang dikodkan base64>
Pembuatan tekstur imej mungkin tidak berfungsi secara optimum jika terdapat perbezaan geometri yang besar antara aset asal dan imej yang dimuat naik. Hanya satu daripada texture_image_url atau texture_prompt boleh digunakan untuk membimbing proses pembuatan tekstur. Jika kedua-dua parameter disediakan, maka texture_prompt akan digunakan untuk membuat tekstur model secara lalai. Pembuatan tekstur melalui sama ada teks atau imej akan dikenakan 10 kredit setiap tugas.
Name
should_remesh
Type
boolean
lalai false (meshy-6, meshy-7), true (others)
Description
Mengawal sama ada untuk membolehkan fasa remesh. Untuk model berkualiti tertinggi, kami mengesyorkan menetapkan should_remesh kepada false.
Hanya berlaku apabila should_remesh = true
Name
topology
Type
string
lalai triangle
Description
Nyatakan topology model yang dijana.
Nilai yang tersedia:
quad: Jana jejaring yang didominasi oleh quad.
triangle: Jana jejaring segi tiga yang telah dinyahkan (decimated).
Name
decimation_mode
Type
integer
Description
Bolehkan penyahan (decimation) adaptif dengan menetapkan tahap bilangan poligon. Apabila ditetapkan, target_polycount diabaikan.
Nilai yang tersedia:
1: Adaptif — bilangan poligon ultra.
2: Adaptif — bilangan poligon tinggi.
3: Adaptif — bilangan poligon sederhana.
4: Adaptif — bilangan poligon rendah.
Name
save_pre_remeshed_model
Type
boolean
lalai false
Description
Apabila ditetapkan kepada true, Meshy juga menyimpan fail GLB tambahan sebelum fasa remesh selesai.
Name
target_polycount
Type
integer
Description
Bilangan sasaran poligon (segi) dalam output. Bilangan sebenar mungkin berbeza daripada sasaran bergantung pada geometri.
target_polycount berkuat kuasa dalam dua kes bebas:
Remesh — dengan should_remesh: true pada model standard. Jejaring di-remesh (dinyahkan/decimated) kepada kira-kira bilangan ini. Julat 100 hingga 300,000, lalai 30,000. Jika decimation_mode ditetapkan, ia diberi keutamaan dan target_polycount diabaikan.
Smart Topology — dengan model_type: smart-topology dan ai_model: meshy-t2. Model dijana secara terus pada bilangan segi ini; tiada remesh dijalankan dan should_remesh tidak diperlukan. Julat 100 hingga 15,000, lalai 4,000.
Name
symmetry_mode
Type
string
⚠ lapuk
lalai auto
Description
Lapuk. Parameter ini tidak lagi menjejaskan output.
Medan symmetry_mode mengawal tingkah laku simetri semasa proses penjanaan model.
Nilai yang sah adalah:
off: Melumpuhkan simetri.
auto: Menentukan dan menerapkan simetri secara automatik berdasarkan geometri input.
on: Menguatkuasakan simetri semasa penjanaan.
Name
pose_mode
Type
string
lalai ""
Description
Nyatakan mode pose untuk model yang dijana.
Nilai yang tersedia:
a-pose: Jana model dalam pose A.
t-pose: Jana model dalam pose T.
"" (rentetan kosong): Tiada pose khusus digunakan.
Name
is_a_t_pose
Type
boolean
⚠ lapuk
lalai false
Description
Gunakan pose_mode sebagai gantinya. Sama ada untuk menjana model dalam pose A/T.
Name
image_enhancement
Type
boolean
lalai true
Description
Mengoptimumkan imej input untuk hasil yang lebih baik. Tetapkan kepada false untuk mengekalkan rupa tepat imej input tanpa sebarang pemprosesan gaya.
Hanya disokong apabila ai_model ialah meshy-6, meshy-7, atau latest.
Name
remove_lighting
Type
boolean
lalai true
Description
Membuang sorotan dan bayang daripada tekstur warna asas, menghasilkan keputusan yang lebih bersih yang berfungsi dengan lebih baik di bawah persediaan pencahayaan tersuai.
Hanya disokong apabila ai_model ialah meshy-6.
Name
moderation
Type
boolean
lalai false
Description
Apabila ditetapkan kepada true, kandungan input akan disaring secara automatik untuk kandungan yang berpotensi berbahaya. Jika kandungan berbahaya dikesan, tugas tidak akan diteruskan ke penjanaan.
Kandungan daripada input image_url, texture_image_url, dan texture_prompt akan disaring.
Name
target_formats
Type
string[]
Description
Menentukan format fail 3D yang disertakan dalam output. Hanya format yang diminta akan dijana dan dikembalikan, yang boleh mengurangkan masa penyelesaian tugas. Apabila ditinggalkan, semua format yang disokong disertakan.
Nilai yang tersedia: glb, obj, fbx, stl, usdz, 3mf
Apabila ditinggalkan, semua format kecuali 3mf dijana. 3mf hanya disertakan apabila dinyatakan secara jelas.
Name
auto_size
Type
boolean
lalai false
Description
Apabila ditetapkan kepada true, perkhidmatan menggunakan penglihatan AI untuk menganggarkan secara automatik ketinggian sebenar objek tersebut dan mengubah saiz model dengan sewajarnya. Titik asal akan menjadi lalai kepada bottom melainkan origin_at ditetapkan secara jelas.
Name
alpha_thumbnail
Type
boolean
lalai false
Description
Apabila ditetapkan kepada true, tugas ini turut merender versi latar belakang lutsinar (RGBA) bagi pratonton dan mengembalikannya sebagai alpha_thumbnail_url pada respons GET. Medan thumbnail_url yang sedia ada tidak berubah.
Name
multi_view_thumbnails
Type
boolean
lalai false
Description
Apabila ditetapkan kepada true, tugas ini turut merender empat lakaran kecil pandangan kardinal (depan, kanan, belakang, kiri) dan mengembalikannya di bawah thumbnail_urls pada respons GET. Medan thumbnail_url yang sedia ada tidak berubah dan terus menghala kepada pandangan depan, jadi pelanggan sedia ada tidak terjejas.
Menambah kira-kira 3 saat kepada kependaman tugas.
Hanya berlaku apabila auto_size = true
Name
origin_at
Type
string
lalai bottom
Description
Kedudukan titik asal apabila auto_size dibolehkan.
Nilai yang tersedia: bottom, center.
Pulangan
Ciri result pada respons mengandungi id tugas bagi tugas Imej ke 3D yang baharu dicipta.
Mod Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak dapat diterima. Sebab biasa:
Parameter tidak lengkap: Sama ada image_url atau input_task_id mesti disediakan.
Tugas input tidak sah: input_task_id mestilah merujuk kepada tugas Teks ke Imej atau Imej ke Imej yang berstatus SUCCEEDED dan menghasilkan tepat satu imej.
Format imej tidak sah: image_url yang disediakan bukan format yang disokong (.jpg, .jpeg, .png).
URL tidak dapat dicapai: image_url tidak dapat dimuat turun (404 atau timeout).
Data URI tidak sah: Rentetan base64 tidak sah bentuknya.
Kombinasi parameter tidak sah: enable_pbr hanya disokong apabila should_texture bernilai true.
Name
401 - Unauthorized
Description
Pengesahan gagal. Sila semak kunci API anda.
Name
402 - Payment Required
Description
Kredit tidak mencukupi untuk menjalankan tugas ini.
Name
429 - Too Many Requests
Description
Anda telah melebihi had kadar 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 membolehkan anda mendapatkan tugas Imej ke 3D dengan memberikan id tugas yang sah.
Rujuk kepada Objek Tugas Imej ke 3D untuk melihat sifat-sifat
yang disertakan dengan objek tugas Imej ke 3D.
Parameter
Name
id
Type
path
Description
Pengenal pasti unik untuk tugas Imej ke 3D yang ingin diperoleh.
Pulangan
Respons mengandungi objek tugas Imej ke 3D. Semak
bahagian Objek Tugas Imej ke 3D untuk butiran.
Objek Tugas Imej ke 3D adalah unit kerja yang diikuti oleh Meshy untuk menjana model 3D daripada input imej.
Objek ini mempunyai sifat-sifat berikut:
Sifat-sifat
Name
id
Type
string
Description
Pengenal pasti unik untuk tugas ini. Walaupun kami menggunakan UUID yang boleh diurutkan k untuk id tugas sebagai butiran pelaksanaan, anda tidak seharusnya membuat sebarang andaian tentang format id tersebut.
Name
type
Type
string
Description
Jenis tugas Imej ke 3D. Nilainya adalah image-to-3d.
Name
model_urls
Type
object
Description
URL yang boleh dimuat turun untuk fail model 3D bertekstur yang dijana oleh Meshy. Sifat untuk format akan diabaikan jika format tersebut tidak dijana dan bukannya mengembalikan rentetan kosong.
Name
glb
Type
string
Description
URL yang boleh dimuat turun untuk fail GLB.
Name
fbx
Type
string
Description
URL yang boleh dimuat turun untuk fail FBX.
Name
obj
Type
string
Description
URL yang boleh dimuat turun untuk fail OBJ.
Name
usdz
Type
string
Description
URL yang boleh dimuat turun untuk fail USDZ.
Name
mtl
Type
string
Description
URL yang boleh dimuat turun untuk fail MTL, dikembalikan bersama eksport OBJ apabila tekstur hadir.
Name
stl
Type
string
Description
URL yang boleh dimuat turun untuk fail STL.
Name
3mf
Type
string
Description
URL yang boleh dimuat turun untuk fail 3MF. Hanya hadir apabila 3mf diminta melalui target_formats.
Name
pre_remeshed_glb
Type
string
Description
URL yang boleh dimuat turun untuk output GLB asal sebelum remesh.
Hanya tersedia apabila tugas dibuat dengan kedua-dua should_remesh: true dan save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
URL yang boleh dimuat turun untuk imej kecil fail model. Setara dengan thumbnail_urls.front apabila hadir, disimpan untuk keserasian ke belakang.
Name
alpha_thumbnail_url
Type
string
Description
URL yang boleh dimuat turun untuk versi latar belakang telus (RGBA) thumbnail_url. Hanya hadir apabila tugas dibuat dengan alpha_thumbnail: true dan pratonton telus berjaya dirender; jika tidak, medan ini diabaikan.
Name
thumbnail_urls
Type
object
Description
URL yang boleh dimuat turun untuk empat imej kecil pandangan kardinal model 3D yang dijana. Setiap nilai adalah URL yang ditandatangani untuk PNG 512×512 yang dirender dengan bahan dan pencahayaan yang sama seperti thumbnail_url. Berguna untuk pratonton model dari pelbagai sudut dalam saluran paip batch tanpa memuat turun GLB.
Hanya hadir apabila tugas dibuat dengan multi_view_thumbnails: true dan telah mencapai SUCCEEDED. Tugas lama dan tugas yang dibuat tanpa pilihan ini tidak akan menyertakan medan ini.
Name
front
Type
string
Description
Pandangan depan, putaran 0° di sekitar paksi menegak (sepadan dengan thumbnail_url).
Name
right
Type
string
Description
Pandangan kanan, putaran 90°.
Name
back
Type
string
Description
Pandangan belakang, putaran 180°.
Name
left
Type
string
Description
Pandangan kiri, putaran 270°.
Name
texture_prompt
Type
string
Description
Prompt teks yang digunakan untuk membimbing proses tekstur.
Name
texture_image_url
Type
string
Description
URL yang boleh dimuat turun untuk imej tekstur yang digunakan untuk membimbing proses tekstur.
Name
ultra_mode
Type
boolean
Description
Menggemakan nilai ultra_mode yang tugas ini dibuat. Hanya hadir untuk tugas meshy-7 (atau latest) yang secara eksplisit menetapkan ultra_mode; jika tidak, diabaikan.
Name
progress
Type
integer
Description
Kemajuan tugas. Jika tugas belum dimulakan, sifat ini akan menjadi 0. Setelah tugas berjaya, ini akan menjadi 100.
Name
started_at
Type
timestamp
Description
Cap masa apabila tugas dimulakan, dalam milisaat. Jika tugas belum dimulakan, sifat ini akan menjadi 0.
Cap masa mewakili bilangan milisaat yang berlalu sejak 1 Januari 1970 UTC, mengikut
standard RFC 3339.
Sebagai contoh, Jumaat, 1 September 2023 12:00:00 PM GMT diwakili sebagai 1693569600000. Ini terpakai
kepada semua cap masa dalam Meshy API.
Name
created_at
Type
timestamp
Description
Cap masa apabila tugas dicipta, dalam milisaat.
Name
expires_at
Type
timestamp
Description
Cap masa apabila hasil tugas tamat tempoh, dalam milisaat.
Name
finished_at
Type
timestamp
Description
Cap masa apabila tugas selesai, dalam milisaat. Jika tugas belum selesai, sifat ini akan menjadi 0.
Name
status
Type
string
Description
Status tugas. Nilai yang mungkin adalah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Satu array objek URL tekstur yang dijana daripada tugas ini. Biasanya ini hanya mengandungi satu objek URL tekstur. Setiap URL tekstur mempunyai sifat-sifat berikut:
Name
base_color
Type
string
Description
URL yang boleh dimuat turun untuk imej peta warna asas.
Name
metallic
Type
string
Description
URL yang boleh dimuat turun untuk imej peta logam.
Jika tugas dibuat dengan enable_pbr: false, sifat ini akan diabaikan.
Name
normal
Type
string
Description
URL yang boleh dimuat turun untuk imej peta normal.
Jika tugas dibuat dengan enable_pbr: false, sifat ini akan diabaikan.
Name
roughness
Type
string
Description
URL yang boleh dimuat turun untuk imej peta kekasaran.
Jika tugas dibuat dengan enable_pbr: false, sifat ini akan diabaikan.
Name
emission
Type
string
Description
URL yang boleh dimuat turun untuk imej peta pelepasan.
Jika tugas dibuat dengan enable_pbr: false, atau ai_model adalah meshy-5, meshy-7, atau latest, sifat ini akan diabaikan.
Name
preceding_tasks
Type
integer
Description
Bilangan tugas terdahulu.
Nilai medan ini hanya bermakna jika status tugas adalah PENDING.
Name
task_error
Type
object
Description
Butiran ralat untuk tugas yang gagal. Lihat Ralat untuk rujukan penuh objek task_error.
Name
consumed_credits
Type
integer
Description
Bilangan kredit yang digunakan oleh tugas ini. Hadir apabila status tugas adalah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugas FAILED (kredit dikembalikan semula apabila gagal).