Image to 3D API

Ang Image to 3D API ay isang feature na nagbibigay-daan sa iyo na i-integrate ang mga kakayahan ng Meshy sa Image to 3D sa sarili mong aplikasyon. Sa seksyong ito, makikita mo ang lahat ng impormasyong kailangan mo upang makapagsimula sa API na ito.

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

Create an Image to 3D Task

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

Mga Parameter

Isa lamang sa input_task_id o image_url ang kinakailangan. Kung ibinigay ang dalawa, ang input_task_id ang mananaig.

Name
input_task_id
Type
string
Kinakailangan
Description
Ang ID ng isang natapos na image-generation task na dapat gamitin ang output nito bilang input image. Ang task na ito ay dapat isa sa mga sumusunod na task: Text to Image o Image to Image. Bukod pa rito, dapat itong pinatakbo gamit ang API, may status ng SUCCEEDED, at gumagawa ng eksaktong isang imahe.

Name
image_url
Type
string
Kinakailangan
Description
Magbigay ng imahe para gamitin ng Meshy sa paggawa ng model. Kasalukuyang suportado namin ang mga format na .jpg, .jpeg, at .png.
May dalawang paraan upang magbigay ng imahe:
- Publicly accessible URL: Isang URL na naa-access mula sa pampublikong internet.
- Data URI: Isang base64-encoded data URI ng imahe. Halimbawa ng data URI: data:image/jpeg;base64,<your base64-encoded image data>.

Name
model_type
Type
string
default standard
Description
Tukuyin ang uri ng 3D mesh generation.
Mga magagamit na value:
- standard: Regular na high-detail na 3D mesh generation.
- smart-topology: Pumili ng Smart Topology model gamit ang ai_model (meshy-t2).
- lowpoly (deprecated): Gumagawa ng low-poly mesh na na-optimize para sa mas malinis na polygons. Inirerekomenda naming gamitin ang smart-topology sa halip.
Kapag pinili ang smart-topology, hindi pinapansin ang topology, should_remesh, at save_pre_remeshed_model.
Kapag pinili ang lowpoly, hindi pinapansin ang ai_model, topology, target_polycount, should_remesh, at save_pre_remeshed_model.
Name
ai_model
Type
string
default latest
Description
ID ng model na gagamitin. Ang mga magagamit na value ay depende sa model_type.
Standard generation (model_type: standard):
- meshy-6-lite, meshy-6, meshy-7.1, latest (Meshy 7.1)
- meshy-7 (deprecated): gamitin ang meshy-7.1 sa halip.
Smart Topology generation (model_type: smart-topology):
- meshy-t2 (default): ang Smart Topology model — mas malinis na topology, likas na hiwalay na mga parte, triangle output, at isang bilang ng face na maitatakda mo gamit ang target_polycount.
Name
geometry_resolution
Type
string
default standard
Description
Geometry generation pass. Pinapatakbo ng 2k ang Ultra pass sa 2048³; pinapatakbo ito ng 4k sa 4096³ para sa pinakamainam na detalye ng ibabaw.
Mga magagamit na value: standard, 2k, 4k
Nangangailangan ng meshy-7.1 o latest.
Name
ultra_mode
Type
boolean
⚠ lipas na
default false
Description
Gamitin ang geometry_resolution sa halip. Ang ultra_mode: true ay katumbas ng geometry_resolution: "2k".
Name
should_texture
Type
boolean
default true
Description
Tinutukoy kung gagawa ng mga texture. Ang pagtatakda nito sa false ay lalaktawan 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 kasama rin 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
Base color texture resolution. Isa sa 2k (2048×2048), 4k (4096×4096), o 8k (8192×8192). Ang mas mataas na resolution ay kumukuha ng mas maraming detalye ng ibabaw.
Ang 4k at 8k ay hindi magagamit sa ai_model na meshy-6-lite. Sa 8k, walang emission map na ginagawa.
Name
hd_texture
Type
boolean
⚠ lipas na
default false
Description
Gamitin ang texture_resolution sa halip — katumbas ng texture_resolution: "4k". Kapag itinakda ang dalawa, mananaig ang texture_resolution.
Name
texture_prompt
Type
string
Description
Magbigay ng text prompt upang gabayan ang proseso ng texturing. Maximum na 800 na character.
Name
texture_image_url
Type
string
Description
Magbigay ng 2d na imahe upang gabayan ang proseso ng texturing. Kasalukuyang suportado namin ang mga format na .jpg, .jpeg, at .png.
May dalawang paraan upang magbigay ng imahe:
- Publicly accessible URL: Isang URL na naa-access mula sa pampublikong internet
- Data URI: Isang base64-encoded data URI ng imahe. Halimbawa ng data URI: data:image/jpeg;base64,<your base64-encoded image data>
Ang image texturing ay maaaring hindi gumana nang optimal kung may malalaking pagkakaiba sa heometriya sa pagitan ng orihinal na asset at ng na-upload na imahe. Isa lamang sa texture_image_url o texture_prompt ang maaaring gamitin upang gabayan ang proseso ng texturing. Kung ibinigay ang dalawang parameter, gagamitin ang texture_prompt bilang default upang i-texture ang model. Ang texturing sa pamamagitan ng teksto o imahe ay magkakaltas ng 10 credits kada task.

Name
should_remesh
Type
boolean
default false (Meshy 6 and Meshy 7 models), true (others)
Description
Kinokontrol kung papaganahin ang remesh phase. Para sa pinakamataas na kalidad ng model, inirerekomenda naming itakda ang should_remesh sa false.

Naaangkop lamang kapag should_remesh = true

Name
topology
Type
string
default triangle
Description
Tukuyin ang topology ng nabuong model.
Mga magagamit na value:
- quad: Gumawa ng quad-dominant mesh.
- triangle: Gumawa ng decimated triangle mesh.
Name
decimation_mode
Type
integer
Description
Paganahin ang adaptive decimation sa pagtakda ng antas ng polycount. Kapag itinakda, hindi pinapansin ang target_polycount.
Mga magagamit na value:
- 1: Adaptive — ultra polycount.
- 2: Adaptive — mataas na polycount.
- 3: Adaptive — katamtamang polycount.
- 4: Adaptive — mababang polycount.
Name
save_pre_remeshed_model
Type
boolean
default false
Description
Kapag itinakda sa true, iniimbak din ng Meshy ang isang karagdagang GLB file bago matapos ang remesh phase.

Name
target_polycount
Type
integer
Description
Target na bilang ng mga polygon (face) sa output. Ang aktwal na bilang ay maaaring lumihis mula sa target depende sa heometriya.
Ang target_polycount ay may bisa sa dalawang independiyenteng kaso:
- Remesh — kasama ang should_remesh: true sa isang standard model. Ang mesh ay ni-remesh (na-decimate) sa humigit-kumulang na bilang na ito. Sakop mula 100 hanggang 300,000, default na 30,000. Kung itinakda ang decimation_mode, ito ang mananaig at hindi pinapansin ang target_polycount.
- Smart Topology — kasama ang model_type: smart-topology at ai_model: meshy-t2. Direktang binubuo ang model sa bilang ng face na ito; hindi tumatakbo ang remesh at hindi kinakailangan ang should_remesh. Sakop mula 100 hanggang 15,000, default na 4,000.

Name
symmetry_mode
Type
string
⚠ lipas na
default auto
Description
Deprecated. Ang parameter na ito ay wala nang epekto sa output.
Ang field na symmetry_mode ay kinokontrol ang pag-uugali ng simetriya sa panahon ng proseso ng paggawa ng model.
Ang mga wastong value ay:
- off: Hindi paganahin ang simetriya.
- auto: Awtomatikong tutukuyin at ikakapit ang simetriya batay sa input geometry.
- on: Pinipilit ang simetriya sa panahon ng generation.
Name
pose_mode
Type
string
default ""
Description
Tukuyin ang pose mode para sa nabuong model.
Mga magagamit na value:
- a-pose: Gumawa ng model sa A pose.
- t-pose: Gumawa ng model sa T pose.
- "" (walang laman na string): Walang tiyak na pose na ikakapit.
Name
is_a_t_pose
Type
boolean
⚠ lipas na
default false
Description
Gamitin ang pose_mode sa halip. Kung gagawin ang model sa A/T pose.
Name
image_enhancement
Type
boolean
default true
Description
Nag-oo-optimize ng input image para sa mas magandang resulta. Itakda sa false upang panatilihin ang eksaktong hitsura ng input image nang walang anumang style processing.
Suportado lamang kapag ang ai_model ay meshy-6, meshy-7.1, o latest.
Name
remove_lighting
Type
boolean
default true
Description
Nag-aalis ng mga highlight at anino mula sa base color texture, na nagbubunga ng mas malinis na resulta na mas mainam para sa custom lighting setups.
Suportado lamang kapag ang ai_model ay meshy-6.
Name
moderation
Type
boolean
default false
Description
Kapag itinakda sa true, awtomatikong susuriin ang input content para sa posibleng nakakapinsalang content. Kung natukoy ang nakakapinsalang content, hindi magpapatuloy ang task sa generation.
Ang content mula sa image_url, texture_image_url, at texture_prompt na mga input ay susuriin.
Name
target_formats
Type
string[]
Description
Tinutukoy kung aling mga 3D file format na isasama sa output. Lalabas at gagawin lamang ang mga hiniling na format, na maaaring makapagpababa ng oras ng pagkumpleto ng task. Kapag hindi ito itinakda, lahat ng suportadong format ang isasama.
Mga magagamit na value: glb, obj, fbx, stl, usdz, 3mf
Kapag hindi itinakda, lahat ng format maliban sa 3mf ang gagawin. Ang 3mf ay isasama lamang kapag tahasang itinakda.
Name
auto_size
Type
boolean
default false
Description
Kapag itinakda sa true, gagamit ang serbisyo ng AI vision upang awtomatikong tantiyahin ang taas sa totoong mundo ng bagay at babaguhin ang sukat ng model nang naaayon. Ang origin ay magiging default sa bottom 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 isang 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 nagbabago.
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 nagbabago at patuloy na tumuturo sa front view, kaya hindi apektado ang mga umiiral na client.
Nagdaragdag ng humigit-kumulang na 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 Ibabalik

Ang result property ng response ay naglalaman ng task id ng bagong ginawang Image to 3D task.

Mga Mode ng Kabiguan

Name
400 - Bad Request
Description
Ang request ay hindi katanggap-tanggap. Karaniwang mga sanhi:
- Kulang na parameter: Dapat ibigay ang image_url o input_task_id.
- Hindi wastong input task: Ang input_task_id ay dapat tumutukoy sa isang SUCCEEDED na Text to Image o Image to Image task na gumagawa ng eksaktong isang imahe.
- Hindi wastong format ng imahe: Ang ibinigay na image_url ay hindi suportadong format (.jpg, .jpeg, .png).
- Hindi maabot na URL: Ang image_url ay hindi na-download (404 o timeout).
- Hindi wastong Data URI: Ang base64 string ay malformed.
- Hindi wastong kombinasyon ng parameter: Ang enable_pbr ay suportado lamang kapag ang should_texture ay true.
- Hindi suportadong model para sa low poly: Ang ai_model: "meshy-6-lite" ay hindi suportado sa model_type: "lowpoly".
- Hindi suportadong model para sa Ultra: Nangangailangan ang geometry_resolution ng meshy-7.1 o latest.
Name
401 - Unauthorized
Description
Nabigo ang authentication. Pakisuri ang iyong API key.
Name
402 - Payment Required
Description
Hindi sapat ang credits upang isagawa ang task na ito.
Name
429 - Too Many Requests
Description
Lumagpas ka sa iyong rate limit.

Request

POST

/openapi/v1/image-to-3d

# Simple request with required params
curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>"
  }'

# With Ultra 4K geometry, remesh, PBR, and A-pose
curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>",
    "ai_model": "meshy-7.1",
    "geometry_resolution": "4k",
    "enable_pbr": true,
    "should_remesh": true,
    "target_polycount": 100000,
    "should_texture": true,
    "pose_mode": "a-pose",
    "target_formats": ["glb"]
  }'

Response

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

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

Kunin ang Image to 3D Task

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

Mga Parameter

Name
id
Type
path
Description
Ang natatanging identifier para sa Image to 3D task na kukunin.

Ibinabalik

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

Request

GET

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

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "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/image-to-3d/:id

Burahin ang Image to 3D Task

Permanenteng binubura ng endpoint na ito ang isang Image to 3D task, kasama na ang lahat ng nauugnay na modelo at datos. Hindi na maaaring bawiin ang aksyong ito.

Path Parameters

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

Katayuan ng Task

Ang isang task na PENDING pa ay binubura at ang mga credits na nagamit sa oras ng paggawa nito ay ibinabalik (refund).

Ang isang task na IN_PROGRESS na ay hindi na maaaring burahin: ang kahilingan ay tinatanggihan gamit ang 409 Conflict at ang task ay patuloy na tatakbo. Ang mga credits para sa isang task na naisimulan na ng worker ay hindi na maaaring i-refund, kaya ang pagbura nito habang tumatakbo ay mawawalan ka ng credits at ng resulta. Hintayin munang umabot ito sa SUCCEEDED, FAILED o CANCELED, saka mo lang burahin.

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

Ibinabalik

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

Request

DELETE

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

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/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/image-to-3d

List Image to 3D Tasks

Ang endpoint na ito ay nagbibigay-daan sa iyo upang kunin ang isang listahan ng mga 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. Ang default ay 10 items. Ang maximum na pinapayagan ay 100 items.
Name
sort_by
Type
string
Description
Field na gagamitin sa pag-sort. Mga available na value:
- +created_at: Isaayos ayon sa oras ng paglikha sa ascending order.
- -created_at: Isaayos ayon sa oras ng paglikha sa descending order.

Ibinabalik

Nagbabalik ng isang pinaged na listahan ng The Image to 3D Task Objects.

Request

GET

/openapi/v1/image-to-3d

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

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "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/image-to-3d/:id/stream

I-stream ang Image to 3D Task

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

Mga Parameter

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

Mga Ibinabalik

Nagbabalik ng stream ng The 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 kinakailangang mga field na progress at status.

Request

GET

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

curl -N https://api.meshy.ai/openapi/v1/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": "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
}

The Image to 3D Task Object

Ang Image to 3D Task object ay isang unit ng trabaho na sinusubaybayan ng Meshy upang makabuo ng 3D model mula sa isang image input. Ang object na ito ay may mga sumusunod na properties:

Properties

Name
id
Type
string
Description
Natatanging identifier para sa task. Habang gumagamit kami ng k-sortable UUID para sa task ids bilang implementation detail, hindi mo dapat gawin ang anumang mga palagay tungkol sa format ng id.
Name
type
Type
string
Description
Uri ng Image to 3D task. Ang value ay image-to-3d.
Name
model_urls
Type
object
Description
Downloadable URL sa textured 3D model file na ginawa ng Meshy. Ang property para sa isang format ay tatanggalin kung ang format ay hindi ginawa sa halip na magbalik ng empty string.
- Name
  glb
  Type
  string
  Description
  Downloadable URL sa GLB file.
- Name
  fbx
  Type
  string
  Description
  Downloadable URL sa FBX file.
- Name
  obj
  Type
  string
  Description
  Downloadable URL sa OBJ file.
- Name
  usdz
  Type
  string
  Description
  Downloadable URL sa USDZ file.
- Name
  mtl
  Type
  string
  Description
  Downloadable URL sa MTL file, na ibinabalik kasama ng OBJ exports kapag may mga texture.
- Name
  stl
  Type
  string
  Description
  Downloadable URL sa STL file.
- Name
  3mf
  Type
  string
  Description
  Downloadable URL sa 3MF file. Naririto lamang kapag ang 3mf ay hiniling sa 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 should_remesh: true at save_pre_remeshed_model: true nang sabay.
Name
thumbnail_url
Type
string
Description
Downloadable URL sa thumbnail image ng model file. Katumbas ng thumbnail_urls.front kapag naroroon, itinatago para sa backwards compatibility.
Name
alpha_thumbnail_url
Type
string
Description
Downloadable URL sa isang transparent-background (RGBA) na bersyon ng thumbnail_url. Naririto lamang kapag ang task ay ginawa gamit ang alpha_thumbnail: true at matagumpay na na-render ang transparent preview; kung hindi man, tinatanggal ang field na ito.
Name
thumbnail_urls
Type
object
Description
Mga downloadable URL para sa apat na cardinal-view thumbnails ng ginawang 3D model. Ang bawat value ay isang signed URL sa isang 512×512 PNG na na-render gamit ang parehong mga materials at lighting tulad ng thumbnail_url. Kapaki-pakinabang para sa pag-preview ng model mula sa maraming anggulo sa batch pipelines nang hindi kinakailangang i-download ang GLB.
Naririto 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 maglalaman ng field na ito.
- Name
  front
  Type
  string
  Description
  Front view, 0° rotation sa vertical axis (tumutugma sa thumbnail_url).
- Name
  right
  Type
  string
  Description
  Right view, 90° rotation.
- Name
  back
  Type
  string
  Description
  Back view, 180° rotation.
- Name
  left
  Type
  string
  Description
  Left view, 270° rotation.
Name
texture_prompt
Type
string
Description
Ang text prompt na ginamit upang gabayan ang proseso ng texturing.
Name
texture_image_url
Type
string
Description
Downloadable URL sa texture image na ginamit upang gabayan ang proseso ng texturing.
Name
ultra_mode
Type
boolean
⚠ lipas na
Description
Deprecated; basahin ang geometry_resolution sa halip.
Name
geometry_resolution
Type
string
Description
Ang Ultra tier kung saan pinatakbo ang task (2k o 4k); tinatanggal para sa standard.
Name
progress
Type
integer
Description
Progress ng task. Kung hindi pa nagsisimula 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 kung kailan nagsimula ang task, sa milliseconds. Kung hindi pa nagsisimula ang task, ang property na ito ay magiging 0.
Ang isang timestamp ay kumakatawan sa bilang ng milliseconds na lumipas mula Enero 1, 1970 UTC, sinusunod ang RFC 3339 standard. Halimbawa, Biyernes, Setyembre 1, 2023 12:00:00 PM GMT ay kinakatawan bilang 1693569600000. Ito ay naaangkop sa lahat ng mga timestamp sa Meshy API.
Name
created_at
Type
timestamp
Description
Timestamp ng kung kailan ginawa ang task, sa milliseconds.
Name
expires_at
Type
timestamp
Description
Timestamp ng kung kailan mag-e-expire ang resulta ng task, sa milliseconds.
Name
finished_at
Type
timestamp
Description
Timestamp ng 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 ginawa mula sa task. Karaniwan, isa lamang ang texture URL object nito. Ang bawat texture URL ay may mga sumusunod na properties:
- 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, tinatanggal 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, tinatanggal 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, tinatanggal 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 ang ai_model ay meshy-6-lite, meshy-7.1, o latest, tinatanggal 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 bigong task. Tingnan ang Errors para sa buong reference ng task_error object.
Name
consumed_credits
Type
integer
Description
Ang bilang ng credits na ginamit ng task na ito. Naririto kapag ang status ng task ay PENDING, IN_PROGRESS, o SUCCEEDED. Nagbabalik ng 0 para sa mga FAILED na task (ang credits ay nirefund kapag nabigo).

Example Image to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "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": "",
  "texture_image_url": "",
  "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
}