Ang Multi-Image to 3D API ay isang tampok na nagbibigay-daan sa iyo na isama ang kakayahan ng Meshy na Multi-Image to 3D sa iyong sariling aplikasyon. Sa seksyong ito, makikita mo ang lahat ng impormasyong kailangan mo upang makapagsimula sa API na ito.
Ang endpoint na ito ay nagbibigay-daan sa iyo na gumawa ng bagong Multi-Image to 3D task. Sumangguni sa
The Multi-Image to 3D Task Object upang makita kung anong mga
property ang kasama sa Multi-Image to 3D task object.
Mga Parameter
Isa lamang sa input_task_id o image_urls ang kinakailangan. Kung parehong ibinigay, ang input_task_id ang mauuna.
Name
input_task_id
Type
string
Kinakailangan
Description
Ang ID ng isang natapos na image-generation task na ang output (1-4 na larawan) ang gagamiting input. Ang task na ito ay dapat isa sa mga sumusunod: Text to Image, Image to Image, Text to Image Multi-View, o Image to Image Multi-View. Bukod dito, dapat itong pinatakbo sa pamamagitan ng API at may status na SUCCEEDED.
Name
image_urls
Type
array
Kinakailangan
Description
Magbigay ng 1 hanggang 4 na larawan na gagamitin ni Meshy sa paggawa ng modelo. Kasalukuyan naming sinusuportahan ang mga format na .jpg, .jpeg, at .png. Dapat ipakita ng lahat ng larawan ang parehong bagay mula sa iba't ibang anggulo para sa pinakamainam na resulta.
May dalawang paraan upang magbigay ng bawat larawan:
Publicly accessible URL: Isang URL na naa-access mula sa pampublikong internet.
Data URI: Isang base64-encoded na data URI ng larawan. Halimbawa ng data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Para sa meshy-7 (o latest), ang unang larawan ang ginagamit bilang pangunahing (harap) view. Hindi mahalaga ang pagkakasunod-sunod ng ibang mga larawan.
Name
ai_model
Type
string
default latest
Description
ID ng modelong gagamitin. Mga available na value: meshy-5, meshy-6, meshy-7, latest (Meshy 7).
Name
ultra_mode
Type
boolean
default false
Description
Nagbibigay-daan sa Ultra generation para sa mas mataas ang kalidad na heometriya na may mas maayos na detalye sa ibabaw.
Sinusuportahan lamang kapag ang ai_model ay meshy-7 (o latest).
Name
should_texture
Type
boolean
default true
Description
Tinutukoy kung gagawa ng mga texture. Ang pagtatakda nito sa false ay lalaktawan ang yugto ng texture, na magbibigay ng mesh na walang texture.
Naaangkop lamang kapag should_texture = true
Name
enable_pbr
Type
boolean
default false
Description
Gumawa ng PBR Maps (metallic, roughness, normal) bilang karagdagan sa base color. Isang emission map ang kasama rin kapag ang ai_model ay meshy-6, maliban sa texture_resolution: 8k. Hindi gumagawa ng emission map ang meshy-7 at latest.
Name
texture_resolution
Type
string
default 2k
Description
Ang resolution ng base color texture. Isa sa 2k (2048×2048), 4k (4096×4096), o 8k (8192×8192). Ang mas mataas na resolution ay nakakakuha ng mas maraming detalye sa ibabaw.
Ang 4k at 8k ay nangangailangan ng ai_model na meshy-6, meshy-7 o latest. Sa 8k, walang emission map na nagagawa.
Name
hd_texture
Type
boolean
⚠ lipas na
default false
Description
Gamitin ang texture_resolution sa halip — katumbas ng texture_resolution: "4k". Kapag pareho itong itinakda, ang texture_resolution ang mananaig.
Name
texture_prompt
Type
string
Description
Magbigay ng text prompt upang gabayan ang proseso ng pag-te-texture. Maximum na 800 na character.
Name
texture_image_url
Type
string
Description
Magbigay ng 2d na larawan upang gabayan ang proseso ng pag-te-texture. Kasalukuyan naming sinusuportahan ang mga format na .jpg, .jpeg, at .png.
May dalawang paraan upang magbigay ng larawan:
Publicly accessible URL: Isang URL na naa-access mula sa pampublikong internet
Data URI: Isang base64-encoded na data URI ng larawan. Halimbawa ng data URI: data:image/jpeg;base64,<your base64-encoded image data>
Maaaring hindi gumana nang optimal ang pag-te-texture ng larawan kung may malaking pagkakaiba sa heometriya sa pagitan ng orihinal na asset at ng na-upload na larawan. Isa lamang sa texture_image_url o texture_prompt ang maaaring gamitin upang gabayan ang proseso ng pag-te-texture. Kung parehong ibinigay ang mga parameter, gagamitin ang texture_prompt bilang default upang i-texture ang modelo.
Name
texture_image_urls
Type
string[]
Description
Magbigay ng 1 hanggang 4 na larawan na nagpapakita ng parehong bagay mula sa iba't ibang view upang gabayan ang pag-te-texture. Ang unang larawan ang pangunahing (harap) view; hindi mahalaga ang pagkakasunod-sunod ng ibang mga view (kaliwa, likod, kanan).
Ang bawat elemento ay tumatanggap ng parehong mga format tulad ng texture_image_url (isang publicly accessible URL o isang base64 data URI, .jpg/.jpeg/.png).
Ang mga larawang ito ay gagabay lamang sa texture, at hiwalay sa image_urls — ang dalawang listahan ay maaaring maglaman ng iba't ibang larawan at iba't ibang bilang ng mga larawan.
Nangangailangan ng ai_model na meshy-7 o latest. Hindi maaaring pagsamahin sa texture_image_url o texture_prompt.
Name
should_remesh
Type
boolean
default false (meshy-6), true (others)
Description
Kinokontrol kung papagana ang yugto ng remesh. Para sa modelong may pinakamataas na kalidad, inirerekomenda naming itakda ang should_remesh sa false.
Naaangkop lamang kapag should_remesh = true
Name
topology
Type
string
default triangle
Description
Tukuyin ang topology ng nabuong modelo.
Mga available na value:
quad: Gumawa ng mesh na quad-dominant.
triangle: Gumawa ng decimated triangle mesh.
Name
target_polycount
Type
integer
default 30,000
Description
Tukuyin ang target na bilang ng mga polygon sa nabuong modelo. Ang aktwal na bilang ng mga polygon ay maaaring lumihis mula sa target depende sa pagiging kumplikado ng heometriya.
Ang valid na saklaw ng value ay depende sa user tier:
100 hanggang 300,000 (kasama)
Name
decimation_mode
Type
integer
Description
Paganahin ang adaptive decimation sa pamamagitan ng pagtatakda ng antas ng polycount. Kapag itinakda, hindi papansinin ang target_polycount.
Mga available na value:
1: Adaptive — ultra polycount.
2: Adaptive — high polycount.
3: Adaptive — medium polycount.
4: Adaptive — low polycount.
Name
save_pre_remeshed_model
Type
boolean
default false
Description
Kapag itinakda sa true, iniimbak din ni Meshy ang karagdagang GLB file bago matapos ang yugto ng remesh.
Name
symmetry_mode
Type
string
⚠ lipas na
default auto
Description
Deprecated. Hindi na naaapektuhan ng parameter na ito ang output.
Ang field na symmetry_mode ay kumokontrol sa asal ng simetriya sa proseso ng paggawa ng modelo.
Ang mga valid na value ay:
off: Nagdi-disable ng simetriya.
auto: Awtomatikong tinutukoy at inilalapat ang simetriya batay sa input geometry.
on: Ipinapatupad ang simetriya sa panahon ng paggawa.
Name
pose_mode
Type
string
default ""
Description
Tukuyin ang pose mode para sa nabuong modelo.
Mga available na value:
a-pose: Gumawa ng modelo sa A pose.
t-pose: Gumawa ng modelo sa T pose.
"" (empty string): Walang partikular na pose na inilapat.
Name
is_a_t_pose
Type
boolean
⚠ lipas na
default false
Description
Gamitin ang pose_mode sa halip. Kung gagawa ba ng modelo sa A/T pose.
Name
image_enhancement
Type
boolean
default true
Description
Ino-optimize ang mga input na larawan para sa mas magandang resulta. Itakda sa false upang mapanatili ang eksaktong hitsura ng mga input na larawan nang walang anumang pagproseso ng estilo.
Sinusuportahan lamang kapag ang ai_model ay meshy-6, meshy-7 o latest.
Name
remove_lighting
Type
boolean
default true
Description
Inaalis ang mga highlight at anino mula sa base color texture, na nagbibigay ng mas malinis na resulta na mas maayos gumana sa mga custom na setup ng ilaw.
Sinusuportahan lamang kapag ang ai_model ay meshy-6, meshy-7 o latest.
Name
moderation
Type
boolean
default false
Description
Kapag itinakda sa true, awtomatikong sasala ang input content para sa potensyal na mapanganib na nilalaman. Kung natukoy ang mapanganib na nilalaman, hindi magpapatuloy ang task sa pagbuo.
Sasalain ang bawat larawan mula sa image_urls at ang text mula sa texture_prompt.
Name
target_formats
Type
string[]
Description
Tinutukoy kung aling mga 3D file format ang isasama sa output. Ang mga hiniling na format lamang ang gagawin at ibabalik, na maaaring magpabawas sa oras ng pagkumpleto ng task.
Mga available na value: glb, obj, fbx, stl, usdz, 3mf
Kapag hindi isinama, lahat ng format maliban sa 3mf ang gagawin. Isasama lamang ang 3mf kapag tahasang tinukoy.
Name
auto_size
Type
boolean
default false
Description
Kapag itinakda sa true, gumagamit ang serbisyo ng AI vision upang awtomatikong tantiyahin ang tunay na taas ng bagay sa totoong mundo at ire-resize ang modelo ayon dito. Ang origin ay magiging bottom bilang default maliban kung tahasang itinakda ang origin_at.
Name
alpha_thumbnail
Type
boolean
default false
Description
Kapag itinakda sa true, ire-render din ng task ang bersyong may transparent na background (RGBA) ng preview at ibabalik ito bilang alpha_thumbnail_url sa GET response. Hindi nagbabago ang umiiral na field na thumbnail_url.
Name
multi_view_thumbnails
Type
boolean
default false
Description
Kapag itinakda sa true, ire-render din ng task ang apat na cardinal-view na thumbnail (harap, kanan, likod, kaliwa) at ibabalik ang mga ito sa ilalim ng thumbnail_urls sa GET response. Hindi nagbabago ang umiiral na field na thumbnail_url at patuloy itong tumuturo sa harap na view, kaya hindi maaapektuhan ang mga umiiral na kliyente.
Nagdaragdag ng humigit-kumulang 3 segundo sa latency ng task.
Naaangkop lamang kapag auto_size = true
Name
origin_at
Type
string
default bottom
Description
Posisyon ng origin kapag pinagana ang auto_size. Mga available na value: bottom, center.
Mga Ibinabalik
Ang property na result ng response ay naglalaman ng id ng task ng bagong ginawang Multi-Image to 3D task.
Mga Mode ng Pagkabigo
Name
400 - Bad Request
Description
Hindi katanggap-tanggap ang request. Karaniwang mga dahilan:
Missing parameter: Alinman sa image_urls o input_task_id ay dapat ibigay.
Invalid input task: Ang input_task_id ay dapat tumukoy sa isang SUCCEEDED na Text to Image, Image to Image, o multi-view variant na task.
Invalid image count: Ang image_urls ay dapat maglaman ng 1 hanggang 4 na larawan, at ang texture_image_urls ay 1 hanggang 4.
Invalid image format: Isa o higit pa sa mga larawan sa image_urls ay hindi suportadong mga format.
Conflicting texture inputs: Hindi maaaring pagsamahin ang texture_image_urls sa texture_image_url o texture_prompt, at nangangailangan ito ng should_texture: true.
Unsupported model for multi-view texture: Nangangailangan ang texture_image_urls ng ai_model na meshy-7 o latest.
Unreachable URL: Isa o higit pa sa mga elemento ng image_urls o texture_image_urls ay hindi ma-download.
Name
401 - Unauthorized
Description
Nabigo ang authentication. Pakisuri ang iyong API key.
Name
402 - Payment Required
Description
Hindi sapat na credits upang isagawa ang task na ito.
Name
429 - Too Many Requests
Description
Nalagpasan mo na ang iyong rate limit.
Request
POST
/openapi/v1/multi-image-to-3d
# Simple requestcurlhttps://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>" ] }'# With PBR texturing and GLB formatcurlhttps://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"] }'
Ang endpoint na ito ay nagbibigay-daan sa iyo na kunin ang isang Multi-Image to 3D na gawain gamit ang isang wastong task id.
Sumangguni sa Ang Multi-Image to 3D Task Object upang makita kung aling
mga katangian ang kasama sa Multi-Image to 3D task object.
Mga Parameter
Name
id
Type
path
Description
Natatanging tagatukoy para sa Multi-Image to 3D na gawain na kukunin.
Mga Ibinabalik
Ang tugon ay naglalaman ng Multi-Image to 3D task object. Suriin ang
Ang Multi-Image to 3D Task Object na seksyon para sa mga detalye.
Ang endpoint na ito ay permanenteng nagtatanggal ng isang Multi-Image to 3D na gawain, kasama ang lahat ng kaugnay na modelo at datos. Ang aksyong ito ay hindi na mababawi.
Mga Parameter ng Landas
Name
id
Type
path
Description
Ang ID ng Multi-Image to 3D na gawain na tatanggalin.
Ang Multi-Image to 3D Task object ay isang work unit na sinusubaybayan ng Meshy upang makabuo ng 3d model mula sa maraming imahe (sa pagitan ng 1 hanggang 4 kasama). Ang mga imahe ay dapat na ng parehong bagay, mas mainam kung mula sa iba't ibang view o anggulo.
Ang object ay mayroong sumusunod na mga property:
Mga Property
Name
id
Type
string
Description
Natatanging identifier para sa task. Bagamat gumagamit kami ng k-sortable UUID para sa task ids bilang
implementation detail, hindi ka dapat gumawa ng anumang mga palagay tungkol sa format ng id.
Name
type
Type
string
Description
Uri ng Multi-Image to 3D task. Ang value ay multi-image-to-3d.
Name
model_urls
Type
object
Description
Downloadable URL sa textured 3D model file na nabuo ng Meshy. Ang property para sa isang format ay itatanggal kung ang format ay hindi nabuo sa halip na magbalik ng walang laman na string.
Name
glb
Type
string
Description
Downloadable URL sa GLB file.
Name
fbx
Type
string
Description
Downloadable URL sa FBX file.
Name
obj
Type
string
Description
Downloadable URL sa OBJ file.
Name
usdz
Type
string
Description
Downloadable URL sa USDZ file.
Name
mtl
Type
string
Description
Downloadable URL sa MTL file, na ibinabalik kasama ng OBJ exports kapag may mga texture.
Name
stl
Type
string
Description
Downloadable URL sa STL file.
Name
3mf
Type
string
Description
Downloadable URL sa 3MF file. Naririto lamang kapag ang 3mf ay hiniling sa pamamagitan ng target_formats.
Name
pre_remeshed_glb
Type
string
Description
Downloadable URL sa orihinal na GLB output bago mag-remesh.
Makukuha lamang kapag ang task ay ginawa gamit ang parehong should_remesh: true at save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Downloadable URL sa thumbnail image ng model file. Katumbas ng thumbnail_urls.front kapag naroroon, itinatago para sa backwards compatibility.
Name
alpha_thumbnail_url
Type
string
Description
Downloadable URL sa isang transparent-background (RGBA) na bersyon ng thumbnail_url. Naririto lamang kapag ang task ay ginawa gamit ang alpha_thumbnail: true at ang transparent preview ay matagumpay na na-render; kung hindi, ang field na ito ay itatanggal.
Name
thumbnail_urls
Type
object
Description
Downloadable URLs para sa apat na cardinal-view thumbnails ng nabuong 3D model. Bawat value ay isang signed URL sa isang 512×512 PNG na na-render gamit ang parehong materyales at ilaw tulad ng thumbnail_url. Kapaki-pakinabang para sa pag-preview ng model mula sa maraming anggulo sa batch pipelines nang hindi dina-download ang GLB.
Naririto lamang kapag ang task ay ginawa gamit ang multi_view_thumbnails: true at nakarating na sa SUCCEEDED. Ang mga mas lumang task at mga task na ginawa nang walang opt-in ay hindi maglalaman ng field na ito.
Name
front
Type
string
Description
Front view, 0° rotation sa paligid ng vertical axis (tumutugma sa thumbnail_url).
Name
right
Type
string
Description
Right view, 90° rotation.
Name
back
Type
string
Description
Back view, 180° rotation.
Name
left
Type
string
Description
Left view, 270° rotation.
Name
texture_prompt
Type
string
Description
Ang text prompt na ginamit upang gabayan ang proseso ng pag-texture.
Name
texture_image_urls
Type
string[]
Description
Downloadable URLs sa mga texture reference image na ginamit upang likhain ang task, ayon sa pagkakasunod-sunod ng kanilang pagbibigay. Naririto lamang kapag ang task ay ginawa gamit ang texture_image_urls.
Name
ultra_mode
Type
boolean
Description
Inuulit ang value ng ultra_mode na ginamit sa paggawa ng task. Naririto lamang para sa mga meshy-7 (o latest) na task na tahasang nagtakda ng ultra_mode; itinatanggal kung hindi.
Name
progress
Type
integer
Description
Progress ng task. Kung ang task ay hindi pa nagsisimula, ang property na ito ay magiging 0. Kapag ang task ay nagtagumpay na, ito ay magiging 100.
Name
started_at
Type
timestamp
Description
Timestamp kung kailan sinimulan ang task, sa milliseconds. Kung ang task ay hindi pa nagsisimula, ang property na ito ay magiging 0.
Ang timestamp ay kumakatawan sa bilang ng milliseconds na lumipas mula Enero 1, 1970 UTC, ayon
sa RFC 3339 standard.
Halimbawa, Biyernes, Setyembre 1, 2023 12:00:00 PM GMT ay kinakatawan bilang 1693569600000. Ito ay nalalapat
sa lahat ng timestamp sa Meshy API.
Name
created_at
Type
timestamp
Description
Timestamp kung kailan nilikha ang task, sa milliseconds.
Name
expires_at
Type
timestamp
Description
Timestamp kung kailan mag-e-expire ang resulta ng task, sa milliseconds.
Name
finished_at
Type
timestamp
Description
Timestamp kung kailan natapos ang task, sa milliseconds. Kung ang task ay hindi pa tapos, ang property na ito ay magiging 0.
Name
status
Type
string
Description
Status ng task. Ang mga posibleng value ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Isang array ng texture URL objects na nabuo mula sa task. Karaniwan itong naglalaman lamang ng isang texture URL object. Bawat texture URL ay mayroong sumusunod na mga property:
Name
base_color
Type
string
Description
Downloadable URL sa base color map image.
Name
metallic
Type
string
Description
Downloadable URL sa metallic map image.
Kung ang task ay nilikha gamit ang enable_pbr: false, ang property na ito ay itatanggal.
Name
normal
Type
string
Description
Downloadable URL sa normal map image.
Kung ang task ay nilikha gamit ang enable_pbr: false, ang property na ito ay itatanggal.
Name
roughness
Type
string
Description
Downloadable URL sa roughness map image.
Kung ang task ay nilikha gamit ang enable_pbr: false, ang property na ito ay itatanggal.
Name
emission
Type
string
Description
Downloadable URL sa emission map image.
Kung ang task ay nilikha gamit ang enable_pbr: false, o ang ai_model ay meshy-5, ang property na ito ay itatanggal.
Name
preceding_tasks
Type
integer
Description
Ang bilang ng mga naunang task.
Ang value ng field na ito ay makabuluhan lamang kung ang status ng task ay PENDING.
Name
task_error
Type
object
Description
Mga detalye ng error para sa mga nabigong task. Tingnan ang Errors para sa buong reference ng task_error object.
Name
consumed_credits
Type
integer
Description
Ang bilang ng credits na ginamit ng task na ito. Naririto kapag ang status ng task ay PENDING, IN_PROGRESS, o SUCCEEDED. Nagbabalik ng 0 para sa mga FAILED na task (ang credits ay ire-refund kapag nabigo).