Image to 3D API adalah ciri yang membolehkan anda mengintegrasikan keupayaan Imej ke 3D dari Meshy ke dalam aplikasi anda sendiri. Dalam seksyen ini, anda akan menemui semua maklumat yang anda perlukan untuk memulakan dengan API ini.
Endpoint ini membolehkan anda mencipta tugasan Imej ke 3D yang baru. Rujuk
Objek Tugasan Imej ke 3D untuk melihat harta-harta yang disertakan dengan objek tugasan Imej ke 3D.
Parameter
Hanya satu daripada input_task_id atau image_url adalah diperlukan. Jika kedua-duanya disediakan, input_task_id diberi keutamaan.
Name
input_task_id
Type
string
Diperlukan
Description
ID bagi tugasan penjanaan imej yang telah siap yang outputnya patut digunakan sebagai imej input. Tugasan ini mesti salah satu daripada tugasan 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 digunakan oleh Meshy dalam penciptaan model. Pada masa ini, kami menyokong format .jpg, .jpeg, dan .png.
Terdapat dua cara untuk memberikan imej:
URL yang boleh diakses umum: URL yang boleh diakses dari internet awam.
Data URI: Data URI berasas64 dari imej. Contoh data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
model_type
Type
string
lalai standard
Description
Nyatakan jenis penjanaan jejaring 3D.
Nilai-nilai yang tersedia:
standard: Penjanaan jejaring 3D dengan butiran tinggi biasa.
smart-topology: Pilih model Smart Topology dengan ai_model (meshy-t1 atau meshy-t2).
lowpoly (lapuk): Menjana jejaring low-poly dioptimumkan untuk poligon yang lebih bersih. 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 ingin digunakan. Nilai-nilai yang tersedia bergantung pada model_type.
meshy-t2 (default, disyorkan): model Smart Topology — topology yang lebih bersih, bahagian yang terasing secara semulajadi, output segitiga, dan kiraan wajah yang boleh anda tetapkan dengan target_polycount.
meshy-t1: model low-poly lama; tidak menyokong pengaturan kiraan wajah dengan target_polycount.
Name
ultra_mode
Type
boolean
lalai false
Description
Mengaktifkan penjanaan Ultra untuk geometri berketepatan lebih tinggi dengan butiran permukaan yang lebih halus.
Hanya disokong apabila ai_model adalah meshy-7 (atau latest).
Name
should_texture
Type
boolean
lalai true
Description
Menentukan sama ada tekstur dihasilkan. Mengaturnya ke false akan melangkaui fasa tekstur, memberikan jejaring tanpa tekstur.
Hanya berlaku apabila should_texture = true
Name
enable_pbr
Type
boolean
lalai false
Description
Menjana Peta PBR (metallic, roughness, normal) sebagai tambahan kepada warna asas. Peta emissive juga disertakan apabila ai_model adalah meshy-6, kecuali pada texture_resolution: 8k. meshy-7 dan latest tidak menghasilkan peta emissive.
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 menangkap lebih banyak butiran permukaan.
4k dan 8k tidak tersedia dengan ai_model: meshy-5. Pada 8k, tiada peta emissive dihasilkan.
Name
hd_texture
Type
boolean
⚠ lapuk
lalai false
Description
Gunakan texture_resolution sebagai gantinya — setara dengan texture_resolution: "4k". Apabila kedua-duanya ditetapkan, texture_resolution diprioritaskan.
Name
texture_prompt
Type
string
Description
Berikan prompt teks untuk membimbing proses pemetaan tekstur. Maksimum 600 aksara.
Name
texture_image_url
Type
string
Description
Berikan imej 2d untuk membimbing proses pemetaan tekstur. Pada masa ini, kami menyokong format .jpg, .jpeg, dan .png.
Terdapat dua cara untuk memberikan imej:
URL yang boleh diakses umum: URL yang boleh diakses dari internet awam
Data URI: Data URI berasas64 dari imej. Contoh data URI: data:image/jpeg;base64,<your base64-encoded image data>
Pemetaan tekstur mungkin tidak berfungsi dengan optimum jika terdapat perbezaan geometri yang besar antara aset asal dan imej yang dimuat naik. Hanya salah satu daripada texture_image_url atau texture_prompt boleh digunakan untuk membimbing proses pemetaan tekstur. Jika kedua-dua parameter disediakan, maka texture_prompt akan digunakan untuk memetakan model secara lalai. Pemetaan melalui teks atau imej akan menelan 10 kredit bagi setiap tugas.
Name
should_remesh
Type
boolean
lalai false (meshy-6, meshy-7), true (lain-lain)
Description
Mengawal sama ada untuk mengaktifkan fasa remesh. Untuk model berkualiti tertinggi, kami mengesyorkan menetapkan should_remesh ke false.
Hanya berlaku apabila should_remesh = true
Name
topology
Type
string
lalai triangle
Description
Nyatakan topology dari model yang dihasilkan.
Nilai-nilai yang tersedia:
quad: Menjana jejaring quad-dominant.
triangle: Menjana jejaring triangle yang dikecilkan.
Name
decimation_mode
Type
integer
Description
Aktifkan decimation boleh suai dengan menetapkan tahap bilangan poligon. Apabila ditetapkan, target_polycount diabaikan.
Nilai-nilai yang tersedia:
1: Boleh suai — bilangan poligon ultra.
2: Boleh suai — bilangan poligon tinggi.
3: Boleh suai — bilangan poligon sederhana.
4: Boleh suai — bilangan poligon rendah.
Name
save_pre_remeshed_model
Type
boolean
lalai false
Description
Apabila ditetapkan true, Meshy juga menyimpan fail GLB tambahan sebelum fasa remesh selesai.
Name
target_polycount
Type
integer
Description
Sasaran bilangan poligon (wajah) dalam output. Jumlah sebenar mungkin menyimpang daripada sasaran bergantung kepada geometri.
target_polycount berkuatkuasa dalam dua kes bebas:
Remesh — dengan should_remesh: true pada model standard. Jejaring di-remesh (dikurangkan) 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 dihasilkan langsung pada bilangan wajah 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 mempengaruhi output.
Medan symmetry_mode mengawal tingkah laku simetri semasa proses penjanaan model.
Nilai-nilai yang sah adalah:
off: Menonaktifkan simetri.
auto: Menentukan dan menggunakan simetri secara automatik berdasarkan geometri input.
on: Memaksa simetri semasa penjanaan.
Name
pose_mode
Type
string
lalai ""
Description
Nyatakan mod pose untuk model yang dihasilkan.
Nilai-nilai yang tersedia:
a-pose: Menjana model dalam pose A.
t-pose: Menjana model dalam pose T.
"" (rentetan kosong): Tiada pose tertentu diterapkan.
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 ke false untuk mengekalkan penampilan sebenar imej input tanpa sebarang pemprosesan gaya.
Hanya disokong apabila ai_model adalah meshy-6, meshy-7, atau latest.
Name
remove_lighting
Type
boolean
lalai true
Description
Menghilangkan sorotan dan bayang-bayang dari tekstur warna asas, menghasilkan keputusan yang lebih bersih yang berfungsi lebih baik di bawah lampu penyesuaian tersuai.
Hanya disokong apabila ai_model adalah meshy-6.
Name
moderation
Type
boolean
lalai false
Description
Apabila ditetapkan ke true, kandungan input akan disaring secara automatik untuk kandungan yang berpotensi berbahaya. Jika kandungan berbahaya dikesan, tugasan tidak akan diteruskan ke penjanaan.
Kandungan dari input image_url, texture_image_url, dan texture_prompt akan disaring.
Name
target_formats
Type
string[]
Description
Menentukan format fail 3D yang ingin disertakan dalam output. Hanya format yang diminta akan dijana dan dipulangkan, yang boleh mengurangkan masa penyelesaian tugas. Apabila diabaikan, semua format yang disokong disertakan.
Nilai-nilai yang tersedia: glb, obj, fbx, stl, usdz, 3mf
Apabila diabaikan, semua format kecuali 3mf dijana. 3mf hanya disertakan apabila dinyatakan secara eksplisit.
Name
auto_size
Type
boolean
lalai false
Description
Apabila ditetapkan kepada true, perkhidmatan menggunakan penglihatan AI untuk menganggarkan secara automatik ketinggian sebenar objek dan menukar saiz model dengan sewajarnya. Titik asal akan menjadi bottom secara lalai kecuali origin_at ditetapkan secara eksplisit.
Name
alpha_thumbnail
Type
boolean
lalai false
Description
Apabila ditetapkan kepada true, tugasan akan menghasilkan versi latar belakang telus (RGBA) dari 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, tugasan akan menghasilkan empat imej kecil paparan kardinal (depan, kanan, belakang, kiri) dan mengembalikannya di bawah thumbnail_urls pada respons GET. Medan thumbnail_url yang sedia ada tidak berubah dan terus menunjuk kepada paparan depan, jadi pelanggan sedia ada tidak terpengaruh.
Menambah kira-kira 3 saat kepada latensi tugasan.
Hanya berlaku apabila auto_size = true
Name
origin_at
Type
string
lalai bottom
Description
Kedudukan titik asal apabila auto_size diaktifkan.
Nilai-nilai yang tersedia: bottom, center.
Returns
Harta result dari respons mengandungi id tugasan Imej ke 3D yang baru dibuat.
Failure Modes
Name
400 - Bad Request
Description
Permohonan tidak boleh diterima. Punca yang biasa:
Parameter hilang: Sama ada image_url atau input_task_id mesti disediakan.
Tugasan input tidak sah: input_task_id mesti merujuk kepada tugasan Teks ke Imej atau Imej ke Imej SUCCEEDED yang menghasilkan tepat satu imej.
Format imej tidak sah: image_url yang disediakan bukan format yang disokong (.jpg, .jpeg, .png).
URL tidak boleh dicapai: image_url tidak boleh dimuat turun (404 atau timeout).
Data URI tidak sah: Rentetan berasas64 rosak.
Gabungan parameter tidak sah: enable_pbr hanya disokong apabila should_texture adalah benar.
Name
401 - Unauthorized
Description
Pengesahan gagal. Sila semak kunci API anda.
Name
402 - Payment Required
Description
Kredit tidak mencukupi untuk melaksanakan tugas ini.
Name
429 - Too Many Requests
Description
Anda telah melebihi had kadar anda.
Request
POST
/openapi/v1/image-to-3d
# Permintaan mudah dengan parameter yang diperlukancurlhttps://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>" }'# Dengan remesh, PBR, dan 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 tugasan Imej ke 3D dengan memberikan id tugasan yang sah.
Rujuk Objek Tugasan Imej ke 3D untuk melihat
harta-harta yang disertakan dengan objek tugasan Imej ke 3D.
Parameter
Name
id
Type
path
Description
Pengenal pasti unik untuk tugasan Imej ke 3D yang ingin didapati.
Returns
Respons mengandungi objek tugasan Imej ke 3D. Semak
bahagian Objek Tugasan Imej ke 3D untuk butiran.
Objek Tugasan Imej ke 3D adalah unit kerja yang diikuti oleh Meshy untuk menjana model 3D dari input imej.
Objek ini mempunyai harta-harta berikut:
Properties
Name
id
Type
string
Description
Pengenal pasti unik untuk tugasan tersebut. Walaupun kami menggunakan UUID k-sortable untuk id tugasan sebagai perincian pelaksanaan, anda tidak seharusnya membuat sebarang andaian tentang format id tersebut.
Name
type
Type
string
Description
Jenis tugasan Imej ke 3D. Nilainya adalah image-to-3d.
Name
model_urls
Type
object
Description
URL yang boleh dimuat turun kepada fail model 3D bertekstur yang dijana oleh Meshy. Harta untuk format akan diabaikan jika format tersebut tidak dijana dan bukannya memulangkan rentetan kosong.
Name
glb
Type
string
Description
URL yang boleh dimuat turun kepada fail GLB.
Name
fbx
Type
string
Description
URL yang boleh dimuat turun kepada fail FBX.
Name
obj
Type
string
Description
URL yang boleh dimuat turun kepada fail OBJ.
Name
usdz
Type
string
Description
URL yang boleh dimuat turun kepada fail USDZ.
Name
mtl
Type
string
Description
URL yang boleh dimuat turun kepada fail MTL, dipulangkan bersama eksport OBJ apabila tekstur ada.
Name
stl
Type
string
Description
URL yang boleh dimuat turun kepada fail STL.
Name
3mf
Type
string
Description
URL yang boleh dimuat turun kepada fail 3MF. Hanya ada apabila 3mf diminta melalui target_formats.
Name
pre_remeshed_glb
Type
string
Description
URL yang boleh dimuat turun kepada output GLB asal sebelum remeshing.
Tersedia hanya apabila tugasan dicipta dengan should_remesh: true dan save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
URL yang boleh dimuat turun kepada imej kecil model tersebut. Setaraf dengan thumbnail_urls.front apabila ada, disimpan untuk keserasian ke belakang.
Name
alpha_thumbnail_url
Type
string
Description
URL yang boleh dimuat turun kepada versi latar belakang telus (RGBA) thumbnail_url. Hanya ada apabila tugas tersebut dicipta 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 gambar kecil pemandangan kardinal model 3D yang dijana. Setiap nilai adalah URL ditandatangani kepada 512×512 PNG yang dirender dengan bahan dan pencahayaan yang sama seperti thumbnail_url. Berguna untuk mempratonton model dari pelbagai sudut dalam paip batch tanpa memuat turun GLB.
Hanya ada apabila tugasan dicipta dengan multi_view_thumbnails: true dan telah mencapai SUCCEEDED. Tugasan lama dan tugasan yang dicipta tanpa pilihan tidak akan menyertakan medan ini.
Name
front
Type
string
Description
Pandangan hadapan, putaran 0° 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 pemetaan tekstur.
Name
texture_image_url
Type
string
Description
URL yang boleh dimuat turun kepada imej tekstur yang digunakan untuk membimbing proses pemetaan tekstur.
Name
ultra_mode
Type
boolean
Description
Menggemakan nilai ultra_mode yang tugasan itu dicipta dengannya. Hanya hadir untuk tugasan meshy-7 (atau latest) yang menetapkan ultra_mode secara eksplisit; jika tidak, medan ini diabaikan.
Name
progress
Type
integer
Description
Kemajuan tugasan. Jika tugasan belum bermula, harta ini akan 0. Setelah tugasan berjaya, ini akan menjadi 100.
Name
started_at
Type
timestamp
Description
Cap masa ketika tugasan dimulakan, dalam milisaat. Jika tugasan belum bermula, harta ini akan menjadi 0.
Cap masa mewakili bilangan milisaat yang telah berlalu sejak 1 Januari 1970 UTC, mengikuti
standard RFC 3339.
Sebagai contoh, Jumat, 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 ketika tugasan dicipta, dalam milisaat.
Name
expires_at
Type
timestamp
Description
Cap masa ketika hasil tugasan tamat, dalam milisaat.
Name
finished_at
Type
timestamp
Description
Cap masa ketika tugasan ditamatkan, dalam milisaat. Jika tugasan belum selesai, harta ini akan menjadi 0.
Name
status
Type
string
Description
Status tugasan. Nilai-nilai yang mungkin adalah salah satu dari PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Array objek URL tekstur yang dijana dari tugasan tersebut. Biasanya ini hanya mengandungi satu objek URL tekstur. Setiap URL tekstur mempunyai harta-harta berikut:
Name
base_color
Type
string
Description
URL yang boleh dimuat turun kepada imej peta warna dasar.
Name
metallic
Type
string
Description
URL yang boleh dimuat turun kepada imej peta metallic.
Jika tugasan dibuat dengan enable_pbr: false, harta ini akan diabaikan.
Name
normal
Type
string
Description
URL yang boleh dimuat turun kepada imej peta normal.
Jika tugasan dibuat dengan enable_pbr: false, harta ini akan diabaikan.
Name
roughness
Type
string
Description
URL yang boleh dimuat turun kepada imej peta roughness.
Jika tugasan dibuat dengan enable_pbr: false, harta ini akan diabaikan.
Name
emission
Type
string
Description
URL yang boleh dimuat turun kepada imej peta emission.
Jika tugasan dibuat dengan enable_pbr: false, atau ai_model adalah meshy-5, meshy-7, atau latest, harta ini akan diabaikan.
Name
preceding_tasks
Type
integer
Description
Bilangan tugasan terdahulu.
Nilai medan ini mempunyai makna hanya jika status tugasan adalah PENDING.
Name
task_error
Type
object
Description
Butiran ralat untuk tugasan yang gagal. Lihat Errors untuk rujukan penuh objek task_error.
Name
consumed_credits
Type
integer
Description
Bilangan kredit yang digunakan oleh tugasan ini. Hadir apabila status tugasan adalah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugasan FAILED (kredit dikembalikan jika gagal).