API Teks ke 3D adalah fitur yang memungkinkan Anda mengintegrasikan kemampuan Teks ke 3D dari Meshy ke dalam aplikasi Anda sendiri. Dalam bagian ini, Anda akan menemukan semua informasi yang Anda butuhkan untuk memulai dengan API ini.
Teks ke 3D menggunakan alur kerja dua langkah. Pertama, buat tugas pratinjau (mode: "preview") untuk menghasilkan mesh 3D tanpa tekstur, sehingga Anda dapat mengevaluasi bentuknya. Kemudian, berikan ID tugas pratinjau yang telah selesai ke tugas penyempurnaan (mode: "refine") untuk menerapkan tekstur pada mesh. Kedua langkah berbagi endpoint yang sama.
Endpoint ini membuat Text to 3D preview task, yang menghasilkan mesh 3D tanpa tekstur (hanya geometri) dari sebuah prompt teks. Ini adalah langkah pertama dari alur kerja dua langkah. Setelah preview berhasil, gunakan ID task yang dikembalikan untuk membuat refine task untuk pemberian tekstur. Lihat
The Text to 3D Task Object untuk skema respons lengkap.
Parameter
Name
mode
Type
string
Wajib
Description
Bidang ini harus diatur ke "preview" saat membuat preview task.
Name
prompt
Type
string
Wajib
Description
Jelaskan objek seperti apa yang menjadi model 3D tersebut. Maksimum 800 karakter.
Name
model_type
Type
string
default standard
Description
Tentukan jenis pembuatan mesh 3D.
Nilai yang tersedia:
standard: Pembuatan mesh 3D detail tinggi reguler.
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 penggunaan smart-topology sebagai gantinya.
Ketika smart-topology dipilih, should_remesh dan decimation_mode diabaikan, dan hanya topology: triangle yang diterima.
Ketika lowpoly dipilih, ai_model, topology, target_polycount, dan should_remesh 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 wajah yang dapat Anda atur dengan target_polycount.
Name
ultra_mode
Type
boolean
default false
Description
Mengaktifkan pembuatan Ultra untuk geometri dengan fidelitas lebih tinggi dengan detail permukaan yang lebih halus. Pembuatan memakan waktu lebih lama dan menambah 5 kredit.
Hanya didukung ketika ai_model adalah meshy-7 (atau latest), dan hanya pada modepreview.
Name
should_remesh
Type
boolean
default false (meshy-6, meshy-7), true (others)
Description
Mengontrol apakah akan mengaktifkan fase remesh. Untuk model dengan kualitas tertinggi, kami merekomendasikan untuk mengatur should_remesh ke false.
Hanya berlaku ketika should_remesh = true
Name
topology
Type
string
default triangle
Description
Tentukan topology dari model yang dihasilkan.
Nilai yang tersedia:
quad: Menghasilkan mesh yang didominasi quad.
triangle: Menghasilkan mesh triangle yang telah didesimasi.
Output Smart Topology hanya berupa triangle. Meminta quad bersamaan dengan ai_model: meshy-t2 akan menghasilkan kesalahan.
Name
decimation_mode
Type
integer
Description
Aktifkan desimasi 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
target_polycount
Type
integer
Description
Jumlah target poligon (wajah) pada output. Jumlah sebenarnya dapat menyimpang dari target tergantung pada geometrinya.
target_polycount berlaku dalam dua kasus independen:
Remesh — dengan should_remesh: true pada model standard. Mesh akan di-remesh (didesimasi) menjadi kira-kira jumlah ini. Rentang 100 hingga 300.000, default 30.000. Jika decimation_mode diatur, itu memiliki prioritas dan target_polycount diabaikan.
Smart Topology — dengan model_type: smart-topology dan ai_model: meshy-t2. Model dihasilkan langsung pada jumlah wajah ini; tidak ada 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.
Bidang 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: Memberlakukan 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
art_style
Type
string
⚠ usang
default realistic
Description
Tidak didukung oleh Meshy-6. Permintaan yang menggunakan Meshy-6 akan mengabaikan art_style, dan beberapa kombinasi dapat menyebabkan kesalahan. Nilai yang tersedia: realistic, sculpture.
enable_pbr harus diatur ke false saat menggunakan gaya Sculpture, karena gaya Sculpture menghasilkan set peta PBR-nya sendiri.
Name
moderation
Type
boolean
default false
Description
Ketika diatur ke true, konten input akan secara otomatis diperiksa untuk potensi konten berbahaya. Jika konten berbahaya terdeteksi, task tidak akan dilanjutkan ke pembuatan.
Teks dari 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 dihasilkan. 3mf hanya disertakan ketika ditentukan secara eksplisit.
Name
alpha_thumbnail
Type
boolean
default false
Description
Ketika diatur ke true, task juga me-render versi latar belakang transparan (RGBA) dari preview dan mengembalikannya sebagai alpha_thumbnail_url pada respons GET. Bidang thumbnail_url yang sudah ada tetap tidak berubah.
Name
auto_size
Type
boolean
default false
Description
Ketika 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 default ke bottom kecuali origin_at diatur secara eksplisit.
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.
Hasil
Properti result pada respons berisi id task dari Text to 3D task yang baru dibuat.
Mode Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak dapat diterima. Penyebab umum:
Parameter hilang: Parameter yang diperlukan (misalnya, prompt, mode) hilang.
Parameter tidak valid: art_style bukan salah satu nilai yang diizinkan.
Prompt terlalu panjang: prompt melebihi batas karakter.
Name
401 - Unauthorized
Description
Autentikasi gagal. Silakan periksa kunci API Anda.
Name
402 - Payment Required
Description
Kredit tidak mencukupi untuk melakukan task ini.
Name
429 - Too Many Requests
Description
Anda telah melebihi batas laju Anda.
Request
POST
/openapi/v2/text-to-3d
# Simple preview with required params onlycurlhttps://api.meshy.ai/openapi/v2/text-to-3d \-H'Authorization: Bearer ${YOUR_API_KEY}' \-H'Content-Type: application/json' \-d'{ "mode": "preview", "prompt": "a monster mask"}'# Preview with remesh and A-posecurlhttps://api.meshy.ai/openapi/v2/text-to-3d \-H'Authorization: Bearer ${YOUR_API_KEY}' \-H'Content-Type: application/json' \-d'{ "mode": "preview", "prompt": "a futuristic robot warrior", "should_remesh": true, "target_polycount": 100000, "pose_mode": "a-pose", "target_formats": ["glb"]}'
Endpoint ini membuat Text to 3D refine task, yang menerapkan tekstur pada mesh preview yang telah selesai. Anda harus menyediakan preview_task_id dari preview task yang berhasil. Ini adalah langkah kedua dari workflow dua langkah.
Parameter
Name
mode
Type
string
Wajib
Description
Field ini harus diatur ke "refine" saat membuat refine task.
Name
preview_task_id
Type
string
Wajib
Description
ID preview task yang sesuai.
Status dari preview task yang diberikan harus SUCCEEDED.
Name
enable_pbr
Type
boolean
default false
Description
Menghasilkan peta PBR (metallic, roughness, normal) selain base color. Emission map juga disertakan ketika ai_model adalah meshy-6, kecuali pada texture_resolution: 8k (tidak ada emission map yang dihasilkan). meshy-7 (dan latest) tidak menghasilkan emission map.
Name
texture_resolution
Type
string
default 2k
Description
Resolusi tekstur base color. Salah satu dari 2k (2048×2048), 4k (4096×4096), atau 8k (8192×8192). Resolusi yang lebih tinggi menangkap lebih banyak detail permukaan. Hanya berlaku untuk mode refine.
4k dan 8k memerlukan ai_modelmeshy-6, meshy-7, atau latest. Pada 8k, tidak ada emission map 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 akan diprioritaskan.
Name
texture_prompt
Type
string
Description
Berikan prompt teks tambahan untuk memandu proses texturing. Maksimum 800 karakter.
Name
texture_image_url
Type
string
Description
Berikan gambar 2d untuk memandu proses texturing. Kami saat ini 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 dienkode base64. Contoh data URI: data:image/jpeg;base64,<data gambar terenkode base64 Anda>
Texturing gambar mungkin tidak berfungsi secara optimal jika terdapat perbedaan geometri yang signifikan antara aset asli dan gambar yang diunggah. Hanya satu dari texture_image_url atau texture_prompt yang dapat digunakan untuk memandu proses texturing. Jika kedua parameter diberikan, maka texture_prompt akan digunakan secara default untuk melakukan texturing pada model tersebut.
Name
ai_model
Type
string
default latest
Description
ID model yang digunakan untuk refining. Nilai yang tersedia: meshy-5, meshy-6, meshy-7, latest (Meshy 7).
latest diselesaikan di sini persis seperti pada preview task (saat ini Meshy 7), sehingga preview latest dan refine latest-nya selalu berada pada model tekstur yang sama.
Name
moderation
Type
boolean
default false
Description
Ketika diatur ke true, konten input akan secara otomatis diperiksa untuk konten yang berpotensi berbahaya. Jika konten berbahaya terdeteksi, task tidak akan dilanjutkan ke tahap generation.
Baik teks dari texture_prompt maupun gambar dari texture_image_url akan diperiksa.
Name
remove_lighting
Type
boolean
default true
Description
Menghapus highlight dan bayangan dari tekstur base color, menghasilkan hasil yang lebih bersih yang berfungsi lebih baik di bawah setup pencahayaan khusus.
Hanya berlaku ketika ai_model adalah meshy-6. Pada meshy-7 (dan latest) parameter ini diterima tetapi diabaikan.
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 ketika secara eksplisit ditentukan.
Name
alpha_thumbnail
Type
boolean
default false
Description
Ketika diatur ke true, task akan tambahan me-render versi latar belakang transparan (RGBA) dari preview dan mengembalikannya sebagai alpha_thumbnail_url pada respons GET. Field thumbnail_url yang sudah ada tidak berubah.
Name
auto_size
Type
boolean
default false
Description
Ketika 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 default ke bottom kecuali origin_at diatur secara eksplisit.
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.
Returns
Properti result dari respons berisi id task dari Text to 3D task yang baru dibuat.
Mode Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak dapat diterima. Penyebab umum:
ID task tidak valid: preview_task_id tidak valid atau tidak ada.
Task belum siap: Preview task belum berhasil.
Ketidakcocokan model: Model AI dari preview task tidak kompatibel dengan model refine yang diminta.
Name
401 - Unauthorized
Description
Autentikasi gagal. Silakan periksa kunci API Anda.
Name
402 - Payment Required
Description
Kredit tidak cukup untuk melakukan task ini.
Name
404 - Not Found
Description
Preview task yang ditentukan oleh preview_task_id tidak ditemukan.
Endpoint ini memungkinkan Anda untuk mengambil tugas Teks ke 3D dengan memberikan id tugas yang valid.
Lihat Objek Tugas Teks ke 3D untuk melihat properti apa saja yang termasuk dalam objek tugas Teks ke 3D.
Endpoint ini berfungsi untuk tugas pratinjau dan penyempurnaan.
Parameter
Name
id
Type
path
Description
Pengidentifikasi unik untuk tugas Teks ke 3D yang akan diambil.
Mengembalikan
Respon berisi objek tugas Teks ke 3D. Periksa
bagian Objek Tugas Teks ke 3D untuk detailnya.
Objek Tugas Teks ke 3D adalah unit kerja yang dilacak oleh Meshy untuk menghasilkan model 3D dari input teks. Ada dua tahap dalam API Teks ke 3D, preview dan refine. Tahap preview digunakan untuk menghasilkan model 3D hanya mesh, dan tahap refine digunakan untuk menghasilkan model 3D bertekstur berdasarkan hasil tahap preview.
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 tentang format id.
Name
type
Type
string
Description
Jenis tugas Teks ke 3D. Nilai yang mungkin adalah text-to-3d-preview untuk tugas tahap preview dan text-to-3d-refine untuk tugas tahap refine.
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 daripada 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
usdz
Type
string
Description
URL yang dapat diunduh ke file USDZ.
Name
obj
Type
string
Description
URL yang dapat diunduh ke file OBJ.
Name
mtl
Type
string
Description
URL yang dapat diunduh ke file MTL.
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
prompt
Type
string
Description
Ini adalah prompt yang tidak dimodifikasi yang digunakan untuk membuat tugas.
Name
negative_prompt
Type
string
⚠ usang
Description
Dipertahankan untuk kompatibilitas ke belakang. Bidang ini tidak memiliki dampak fungsional pada model yang dihasilkan.
Name
art_style
Type
string
⚠ usang
Description
art_style yang tidak dimodifikasi yang digunakan untuk membuat tugas preview. Tidak didukung oleh Meshy-6.
Name
texture_richness
Type
string
⚠ usang
Description
Dipertahankan untuk kompatibilitas ke belakang. Bidang ini tidak memiliki dampak fungsional pada model yang dihasilkan.
Name
texture_prompt
Type
string
Description
Prompt teks tambahan yang disediakan untuk memandu proses tekstur selama tahap refine.
Name
ultra_mode
Type
boolean
Description
Menggemakan nilai ultra_mode yang dibuat dengan tugas preview. Hanya ada untuk tugas preview meshy-7 (atau latest) yang secara eksplisit menetapkan ultra_mode; dihilangkan jika tidak.
Name
texture_image_url
Type
string
Description
URL yang dapat diunduh ke gambar tekstur yang digunakan untuk memandu proses tekstur.
Name
thumbnail_url
Type
string
Description
URL yang dapat diunduh ke gambar thumbnail dari file model.
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
video_url
Type
string
⚠ usang
Description
URL yang dapat diunduh ke video pratinjau. Akan dihapus dalam rilis mendatang.
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.
Sebuah 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 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
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
Sebuah 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, properti ini akan dihilangkan.
Name
preceding_tasks
Type
integer
Description
Jumlah tugas sebelumnya.
Nilai dari bidang ini berarti 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).
Contoh Objek Tugas Teks ke 3D
{"id":"018a210d-8ba4-705c-b111-1f1776f7f578","type":"text-to-3d-preview","model_urls": {"glb":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***","fbx":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***","usdz":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***","obj":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***","mtl":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***","stl":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***" },"prompt":"a monster mask","texture_prompt":"green slimy skin with scales and warts","texture_image_url":"","thumbnail_url":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***","progress":100,"started_at":1692771667037,"created_at":1692771650657,"finished_at":1692771669037,"status":"SUCCEEDED","texture_urls": [ {"base_color":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***","metallic":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX","normal":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX","roughness":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX","emission":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX" } ],"preceding_tasks":0,"task_error": {"message":"" },"consumed_credits":20}