API Teks ke 3D
Jana model 3D daripada gesaan teks dalam aplikasi anda sendiri.
Teks ke 3D berfungsi dalam dua langkah. Pertama, cipta tugasan preview (mode: "preview") untuk menjana jejaring 3D tanpa tekstur, supaya anda boleh menyemak bentuknya. Kemudian, hantar ID tugasan preview yang berjaya ke tugasan refine (mode: "refine") untuk mentekstur jejaring tersebut. Kedua-dua langkah menggunakan endpoint yang sama.
Cipta tugas pratonton Teks ke 3D
Mencipta tugas pratonton Teks ke 3D, yang menjana jejaring 3D tanpa tekstur (geometri sahaja) daripada prompt teks. Ini ialah langkah pertama dalam aliran kerja dua langkah. Selepas pratonton berjaya, hantar ID tugasnya dalam tugas refine untuk mentekstur jejaring itu. Lihat Cipta tugas refine Teks ke 3D. Untuk skema respons penuh, lihat Objek tugas Teks ke 3D.
Tugas ini berjalan di latar belakang. Untuk tempoh biasa sesuatu tugas mengambil masa, lihat Masa pemprosesan.
Request
# Simple preview with required params only
curl https://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 Ultra 4K geometry, remesh, and A-pose
curl https://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",
"ai_model": "meshy-7.1",
"geometry_resolution": "4k",
"should_remesh": true,
"target_polycount": 100000,
"pose_mode": "a-pose",
"target_formats": ["glb"]
}'
Response
{
"result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
Parameter
- Name
- mode
- Type
- string
- Diperlukan
- Description
Langkah dalam aliran kerja dua langkah. Hantar
previewuntuk mencipta tugas pratonton.
- Name
- prompt
- Type
- string
- Diperlukan
- Description
Teks yang menerangkan objek yang hendak dijana, sehingga 800 aksara. Teks yang lebih panjang akan mengembalikan
400.
- Name
- model_type
- Type
- string
- lalai standard
- Description
Jenis jejaring 3D yang hendak dijana.
Nilai yang tersedia:
standard: jejaring 3D berperincian tinggismart-topology: jejaring Smart Topology. Pilih model denganai_model(meshy-t2ataumeshy-t2.5).
Dengan
smart-topology, Meshy mengabaikanshould_remeshdandecimation_mode, dan hanya menerimatopology: triangle.
- Name
- ai_model
- Type
- string
- lalai latest
- Description
Model AI yang menjana model 3D tersebut. Nilai yang tersedia bergantung pada
model_type.Model standard (
model_type: standard):meshy-6-litemeshy-6meshy-7.1latest: Meshy 7.1meshy-7(lapuk): hantarmeshy-7.1sebagai gantinya
Model Smart Topology (
model_type: smart-topology):meshy-t2: topology yang lebih bersih, bahagian yang terpisah secara semula jadi, output segi tiga, dan bilangan muka yang anda tetapkan dengantarget_polycountmeshy-t2.5(lalai): perincian yang lebih tajam untuk aset permainan, output segi tiga, dan bilangan muka yang anda tetapkan dengantarget_polycount
- Name
- geometry_resolution
- Type
- string
- lalai standard
- Description
Laluan penjanaan geometri. Hanya terpakai untuk tugas pratonton. Refine dengan parameter ini mengembalikan
400.Nilai yang tersedia:
standard2k: menjalankan laluan Ultra pada 2048³4k: menjalankan laluan Ultra pada 4096³, untuk perincian permukaan yang lebih halus
2kmemerlukanmeshy-7.1,latest, ataumeshy-7yang lapuk.4kmemerlukanmeshy-7.1ataulatest. Model lain mengembalikan400.
- Name
- ultra_mode
- Type
- boolean
- ⚠ lapuk
- lalai false
- Description
Hantar
geometry_resolutionsebagai gantinya.ultra_mode: trueadalah sama dengangeometry_resolution: "2k".
- Name
- should_remesh
- Type
- boolean
- lalai true (meshy-6-lite), false (other models)
- Description
Sama ada untuk remesh model selepas penjanaan. Untuk model 3D berkualiti tertinggi, hantar
false.
should_remesh = true- Name
- topology
- Type
- string
- lalai triangle
- Description
Jenis muka bagi model yang di-remesh.
Nilai yang tersedia:
quad: jejaring didominasi segi empat (quad)triangle: jejaring segi tiga yang telah didesimasi
Output Smart Topology adalah segi tiga sahaja. Menghantar
quaddenganai_modelmeshy-t2ataumeshy-t2.5akan mengembalikan400.
- Name
- decimation_mode
- Type
- integer
- Description
Bilangan muka adaptif, mengikut tahap. Apabila anda menetapkannya, Meshy mengabaikan
target_polycount.Nilai yang tersedia:
1: ultra2: tinggi3: sederhana4: rendah
- Name
- target_polycount
- Type
- integer
- Description
Bilangan muka yang disasarkan. Hasilnya boleh berbeza daripada sasaran, bergantung pada geometri. Ia terpakai dalam dua kes berasingan:
- Remesh: dengan
should_remesh: truepada modelstandard. Meshy me-remesh (mendesimasi) jejaring itu kepada kira-kira bilangan ini. Jika anda menetapkandecimation_mode, Meshy menggunakannya dan mengabaikantarget_polycount. - Smart Topology: dengan
model_type: smart-topologydanai_modelmeshy-t2ataumeshy-t2.5. Meshy menjana model pada bilangan muka ini secara terus. Tiada remesh dijalankan, dan anda tidak perlushould_remesh.
Jadual berikut menunjukkan julat dan nilai lalai untuk setiap kes:
Kes Julat Lalai Remesh 100hingga30000030000meshy-t2100hingga150004000meshy-t2.5100hingga3000015000Nilai di luar julat mengembalikan
400.- Remesh: dengan
- Name
- symmetry_mode
- Type
- string
- ⚠ lapuk
- lalai auto
- Description
Biarkan ia dikeluarkan. Parameter ini tidak menjejaskan output.
Nilai yang tersedia:
off: melumpuhkan simetriauto: menggunakan simetri berdasarkan geometri inputon: menguatkuasakan simetri semasa penjanaan
- Name
- pose_mode
- Type
- string
- lalai ""
- Description
Pose model yang dijana.
Nilai yang tersedia:
a-pose: pose At-pose: pose T""(rentetan kosong): tiada pose tertentu
- Name
- is_a_t_pose
- Type
- boolean
- ⚠ lapuk
- lalai false
- Description
Hantar
pose_modesebagai gantinya. Sama ada untuk menjana model dalam pose A atau pose T.
- Name
- art_style
- Type
- string
- ⚠ lapuk
- lalai realistic
- Description
Biarkan ia dikeluarkan. Meshy mengabaikannya.
- Name
- moderation
- Type
- boolean
- lalai false
- Description
Sama ada untuk menyaring
promptbagi kandungan berbahaya sebelum menjana. Jika Meshy mengesan kandungan berbahaya, permintaan mengembalikan400dan Meshy tidak mencipta tugas.
- Name
- target_formats
- Type
- string[]
- Description
Format fail yang hendak dijana. Meshy hanya menjana dan mengembalikan format ini, yang boleh memendekkan tugas tersebut. Jika anda membiarkannya dikeluarkan, Meshy menjana setiap format kecuali
3mf, yang hanya dijana apabila anda memintanya.Nilai yang tersedia:
glbobjfbxstlusdz3mf
- Name
- alpha_thumbnail
- Type
- boolean
- lalai false
- Description
Sama ada untuk turut merender pratonton dengan latar belakang lutsinar (RGBA), dikembalikan dalam
alpha_thumbnail_urlapabila anda mendapatkan tugas tersebut.thumbnail_urltidak berubah.
- Name
- auto_size
- Type
- boolean
- lalai false
- Description
Sama ada untuk menganggarkan ketinggian sebenar objek dengan penglihatan AI dan mengubah saiz model mengikutnya. Meshy meletakkan titik asal di bahagian bawah melainkan anda menetapkan
origin_at.
auto_size = true- Name
- origin_at
- Type
- string
- lalai bottom
- Description
Di mana hendak meletakkan titik asal model,
bottomataucenter.
Nilai yang dikembalikan
Medan result dalam respons menyimpan ID bagi tugas Teks ke 3D yang baharu.
Mod kegagalan
- Name
400 - Bad Request- Description
Permintaan tidak dapat dijalankan. Mesej ralat menyatakan masalah yang ditemui. Contohnya:
- Parameter hilang: Parameter yang diperlukan, seperti
promptataumode, tiada. - Prompt terlalu panjang:
promptmelebihi had aksara. - Model tidak disokong untuk Ultra:
geometry_resolutionialah2katau4k, denganai_modelyang tidak dapat menjalankannya.
Betulkan permintaan tersebut, kemudian hantar semula. Lihat Ralat.
- Parameter hilang: Parameter yang diperlukan, seperti
- Name
401 - Unauthorized- Description
Kunci API tiada atau tidak sah. Semak header
Authorization.
- Name
402 - Payment Required- Description
Contohnya:
- Kredit tidak mencukupi: Akaun tidak mempunyai kredit yang cukup untuk tugas ini, atau akaun telah mencapai had kredit. Semak baki kredit anda, kemudian cuba semula.
- Pelan percuma: Mencipta tugas memerlukan pelan berbayar. Naik taraf pelan anda dalam tetapan langganan anda, kemudian cuba semula.
- Name
403 - Forbidden- Description
Moderation kandungan menyekat prompt atau imej input. Ubah input tersebut, kemudian cuba semula.
- Name
429 - Too Many Requests- Description
Anda telah melebihi had kadar anda. Tunggu, kemudian cuba semula. Lihat Had kadar.
Cipta tugas refine Teks ke 3D
Mencipta tugas refine Teks ke 3D, yang mentekstur jejaring daripada tugas preview yang telah selesai. Hantar ID tugas preview yang berjaya sebagai preview_task_id. Lihat Cipta tugas preview Teks ke 3D. Ini adalah langkah kedua dalam aliran kerja dua langkah.
Tugas berjalan di latar belakang. Untuk tempoh biasa yang diambil oleh sesuatu tugas, lihat Masa pemprosesan.
Request
# Basic refine task
curl https://api.meshy.ai/openapi/v2/text-to-3d \
-H 'Authorization: Bearer ${YOUR_API_KEY}' \
-H 'Content-Type: application/json' \
-d '{
"mode": "refine",
"preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"enable_pbr": true
}'
# Refine with auto-size and GLB format
curl https://api.meshy.ai/openapi/v2/text-to-3d \
-H 'Authorization: Bearer ${YOUR_API_KEY}' \
-H 'Content-Type: application/json' \
-d '{
"mode": "refine",
"preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"target_formats": ["glb"],
"auto_size": true
}'
# Refine with Meshy N1 from the preview's stored reference image
curl https://api.meshy.ai/openapi/v2/text-to-3d \
-H 'Authorization: Bearer ${YOUR_API_KEY}' \
-H 'Content-Type: application/json' \
-d '{
"mode": "refine",
"preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"ai_model": "meshy-n1"
}'
Response
{
"result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
Parameter
- Name
- mode
- Type
- string
- Diperlukan
- Description
Langkah dalam aliran kerja dua langkah. Hantar
refineuntuk mencipta tugas refine.
- Name
- preview_task_id
- Type
- string
- Diperlukan
- Description
ID tugas preview yang hendak ditekstur. Tugas preview tersebut mesti mempunyai status
SUCCEEDED.
- Name
- enable_pbr
- Type
- boolean
- lalai false
- Description
Sama ada untuk turut menjana peta PBR (metallic, roughness, dan normal) bersama warna asas.
Dengan
ai_modelmeshy-6, Meshy turut menjana peta emission, kecuali padatexture_resolution: 8k.meshy-6-lite,meshy-7,meshy-7.1, danlatesttidak menjana peta emission. Begitu juga refine bagi previewmeshy-t2ataumeshy-t2.5yang tidak menetapkanai_model. Denganai_model: meshy-n1,truememulangkan400.
- Name
- texture_resolution
- Type
- string
- lalai 2k
- Description
Resolusi tekstur warna asas. Hanya terpakai untuk tugas refine. Preview dengan parameter ini memulangkan
400.Nilai yang tersedia:
2k: 2048×20484k: 4096×40968k: 8192×8192
Resolusi yang lebih tinggi merakam lebih banyak perincian permukaan.
4kdan8kmemerlukanai_modelmeshy-6,meshy-7.1, ataulatest. Denganmeshy-n1, ia memulangkan400. Pada8k, Meshy tidak menjana peta emission.
- Name
- hd_texture
- Type
- boolean
- ⚠ lapuk
- lalai false
- Description
Hantar
texture_resolutionsebagai gantinya.hd_texture: trueadalah sama sepertitexture_resolution: "4k". Jika anda menghantar kedua-duanya, Meshy akan menggunakantexture_resolution.
- Name
- texture_prompt
- Type
- string
- Description
Teks yang membimbing proses pentekstur, sehingga 800 aksara. Teks yang lebih panjang memulangkan
400. Hantartexture_promptatautexture_image_url, bukan kedua-duanya. Jika anda menghantar kedua-duanya, Meshy akan menggunakantexture_prompt. Denganai_model: meshy-n1, menghantarnya memulangkan400.
- Name
- texture_image_url
- Type
- string
- Description
Imej 2D yang membimbing proses pentekstur, sebagai URL awam atau Data URI berkod base64, seperti
data:image/jpeg;base64,<your base64-encoded image data>.Imej mesti merupakan fail
.jpg,.jpeg,.png, atau.webpdengan saiz maksimum 20 MB, sekurang-kurangnya 32 piksel pada setiap sisi, dan paling banyak 178,956,970 piksel (lebar × tinggi).Dengan
ai_model: meshy-n1, Meshy mentekstur daripada imej ini sebagai pandangan hadapan.Pentekstur daripada imej mungkin tidak berfungsi dengan baik apabila bentuk dalam imej berbeza dengan ketara daripada model tersebut.
- Name
- ai_model
- Type
- string
- lalai inherited from the preview task
- Description
Model AI yang mentekstur jejaring tersebut.
Nilai yang tersedia:
meshy-6-litemeshy-6meshy-7.1latest: Meshy 7.1meshy-n1: tekstur warna asas 2K hanya daripada imej rujukan. Tiada prompt teks, tiada peta PBR, tiada 4K atau 8K.meshy-7(lapuk): hantarmeshy-7.1sebagai gantinya
Biarkan kosong untuk menggunakan model tugas preview, supaya preview dan refine-nya berjalan pada model yang sama dari hujung ke hujung. Hantar nilai untuk mengatasinya.
latestyang dinyatakan secara eksplisit diselesaikan dengan cara yang sama seperti pada tugas preview, jadi previewlatestdan refinelatest-nya sentiasa menggunakan model tekstur yang sama.Dengan
meshy-n1, Meshy mentekstur daripadatexture_image_url. Tanpanya, Meshy menggunakan imej rujukan yang disimpan oleh previewmeshy-7.1ataulatest. Preview lain memulangkan400melainkan anda menghantartexture_image_url. Preview boleh mempunyai paling banyak 7,999,999 segi tiga. Preview yang telah diremesh kepada quad memulangkan400.
- Name
- moderation
- Type
- boolean
- lalai false
- Description
Sama ada untuk menyaring
texture_promptdantexture_image_urlbagi kandungan berbahaya sebelum penjanaan. Jika Meshy mengesan kandungan berbahaya, permintaan memulangkan400dan Meshy tidak mencipta tugas.
- Name
- remove_lighting
- Type
- boolean
- lalai true
- Description
Sama ada untuk mengalih keluar sorotan dan bayang-bayang daripada tekstur warna asas. Hasil yang lebih bersih berfungsi lebih baik di bawah pencahayaan tersuai.
Hanya berkesan apabila
ai_modelialahmeshy-6.meshy-7.1danlatestmenerimanya tetapi mengabaikannya, begitu juga refine bagi previewmeshy-t2ataumeshy-t2.5yang tidak menetapkanai_model. Menghantarnya denganmeshy-6-litememulangkan400. Denganmeshy-n1,truememulangkan400.
- Name
- target_formats
- Type
- string[]
- Description
Format fail yang hendak dijana. Meshy hanya menjana dan memulangkan format ini, yang boleh memendekkan tugas. Jika anda membiarkannya kosong, Meshy menjana setiap format kecuali
3mf, yang hanya dijana apabila anda memintanya.Nilai yang tersedia:
glbobjfbxstlusdz3mf
- Name
- alpha_thumbnail
- Type
- boolean
- lalai false
- Description
Sama ada untuk turut merender preview dengan latar belakang lutsinar (RGBA), dipulangkan dalam
alpha_thumbnail_urlapabila anda mendapatkan tugas tersebut.thumbnail_urltidak berubah.
- Name
- auto_size
- Type
- boolean
- lalai false
- Description
Sama ada untuk menganggarkan ketinggian dunia-sebenar objek menggunakan penglihatan AI dan mengubah saiz model mengikutnya. Meshy meletakkan titik asal di bahagian bawah melainkan anda menetapkan
origin_at.
auto_size = true- Name
- origin_at
- Type
- string
- lalai bottom
- Description
Lokasi untuk meletakkan titik asal model,
bottomataucenter.
Nilai pulangan
Medan result dalam respons memegang ID tugas Teks ke 3D yang baharu.
Mod kegagalan
- Name
400 - Bad Request- Description
Permintaan tidak dapat dijalankan. Mesej ralat menyatakan masalah yang ditemui. Contohnya:
- ID tugas tidak sah:
preview_task_idtidak sah, atau tidak sepadan dengan mana-mana tugas preview anda. - Tugas belum sedia: Tugas preview belum berjaya lagi.
- Model tidak sepadan: Model AI tugas preview tidak berfungsi dengan model refine yang diminta.
- Model tidak disokong untuk remove_lighting:
remove_lightingdihantar bersamaai_model: "meshy-6-lite". - Tiada imej rujukan untuk Meshy N1:
ai_model: meshy-n1dihantar tanpatexture_image_url, dan preview tidak mempunyai imej rujukan yang boleh digunakan oleh Meshy N1. Hantartexture_image_url. - Preview quad untuk Meshy N1:
ai_model: meshy-n1dihantar untuk preview yang diremesh kepada quad. Refine denganai_modelyang lain. - Terlalu banyak segi tiga untuk Meshy N1: Dengan
ai_model: meshy-n1, preview mempunyai lebih daripada 7,999,999 segi tiga. Refine denganai_modelyang lain. - Pilihan tidak disokong untuk Meshy N1:
ai_model: meshy-n1dihantar bersama salah satu pilihan berikut:texture_promptenable_pbr: truetexture_resolutionbernilai4katau8khd_texture: truetanpatexture_resolutionremove_lighting: true
Betulkan permintaan, kemudian hantar semula. Lihat Ralat.
- ID tugas tidak sah:
- Name
401 - Unauthorized- Description
Kunci API tiada atau tidak sah. Semak header
Authorization.
- Name
402 - Payment Required- Description
Contohnya:
- Kredit tidak mencukupi: Akaun tidak mempunyai kredit yang mencukupi untuk tugas ini, atau akaun telah mencapai had kredit. Semak baki kredit anda, kemudian cuba lagi.
- Pelan percuma: Mencipta tugas memerlukan pelan berbayar. Naik taraf pelan anda dalam tetapan langganan anda, kemudian cuba lagi.
- Name
403 - Forbidden- Description
Moderation kandungan menyekat prompt atau imej input. Tukar input, kemudian cuba lagi.
- Name
429 - Too Many Requests- Description
Anda telah melebihi had kadar anda. Tunggu, kemudian cuba lagi. Lihat Had kadar.
Dapatkan tugas Text to 3D
Mengembalikan tugas Teks ke 3D berdasarkan ID-nya. Ia berfungsi untuk kedua-dua tugas preview dan refine.
Request
curl https://api.meshy.ai/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
{
"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=***",
"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=***",
"usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
"stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
"prompt": "a monster mask",
"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=***"
}
],
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 20
}
Parameter
- Name
- id
- Type
- path
- Description
ID tugas daripada respons create.
Hasil Pulangan
Contoh
Jadual berikut menunjukkan contoh model bagi setiap mode.
| Mode | Contoh model |
|---|---|
| Preview | ![]() |
| Refine | ![]() |
Delete a Text to 3D task
Memadamkan tugas Teks ke 3D secara kekal, termasuk model dan datanya. Anda tidak boleh membuat asal pemadaman.
Request
curl --request DELETE \
--url https://api.meshy.ai/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS. The task keeps running:
{
"message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}
Parameter laluan
- Name
- id
- Type
- path
- Description
ID tugas yang hendak dipadamkan.
Status tugas
Memadamkan tugas PENDING akan memulangkan kredit yang digunakan semasa anda mencipta tugas tersebut.
Tugas IN_PROGRESS tidak boleh dipadamkan. Permintaan akan memulangkan 409 Conflict,
dan tugas tersebut terus berjalan. Meshy tidak memulangkan kredit untuk tugas yang telah bermula,
jadi memadamkannya akan membuat anda rugi kredit dan juga hasil tugas tersebut. Tunggu sehingga ia
mencapai status SUCCEEDED, FAILED, atau CANCELED, barulah padamkannya.
Memadamkan tugas yang berada dalam status akhir (SUCCEEDED, FAILED, atau CANCELED)
tidak akan memulangkan kreditnya.
Pulangan
200 OK apabila tugas berjaya dipadamkan, atau 409 Conflict apabila tugas
berstatus IN_PROGRESS.
Senaraikan tugasan Teks ke 3D
Mengembalikan senarai tugasan Teks ke 3D anda.
Request
curl https://api.meshy.ai/openapi/v2/text-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
[
{
"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=***",
"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=***",
"usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
"prompt": "a monster mask",
"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=***"
}
],
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 20
}
]
Parameter
- Name
- page_num
- Type
- integer
- lalai 1
- Description
Nombor halaman untuk dikembalikan, sehingga
255. Nilai yang lebih besar akan mengembalikan400.
- Name
- page_size
- Type
- integer
- lalai 10
- Description
Bilangan tugasan setiap halaman, sehingga
100.
- Name
- sort_by
- Type
- string
- Description
Susunan isihan.
Nilai yang tersedia:
+created_at: paling lama dahulu-created_at: paling baru dahulu
Nilai Kembali
Senarai bernombor halaman bagi objek tugasan Teks ke 3D.
Strim tugasan Teks ke 3D
Menstrim kemas kini tugasan Teks ke 3D sebagai Server-Sent Events (SSE).
Request
curl -N https://api.meshy.ai/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response Stream
// Error event example
event: error
data: {
"status_code": 404,
"message": "Task not found"
}
// Message event examples illustrate task progress.
// These examples are shortened. Each event holds the full task object.
event: message
data: {
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"progress": 0,
"status": "PENDING"
}
event: message
data: {
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"progress": 50,
"status": "IN_PROGRESS"
}
event: message
data: {
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "text-to-3d-preview",
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1692771650657,
"started_at": 1692771667037,
"finished_at": 1692771669037,
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
},
"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": null,
"consumed_credits": 20
}
Parameter
- Name
- id
- Type
- path
- Description
ID tugasan daripada respons cipta (create).
Pulangan
Strim objek tugasan Teks ke 3D sebagai Server-Sent Events.
Setiap acara (event) memegang objek tugasan yang lengkap, dalam bentuk yang sama seperti yang dikembalikan oleh endpoint Get. Semasa tugasan berstatus PENDING atau IN_PROGRESS, medan hasilnya masih belum mempunyai nilai.
Objek tugas Text to 3D
Objek tugas Text to 3D menerangkan satu tugas yang menjana model 3D daripada prompt teks. Ia menyimpan status, progress, dan fail model apabila tugas berjaya. Teks ke 3D mempunyai dua peringkat, preview dan refine. Tugas preview menjana model 3D yang hanya mengandungi jejaring, dan tugas refine menjana model 3D bertekstur daripada hasil preview.
Ciri-ciri
Example Text to 3D Task Object
{
"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": null,
"consumed_credits": 20
}
- Name
- id
- Type
- string
- Description
ID tugas. Anggap ia sebagai rentetan legap (opaque), dan jangan bergantung pada formatnya.
- Name
- type
- Type
- string
- Description
Jenis tugas,
text-to-3d-previewuntuk tugas preview atautext-to-3d-refineuntuk tugas refine.
- Name
- model_urls
- Type
- object
- Description
URL muat turun untuk model 3D yang dijana, satu bagi setiap format fail. Format yang tidak dijana oleh tugas tidak mempunyai kunci, berbanding rentetan kosong.
- Name
glb- Type
- string
- Description
Fail GLB.
- Name
fbx- Type
- string
- Description
Fail FBX.
- Name
usdz- Type
- string
- Description
Fail USDZ.
- Name
obj- Type
- string
- Description
Fail OBJ.
- Name
mtl- Type
- string
- Description
Fail MTL.
- Name
stl- Type
- string
- Description
Fail STL.
- Name
3mf- Type
- string
- Description
Fail 3MF. Hadir hanya apabila
target_formatsmengandungi3mf.
- Name
- prompt
- Type
- string
- Description
promptyang anda hantar untuk mencipta tugas, tidak diubah.
- Name
- texture_prompt
- Type
- string
- Description
Prompt teks yang anda hantar untuk membimbing pemberian tekstur dalam peringkat refine.
- Name
- ultra_mode
- Type
- boolean
- ⚠ lapuk
- Description
Rujuk
geometry_resolutionsebagai gantinya.
- Name
- geometry_resolution
- Type
- string
- Description
Tahap Ultra yang digunakan oleh tugas preview,
2katau4k. Medan ini tiada untukstandard.
- Name
- texture_image_url
- Type
- string
- Description
URL muat turun untuk imej yang anda hantar untuk membimbing pemberian tekstur.
- Name
- thumbnail_url
- Type
- string
- Description
URL muat turun untuk imej kecil model 3D.
- Name
- alpha_thumbnail_url
- Type
- string
- Description
URL muat turun untuk versi
thumbnail_urldengan latar belakang lutsinar (RGBA). Hadir hanya apabila anda mencipta tugas denganalpha_thumbnail: truedan Meshy menjana preview lutsinar tersebut.
- Name
- progress
- Type
- integer
- Description
Berapa banyak tugas telah selesai, dalam peratusan. Nilainya
0sehingga tugas bermula dan100apabila ia berjaya.
- Name
- started_at
- Type
- timestamp
- Description
Masa tugas bermula, dalam milisaat Unix. Nilainya
0sehingga tugas bermula.
- Name
- created_at
- Type
- timestamp
- Description
Masa tugas dicipta, dalam milisaat Unix.
- Name
- finished_at
- Type
- timestamp
- Description
Masa tugas selesai, dalam milisaat Unix. Nilainya
0sehingga tugas selesai.
- Name
- status
- Type
- string
- Description
Status tugas, salah satu daripada
PENDING,IN_PROGRESS,SUCCEEDED,FAILED, atauCANCELED.
- Name
- texture_urls
- Type
- array
- Description
URL muat turun untuk peta tekstur yang dijana, sebagai tatasusunan objek. Biasanya ia menyimpan satu objek. Setiap objek mempunyai medan berikut:
- Name
base_color- Type
- string
- Description
Peta warna asas.
- Name
metallic- Type
- string
- Description
Peta metallic. Tiada apabila anda mencipta tugas dengan
enable_pbr: false.
- Name
normal- Type
- string
- Description
Peta normal. Tiada apabila anda mencipta tugas dengan
enable_pbr: false.
- Name
roughness- Type
- string
- Description
Peta roughness. Tiada apabila anda mencipta tugas dengan
enable_pbr: false.
- Name
emission- Type
- string
- Description
Peta emission. Tiada dalam mana-mana kes berikut:
- Anda mencipta tugas dengan
enable_pbr: false. ai_modelialahmeshy-6-lite,meshy-7,meshy-7.1, ataulatest.texture_resolutionialah8k.- Tugas memperhalusi (refine) preview
meshy-t2ataumeshy-t2.5tanpa menetapkanai_model.
- Anda mencipta tugas dengan
- Name
- preceding_tasks
- Type
- integer
- Description
Bilangan tugas di hadapan tugas ini dalam baris gilir. Nilai ini hanya bermakna semasa tugas berstatus
PENDING.
- Name
- task_error
- Type
- object
- Description
Butiran ralat apabila tugas gagal. Ia
nullmelainkan statusnyaFAILED. Lihat Ralat.
- Name
- consumed_credits
- Type
- integer
- Description
Bilangan kredit yang digunakan oleh tugas. Hadir apabila status ialah
PENDING,IN_PROGRESS, atauSUCCEEDED. Nilainya0untuk tugasFAILED, kerana Meshy memulangkan semula kredit apabila tugas gagal.

