Multi-Image to 3D API

Ang Multi-Image to 3D API ay isang feature na nagbibigay-daan sa iyo na isama ang mga kakayahan ng Multi-Image to 3D ng Meshy sa iyong sariling application. Sa seksyong ito, makikita mo ang lahat ng impormasyon na kailangan mo upang magsimula 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 upang gumawa ng bagong Multi-Image to 3D task. Sanggunian ang The Multi-Image to 3D Task Object upang makita kung aling 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 ibinigay ang dalawa, ang input_task_id ang mauuna.

Name
input_task_id
Type
string
Kinakailangan
Description
Ang ID ng isang natapos na image-generation task kung saan ang output (1-4 na larawan) ang 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 ito ay pinatakbo gamit ang 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. Kasalukuyang sinusuportahan namin ang mga format na .jpg, .jpeg, at .png. Ang lahat ng larawan ay dapat naglalarawan ng 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 data URI ng larawan. Halimbawa ng isang data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Para sa meshy-7.1 (o latest), ang unang larawan ay ginagamit bilang pangunahing (harap) na view. Ang pagkakasunod-sunod ng natitirang mga larawan ay hindi mahalaga.

Name
ai_model
Type
string
default latest
Description
ID ng modelong gagamitin.
Mga magagamit na value:
- meshy-6-lite, meshy-6, meshy-7.1, latest (Meshy 7.1)
- meshy-7 (deprecated): gamitin ang meshy-7.1 sa halip.
Name
geometry_resolution
Type
string
default standard
Description
Ang geometry generation pass. Ang 2k ay pinapatakbo ang Ultra pass sa 2048³. Nangangailangan ng meshy-7.1 o latest.
Mga magagamit na value: standard, 2k
Name
ultra_mode
Type
boolean
⚠ lipas na
default false
Description
Gamitin ang geometry_resolution sa halip. Ang ultra_mode: true ay kapareho ng geometry_resolution: "2k".
Name
should_texture
Type
boolean
default true
Description
Tinutukoy kung gagawa ng mga texture. Kapag itinakda sa false, nalalaktawan 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 ay isinasama din 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
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.1 o latest. Sa 8k, walang emission map na ginagawa.
Name
hd_texture
Type
boolean
⚠ lipas na
default false
Description
Gamitin ang texture_resolution sa halip — kapareho ng texture_resolution: "4k". Kapag itinakda ang dalawa, ang texture_resolution ang mauuna.
Name
texture_prompt
Type
string
Description
Magbigay ng text prompt upang gabayan ang proseso ng texturing. Pinakamataas na 800 na karakter.
Name
texture_image_url
Type
string
Description
Magbigay ng 2d na larawan upang gabayan ang proseso ng texturing. Kasalukuyang sinusuportahan namin 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 data URI ng larawan. Halimbawa ng isang data URI: data:image/jpeg;base64,<your base64-encoded image data>
Ang image texturing ay maaaring hindi gumana nang optimal kung mayroong 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 texturing. Kung ibinigay ang dalawang parameter, ang texture_prompt ang gagamitin 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 texturing. Ang unang larawan ay ang pangunahing (harap) na view; ang pagkakasunod-sunod ng natitirang mga view (kaliwa, likod, kanan) ay hindi mahalaga.
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 ginagabayan lamang ang texture, at hiwalay sa image_urls — ang dalawang listahan ay maaaring magkaroon ng magkaibang larawan at magkaibang bilang ng larawan.
Nangangailangan ng ai_model na meshy-7.1 o latest. Hindi maaaring pagsamahin sa 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, iminumungkahi namin na 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 magagamit na value:
- quad: Gumawa ng quad-dominant mesh.
- triangle: Gumawa ng decimated triangle mesh.
Name
target_polycount
Type
integer
default 30,000
Description
Tukuyin ang target na bilang ng polygon sa nabuong modelo. Ang aktwal na bilang ng polygon ay maaaring lumihis mula sa target depende sa pagkakumplikado ng heometriya.
Ang balidong saklaw ng value ay nag-iiba depende sa user tier:
- 100 hanggang 300,000 (kabilang)
Name
decimation_mode
Type
integer
Description
Paganahin ang adaptive decimation sa pagtatakda ng polycount level. Kapag itinakda, ang target_polycount ay hindi pinapansin.
Mga magagamit 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 isang karagdagang GLB file bago matapos ang remesh phase.

Name
symmetry_mode
Type
string
⚠ lipas na
default auto
Description
Deprecated. Ang parameter na ito ay hindi na nakakaapekto sa output.
Ang field na symmetry_mode ay kinokontrol ang gawi ng simetriya sa panahon ng proseso ng paggawa ng modelo.
Ang mga balidong value ay:
- off: Hindi paganahin ang simetriya.
- auto: Awtomatikong tinutukoy at ilalapat ang simetriya batay sa input geometry.
- on: Ipinipilit ang simetriya sa panahon ng paggawa.
Name
pose_mode
Type
string
default ""
Description
Tukuyin ang pose mode para sa nabuong modelo.
Mga magagamit na value:
- a-pose: Gumawa ng modelo sa A pose.
- t-pose: Gumawa ng modelo sa T pose.
- "" (walang laman na string): Walang tinukoy na pose na ilapat.
Name
is_a_t_pose
Type
boolean
⚠ lipas na
default false
Description
Gamitin ang pose_mode sa halip. Kung gagawa ng modelo sa A/T pose.
Name
image_enhancement
Type
boolean
default true
Description
Ina-optimize ang mga input image para sa mas magandang resulta. Itakda sa false upang panatilihin ang eksaktong hitsura ng mga input image na walang anumang style processing.
Sinusuportahan lamang kapag ang ai_model ay meshy-6, meshy-7.1 o latest.
Name
remove_lighting
Type
boolean
default true
Description
Tinatanggal ang mga highlight at shadow mula sa base color texture, na nagbubunga ng mas malinis na resulta na gumagana nang mas mahusay sa ilalim ng custom na setup ng ilaw.
Sinusuportahan lamang kapag ang ai_model ay meshy-6, meshy-7.1 o latest.
Name
moderation
Type
boolean
default false
Description
Kapag itinakda sa true, ang input content ay awtomatikong sususuriin para sa potensyal na nakakapinsalang content. Kung matukoy ang nakakapinsalang content, hindi magpapatuloy ang task sa generation.
Ang bawat larawan mula sa image_urls at ang teksto mula sa texture_prompt ay susuriin.
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 makapagbawas sa oras ng pagkumpleto ng task.
Mga magagamit na value: glb, obj, fbx, stl, usdz, 3mf
Kapag hindi tinukoy, lahat ng format maliban sa 3mf ang gagawin. Ang 3mf ay isasama lamang 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 bagay at i-resize ang 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, ang task ay bukod pa naman ay maglalarawan ng bersyon na may transparent-background (RGBA) ng preview at ibabalik ito bilang alpha_thumbnail_url sa GET response. Ang umiiral nang field na thumbnail_url ay hindi nagbabago.
Name
multi_view_thumbnails
Type
boolean
default false
Description
Kapag itinakda sa true, ang task ay bukod pa naman ay maglalarawan ng apat na cardinal-view thumbnail (harap, kanan, likod, kaliwa) at ibabalik ang mga ito sa ilalim ng thumbnail_urls sa GET response. Ang umiiral nang field na thumbnail_url ay hindi nagbabago at patuloy na nagtuturo sa front view, kaya't hindi apektado ang mga umiiral nang 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. Mga magagamit na value: bottom, center.

Mga Ibinabalik

Ang property na result ng response ay naglalaman ng id ng task ng bagong nagawang Multi-Image to 3D task.

Mga Mode ng Pagkabigo

Name
400 - Bad Request
Description
Ang request ay hindi katanggap-tanggap. Karaniwang mga dahilan:
- Nawawalang parameter: Ang image_urls o input_task_id ay dapat ibigay.
- Di-balidong input task: Ang input_task_id ay dapat tumukoy sa isang SUCCEEDED na Text to Image, Image to Image, o multi-view variant task.
- Di-balidong bilang ng larawan: Ang image_urls ay dapat may 1 hanggang 4 na larawan, at ang texture_image_urls ay 1 hanggang 4.
- Di-balidong format ng larawan: Isa o higit pang mga larawan sa image_urls ay hindi suportadong format.
- Nagkakasalungatang texture input: Ang texture_image_urls ay hindi maaaring pagsamahin sa 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 elemento ng image_urls o texture_image_urls ay hindi ma-download.
- Hindi suportadong resolution para sa multi-image input: Ang geometry_resolution: "4k" ay hindi magagamit sa endpoint na ito; gamitin ang 2k o standard.
Name
401 - Unauthorized
Description
Nabigo ang authentication. Pakisuri ang iyong API key.
Name
402 - Payment Required
Description
Kulang na credits upang isagawa ang task na ito.
Name
429 - Too Many Requests
Description
Lumagpas ka na sa 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 Detalye ng Multi-Image to 3D Task

Ginagamit ang endpoint na ito upang kunin ang detalye ng 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 anong mga properties ang kasama sa Multi-Image to 3D task object.

Mga Parameter

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

Mga Ibinabalik na Halaga

Ang tugon ay naglalaman ng Multi-Image to 3D task object. Tingnan ang The Multi-Image to 3D Task Object na seksyon 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

Mag-delete ng Multi-Image to 3D Task

Ang endpoint na ito ay permanenteng nagde-delete ng isang Multi-Image to 3D task, kasama na ang lahat ng kaugnay na models at data. Ang aksyong ito ay hindi na maaaring i-reverse.

Path Parameters

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

Status ng Task

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

Ang isang task na IN_PROGRESS na ay hindi maaaring i-delete: ang request ay tatanggihan na may 409 Conflict at magpapatuloy pa ring tumakbo ang task. Ang mga credits para sa isang task na sinimulan na ng worker ay hindi na maaaring i-refund, kaya ang pagde-delete nito habang kasalukuyang tumatakbo ay magiging dahilan para mawala sa iyo ang credits at ang resulta. Hintayin na maabot nito ang SUCCEEDED, FAILED o CANCELED, bago ito i-delete.

Ang isang task na nasa terminal state (SUCCEEDED, FAILED o CANCELED) ay dine-delete 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

List Multi-Image to 3D Tasks

Ginagamit ang endpoint na ito para kumuha ng listahan ng mga Multi-Image to 3D na tasks.

Mga Parameter

Opsyonal na mga attribute

Name
page_num
Type
integer
Description
Numero ng page para sa pagination. Nagsisimula at defaults sa 1.
Name
page_size
Type
integer
Description
Limitasyon ng laki ng page. Defaults sa 10 na items. Ang maximum na pinapayagan ay 100 na items.
Name
sort_by
Type
string
Description
Field na gagamitin sa pag-sort. Mga available na value:
- +created_at: Isort ayon sa oras ng paggawa nang ascending.
- -created_at: Isort ayon sa oras ng paggawa nang descending.

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

I-stream ang Multi-Image to 3D Task

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

Mga Parameter

Name
id
Type
path
Description
Ang natatanging identifier ng Multi-Image to 3D task na iistream.

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 maglalaman lamang ng mga kinakailangang 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 upang makagawa ng 3d model mula sa maraming larawan (mula 1 hanggang 4 na kasama). Dapat ang mga larawan ay ng parehong bagay, mas mainam kung mula sa iba't ibang view o anggulo. Ang object ay may mga sumusunod na properties:

Properties

Name
id
Type
string
Description
Natatanging identifier para sa task. Bagaman gumagamit kami ng k-sortable UUID para sa mga task id bilang implementation detail, hindi dapat kayo gumawa ng anumang pagpapalagay 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 may texture na 3D model file na ginawa ng Meshy. Aalisin ang property para sa isang format kung hindi ito 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, 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. Naroroon lamang kapag hiniling ang 3mf sa pamamagitan ng target_formats.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  Downloadable URL sa orihinal na GLB output bago ang remeshing.
  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 sa thumbnail image ng model file. Katumbas ng thumbnail_urls.front kapag naroroon, iniingatan para sa backwards compatibility.
Name
alpha_thumbnail_url
Type
string
Description
Downloadable URL sa isang bersyon na may transparent na background (RGBA) ng thumbnail_url. Naroroon lamang kapag ang task ay ginawa gamit ang alpha_thumbnail: true at matagumpay na na-render ang transparent na 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. Bawat value ay isang signed URL sa isang 512×512 PNG na na-render gamit ang parehong mga materyales at ilaw tulad ng thumbnail_url. Kapaki-pakinabang para sa pag-preview ng model mula sa maraming anggulo sa batch pipelines nang hindi kailangang i-download ang GLB.
Naroroon 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° na pag-ikot sa paligid ng vertical axis (katugma ng thumbnail_url).
- Name
  right
  Type
  string
  Description
  Right view, 90° na pag-ikot.
- Name
  back
  Type
  string
  Description
  Back view, 180° na pag-ikot.
- Name
  left
  Type
  string
  Description
  Left view, 270° na pag-ikot.
Name
texture_prompt
Type
string
Description
Ang text prompt na ginamit upang gabayan ang proseso ng texturing.
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 pagkakabigay nito. Naroroon lamang kapag ang task ay ginawa gamit ang texture_image_urls.
Name
ultra_mode
Type
boolean
⚠ lipas na
Description
Deprecated na; basahin sa halip 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 kung kailan sinimulan ang task, sa milliseconds. Kung hindi pa nasisimulan ang task, ang property na ito ay magiging 0.
Ang isang timestamp ay kumakatawan sa bilang ng mga milliseconds na lumipas mula Enero 1, 1970 UTC, alinsunod sa RFC 3339 standard. Halimbawa, ang Biyernes, Setyembre 1, 2023 12:00:00 PM GMT ay kinakatawan bilang 1693569600000. Ito ay naaangkop 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 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. Karaniwan itong naglalaman lamang ng isang texture URL object. Bawat texture URL ay may mga sumusunod na 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 ginawa gamit ang enable_pbr: false, aalisin ang property na ito.
- Name
  normal
  Type
  string
  Description
  Downloadable URL 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 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 sa emission map image.
  Kung ang task ay ginawa gamit ang enable_pbr: false, o meshy-6-lite ang ai_model, 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 FAILED na task (ang credits ay ire-refund 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,
}