Multi-Image to 3D API

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 impormasyong kailangan mo upang makapagsimula sa API na ito.

POST/openapi/v1/multi-image-to-3d

Gumawa ng Multi-Image to 3D Task

Ang endpoint na ito ay nagbibigay-daan sa iyo na gumawa ng bagong Multi-Image to 3D task. Tingnan ang The Multi-Image to 3D Task Object para makita kung aling mga property ang kasama sa Multi-Image to 3D task object.

Tumatakbo ang task sa background. Para sa karaniwang tagal nito, tingnan ang Processing Times.

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 nang 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: Text to Image, Image to Image, Text to Image Multi-View, o Image to Image Multi-View. Bukod dito, dapat itong naisagawa 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, .png, at .webp. Dapat ipakita ng lahat ng larawan ang parehong bagay mula sa iba't ibang anggulo para sa pinakamahusay na resulta.
Pinakamataas na laki ng file: 20 MB bawat larawan.
May dalawang paraan para magbigay ng bawat larawan:
- Publicly accessible URL: 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>.
Para sa meshy-7.1 (o latest), ang unang larawan ang ginagamit bilang pangunahing (harap na) view. Ang pagkakasunod-sunod ng ibang mga larawan ay hindi mahalaga.

Name
ai_model
Type
string
default latest
Description
ID ng modelong gagamitin.
Available na mga value:
- meshy-6-lite, meshy-6, meshy-7.1, latest (Meshy 7.1)
- meshy-7 (deprecated): gamitin na lang ang meshy-7.1.
Name
geometry_resolution
Type
string
default standard
Description
Pass ng pagbuo ng heometriya. Ang 2k ay nagpapatakbo ng Ultra pass sa 2048³. Kinakailangan ang meshy-7.1 o latest.
Available na mga value: standard, 2k
Name
ultra_mode
Type
boolean
⚠ lipas na
default false
Description
Gamitin na lang ang geometry_resolution. Ang ultra_mode: true ay katumbas ng geometry_resolution: "2k".
Name
should_texture
Type
boolean
default true
Description
Tinutukoy kung gagawa ng mga texture. Kapag itinakda sa false, nililiktaan ang texture phase, na nagbibigay 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 din ang kasama kapag ang ai_model ay meshy-6, maliban sa texture_resolution: 8k. Ang meshy-6-lite, meshy-7.1 at latest ay hindi gumagawa ng emission map.
Name
texture_resolution
Type
string
default 2k
Description
Resolution ng base color texture. Isa sa 2k (2048×2048), 4k (4096×4096), o 8k (8192×8192). 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.1 o latest. Sa 8k, walang emission map na nagagawa.
Name
hd_texture
Type
boolean
⚠ lipas na
default false
Description
Gamitin na lang ang texture_resolution — katumbas ito ng texture_resolution: "4k". Kapag parehong itinakda, ang texture_resolution ang mangingibabaw.
Name
texture_prompt
Type
string
Description
Magbigay ng text prompt para gabayan ang proseso ng pag-texture. Maximum na 800 na karakter.
Name
texture_image_url
Type
string
Description
Magbigay ng 2d na larawan para gabayan ang proseso ng pag-texture. Kasalukuyan naming sinusuportahan ang mga format na .jpg, .jpeg, .png, at .webp.
Pinakamataas na laki ng file: 20 MB.
May dalawang paraan para magbigay ng larawan:
- Publicly accessible URL: 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 pag-texture ng larawan kung may malalaking 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-texture. Kung parehong ibinigay ang mga parameter, ang texture_prompt ang gagamitin bilang default para 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 para gabayan ang pag-texture. Ang unang larawan ang pangunahing (harap na) view; ang pagkakasunod-sunod ng ibang mga view (kaliwa, likod, kanan) ay hindi mahalaga.
Ang bawat elemento ay tumatanggap ng parehong mga format gaya ng texture_image_url (isang publicly accessible URL o isang base64 data URI, .jpg/.jpeg/.png/.webp).
Pinakamataas na laki ng file: 20 MB bawat larawan.
Ginagabayan lamang ng mga larawang ito ang texture, at hiwalay ito sa image_urls — maaaring magkaiba ang dalawang listahan sa mga larawan at sa bilang ng mga larawan.
Nangangailangan ng ai_model na meshy-7.1 o latest. Hindi maaaring isama kasama ng texture_image_url o texture_prompt.

Name
should_remesh
Type
boolean
default false (Meshy 6 and Meshy 7 models), true (others)
Description
Kinokontrol kung papagana ang remesh phase. Para sa pinakamataas na kalidad ng modelo, 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 modelong gagawin.
Available na mga value:
- quad: Gumawa ng quad-dominant na mesh.
- triangle: Gumawa ng decimated na triangle mesh.
Name
target_polycount
Type
integer
default 30,000
Description
Tukuyin ang target na bilang ng mga polygon sa modelong gagawin. Ang aktwal na bilang ng mga polygon ay maaaring lumihis sa target depende sa pagiging kumplikado ng heometriya.
Ang valid na saklaw ay 100 hanggang 300,000 (kasama).
Name
decimation_mode
Type
integer
Description
Paganahin ang adaptive decimation sa pamamagitan ng pagtatakda ng polycount level. Kapag itinakda, hindi pinapansin ang target_polycount.
Available na mga 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, nagtatago rin si Meshy ng karagdagang GLB file bago matapos ang remesh phase.

Name
symmetry_mode
Type
string
⚠ lipas na
default auto
Description
Deprecated na. Ang parameter na ito ay hindi na nakakaapekto sa output.
Ang field na symmetry_mode ay kumokontrol sa pag-uugali ng simetriya sa panahon ng proseso ng pagbuo ng modelo.
Ang mga valid na value ay:
- off: Nililiktaan ang simetriya.
- auto: Awtomatikong tinutukoy at inilalapat ang simetriya base sa input na heometriya.
- on: Pinapatupad ang simetriya sa panahon ng paggawa.
Name
pose_mode
Type
string
default ""
Description
Tukuyin ang pose mode para sa modelong gagawin.
Available na mga value:
- a-pose: Gumawa ng modelo sa A pose.
- t-pose: Gumawa ng modelo sa T pose.
- "" (walang laman na string): Walang tiyak na pose na ilalapat.
Name
is_a_t_pose
Type
boolean
⚠ lipas na
default false
Description
Gamitin na lang ang pose_mode. Kung gagawin ba ang modelo sa A/T pose.
Name
image_enhancement
Type
boolean
default true
Description
Ino-optimize ang mga input na larawan para sa mas mahusay na 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.1 o latest. Ang pagtatakda nito gamit ang meshy-6-lite ay magreresulta sa error.
Name
remove_lighting
Type
boolean
default true
Description
Tinatanggal ang mga highlight at anino mula sa base color texture, na nagbubunga ng mas malinis na resulta na mas gumagana nang mahusay sa mga custom na setup ng ilaw.
Sinusuportahan lamang kapag ang ai_model ay meshy-6, meshy-7.1 o latest. Ang pagtatakda nito gamit ang meshy-6-lite ay magreresulta sa error.
Name
moderation
Type
boolean
default false
Description
Kapag itinakda sa true, awtomatikong susuriin ang input na content para sa mga potensyal na mapanganib na nilalaman. Kung may matuklasan na mapanganib na nilalaman, hindi magpapatuloy ang task sa pagbuo.
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. Ang mga hinihinging format lamang ang gagawin at ibabalik, na maaaring magpaikli sa oras ng pagkumpleto ng task.
Available na mga value: glb, obj, fbx, stl, usdz, 3mf
Kapag hindi tinukoy, lahat ng format maliban sa 3mf ang gagawin. Ang 3mf ay isinasama lamang kapag tahasang tinukoy.
Name
auto_size
Type
boolean
default false
Description
Kapag itinakda sa true, gumagamit ang serbisyo ng AI vision upang awtomatikong tantyahin ang real-world na taas ng bagay at ayusin ang laki ng modelo nang naaayon. 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 bersyon na may transparent-background (RGBA) ng preview at ibabalik ito bilang alpha_thumbnail_url sa GET response. Ang umiiral na field na thumbnail_url ay hindi nababago.
Name
multi_view_thumbnails
Type
boolean
default false
Description
Kapag itinakda sa true, ire-render din ng task ang apat na cardinal-view thumbnail (harap, kanan, likod, kaliwa) at ibabalik ang mga ito sa ilalim ng thumbnail_urls sa GET response. Ang umiiral na field na thumbnail_url ay hindi nababago at patuloy na tumuturo sa front view, kaya hindi naaapektuhan ang mga umiiral na client.
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. Available na mga 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:
- Nawawalang parameter: Dapat ibigay ang alinman sa image_urls o input_task_id.
- Hindi valid na input task: Ang input_task_id ay dapat tumukoy sa isang SUCCEEDED na Text to Image, Image to Image, o multi-view variant task.
- Hindi valid na bilang ng larawan: Ang image_urls ay dapat maglaman ng 1 hanggang 4 na larawan, at ang texture_image_urls ay 1 hanggang 4.
- Hindi valid na format ng larawan: Isa o higit pang mga larawan sa image_urls ay hindi suportadong format.
- Magkasalungat na texture input: Ang texture_image_urls ay hindi maaaring isama kasama ng texture_image_url o texture_prompt, at nangangailangan ng should_texture: true.
- Hindi suportadong modelo para sa multi-view texture: Ang texture_image_urls ay nangangailangan ng ai_model na meshy-7.1 o latest.
- Hindi maabot na URL: Isa o higit pang mga elemento ng image_urls o texture_image_urls ay hindi na-download.
- Masyadong malaki ang larawan: Isa o higit pang mga larawan sa image_urls, texture_image_url o texture_image_urls ay lumampas sa 20 MB.
- Hindi suportadong resolution para sa multi-image input: Ang geometry_resolution: "4k" ay hindi available sa endpoint na ito; gamitin ang 2k o standard.
- Hindi suportadong modelo para sa mga opsyon ng larawan: Itinakda ang image_enhancement o remove_lighting kasama ng ai_model: "meshy-6-lite".
Name
401 - Unauthorized
Description
Nabigo ang authentication. Pakisuri ang iyong API key.
Name
402 - Payment Required
Description
Kulang ang credits para isagawa ang task na ito.
Name
429 - Too Many Requests
Description
Nalampasan mo na ang iyong rate limit.

Request

POST

/openapi/v1/multi-image-to-3d

# Simple request
curl 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 Ultra 2K geometry, PBR texturing and GLB format
curl 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>"
    ],
    "ai_model": "meshy-7.1",
    "geometry_resolution": "2k",
    "should_texture": true,
    "enable_pbr": true,
    "target_formats": ["glb"]
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

GET/openapi/v1/multi-image-to-3d/:id

Kunin ang isang Multi-Image to 3D Task

Ang endpoint na ito ay nagbibigay-daan sa iyo na kunin ang isang Multi-Image to 3D task gamit ang isang valid na task id. Sumangguni sa The Multi-Image to 3D Task Object upang makita kung aling mga properties ang kasama sa Multi-Image to 3D task object.

Mga Parameter

Name
id
Type
path
Description
Natatanging identifier para sa Multi-Image to 3D task na kukunin.

Ibinabalik

Ang tugon ay naglalaman ng Multi-Image to 3D task object. Tingnan ang seksyong The Multi-Image to 3D Task Object para sa mga detalye.

Request

GET

/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl https://api.meshy.ai/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "multi-image-to-3d",
  "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=***",
    "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=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "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": 30
}

DELETE/openapi/v1/multi-image-to-3d/:id

Burahin ang Multi-Image to 3D Task

Permanenteng binubura ng endpoint na ito ang isang Multi-Image to 3D task, kasama ang lahat ng kaugnay na mga modelo at datos. Hindi na ito maibabalik kapag nagawa na.

Mga Path Parameter

Name
id
Type
path
Description
Ang ID ng Multi-Image to 3D task na ibubura.

Status ng Task

Ang isang task na PENDING pa ay buburahin at ire-refund ang mga credits na nagamit noong oras ng paggawa nito.

Ang isang task na IN_PROGRESS na ay hindi na puwedeng burahin: tatanggihan ang request na may 409 Conflict at magpapatuloy pa rin ang pagpapatakbo ng task. Ang mga credits para sa isang task na nasimulan na ng worker ay hindi na maaaring i-refund, kaya kapag binura mo ito habang isinasagawa ay mawawalan ka parehong ng credits at ng resulta. Hintayin na umabot ito sa SUCCEEDED, FAILED, o CANCELED, bago ito burahin.

Ang isang task na nasa terminal state (SUCCEEDED, FAILED, o CANCELED) ay buburahin nang walang refund.

Ibinabalik

Nagbabalik ng 200 OK kapag matagumpay, o 409 Conflict kapag ang task ay IN_PROGRESS.

Request

DELETE

/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/multi-image-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 is left 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."
}

GET/openapi/v1/multi-image-to-3d

I-list ang Mga Multi-Image to 3D Task

Ang endpoint na ito ay nagbibigay-daan sa iyo na kumuha ng listahan ng mga Multi-Image to 3D task.

Mga Parameter

Opsyonal na mga attribute

Name
page_num
Type
integer
Description
Numero ng pahina para sa pagination. Nagsisimula at nagde-default sa 1.
Name
page_size
Type
integer
Description
Limitasyon ng laki ng pahina. Nagde-default sa 10 items. Ang pinakamataas na pinapayagan ay 100 items.
Name
sort_by
Type
string
Description
Field na gagamitin sa pag-sort. Mga available na value:
- +created_at: I-sort ayon sa oras ng paggawa sa ascending order.
- -created_at: I-sort ayon sa oras ng paggawa sa descending order.

Ibinabalik

Nagbabalik ng paginated na listahan ng Mga Multi-Image to 3D Task Object.

Request

GET

/openapi/v1/multi-image-to-3d

curl https://api.meshy.ai/openapi/v1/multi-image-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "multi-image-to-3d",
    "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=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
      "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "thumbnail_urls": {
      "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
      "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
      "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
      "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
    },
    "texture_prompt": "",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "expires_at": 1692771679037,
    "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": 30
  }
]

GET/openapi/v1/multi-image-to-3d/:id/stream

Mag-stream ng Multi-Image to 3D Task

Ang endpoint na ito ay nag-sstream ng real-time na update para sa isang Multi-Image to 3D task gamit ang Server-Sent Events (SSE).

Mga Parameter

Name
id
Type
path
Description
Natatanging identifier para sa Multi-Image to 3D task na i-stream.

Ibinabalik

Nagbabalik ng stream ng The Multi-Image to 3D Task Objects bilang Server-Sent Events.

Para sa mga task na PENDING o IN_PROGRESS, ang response stream ay magsasama lamang ng kinakailangang mga field na progress at status.

Request

GET

/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/multi-image-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.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "multi-image-to-3d",
  "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=***",
  "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=***",
  "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
  "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
  "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
  "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
  "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "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": 30
}

Ang Multi-Image to 3D Task Object

Ang Multi-Image to 3D Task object ay isang work unit na sinusubaybayan ng Meshy para makabuo ng 3d model mula sa maraming imahe (sa pagitan ng 1 hanggang 4 inclusive). Dapat ay parehong bagay ang nasa mga imahe, mas mabuti kung mula sa magkaibang views o angles. Ang object ay may mga sumusunod na properties:

Properties

Name
id
Type
string
Description
Natatanging identifier para sa task. Bagama't gumagamit kami ng k-sortable UUID para sa mga task id bilang implementation detail, hindi ka dapat gumawa ng anumang 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 patungo sa textured 3D model file na nabuo ng Meshy. Ang property para sa isang format ay aalisin kung hindi nabuo ang format sa halip na magbalik ng isang walang laman na string.
- Name
  glb
  Type
  string
  Description
  Downloadable URL patungo sa GLB file.
- Name
  fbx
  Type
  string
  Description
  Downloadable URL patungo sa FBX file.
- Name
  obj
  Type
  string
  Description
  Downloadable URL patungo sa OBJ file.
- Name
  usdz
  Type
  string
  Description
  Downloadable URL patungo sa USDZ file.
- Name
  mtl
  Type
  string
  Description
  Downloadable URL patungo sa MTL file, ibinabalik kasama ng OBJ exports kapag may mga texture.
- Name
  stl
  Type
  string
  Description
  Downloadable URL patungo sa STL file.
- Name
  3mf
  Type
  string
  Description
  Downloadable URL patungo sa 3MF file. Lalabas lamang kapag hiniling ang 3mf sa pamamagitan ng target_formats.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  Downloadable URL patungo sa orihinal na GLB output bago mag-remesh.
  Available 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 patungo sa thumbnail image ng model file. Katumbas ng thumbnail_urls.front kapag naroroon, pinapanatili para sa backwards compatibility.
Name
alpha_thumbnail_url
Type
string
Description
Downloadable URL patungo sa isang bersyon na transparent-background (RGBA) ng thumbnail_url. Lalabas lamang kapag ang task ay ginawa gamit ang alpha_thumbnail: true at matagumpay na na-render ang transparent preview; kung hindi, aalisin ang field na ito.
Name
thumbnail_urls
Type
object
Description
Downloadable URLs para sa apat na cardinal-view thumbnails ng nabuong 3D model. Ang bawat value ay isang signed URL patungo sa 512×512 PNG na na-render gamit ang parehong mga materyales at liwanag tulad ng thumbnail_url. Kapaki-pakinabang para sa pag-preview ng model mula sa maraming anggulo sa batch pipelines nang hindi nagda-download ng GLB.
Lalabas lamang kapag ang task ay ginawa gamit ang multi_view_thumbnails: true at naabot na ang SUCCEEDED. Ang mga mas lumang task at mga task na ginawa nang walang opt-in ay hindi magsasama ng field na ito.
- Name
  front
  Type
  string
  Description
  Front view, 0° rotation sa paligid ng vertical axis (katumbas ng 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 para gabayan ang proseso ng pag-texture.
Name
texture_image_urls
Type
string[]
Description
Downloadable URLs patungo sa mga texture reference images na ginamit upang likhain ang task, ayon sa pagkakasunod-sunod ng pagkakaroon ng mga ito. Lalabas lamang kapag ang task ay ginawa gamit ang texture_image_urls.
Name
ultra_mode
Type
boolean
⚠ lipas na
Description
Deprecated na; basahin na lamang ang geometry_resolution.
Name
geometry_resolution
Type
string
Description
Ang Ultra tier kung saan tumakbo ang task (2k); aalisin para sa standard.
Name
progress
Type
integer
Description
Progress ng task. Kung hindi pa nasisimulan ang task, ang property na ito ay magiging 0. Kapag matagumpay na ang task, ito ay magiging 100.
Name
started_at
Type
timestamp
Description
Timestamp ng oras na sinimulan ang task, sa milliseconds. Kung hindi pa nasisimulan ang task, ang property na ito ay magiging 0.
Ang timestamp ay kumakatawan sa bilang ng mga milliseconds na lumipas mula Enero 1, 1970 UTC, kasunod ng RFC 3339 standard. Halimbawa, ang Biyernes, Setyembre 1, 2023 12:00:00 PM GMT ay kinakatawan bilang 1693569600000. Nalalapat ito sa lahat ng mga timestamp sa Meshy API.
Name
created_at
Type
timestamp
Description
Timestamp ng oras na nagawa ang task, sa milliseconds.
Name
expires_at
Type
timestamp
Description
Timestamp ng oras na mag-e-expire ang resulta ng task, sa milliseconds.
Name
finished_at
Type
timestamp
Description
Timestamp ng oras na natapos ang task, sa milliseconds. Kung hindi pa tapos ang task, 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. Karaniwang isa lamang na texture URL object ang laman nito. Ang bawat texture URL ay may mga sumusunod na properties:
- Name
  base_color
  Type
  string
  Description
  Downloadable URL patungo sa base color map image.
- Name
  metallic
  Type
  string
  Description
  Downloadable URL patungo sa metallic map image.
  Kung ang task ay ginawa gamit ang enable_pbr: false, aalisin ang property na ito.
- Name
  normal
  Type
  string
  Description
  Downloadable URL patungo sa normal map image.
  Kung ang task ay ginawa gamit ang enable_pbr: false, aalisin ang property na ito.
- Name
  roughness
  Type
  string
  Description
  Downloadable URL patungo sa roughness map image.
  Kung ang task ay ginawa gamit ang enable_pbr: false, aalisin ang property na ito.
- Name
  emission
  Type
  string
  Description
  Downloadable URL patungo sa emission map image.
  Kung ang task ay ginawa gamit ang enable_pbr: false, o ang ai_model ay meshy-6-lite, meshy-7.1, o latest, aalisin ang property na ito.
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. Naroroon kapag ang status ng task ay PENDING, IN_PROGRESS, o SUCCEEDED. Nagbabalik ng 0 para sa mga task na FAILED (ang mga credit ay irinereimburse kapag nabigo).

Example Multi-Image to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "multi-image-to-3d",
  "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=***",
    "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=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "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": 30,
}