Ang Multi-Image to 3D API ay isang feature na nagbibigay-daan sa iyo na i-integrate ang mga kakayahan ng Multi-Image to 3D ng Meshy sa sarili mong application. Sa seksyong ito, makikita mo ang lahat ng impormasyon
na kailangan mo para makapagsimula sa API na ito.
Pinapayagan ka ng endpoint na ito na gumawa ng bagong Multi-Image to 3D task. Sumangguni sa
Ang Multi-Image to 3D Task Object upang makita kung aling
mga property ang kasama sa Multi-Image to 3D task object.
Mga Parameter
Isa lang sa input_task_id o image_urls ang kinakailangan. Kung parehong ibinigay, mas may priority ang input_task_id.
Name
input_task_id
Type
string
Kinakailangan
Description
Ang ID ng isang nakumpletong image-generation task na ang output (1-4 na larawan) ay dapat gamitin bilang input. Ang task na ito ay dapat isa sa mga sumusunod na task: 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 para gamitin ng Meshy sa paggawa ng model. Kasalukuyan naming sinusuportahan ang mga format na .jpg, .jpeg, at .png. Dapat ipakita ng lahat ng larawan ang parehong object mula sa iba't ibang anggulo para sa pinakamahusay na resulta.
May dalawang paraan upang ibigay ang bawat larawan:
URL na pampublikong naa-access: Isang URL na naa-access mula sa pampublikong internet.
Data URI: Isang base64-encoded data URI ng larawan. Halimbawa ng data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
ai_model
Type
string
default latest
Description
ID ng model na gagamitin. Mga available na value: meshy-5, meshy-6, latest (Meshy 6).
Name
should_texture
Type
boolean
default true
Description
Tinutukoy kung bubuo ng mga texture. Kapag itinakda ito sa false, nilalaktawan ang texture phase, na nagbibigay ng mesh na walang mga texture.
Naaangkop lamang kapag should_texture = true
Name
enable_pbr
Type
boolean
default false
Description
Bumuo ng PBR maps (metallic, roughness, normal) bukod pa sa base color. Kasama rin ang emission map kapag ang ai_model ay meshy-6 o latest.
Name
hd_texture
Type
boolean
default false
Description
Bumuo ng base color texture sa 4K (4096×4096) na resolusyon para sa mas mataas na detalye.
Sinusuportahan lang kapag ang ai_model ay meshy-6 o latest. Palaging binubuo ang PBR maps sa 2K.
Name
texture_prompt
Type
string
Description
Magbigay ng text prompt upang gabayan ang proseso ng texture. Maximum na 600 character.
Name
texture_image_url
Type
string
Description
Magbigay ng 2d na larawan upang gabayan ang proseso ng texture. Kasalukuyan naming sinusuportahan ang mga format na .jpg, .jpeg, at .png.
May dalawang paraan upang ibigay ang larawan:
URL na pampublikong naa-access: Isang URL na naa-access mula sa pampublikong internet
Data URI: Isang base64-encoded data URI ng larawan. Halimbawa ng data URI: data:image/jpeg;base64,<your base64-encoded image data>
Maaaring hindi gumana nang optimal ang image texturing kung may malalaking pagkakaiba sa heometriya sa pagitan ng orihinal na asset at na-upload na larawan. Isa lang sa texture_image_url o texture_prompt ang maaaring gamitin upang gabayan ang proseso ng texture. Kung parehong ibinigay ang mga parameter, gagamitin ang texture_prompt upang lagyan ng texture ang model bilang default.
Name
should_remesh
Type
boolean
default false (meshy-6), true (others)
Description
Kinokontrol kung ie-enable ang remesh phase. Kapag itinakda sa false, ibinabalik ng API ang pinakamataas na precision na triangular mesh.
Naaangkop lamang kapag should_remesh = true
Name
topology
Type
string
default triangle
Description
Tukuyin ang topology ng nabuong model.
Mga available na value:
quad: Bumuo ng quad-dominant na mesh.
triangle: Bumuo ng decimated triangle mesh.
Name
target_polycount
Type
integer
default 30,000
Description
Tukuyin ang target na bilang ng mga polygon sa nabuong model. Maaaring lumihis ang aktuwal na bilang ng mga polygon mula sa target depende sa pagiging kumplikado ng heometriya.
Nag-iiba ang valid na saklaw ng value depende sa user tier:
100 hanggang 300,000 (kasama)
Name
decimation_mode
Type
integer
Description
I-enable ang adaptive decimation sa pamamagitan ng pagtatakda ng polycount level. Kapag itinakda, binabalewala 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, nag-iimbak din ang Meshy ng karagdagang GLB file bago makumpleto ang remesh phase.
Name
symmetry_mode
Type
string
⚠ lipas na
default auto
Description
Deprecated. Hindi na naaapektuhan ng parameter na ito ang output.
Kinokontrol ng field na symmetry_mode ang pag-uugali ng simetriya sa panahon ng proseso ng pagbuo ng model.
Ang mga valid na value ay:
off: Hindi pinapagana ang simetriya.
auto: Awtomatikong tinutukoy at inilalapat ang simetriya batay sa input geometry.
on: Ipinapatupad ang simetriya habang bumubuo.
Name
pose_mode
Type
string
default ""
Description
Tukuyin ang pose mode para sa nabuong model.
Mga available na value:
a-pose: Bumuo ng model sa A pose.
t-pose: Bumuo ng model 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 bubuo ng model sa A/T pose.
Name
image_enhancement
Type
boolean
default true
Description
Ino-optimize ang mga input image para sa mas magagandang resulta. Itakda sa false upang mapanatili ang eksaktong hitsura ng mga input image nang walang anumang style processing.
Sinusuportahan lang kapag ang ai_model ay meshy-6 o latest.
Name
remove_lighting
Type
boolean
default true
Description
Tinatanggal ang mga highlight at shadow mula sa base color texture, na gumagawa ng mas malinis na resulta na mas mahusay gumana sa ilalim ng mga custom lighting setup.
Sinusuportahan lang kapag ang ai_model ay meshy-6 o latest.
Name
moderation
Type
boolean
default false
Description
Kapag itinakda sa true, awtomatikong susuriin ang input content para sa potensyal na nakakapinsalang content. Kung may matukoy na nakakapinsalang content, hindi magpapatuloy ang task sa generation.
Susuriin 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. Tanging ang mga hiniling na format ang bubuuin at ibabalik, na maaaring magpababa sa oras ng pagkumpleto ng task.
Mga available na value: glb, obj, fbx, stl, usdz, 3mf
Kapag inalis, bubuuin ang lahat ng format maliban sa 3mf. Kasama lang ang 3mf kapag tahasang tinukoy.
Name
auto_size
Type
boolean
default false
Description
Kapag itinakda sa true, ginagamit ng serbisyo ang AI vision upang awtomatikong tantiyahin ang real-world na taas ng object at i-resize ang model nang naaayon. Magde-default ang origin sa bottom maliban kung tahasang itinakda ang origin_at.
Name
alpha_thumbnail
Type
boolean
default false
Description
Kapag itinakda sa true, karagdagan ding nagre-render ang task ng transparent-background (RGBA) na bersyon ng preview at ibinabalik ito bilang alpha_thumbnail_url sa GET response. Hindi nagbabago ang kasalukuyang field na thumbnail_url.
Name
multi_view_thumbnails
Type
boolean
default false
Description
Kapag itinakda sa true, karagdagan ding nagre-render ang task ng apat na cardinal-view thumbnail (front, right, back, left) at ibinabalik ang mga ito sa ilalim ng thumbnail_urls sa GET response. Hindi nagbabago ang kasalukuyang field na thumbnail_url at patuloy na tumuturo sa front view, kaya hindi naaapektuhan ang mga kasalukuyang client.
Nagdaragdag ng humigit-kumulang 3 segundo sa task latency.
Naaangkop lamang kapag auto_size = true
Name
origin_at
Type
string
default bottom
Description
Posisyon ng origin kapag naka-enable ang auto_size. Mga available na value: bottom, center.
Ibinabalik
Ang property na result ng response ay naglalaman ng task id ng bagong gawang Multi-Image to 3D task.
Mga Failure Mode
Name
400 - Bad Request
Description
Hindi katanggap-tanggap ang request. Mga karaniwang dahilan:
Nawawalang parameter: Dapat ibigay ang alinman sa image_urls o input_task_id.
Invalid na input task: Dapat tumukoy ang input_task_id sa isang SUCCEEDED na Text to Image, Image to Image, o multi-view variant task.
Invalid na bilang ng larawan: Dapat maglaman ang image_urls ng pagitan ng 1 at 4 na larawan.
Invalid na format ng larawan: Hindi suportadong format ang isa o higit pang larawan sa image_urls.
Hindi maabot na URL: Hindi ma-download ang isa o higit pang image_urls.
Name
401 - Unauthorized
Description
Nabigo ang authentication. Pakisuri ang iyong API key.
Name
402 - Payment Required
Description
Hindi sapat ang credits upang isagawa ang task na ito.
Name
429 - Too Many Requests
Description
Lumampas ka na sa iyong rate limit.
Request
POST
/openapi/v1/multi-image-to-3d
# Simple requestcurl https://api.meshy.ai/openapi/v1/multi-image-to-3d \ -X POST \ -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 formatcurl https://api.meshy.ai/openapi/v1/multi-image-to-3d \ -X POST \ -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"] }'
Pinapayagan ka ng endpoint na ito na kunin ang isang Multi-Image to 3D na gawain gamit ang valid na task id.
Sumangguni sa Ang Multi-Image to 3D Task Object upang makita kung aling
mga property ang kasama sa Multi-Image to 3D task object.
Mga Parameter
Name
id
Type
path
Description
Natatanging identifier para sa Multi-Image to 3D na gawain na kukunin.
Mga Ibinabalik
Naglalaman ang response ng Multi-Image to 3D task object. Tingnan ang
seksyong Ang Multi-Image to 3D Task Object para sa mga detalye.
Permanenteng dine-delete ng endpoint na ito ang isang Multi-Image to 3D task, kabilang ang lahat ng nauugnay na mga modelo at data. Hindi na mababawi ang aksyong ito.
Ang Multi-Image to 3D Task object ay isang work unit na sinusubaybayan ng Meshy upang makabuo ng 3d model mula sa maraming larawan (mula 1 hanggang 4 kasama). Dapat ay iisang bagay ang nasa mga larawan, pinakamainam kung mula sa iba't ibang view o anggulo.
Ang object ay may mga sumusunod na property:
Mga Property
Name
id
Type
string
Description
Natatanging identifier para sa gawain. Bagama't gumagamit kami ng k-sortable UUID para sa mga task id bilang
detalye ng implementasyon, hindi ka dapat gumawa ng anumang palagay tungkol sa format ng id.
Name
type
Type
string
Description
Uri ng gawain na Multi-Image to 3D. Ang value ay multi-image-to-3d.
Name
model_urls
Type
object
Description
Nada-download na URL papunta sa file ng 3D model na may texture na nabuo ng Meshy. Hindi isasama ang property para sa isang format kung hindi nabuo ang format, sa halip na magbalik ng empty string.
Name
glb
Type
string
Description
Nada-download na URL papunta sa GLB file.
Name
fbx
Type
string
Description
Nada-download na URL papunta sa FBX file.
Name
obj
Type
string
Description
Nada-download na URL papunta sa OBJ file.
Name
usdz
Type
string
Description
Nada-download na URL papunta sa USDZ file.
Name
mtl
Type
string
Description
Nada-download na URL papunta sa MTL file, ibinabalik kasabay ng mga OBJ export kapag may mga texture.
Name
stl
Type
string
Description
Nada-download na URL papunta sa STL file.
Name
3mf
Type
string
Description
Nada-download na URL papunta sa 3MF file. Naroroon lamang kapag hiniling ang 3mf sa pamamagitan ng target_formats.
Name
pre_remeshed_glb
Type
string
Description
Nada-download na URL papunta sa orihinal na GLB output bago ang remesh.
Available lamang kapag nilikha ang gawain na may parehong should_remesh: true at save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Nada-download na URL papunta sa thumbnail image ng model file. Katumbas ng thumbnail_urls.front kapag naroroon, pinananatili para sa backward compatibility.
Name
alpha_thumbnail_url
Type
string
Description
Nada-download na URL papunta sa bersyong may transparent-background (RGBA) ng thumbnail_url. Naroroon lamang kapag nilikha ang gawain na may alpha_thumbnail: true at matagumpay na na-render ang transparent preview; kung hindi, hindi isasama ang field na ito.
Name
thumbnail_urls
Type
object
Description
Mga nada-download na URL para sa apat na cardinal-view thumbnail ng nabuong 3D model. Ang bawat value ay isang signed URL papunta sa 512×512 PNG na na-render gamit ang parehong mga material at lighting gaya ng thumbnail_url. Kapaki-pakinabang para sa pag-preview ng model mula sa maraming anggulo sa mga batch pipeline nang hindi dina-download ang GLB.
Naroroon lamang kapag nilikha ang gawain na may multi_view_thumbnails: true at umabot na sa SUCCEEDED. Hindi isasama ng mas lumang mga gawain at mga gawaing nilikha nang walang opt-in ang 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 paglalagay ng texture.
Name
progress
Type
integer
Description
Progress ng gawain. Kung hindi pa nagsisimula ang gawain, ang property na ito ay magiging 0. Kapag nagtagumpay na ang gawain, magiging 100 ito.
Name
started_at
Type
timestamp
Description
Timestamp kung kailan nagsimula ang gawain, sa milliseconds. Kung hindi pa nagsisimula ang gawain, ang property na ito ay magiging 0.
Ang timestamp ay kumakatawan sa bilang ng milliseconds na lumipas mula Enero 1, 1970 UTC, alinsunod sa
pamantayang RFC 3339.
Halimbawa, ang Biyernes, Setyembre 1, 2023 12:00:00 PM GMT ay kinakatawan bilang 1693569600000. Nalalapat ito
sa lahat ng timestamp sa Meshy API.
Name
created_at
Type
timestamp
Description
Timestamp kung kailan nilikha ang gawain, sa milliseconds.
Name
expires_at
Type
timestamp
Description
Timestamp kung kailan mag-e-expire ang resulta ng gawain, sa milliseconds.
Name
finished_at
Type
timestamp
Description
Timestamp kung kailan natapos ang gawain, sa milliseconds. Kung hindi pa tapos ang gawain, ang property na ito ay magiging 0.
Name
status
Type
string
Description
Status ng gawain. Ang mga posibleng value ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Isang array ng mga texture URL object na nabuo mula sa gawain. Karaniwan, naglalaman lamang ito ng isang texture URL object. Ang bawat texture URL ay may sumusunod na mga property:
Name
base_color
Type
string
Description
Nada-download na URL papunta sa base color map image.
Name
metallic
Type
string
Description
Nada-download na URL papunta sa metallic map image.
Kung nilikha ang gawain na may enable_pbr: false, hindi isasama ang property na ito.
Name
normal
Type
string
Description
Nada-download na URL papunta sa normal map image.
Kung nilikha ang gawain na may enable_pbr: false, hindi isasama ang property na ito.
Name
roughness
Type
string
Description
Nada-download na URL papunta sa roughness map image.
Kung nilikha ang gawain na may enable_pbr: false, hindi isasama ang property na ito.
Name
emission
Type
string
Description
Nada-download na URL papunta sa emission map image.
Kung nilikha ang gawain na may enable_pbr: false, o ang ai_model ay meshy-5, hindi isasama ang property na ito.
Name
preceding_tasks
Type
integer
Description
Ang bilang ng mga naunang gawain.
Makabuluhan lamang ang value ng field na ito kung ang status ng gawain ay PENDING.
Name
task_error
Type
object
Description
Mga detalye ng error para sa mga nabigong gawain. Tingnan ang Errors para sa buong reference ng task_error object.
Name
consumed_credits
Type
integer
Description
Ang bilang ng credits na nakonsumo ng gawaing ito. Naroroon kapag ang status ng gawain ay PENDING, IN_PROGRESS, o SUCCEEDED. Nagbabalik ng 0 para sa mga FAILED na gawain (nire-refund ang credits kapag nabigo).