Image to 3D API

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

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

Gumawa ng Image to 3D Task

Pinapayagan ka ng endpoint na ito na gumawa ng bagong Image to 3D task. Sumangguni sa Image to 3D Task Object upang makita kung aling properties ang kasama sa Image to 3D task object.

Mga Parameter

Isa lang sa input_task_id o image_url ang kinakailangan. Kung parehong ibinigay, mas may priority ang input_task_id.

Name
input_task_id
Type
string
Kinakailangan
Description
Ang ID ng isang nakumpletong image-generation task na ang output ay dapat gamitin bilang input image. Ang task na ito ay dapat isa sa mga sumusunod na task: Text to Image o Image to Image. Bukod dito, dapat itong pinatakbo sa pamamagitan ng API, may status na SUCCEEDED, at eksaktong isang image ang nagagawa.

Name
image_url
Type
string
Kinakailangan
Description
Magbigay ng image para gamitin ng Meshy sa paggawa ng model. Kasalukuyan naming sinusuportahan ang mga format na .jpg, .jpeg, at .png.
May dalawang paraan para ibigay ang image:
- URL na pampublikong naa-access: Isang URL na naa-access mula sa pampublikong internet.
- Data URI: Isang base64-encoded na data URI ng image. 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 available na value:
- standard: Regular na high-detail na 3D mesh generation.
- lowpoly: Bumubuo ng low-poly mesh na optimized para sa mas malilinis na polygon.
Kapag pinili ang lowpoly, hindi papansinin ang ai_model, topology, target_polycount, should_remesh, save_pre_remeshed_model.
Name
ai_model
Type
string
default latest
Description
ID ng model na gagamitin. Mga available na value: meshy-5, meshy-6, latest (Meshy 6).
Name
should_texture
Type
boolean
default true
Description
Tinutukoy kung bubuuin ang mga texture. Kapag itinakda ito sa false, nilalaktawan ang texture phase, na nagbibigay ng mesh na walang mga texture.

Naaangkop lamang kapag should_texture = true

Name
enable_pbr
Type
boolean
default false
Description
Bumuo ng PBR maps (metallic, roughness, normal) bilang karagdagan sa base color. Kasama rin ang emission map kapag ang ai_model ay meshy-6 o latest.
Name
hd_texture
Type
boolean
default false
Description
Bumuo ng base color texture sa 4K (4096×4096) resolution para sa mas mataas na detalye.
Sinusuportahan lang kapag ang ai_model ay meshy-6 o latest. Palaging binubuo ang PBR maps sa 2K.
Name
texture_prompt
Type
string
Description
Magbigay ng text prompt upang gabayan ang proseso ng texturing. Maximum na 600 character.
Name
texture_image_url
Type
string
Description
Magbigay ng 2d image upang gabayan ang proseso ng texturing. Kasalukuyan naming sinusuportahan ang mga format na .jpg, .jpeg, at .png.
May dalawang paraan para ibigay ang image:
- URL na pampublikong naa-access: Isang URL na naa-access mula sa pampublikong internet
- Data URI: Isang base64-encoded na data URI ng image. Halimbawa ng data URI: data:image/jpeg;base64,<your base64-encoded image data>
Maaaring hindi gumana nang optimal ang image texturing kung may malalaking pagkakaiba sa heometriya sa pagitan ng orihinal na asset at ng na-upload na image. Isa lang sa texture_image_url o texture_prompt ang maaaring gamitin upang gabayan ang proseso ng texturing. Kung parehong ibinigay ang mga parameter, gagamitin ang texture_prompt para i-texture ang model bilang default. Ang texturing sa pamamagitan ng text o image ay magkakahalaga ng 10 credits bawat task.

Name
should_remesh
Type
boolean
default false (meshy-6), true (others)
Description
Kinokontrol kung ie-enable ang remesh phase. Kapag itinakda sa false, ibinabalik ng API ang triangular mesh na may pinakamataas na precision.

Naaangkop lamang kapag should_remesh = true

Name
topology
Type
string
default triangle
Description
Tukuyin ang topology ng nabuong model.
Mga available na value:
- quad: Bumuo ng quad-dominant mesh.
- triangle: Bumuo ng decimated na triangle mesh.
Name
target_polycount
Type
integer
default 30,000
Description
Tukuyin ang target na bilang ng mga polygon sa nabuong model. Maaaring lumihis ang aktuwal na bilang ng mga polygon mula sa target depende sa complexity ng heometriya.
Nag-iiba ang valid na value range depende sa user tier:
- 100 hanggang 300,000 (kasama)
Name
decimation_mode
Type
integer
Description
I-enable ang adaptive decimation sa pamamagitan ng pagtatakda ng polycount level. Kapag itinakda, hindi papansinin ang target_polycount.
Mga available na value:
- 1: Adaptive — ultra polycount.
- 2: Adaptive — high polycount.
- 3: Adaptive — medium polycount.
- 4: Adaptive — low polycount.
Name
save_pre_remeshed_model
Type
boolean
default false
Description
Kapag itinakda sa true, nag-i-store din ang Meshy ng karagdagang GLB file bago makumpleto ang remesh phase.

Name
symmetry_mode
Type
string
⚠ lipas na
default auto
Description
Deprecated. Hindi na naaapektuhan ng parameter na ito ang output.
Kinokontrol ng symmetry_mode field ang gawi ng simetriya habang isinasagawa ang proseso ng model generation.
Ang mga valid na value ay:
- off: Dini-disable ang simetriya.
- auto: Awtomatikong tinutukoy at inilalapat ang simetriya batay sa input heometriya.
- on: Ipinapatupad ang simetriya habang nagge-generate.
Name
pose_mode
Type
string
default ""
Description
Tukuyin ang pose mode para sa nabuong model.
Mga available na value:
- a-pose: Bumuo ng model sa A pose.
- t-pose: Bumuo ng model sa T pose.
- "" (empty string): Walang partikular na pose na inilapat.
Name
is_a_t_pose
Type
boolean
⚠ lipas na
default false
Description
Gamitin ang pose_mode sa halip. Kung bubuuin ba ang model sa A/T pose.
Name
image_enhancement
Type
boolean
default true
Description
Ino-optimize ang input image para sa mas magagandang resulta. Itakda sa false upang panatilihin ang eksaktong hitsura ng input image nang walang anumang style processing.
Sinusuportahan lang kapag ang ai_model ay meshy-6 o latest.
Name
remove_lighting
Type
boolean
default true
Description
Tinatanggal ang mga highlight at shadow mula sa base color texture, na nagbubunga ng mas malinis na resulta na mas gumagana sa ilalim ng mga custom lighting setup.
Sinusuportahan lang kapag ang ai_model ay meshy-6 o latest.
Name
moderation
Type
boolean
default false
Description
Kapag itinakda sa true, awtomatikong isasailalim sa screening ang input content para sa potensyal na nakakapinsalang content. Kung may matukoy na nakakapinsalang content, hindi magpapatuloy ang task sa generation.
Isasailalim sa screening ang content mula sa mga input na image_url, texture_image_url, at texture_prompt.
Name
target_formats
Type
string[]
Description
Tinutukoy kung aling mga 3D file format ang isasama sa output. Tanging ang mga hiniling na format lang ang bubuuin at ibabalik, na maaaring magpababa ng oras ng pagkumpleto ng task. Kapag hindi inilagay, isinasama ang lahat ng sinusuportahang format.
Mga available na value: glb, obj, fbx, stl, usdz, 3mf
Kapag hindi inilagay, binubuo ang lahat ng format maliban sa 3mf. Isinasama lang ang 3mf kapag tahasang tinukoy.
Name
auto_size
Type
boolean
default false
Description
Kapag itinakda sa true, gumagamit ang service ng AI vision upang awtomatikong tantiyahin ang aktuwal na taas ng object sa totoong mundo at i-resize ang model nang naaayon. Magde-default ang origin sa bottom maliban kung tahasang itinakda ang origin_at.
Name
alpha_thumbnail
Type
boolean
default false
Description
Kapag itinakda sa true, nagre-render din ang task ng transparent-background (RGBA) na bersyon ng preview at ibinabalik ito bilang alpha_thumbnail_url sa GET response. Hindi nagbabago ang umiiral na thumbnail_url field.
Name
multi_view_thumbnails
Type
boolean
default false
Description
Kapag itinakda sa true, nagre-render din ang task ng apat na cardinal-view thumbnail (front, right, back, left) at ibinabalik ang mga ito sa ilalim ng thumbnail_urls sa GET response. Hindi nagbabago ang umiiral na thumbnail_url field at patuloy itong tumuturo sa front view, kaya hindi maaapektuhan ang mga umiiral na client.
Nagdaragdag ng humigit-kumulang 3 segundo sa task latency.

Naaangkop lamang kapag auto_size = true

Name
origin_at
Type
string
default bottom
Description
Posisyon ng origin kapag naka-enable ang auto_size.
Mga available na value: bottom, center.

Mga Ibinabalik

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

Mga Mode ng Pagkabigo

Name
400 - Bad Request
Description
Hindi katanggap-tanggap ang request. Mga karaniwang sanhi:
- Nawawalang parameter: Dapat ibigay ang alinman sa image_url o input_task_id.
- Invalid na input task: Dapat tumukoy ang input_task_id sa isang SUCCEEDED Text to Image o Image to Image task na eksaktong isang image ang ginagawa.
- Invalid na image format: Ang ibinigay na image_url ay hindi sinusuportahang format (.jpg, .jpeg, .png).
- Hindi maabot na URL: Hindi ma-download ang image_url (404 o timeout).
- Invalid na Data URI: Mali ang pagkaka-form ng base64 string.
- Invalid na kombinasyon ng parameter: Sinusuportahan lang ang enable_pbr kapag true ang should_texture.
Name
401 - Unauthorized
Description
Nabigo ang authentication. Pakisuri ang iyong API key.
Name
402 - Payment Required
Description
Hindi sapat ang credits para isagawa ang task na ito.
Name
429 - Too Many Requests
Description
Nalampasan mo na ang iyong rate limit.

Request

POST

/openapi/v1/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 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>",
    "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 isang Image to 3D Task

Pinapayagan ka ng endpoint na ito na kunin ang isang Image to 3D task gamit ang valid na task id. Sumangguni sa Object ng Image to 3D Task upang makita kung aling mga property ang kasama sa object ng Image to 3D task.

Mga Parameter

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

Mga Ibinabalik

Naglalaman ang response ng object ng Image to 3D task. Tingnan ang seksyong Object ng Image to 3D Task 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 isang Image to 3D Task

Permanenteng binubura ng endpoint na ito ang isang Image to 3D task, kabilang ang lahat ng nauugnay na modelo at data. Hindi na maibabalik ang pagkilos na ito.

Mga Path Parameter

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

Ibinabalik

Nagbabalik ng 200 OK kapag matagumpay.

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

// Returns 200 Ok on success.

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

Ilista ang mga Image to 3D Task

Pinapayagan ka ng endpoint na ito na kunin ang 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 sa laki ng pahina. Nagde-default sa 10 item. Ang maximum na pinapayagan ay 50 item.
Name
sort_by
Type
string
Description
Field na pag-uuriin ayon dito. Mga available na value:
- +created_at: Pag-uri-uriin ayon sa oras ng paggawa sa pataas na ayos.
- -created_at: Pag-uri-uriin ayon sa oras ng paggawa sa pababang ayos.

Mga Ibinabalik

Nagbabalik ng naka-pagination na listahan ng Mga Image to 3D Task Object.

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

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

Mga Parameter

Name
id
Type
path
Description
Natatanging identifier para sa 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, isasama lang ng response stream ang 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
}

Ang Image to 3D Task Object

Ang Image to 3D Task object ay isang work unit na sinusubaybayan ng Meshy upang bumuo ng 3D model mula sa input na image. Ang object ay may mga sumusunod na property:

Mga Property

Name
id
Type
string
Description
Natatanging identifier para sa task. Bagama't gumagamit kami ng k-sortable UUID para sa mga task id bilang detalye ng implementasyon, hindi ka dapat gumawa ng anumang palagay tungkol sa format ng id.
Name
type
Type
string
Description
Uri ng Image to 3D task. Ang value ay image-to-3d.
Name
model_urls
Type
object
Description
Nada-download na URL patungo sa textured 3D model file na ginawa ng Meshy. Ang property para sa isang format ay aalisin kung hindi nabuo ang format sa halip na magbalik ng empty string.
- Name
  glb
  Type
  string
  Description
  Nada-download na URL patungo sa GLB file.
- Name
  fbx
  Type
  string
  Description
  Nada-download na URL patungo sa FBX file.
- Name
  obj
  Type
  string
  Description
  Nada-download na URL patungo sa OBJ file.
- Name
  usdz
  Type
  string
  Description
  Nada-download na URL patungo sa USDZ file.
- Name
  mtl
  Type
  string
  Description
  Nada-download na URL patungo sa MTL file, na ibinabalik kasama ng mga OBJ export kapag may mga texture.
- Name
  stl
  Type
  string
  Description
  Nada-download na URL patungo sa STL file.
- Name
  3mf
  Type
  string
  Description
  Nada-download na URL patungo sa 3MF file. Naroroon lamang kapag hiniling ang 3mf sa pamamagitan ng target_formats.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  Nada-download na URL patungo sa orihinal na GLB output bago ang remeshing.
  Available lamang kapag ginawa ang task gamit ang parehong should_remesh: true at save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Nada-download na URL patungo sa thumbnail image ng model file. Katumbas ng thumbnail_urls.front kapag naroroon, pinananatili para sa backwards compatibility.
Name
alpha_thumbnail_url
Type
string
Description
Nada-download na URL patungo sa transparent-background (RGBA) na bersyon ng thumbnail_url. Naroroon lamang kapag ginawa ang task gamit ang alpha_thumbnail: true at matagumpay na na-render ang transparent preview; kung hindi, inaalis ang field na ito.
Name
thumbnail_urls
Type
object
Description
Mga nada-download na URL para sa apat na cardinal-view thumbnail ng nabuong 3D model. Ang bawat value ay isang signed URL patungo sa 512×512 PNG na na-render gamit ang parehong materials at lighting tulad ng thumbnail_url. Kapaki-pakinabang para sa pag-preview ng model mula sa maraming anggulo sa mga batch pipeline nang hindi dina-download ang GLB.
Naroroon lamang kapag ginawa ang task gamit ang multi_view_thumbnails: true at umabot na sa SUCCEEDED. Hindi isasama ng mga mas lumang task at mga task na ginawa nang walang opt-in ang field na ito.
- Name
  front
  Type
  string
  Description
  Front view, 0° rotation sa paligid ng vertical axis (tumutugma sa thumbnail_url).
- Name
  right
  Type
  string
  Description
  Right view, 90° rotation.
- Name
  back
  Type
  string
  Description
  Back view, 180° rotation.
- Name
  left
  Type
  string
  Description
  Left view, 270° rotation.
Name
texture_prompt
Type
string
Description
Ang text prompt na ginamit upang gabayan ang proseso ng paglalagay ng texture.
Name
texture_image_url
Type
string
Description
Nada-download na URL patungo sa texture image na ginamit upang gabayan ang proseso ng paglalagay ng texture.
Name
progress
Type
integer
Description
Progress ng task. Kung hindi pa nagsisimula ang task, ang property na ito ay magiging 0. Kapag nagtagumpay na ang task, magiging 100 ito.
Name
started_at
Type
timestamp
Description
Timestamp kung kailan nagsimula ang task, sa milliseconds. Kung hindi pa nagsisimula ang task, ang property na ito ay magiging 0.
Ang timestamp ay kumakatawan sa bilang ng milliseconds na lumipas mula Enero 1, 1970 UTC, na sumusunod sa RFC 3339 standard. Halimbawa, ang Biyernes, Setyembre 1, 2023 12:00:00 PM GMT ay kinakatawan bilang 1693569600000. Nalalapat ito sa lahat ng timestamp sa Meshy API.
Name
created_at
Type
timestamp
Description
Timestamp kung kailan ginawa 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 mga texture URL object na nabuo mula sa task. Karaniwan, naglalaman lamang ito ng isang texture URL object. Ang bawat texture URL ay may mga sumusunod na property:
- Name
  base_color
  Type
  string
  Description
  Nada-download na URL patungo sa base color map image.
- Name
  metallic
  Type
  string
  Description
  Nada-download na URL patungo sa metallic map image.
  Kung ginawa ang task gamit ang enable_pbr: false, aalisin ang property na ito.
- Name
  normal
  Type
  string
  Description
  Nada-download na URL patungo sa normal map image.
  Kung ginawa ang task gamit ang enable_pbr: false, aalisin ang property na ito.
- Name
  roughness
  Type
  string
  Description
  Nada-download na URL patungo sa roughness map image.
  Kung ginawa ang task gamit ang enable_pbr: false, aalisin ang property na ito.
- Name
  emission
  Type
  string
  Description
  Nada-download na URL patungo sa emission map image.
  Kung ginawa ang task gamit ang enable_pbr: false, o ang ai_model ay meshy-5, aalisin ang property na ito.
Name
preceding_tasks
Type
integer
Description
Ang bilang ng mga naunang task.
Makabuluhan lamang ang value ng field na ito 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 nakonsumo ng task na ito. Naroroon kapag ang status ng task ay PENDING, IN_PROGRESS, o SUCCEEDED. Nagbabalik ng 0 para sa mga FAILED task (ibinabalik ang credits 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
}