Multi-Image to 3D API

Gumawa ng 3D model mula sa isa hanggang apat na larawan ng parehong bagay, na kinunan mula sa iba't ibang anggulo.

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

Create a Multi-Image to 3D task

Lumilikha ng Multi-Image to 3D task. Tumatakbo ang task sa background. Para sa karaniwang tagal ng isang task, tingnan ang Processing times. Para sa mga field na nasa isang task, tingnan ang The Multi-Image to 3D task object.

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"]
  }'

# Textured with Meshy N1 from the input images, the first as the front view
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 front view image url or base64-encoded data URI>",
      "<your back view image url or base64-encoded data URI>"
    ],
    "ai_model": "meshy-7.1",
    "texture_model": "meshy-n1"
  }'

Response

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

Mga Parameter

Name
input_task_id
Type
string
Kinakailangan
Description
Kinakailangan maliban kung magpapadala ka ng image_urls. Ang ID ng isang Text to Image o Image to Image task, kasama ang isang multi-view na task. Ginagamit ng Meshy ang isa hanggang apat nitong larawan bilang input. Dapat ang task ay isa sa ginawa mo gamit ang API at may status na SUCCEEDED.

Name
image_urls
Type
array
Kinakailangan
Description
Kinakailangan maliban kung magpapadala ka ng input_task_id. Isa hanggang apat na larawan, bawat isa bilang isang pampublikong URL o isang data URI, tulad ng data:image/jpeg;base64,<your base64-encoded image data>. Kung ipapadala mo ang dalawa, gagamitin ng Meshy ang input_task_id.
Ang bawat larawan ay dapat na isang .jpg, .jpeg, .png, o .webp na file na hindi hihigit sa 20 MB, hindi bababa sa 32 pixel sa bawat gilid, at hindi hihigit sa 178,956,970 pixel (lapad × taas). Ang paghahatid ng higit sa apat na larawan ay magbabalik ng 400.
Para sa pinakamahusay na resulta, dapat ipakita ng mga larawan ang parehong bagay mula sa iba't ibang anggulo. Sa meshy-7.1 o latest, ginagamit ng Meshy ang unang larawan bilang front view, at hindi mahalaga ang pagkakasunud-sunod ng iba.

Name
ai_model
Type
string
default latest
Description
Ang AI model na gumagawa ng 3D model.
Mga available na value:
- latest: Meshy 7.1
- meshy-7.1
- meshy-6
- meshy-6-lite
- meshy-7: deprecated, magpadala na lang ng meshy-7.1
Name
geometry_resolution
Type
string
default standard
Description
Kung gaano karaming detalye ng heometriya ang gagawin.
Mga available na value:
- standard
- 2k: tumatakbo ang Ultra pass sa 2048³. Nangangailangan ng meshy-7.1, latest, o ang deprecated na meshy-7.
Name
ultra_mode
Type
boolean
⚠ lipas na
default false
Description
Magpadala na lang ng geometry_resolution. Ang ultra_mode: true ay kapareho ng geometry_resolution: "2k".
Name
should_texture
Type
boolean
default true
Description
Kung gagawa ng mga texture. Ang true ay nagbabalik ng isang modelong may texture, at ang false ay lumalaktaw sa hakbang ng texture at nagbabalik ng isang mesh na walang texture.

Naaangkop lamang kapag should_texture = true

Name
texture_model
Type
string
default depends on ai_model
Description
Ang AI model na nagla-texture sa 3D model mula sa ilang view, sa iisang task. Iwanan itong blangko para gamitin ang default na texture model para sa iyong ai_model. Hindi ito nagbabago sa halaga ng credits.
Mga available na value:
- meshy-7: Meshy 7, na may PBR maps at texture na hanggang 8K
- meshy-n1: Meshy N1, isang 2K na base color texture mula lamang sa mga reference na larawan
Tinatanggap ng bawat ai_model ang pareho. Ang isang textured na kahilingan na may meshy-6 o meshy-6-lite ay magbabalik ng 400, gayundin ang isang opsyon na hindi suportado ng napiling texture model. Kapag should_texture: false, hindi pinapansin ng Meshy ang texture_model, ngunit ang isang hindi kilalang value ay magbabalik pa rin ng 400.
Sa meshy-n1, nagla-texture ang Meshy mula sa texture_image_urls o texture_image_url, o mula sa mga input na larawan kapag hindi mo ipinadala ang alinman sa dalawa. Ang unang larawan ang front view. Ang isang nagawang modelo na higit sa 7,999,999 triangle ay magpapabigo sa task, at ire-refund ng Meshy ang mga credits nito.
Tingnan ang Models para sa ginagawa ng bawat texture model at kung alin ang pipiliin.
Name
enable_pbr
Type
boolean
default false
Description
Kung gagawa rin ng metallic, roughness, at normal maps, bilang karagdagan sa base color. Gumagawa rin ng emission map ang texture model ng Meshy 6, maliban sa texture_resolution: 8k. Sa texture_model: meshy-n1, ang true ay magbabalik ng 400.
Name
texture_resolution
Type
string
default 2k
Description
Ang sukat ng base color texture. Ang mas malaking sukat ay kumukuha ng mas maraming detalye sa ibabaw.
Mga available na value:
- 2k: 2048×2048
- 4k: 4096×4096
- 8k: 8192×8192
Ang 4k at 8k ay nangangailangan ng texture model na Meshy 7 o Meshy 6, at magbabalik ng 400 sa iba. Sa 8k, hindi gumagawa ang Meshy ng emission map.
Name
hd_texture
Type
boolean
⚠ lipas na
default false
Description
Magpadala na lang ng texture_resolution. Ang hd_texture: true ay kapareho ng texture_resolution: "4k". Kung ipapadala mo ang dalawa, gagamitin ng Meshy ang texture_resolution.
Name
texture_prompt
Type
string
Description
Tekstong gumagabay sa texture, hanggang 800 character. Ang mas mahabang teksto ay magbabalik ng 400. Sa texture_model: meshy-n1, ang pagpapadala nito ay magbabalik ng 400.
Name
texture_image_url
Type
string
Description
Isang 2D na larawan na gumagabay sa texture, bilang isang pampublikong URL o isang data URI, tulad ng data:image/jpeg;base64,<your base64-encoded image data>. Ang larawan ay dapat na isang .jpg, .jpeg, .png, o .webp na file na hindi hihigit sa 20 MB, hindi bababa sa 32 pixel sa bawat gilid, at hindi hihigit sa 178,956,970 pixel (lapad × taas).
Kung ipapadala mo ang parehong texture_image_url at texture_prompt, gagamitin ng Meshy ang texture_prompt. Sa texture_model: meshy-n1, nagla-texture ang Meshy mula sa larawang ito bilang front view.
Maaaring hindi maganda ang resulta ng texture kapag malaki ang pagkakaiba ng hugis sa larawan kumpara sa 3D model.
Name
texture_image_urls
Type
string[]
Description
Isa hanggang apat na larawan ng bagay mula sa iba't ibang view na gumagabay sa texture. Ginagamit ng Meshy ang unang larawan bilang front view. Hindi mahalaga ang pagkakasunud-sunod ng ibang view (left, back, right).
Ang bawat larawan ay sumusunod sa parehong patakaran gaya ng texture_image_url. Isa itong pampublikong URL o data URI, sa format na .jpg, .jpeg, .png, o .webp, na hindi hihigit sa 20 MB, hindi bababa sa 32 pixel sa bawat gilid, at hindi hihigit sa 178,956,970 pixel (lapad × taas).
Ang mga larawang ito ay gumagabay lamang sa texture at hindi nakadepende sa image_urls. Maaaring magkaiba ang nilalaman at bilang ng larawan sa dalawang listahan.
Nangangailangan ang texture_image_urls ng texture model na Meshy 7 o Meshy N1. Ipadala ito kasama ang isa sa mga sumusunod:
- ai_model na meshy-7.1, latest, o ang deprecated na meshy-7
- texture_model na meshy-7 o meshy-n1
Hindi mo ito maaaring ipadala kasama ang texture_image_url o texture_prompt.

Name
should_remesh
Type
boolean
default true (meshy-6-lite), false (other models)
Description
Kung ire-remesh ang modelo pagkatapos itong magawa. Para sa pinakamataas na kalidad ng 3D model, itakda ito sa false.

Naaangkop lamang kapag should_remesh = true

Name
topology
Type
string
default triangle
Description
Ang uri ng face ng naremesh na modelo.
Mga available na value:
- quad: isang mesh na mas maraming quad
- triangle: isang pinaliit na triangle mesh
Sa texture_model: meshy-n1, ang quad ay magbabalik ng 400 kapag naremesh ang modelo, na ginagawa ng meshy-6-lite bilang default.
Name
target_polycount
Type
integer
default 30000
Description
Ang bilang ng face na tatarget, mula 100 hanggang 300000. Maaaring magkaiba ang resulta sa target, depende sa heometriya ng modelo. Ang value na labas sa saklaw ay magbabalik ng 400.
Name
decimation_mode
Type
integer
Description
Adaptive na bilang ng face, ayon sa antas. Kapag itinakda mo ito, hindi pinapansin ng Meshy ang target_polycount.
Mga available na value:
- 1: ultra
- 2: high
- 3: medium
- 4: low
Name
save_pre_remeshed_model
Type
boolean
default false
Description
Kung ise-save rin ang GLB bago ang remesh, na ibinabalik sa model_urls.pre_remeshed_glb.

Name
symmetry_mode
Type
string
⚠ lipas na
default auto
Description
Iwanan itong blangko. Hindi nito naaapektuhan ang output.
Mga available na value:
- off: walang simetriya
- auto: simetriya batay sa input na heometriya
- on: ipinatutupad na simetriya
Name
pose_mode
Type
string
default ""
Description
Ang pose ng nagawang modelo.
Mga available na value:
- a-pose: isang A pose
- t-pose: isang T pose
- "" (walang laman na string): walang tiyak na pose
Name
is_a_t_pose
Type
boolean
⚠ lipas na
default false
Description
Magpadala na lang ng pose_mode. Kung gagawin ang modelo sa A o T pose.
Name
image_enhancement
Type
boolean
default true
Description
Kung ioo-optimize ang mga input na larawan bago gumawa. Pinapanatili ng false ang eksaktong hitsura ng mga input na larawan, nang walang pagproseso ng estilo. Suportado lamang sa meshy-6, meshy-7.1, o latest. Ang pagpapadala nito kasama ang meshy-6-lite ay magbabalik ng 400.
Name
remove_lighting
Type
boolean
default true
Description
Kung aalisin ang mga highlight at anino sa base color texture. Mas maayos ang resulta sa ilalim ng sarili mong ilaw. Ang texture model na Meshy 6 lamang ang gumagamit nito, at sa texture_resolution: 8k palagi nitong inaalis ang ilaw. Sa texture_model: meshy-n1, ang true ay magbabalik ng 400. Sa ai_model: meshy-6-lite at ang default nitong texture model, ang pagpapadala nito ay magbabalik ng 400.
Name
moderation
Type
boolean
default false
Description
Kung susuriin ang mga input para sa mapaminsalang nilalaman. Sinusuri ng Meshy ang bawat input na larawan, texture_image_url o bawat larawan sa texture_image_urls, at ang teksto sa texture_prompt. Kung may nakitang mapaminsalang nilalaman ang Meshy, magbabalik ang kahilingan ng 400 at hindi gagawa ang Meshy ng task.
Name
target_formats
Type
string[]
Description
Ang mga format ng 3D file na gagawin. Gumagawa at nagbabalik lamang ang Meshy ng mga format na nakalista mo, na maaaring magpaikli sa task.
Mga available na value:
- glb
- obj
- fbx
- stl
- usdz
- 3mf
Kung hindi mo ito isasama, gagawa ang Meshy ng bawat format maliban sa 3mf. Gumagawa lamang ang Meshy ng 3mf kapag inilista mo ito.
Name
auto_size
Type
boolean
default false
Description
Kung tatantyahin ang aktwal na taas ng bagay sa totoong mundo gamit ang AI vision at ire-resize ang modelo dito. Inilalagay ng Meshy ang origin sa ilalim maliban kung itatakda mo ang origin_at.

Naaangkop lamang kapag auto_size = true

Name
origin_at
Type
string
default bottom
Description
Kung saan ilalagay ang origin ng modelo, bottom o center.

Name
alpha_thumbnail
Type
boolean
default false
Description
Kung gagawa rin ng preview na may transparent na background (RGBA), na ibinabalik sa alpha_thumbnail_url kapag kinuha mo ang task. Hindi nagbabago ang thumbnail_url.
Name
multi_view_thumbnails
Type
boolean
default false
Description
Kung gagawa rin ng front, right, back, at left na preview, na ibinabalik sa thumbnail_urls kapag kinuha mo ang task. Hindi nagbabago ang thumbnail_url at ipinapakita pa rin nito ang front view. Nagdaragdag ito ng humigit-kumulang 5 segundo sa task.

Ibinabalik

Ang field na result ng response ay naglalaman ng ID ng bagong Multi-Image to 3D task.

Mga paraan ng pagkabigo

Name
400 - Bad Request
Description
Hindi matatakbo ang kahilingan. Sinasabi ng mensahe ng error kung anong problema ang natagpuan nito. Halimbawa:
- Nawawalang parameter: Hindi ipinadala ang alinman sa image_urls o input_task_id.
- Di-wastong input task: Ang input_task_id ay hindi isang SUCCEEDED na Text to Image o Image to Image task, o isang multi-view na task.
- Di-wastong bilang ng larawan: Ang image_urls o texture_image_urls ay hindi naglalaman ng 1 hanggang 4 na larawan.
- Di-wastong format ng larawan: Ang isang larawan sa image_urls ay wala sa isang suportadong format.
- Magkasalungat na texture input: Ipinadala ang texture_image_urls kasama ang texture_image_url, kasama ang texture_prompt, o kasama ang should_texture: false.
- Hindi suportadong model para sa multi-view texture: Ipinadala ang texture_image_urls kasama ang ai_model na meshy-6 o meshy-6-lite, maliban kung ang texture_model ay meshy-7 o meshy-n1.
- Hindi maabot na URL: Hindi ma-download ng Meshy ang isang larawan sa image_urls o texture_image_urls.
- Masyadong malaki ang larawan: Ang isang larawan sa image_urls, texture_image_url, o texture_image_urls ay lampas sa 20 MB.
- Di-wastong sukat ng larawan: Ang isang larawan sa image_urls, texture_image_url, o texture_image_urls ay may gilid na mas maikli sa 32 pixel, o higit sa 178,956,970 pixel (lapad × taas).
- Hindi suportadong resolution para sa multi-image input: Ang geometry_resolution ay "4k", na hindi suportado ng endpoint na ito. Gumamit ng 2k o standard.
- Hindi suportadong model para sa mga opsyon ng larawan: Ipinadala ang image_enhancement kasama ang ai_model: "meshy-6-lite", o ipinadala ang remove_lighting kasama ang ai_model: "meshy-6-lite" at ang default nitong texture model.
- Di-wastong texture model: Ang texture_model ay hindi isang wastong pangalan ng texture model.
- Hindi available ang texture model: Nagpadala ang isang textured na kahilingan ng texture_model na meshy-6 o meshy-6-lite. Tinatanggap lamang ng Multi-Image to 3D ang mga texture model na nagla-texture mula sa ilang view. Magpadala ng meshy-7 o meshy-n1, o iwanang blangko ang texture_model.
- Hindi suportadong opsyon para sa texture model: Humihingi ang kahilingan sa texture model ng isang opsyon na hindi nito suportado, tulad ng enable_pbr: true kasama ang meshy-n1 o isang 4k na texture kasama ang meshy-6-lite. Tingnan ang Models.
Ayusin ang kahilingan, pagkatapos ay ipadala itong muli. Tingnan ang Errors.
Name
401 - Unauthorized
Description
Nawawala o hindi valid ang API key. Suriin ang Authorization header.
Name
402 - Payment Required
Description
Halimbawa:
- Hindi sapat na credits: Walang sapat na credits ang account para sa task na ito, o naabot ng account ang isang limitasyon sa credits. Suriin ang iyong credit balance, pagkatapos ay subukan muli.
- Libreng plano: Nangangailangan ng bayad na plano para makagawa ng task. I-upgrade ang iyong plano sa iyong mga setting ng subscription, pagkatapos ay subukan muli.
Name
403 - Forbidden
Description
Hinarangan ng content moderation ang prompt o isang input na larawan. Baguhin ang input, pagkatapos ay subukan muli.
Name
404 - Not Found
Description
Ang input_task_id ay hindi tumutugma sa alinman sa iyong mga task. Suriin ang task ID, pagkatapos ay ipadala muli ang kahilingan.
Name
429 - Too Many Requests
Description
Nalagpasan mo ang iyong rate limit. Maghintay, pagkatapos ay subukan muli. Tingnan ang Rate limits.

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

Kumuha ng Multi-Image to 3D na gawain

Ibinabalik ang isang Multi-Image to 3D na gawain batay sa ID nito.

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"
    }
  ],
  "preceding_tasks": 0,
  "task_error": null,

  "consumed_credits": 30
}

Mga Parameter

Name
id
Type
path
Description
Ang task ID mula sa create response.

Ibinabalik

Ang Multi-Image to 3D task object.

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

Mag-delete ng Multi-Image to 3D task

Permanenteng nagde-delete ng Multi-Image to 3D task, kasama ang mga model at data nito. Hindi mo na maaaring i-undo ang pag-delete.

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 keeps running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}

Mga path parameter

Name
id
Type
path
Description
Ang ID ng task na ide-delete.

Status ng task

Kapag nag-delete ka ng PENDING na task, maibabalik ang mga credits na nagamit noong ginawa mo ito.

Hindi maaaring i-delete ang isang IN_PROGRESS na task. Ang request ay magbabalik ng 409 Conflict, at magpapatuloy ang task na tumatakbo. Hindi nagre-refund ang Meshy para sa isang task na nagsimula na, kaya kapag dine-delete mo ito, mawawala sa iyo ang credits at ang resulta. Hintayin itong umabot sa SUCCEEDED, FAILED, o CANCELED, bago ito i-delete.

Ang pag-delete ng task na nasa final status na (SUCCEEDED, FAILED, o CANCELED) ay hindi nagre-refund ng mga credits nito.

Mga Ibinabalik

200 OK kapag na-delete na ang task, o 409 Conflict kapag ang task ay IN_PROGRESS.

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

Ilista ang mga gawain ng Multi-Image to 3D

Ibinabalik ang listahan ng iyong mga gawain ng Multi-Image to 3D.

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"
      }
    ],
    "preceding_tasks": 0,
    "task_error": null,

    "consumed_credits": 30
  }
]

Mga Parameter

Name
page_num
Type
integer
default 1
Description
Ang numero ng pahinang ibabalik, hanggang 255. Ang mas malaking halaga ay magbabalik ng 400.
Name
page_size
Type
integer
default 10
Description
Ang bilang ng mga gawain bawat pahina, hanggang 100.
Name
sort_by
Type
string
Description
Ang pagkakasunod-sunod ng pag-uuri.
Mga magagamit na halaga:
- +created_at: pinakaluma muna
- -created_at: pinakabago muna

Ibinabalik

Isang paginated na listahan ng mga Multi-Image to 3D task object.

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

I-stream ang isang Multi-Image to 3D na gawain

Nagsa-stream ng mga update ng isang Multi-Image to 3D na gawain bilang Server-Sent Events (SSE).

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.
// These examples are shortened. Each event holds the full task object.
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "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"
    }
  ],
  "preceding_tasks": 0,
  "task_error": null,

  "consumed_credits": 30
}

Mga Parameter

Name
id
Type
path
Description
Ang task ID mula sa create na tugon.

Ibinabalik

Isang stream ng Multi-Image to 3D task objects bilang Server-Sent Events.

Bawat event ay naglalaman ng buong task object, sa parehong anyo na ibinabalik ng Get endpoint. Habang ang gawain ay PENDING o IN_PROGRESS, wala pang mga value ang mga resulta nitong field.

Ang Multi-Image to 3D na task object

Ang isang Multi-Image to 3D na task object ay naglalarawan ng isang generation ng 3D model mula sa isa hanggang apat na larawan ng isang bagay. Nilalaman nito ang status, ang progress, at ang mga model file kapag matagumpay ang task.

Mga Property

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"
    }
  ],
  "preceding_tasks": 0,
  "task_error": null,

  "consumed_credits": 30
}

Name
id
Type
string
Description
Ang task ID. Ituring itong isang opaque na string, at huwag umasa sa format nito.
Name
type
Type
string
Description
Ang uri ng task, laging multi-image-to-3d.
Name
model_urls
Type
object
Description
Mga download URL para sa nabuong 3D model, isa bawat file format. Ang isang format na hindi binuo ng task ay walang key, sa halip na isang walang-laman na string.
- Name
  glb
  Type
  string
  Description
  Ang GLB file.
- Name
  fbx
  Type
  string
  Description
  Ang FBX file.
- Name
  obj
  Type
  string
  Description
  Ang OBJ file.
- Name
  usdz
  Type
  string
  Description
  Ang USDZ file.
- Name
  mtl
  Type
  string
  Description
  Ang MTL file, ibinabalik kasama ng OBJ file kapag may mga texture ang model.
- Name
  stl
  Type
  string
  Description
  Ang STL file.
- Name
  3mf
  Type
  string
  Description
  Ang 3MF file. Naroroon lamang kapag kasama ang 3mf sa target_formats.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  Ang GLB file bago ang remesh. Naroroon lamang kapag ginawa mo ang task nang may should_remesh: true at save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Download URL para sa isang preview image ng model. Ito ay pareho sa thumbnail_urls.front kapag naroroon ang field na iyon.
Name
alpha_thumbnail_url
Type
string
Description
Download URL para sa isang bersyon ng thumbnail_url na may transparent na background (RGBA). Naroroon lamang kapag ginawa mo ang task nang may alpha_thumbnail: true at na-render ng Meshy ang transparent na preview.
Name
thumbnail_urls
Type
object
Description
Mga download URL para sa mga preview ng 3D model mula sa apat na gilid. Ang bawat isa ay isang signed URL sa isang 512×512 PNG, na na-render gamit ang parehong mga materyal at ilaw gaya ng thumbnail_url. Magagamit mo ang mga ito para i-preview ang model mula sa iba't ibang anggulo nang hindi kailangang i-download ang GLB.
Naroroon lamang kapag ginawa mo ang task nang may multi_view_thumbnails: true at umabot ang task sa SUCCEEDED. Ang isang task na ginawa nang walang multi_view_thumbnails: true ay walang field na ito.
- Name
  front
  Type
  string
  Description
  Ang front view, sa 0° sa paligid ng patayong axis. Tugma ito sa thumbnail_url.
- Name
  right
  Type
  string
  Description
  Ang right view, sa 90°.
- Name
  back
  Type
  string
  Description
  Ang back view, sa 180°.
- Name
  left
  Type
  string
  Description
  Ang left view, sa 270°.
Name
texture_prompt
Type
string
Description
Ang text prompt na gumabay sa texture.
Name
texture_image_urls
Type
string[]
Description
Mga download URL para sa mga texture reference image na ginamit mo noong ginawa mo ang task, sa pagkakasunod-sunod kung paano mo ipinadala ang mga ito. Naroroon lamang kapag ginawa mo ang task nang may texture_image_urls.
Name
ultra_mode
Type
boolean
⚠ lipas na
Description
Sa halip, tingnan ang geometry_resolution.
Name
geometry_resolution
Type
string
Description
Ang Ultra tier na tinakbo ng task, na 2k. Ang isang standard na task ay walang field na ito.
Name
progress
Type
integer
Description
Gaano karaming bahagi ng task ang tapos na, bilang isang porsyento. Ito ay 0 hanggang magsimula ang task at 100 kapag ito ay matagumpay.
Name
started_at
Type
timestamp
Description
Oras na nagsimula ang task, sa Unix milliseconds. Ito ay 0 hanggang magsimula ang task.
Name
created_at
Type
timestamp
Description
Oras na nilikha ang task, sa Unix milliseconds.
Name
expires_at
Type
timestamp
Description
Oras na mag-eexpire ang mga resulta ng task, sa Unix milliseconds.
Name
finished_at
Type
timestamp
Description
Oras na natapos ang task, sa Unix milliseconds. Ito ay 0 hanggang matapos ang task.
Name
status
Type
string
Description
Ang status ng task, isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, o CANCELED.
Name
texture_urls
Type
array
Description
Mga download URL para sa mga texture map na nabuo ng task, bilang isang array ng mga object. Karaniwan itong may isang object. Ang bawat object ay may mga sumusunod na field:
- Name
  base_color
  Type
  string
  Description
  Ang base color map.
- Name
  metallic
  Type
  string
  Description
  Ang metallic map. Hindi kasama kapag ginawa mo ang task nang may enable_pbr: false.
- Name
  normal
  Type
  string
  Description
  Ang normal map. Hindi kasama kapag ginawa mo ang task nang may enable_pbr: false.
- Name
  roughness
  Type
  string
  Description
  Ang roughness map. Hindi kasama kapag ginawa mo ang task nang may enable_pbr: false.
- Name
  emission
  Type
  string
  Description
  Ang emission map. Kasama lamang kapag ginawa mo ang task nang may lahat ng mga sumusunod:
  
  ai_model: meshy-6, kasama ang default nitong texture model
  
  enable_pbr: true
  
  isang texture_resolution na 2k o 4k
Name
preceding_tasks
Type
integer
Description
Ang bilang ng mga task na nauuna sa task na ito sa queue. Makabuluhan lamang ang value habang PENDING pa ang task.
Name
task_error
Type
object
Description
Ang mga detalye ng error kapag nabigo ang task. Ito ay null maliban kung ang status ay FAILED. Tingnan ang Errors.
Name
consumed_credits
Type
integer
Description
Ang bilang ng credits na ginamit ng task. Naroroon kapag ang status ay PENDING, IN_PROGRESS, o SUCCEEDED. Ito ay 0 para sa isang FAILED na task, dahil ibinabalik ng Meshy ang mga credits kapag nabigo ang isang task.