Image to 3D API

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

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

Lumikha ng Image to 3D Task

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

Mga Parameter

Isa lang sa input_task_id o image_url ang kailangan. Kung ang parehong ibibigay, input_task_id ang may prayoridad.

Name
input_task_id
Type
string
Kinakailangan
Description
Ang ID ng isang na-kumpletong task ng image-generation na dapat gamitin bilang input image. Ang task na ito ay dapat isa sa sumusunod na mga task: Text to Image o Image to Image. Bukod pa rito, ito ay dapat tumakbo sa pamamagitan ng API, may status na SUCCEEDED, at makagawa ng eksaktong isang imahe.

Name
image_url
Type
string
Kinakailangan
Description
Magbigay ng isang imahe para gamitin ng Meshy sa paggawa ng modelo. Sinusuportahan namin ang mga format na .jpg, .jpeg, at .png sa ngayon.
May dalawang paraan upang magbigay ng imahe:
- Publicly accessible URL: Isang URL na maaring ma-access mula sa pampublikong internet.
- Data URI: Isang base64-encoded na data URI ng imahe. Halimbawa ng isang 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 halaga:
- standard: Pamantayang mataas na detalyadong 3D mesh generation.
- smart-topology: Piliin ang modelo ng Smart Topology kasama ang ai_model (meshy-t1 o meshy-t2).
- lowpoly (deprecated): Nag-generate ng low-poly na mesh na na-optimize para sa mas malinis na polygon. Inirerekomenda namin ang paggamit ng smart-topology sa halip.
Kapag napili ang smart-topology, ang topology, should_remesh, at save_pre_remeshed_model ay hindi pinapansin.
Kapag napili ang lowpoly, ang ai_model, topology, target_polycount, should_remesh, at save_pre_remeshed_model ay hindi pinapansin.
Name
ai_model
Type
string
default latest
Description
ID ng modelong gagamitin. Ang mga available na halaga ay nakadepende sa model_type.
Standard generation (model_type: standard):
- meshy-5, meshy-6, meshy-7, latest (Meshy 7)
Smart Topology generation (model_type: smart-topology):
- meshy-t2 (default, recommended): ang modelo ng Smart Topology — mas malinis na topology, natively separated parts, triangle output, at isang face count na maari mong itakda sa target_polycount.
- meshy-t1: ang lumang low-poly model; hindi sinusuportahan ang pagtatakda ng face count gamit ang target_polycount.
Name
ultra_mode
Type
boolean
default false
Description
Pinapagana ang Ultra generation para sa mas mataas na kalidad na heometriya na may mas pinong detalye sa ibabaw.
Sinusuportahan lamang kapag ang ai_model ay meshy-7 (o latest).
Name
should_texture
Type
boolean
default true
Description
Tinutukoy kung ang mga texture ay dapat na i-generate. Kung itatakda sa false, liliptan ang texture phase, magbibigay ng mesh na walang mga 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 rin ay kasama kapag ang ai_model ay meshy-6, maliban kapag texture_resolution: 8k. Ang meshy-7 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 tumutukoy ng mas maraming detalye sa ibabaw.
Ang 4k at 8k ay hindi available sa ai_model: meshy-5. Kapag 8k, walang emission map na nagawa.
Name
hd_texture
Type
boolean
⚠ lipas na
default false
Description
Gamitin ang texture_resolution sa halip — katumbas ng texture_resolution: "4k". Kapag pareho silang itinakda, ang texture_resolution ang umiral.
Name
texture_prompt
Type
string
Description
Magbigay ng isang text prompt upang gabayan ang proseso ng pagte-texture. Maximum na 600 characters.
Name
texture_image_url
Type
string
Description
Magbigay ng isang 2d na imahe upang gabayan ang proseso ng pagte-texture. Sinusuportahan namin ang mga format .jpg, .jpeg, at .png sa ngayon.
May dalawang paraan para magbigay ng imahe:
- Publicly accessible URL: Isang URL na maaring ma-access mula sa pampublikong internet
- Data URI: Isang base64-encoded na data URI ng imahe. Halimbawa ng isang data URI: data:image/jpeg;base64,<your base64-encoded image data>
Ang tekstura ng imahe ay maaaring hindi gumana nang maayos kung mayroong malalaking pagkakaiba sa heometriya sa pagitan ng orihinal na asset at ng na-upload na imahe. Isa lang sa texture_image_url o texture_prompt ang maaaring gamitin upang gabayan ang proseso ng pagte-texture. Kung pareho ang ibibigay na parameter, ang texture_prompt ang gagamitin bilang default. Ang teksturasyon sa pamamagitan ng alinmang tekstura o imahe ay nagkakahalaga ng 10 credits bawat gawain.

Name
should_remesh
Type
boolean
default false (meshy-6, meshy-7), true (others)
Description
Sinusuri kung papaganahin ang remesh phase. Para sa pinakamataas na kalidad ng modelo, inirerekomenda namin na itakda ang should_remesh sa false.

Naaangkop lamang kapag should_remesh = true

Name
topology
Type
string
default triangle
Description
Tukuyin ang topology ng modelong gagawin.
Mga available na halaga:
- quad: Gumawa ng quad-dominant na mesh.
- triangle: Gumawa ng decimated triangle mesh.
Name
decimation_mode
Type
integer
Description
Paganahin ang adaptive decimation sa pamamagitan ng pagtatakda ng polycount level. Kapag itinakda, ang target_polycount ay hindi pinapansin.
Mga available na halaga:
- 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 siya ay itinakda sa true, ang Meshy ay nag-iimbak din ng isang dagdag na GLB file bago matapos ang remesh phase.

Name
target_polycount
Type
integer
Description
Target na bilang ng polygons (mga mukha) sa output. Ang aktwal na bilang ay maaaring lumihis mula sa target depende sa heometriya.
Ang target_polycount ay epektibo sa dalawang independiyenteng kaso:
- Remesh — gamit ang should_remesh: true sa isang standard na modelo. Ang mesh ay nire-remesh (na-decimate) sa humigit-kumulang dito. Saklaw mula 100 hanggang 300,000, default 30,000. Kung ang decimation_mode ay naka-set na, ito ang may prayoridad at ang target_polycount ay hindi pinapansin.
- Smart Topology — gamit ang model_type: smart-topology at ai_model: meshy-t2. Ang modelo ay direktang ginagawa sa bilang ng mukha na ito; walang remesh na tumatakbo at ang should_remesh ay hindi kailangan. Saklaw mula 100 hanggang 15,000, default 4,000.

Name
symmetry_mode
Type
string
⚠ lipas na
default auto
Description
Deprecated. Ang parameter na ito ay hindi na nakakaapekto sa output.
Ang field na symmetry_mode ay kumokontrol sa pag-uugali ng simetriya sa proseso ng paggawa ng modelo.
Mga wastong halaga:
- off: Hindi pinapagana ang simetriya.
- auto: Awtomatikong tinutukoy at ina-apply ang simetriya batay sa input heometriya.
- on: Pinapatupad ang simetriya sa panahon ng generation.
Name
pose_mode
Type
string
default ""
Description
Tukuyin ang pose mode para sa modelong gagawin.
Mga available na halaga:
- a-pose: Gawin ang modelo sa isang A pose.
- t-pose: Gawin ang modelo sa isang T pose.
- "" (walang laman na string): Walang tiyak na pose na inilapat.
Name
is_a_t_pose
Type
boolean
⚠ lipas na
default false
Description
Gamitin ang pose_mode sa halip. Tukuyin kung ang modelo ay bubuoin sa isang A/T pose.
Name
image_enhancement
Type
boolean
default true
Description
Pinagbubuti ang input image para sa mas mahusay na mga resulta. Itakda sa false upang mapanatili ang eksaktong hitsura ng input image nang walang anumang style processing.
Sinusuportahan lamang kapag ang ai_model ay meshy-6, meshy-7, o latest.
Name
remove_lighting
Type
boolean
default true
Description
Tinatanggal ang mga highlight at shadow mula sa base color texture, na nagreresulta sa mas malinis na resulta na mas mahusay na gumagana sa ilalim ng mga custom na lighting setups.
Sinusuportahan lamang kapag ang ai_model ay meshy-6.
Name
moderation
Type
boolean
default false
Description
Kapag itinakda sa true, ang input content ay awtomatikong sinusuri para sa posibleng mapanganib na content. Kapag natukoy ang mapanganib na nilalaman, hindi magpapatuloy ang task sa generation.
Ang content mula sa image_url, texture_image_url, at texture_prompt na input ay susuriin.
Name
target_formats
Type
string[]
Description
Tinutukoy kung aling mga format ng 3D file ang isasama sa output. Tanging ang mga hiniling na format ang magagawa at ibabalik, na maaaring magpabawas ng oras sa pagkumpleto ng task. Kapag hindi naibigay, lahat ng sinusuportahang format ay isasama.
Available na halaga: glb, obj, fbx, stl, usdz, 3mf
Kapag hindi naibigay, ang lahat ng format maliban sa 3mf ay nabuo. Ang 3mf ay kasama lamang kapag ito ay tuwirang tinukoy.
Name
auto_size
Type
boolean
default false
Description
Kapag itinakda sa true, ang serbisyo ay gumagamit ng AI vision upang awtomatikong tantiyahin ang real-world na taas ng bagay at muling baguhin ang modelo ayon dito. Ang origin ay magde-default sa bottom maliban kung ang origin_at ay tahasang itinakda.
Name
alpha_thumbnail
Type
boolean
default false
Description
Kapag itinakda sa true, ang task ay karagdagan pang nagre-render ng isang transparent-background (RGBA) na bersyon ng preview at ibabalik ito bilang alpha_thumbnail_url sa GET response. Ang umiiral na field na thumbnail_url ay hindi nababago.
Name
multi_view_thumbnails
Type
boolean
default false
Description
Kapag itinakda sa true, ang task ay karagdagan pang nagre-render ng apat na cardinal-view thumbnails (front, right, back, left) at ibabalik ang mga ito sa thumbnail_urls sa GET response. Ang umiiral na field na thumbnail_url ay hindi nagbabago at patuloy na tumutukoy sa front view, kaya ang mga umiiral na kliyente ay hindi naapektuhan.
Nagdaragdag ito ng halos 3 segundo sa latency ng task.

Naaangkop lamang kapag auto_size = true

Name
origin_at
Type
string
default bottom
Description
Posisyon ng origin kapag ang auto_size ay pinagana.
Available na halaga: bottom, center.

Nagbabalik

Ang result na ari-arian ng sagot ay naglalaman ng task na id ng bagong nilikhang Image to 3D task.

Mga Mode ng Pagkabigo

Name
400 - Bad Request
Description
Ang kahilingan ay hindi katanggap-tanggap. Mga karaniwang sanhi:
- Nawawalang parameter: Kailangan ibigay ang alinman sa image_url o input_task_id.
- Walang saysay na input task: Ang input_task_id ay dapat tumutukoy sa isang SUCCEEDED Text to Image o Image to Image task na gumagawa ng eksaktong isang imahe.
- Walang saysay na format ng imahe: Ang ibinigay na image_url ay hindi suportadong format (.jpg, .jpeg, .png).
- Hindi maabot ang URL: Ang image_url ay hindi ma-download (404 o timeout).
- Walang saysay na Data URI: Ang base64 string ay maling formato.
- Walang saysay na kombinasyon ng parameter: Ang enable_pbr ay sinusuportahan lamang kapag ang should_texture ay totoo.
Name
401 - Unauthorized
Description
Nabigo ang authentication. Paki-check ang iyong API key.
Name
402 - Payment Required
Description
Hindi sapat na credits para isagawa ang task na ito.
Name
429 - Too Many Requests
Description
Lumampas 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 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

Ang endpoint na ito ay nagbibigay-daan sa iyo na i-retrieve ang isang Image to 3D task na may wastong task na id. Sumangguni sa The Image to 3D Task Object upang makita kung aling mga katangian ang kasama sa Image to 3D task object.

Mga Parameter

Name
id
Type
path
Description
Natatanging pagkilala para sa Image to 3D task na dapat i-retrieve.

Nagbabalik

Ang tugon ay naglalaman ng Image to 3D task object. Tingnan ang 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

Tanggalin ang isang Image to 3D Task

Ang endpoint na ito ay permanenteng nagtatanggal ng isang Image to 3D task, kabilang ang lahat ng mga nauugnay na mga modelo at data. Ang aksyong ito ay hindi na maibabalik pa.

Path Parameters

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

Nagbabalik

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

// Nagbabalik ng 200 Ok kapag matagumpay.

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

Listahan ng Image to 3D Tasks

Ang endpoint na ito ay nagbibigay-daan sa iyo na i-retrieve ang isang listahan ng Image to 3D tasks.

Mga Parameter

Mga Optional na katangian

Name
page_num
Type
integer
Description
Numero ng pahina para sa pagination. Nagsisimula at nagde-default sa 1.
Name
page_size
Type
integer
Description
Limit sa laki ng pahina. Default sa 10 na item. Maximum na pinapayagan ay 50 na item.
Name
sort_by
Type
string
Description
Field na pamantayan ng pag-aayos. Available na halaga:
- +created_at: Ayusin ayon sa oras ng paglikha ng pataas.
- -created_at: Ayusin ayon sa oras ng paglikha ng pababa.

Nagbabalik

Nagbabalik ng isang pag-inim 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 isang 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 pagkilala para sa Image to 3D task na dapat i-stream.

Nagbabalik

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

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

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

// Halimbawa ng error event
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Ipinapakita ng halimbawa ng mga mensahe ng kaganapan ang pag-unlad ng task.
// Para sa PENDING o IN_PROGRESS na mga task, ang response stream ay hindi kasama ang lahat ng field.
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 yunit ng trabaho na tinutunton ng Meshy upang makabuo ng 3D na modelo mula sa isang image input. Ang object ay may mga sumusunod na properties:

Mga Properties

Name
id
Type
string
Description
Natatanging tagapagpakilala para sa task. Habang gumagamit kami ng k-sortable na UUID para sa mga task ids bilang detalye ng implementasyon, huwag kang gumawa ng anumang mga palagay tungkol sa formato ng id.
Name
type
Type
string
Description
Uri ng Image to 3D task. Ang halaga ay image-to-3d.
Name
model_urls
Type
object
Description
Downloadable na URL sa textured 3D na model file na ginawa ng Meshy. Ang property para sa isang format ay hindi kasama kung ang format ay hindi nabuo sa halip na magbalik ng isang walang laman na string.
- Name
  glb
  Type
  string
  Description
  Downloadable na URL sa GLB file.
- Name
  fbx
  Type
  string
  Description
  Downloadable na URL sa FBX file.
- Name
  obj
  Type
  string
  Description
  Downloadable na URL sa OBJ file.
- Name
  usdz
  Type
  string
  Description
  Downloadable na URL sa USDZ file.
- Name
  mtl
  Type
  string
  Description
  Downloadable na URL sa MTL file, ibinabalik kasama ng mga OBJ exports kapag may mga texture.
- Name
  stl
  Type
  string
  Description
  Downloadable na URL sa STL file.
- Name
  3mf
  Type
  string
  Description
  Downloadable na URL sa 3MF file. Tangi lamang kapag 3mf ay hiniling sa pamamagitan ng target_formats.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  Downloadable na URL sa orihinal na GLB output bago ang remeshing.
  Available lamang kapag ang task ay nilikha kasama ang parehong should_remesh: true at save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Downloadable na URL sa thumbnail image ng model file. Katumbas ng thumbnail_urls.front kapag naroroon, napanatili para sa pagkatugma pabalik.
Name
alpha_thumbnail_url
Type
string
Description
Downloadable na URL sa isang transparent-background (RGBA) na bersyon ng thumbnail_url. Tanging naroroon lamang kapag ang task ay nilikha kasama ang alpha_thumbnail: true at ang transparent preview ay matagumpay na na-render; kung hindi ito ay hindi kasama.
Name
thumbnail_urls
Type
object
Description
Downloadable na mga URL para sa apat na cardinal-view thumbnails ng ginawang 3D na modelo. Ang bawat halaga ay isang signed URL sa isang 512×512 PNG na na-render kasama ang parehong mga materyales at pag-iilaw bilang thumbnail_url. Kapaki-pakinabang para sa preview ng modelo mula sa iba't ibang mga angulo sa batch pipelines nang hindi nagda-download ng GLB.
Tanging naroroon lamang kapag ang task ay nilikha kasama ang multi_view_thumbnails: true at umabot ng SUCCEEDED. Ang mga mas lumang task at task na nilikha nang walang opt-in ay hindi isasama ang field na ito.
- Name
  front
  Type
  string
  Description
  Front view, 0° na pag-ikot sa paligid ng vertical na axis (katumbas ng thumbnail_url).
- Name
  right
  Type
  string
  Description
  Right view, 90° na pag-ikot.
- Name
  back
  Type
  string
  Description
  Back view, 180° na pag-ikot.
- Name
  left
  Type
  string
  Description
  Left view, 270° na pag-ikot.
Name
texture_prompt
Type
string
Description
Ang text prompt na ginamit upang gabayan ang proseso ng pagte-texture.
Name
texture_image_url
Type
string
Description
Downloadable na URL sa texture na imahe na ginamit upang gabayan ang proseso ng pagte-texture.
Name
ultra_mode
Type
boolean
Description
Ini-echo ang halaga ng ultra_mode na ginamit nang likhain ang task. Naroroon lamang para sa meshy-7 (o latest) na mga task na tahasang itinakda ang ultra_mode; kung hindi ay tinatanggal.
Name
progress
Type
integer
Description
Pag-unlad ng task. Kung ang task ay hindi pa nasisimulan, ang property na ito ay 0. Kapag ang task ay nagtagumpay na, ito'y magiging 100.
Name
started_at
Type
timestamp
Description
Timestamp ng kung kailan sinimulan ang task, sa milliseconds. Kung ang task ay hindi pa nasisimulan, ang property na ito ay 0.
Ang timestamp ay kumakatawan sa bilang ng milliseconds na lumaon mula Enero 1, 1970 UTC, alinsunod sa RFC 3339 na pamantayan. Halimbawa, Biyernes, Setyembre 1, 2023 12:00:00 PM GMT ay kinakatawan bilang 1693569600000. Ang itoy tumutukoy sa lahat ng timestamps sa Meshy API.
Name
created_at
Type
timestamp
Description
Timestamp ng kung kailan nilikha ang task, sa milliseconds.
Name
expires_at
Type
timestamp
Description
Timestamp ng kung kailan mage-expire ang resulta ng task, sa milliseconds.
Name
finished_at
Type
timestamp
Description
Timestamp ng kung kailan natapos ang task, sa milliseconds. Kung ang task ay hindi pa natatapos, ang property na ito ay 0.
Name
status
Type
string
Description
Status ng task. Posibleng mga halaga 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, ito ay naglalaman lamang ng isa na texture URL object. Ang bawat texture URL ay may mga sumusunod na katangian:
- Name
  base_color
  Type
  string
  Description
  Downloadable na URL sa base color map image.
- Name
  metallic
  Type
  string
  Description
  Downloadable na URL sa metallic map image.
  Kapag ang task ay nilikha kasama ng enable_pbr: false, ang property na ito ay hindi kasama.
- Name
  normal
  Type
  string
  Description
  Downloadable na URL sa normal map image.
  Kapag ang task ay nilikha kasama ng enable_pbr: false, ang property na ito ay hindi kasama.
- Name
  roughness
  Type
  string
  Description
  Downloadable na URL sa roughness map image.
  Kapag ang task ay nilikha kasama ng enable_pbr: false, ang property na ito ay hindi kasama.
- Name
  emission
  Type
  string
  Description
  Downloadable na URL sa emission map image.
  Kung ang task ay nilikha kasama ng enable_pbr: false, o ang ai_model ay meshy-5, meshy-7, o latest, ang property na ito ay hindi kasama.
Name
preceding_tasks
Type
integer
Description
Ang bilang ng mga naunang task.
Ang halaga ng field na ito ay may kahulugan lamang kapag ang task status ay PENDING.
Name
task_error
Type
object
Description
Mga detalye ng error para sa nabigong mga task. Tingnan ang Errors para sa buong task_error na reference object.
Name
consumed_credits
Type
integer
Description
Ang bilang ng mga credits na konsumo sa task na ito. Kasalukuyan kapag ang status ng task ay PENDING, IN_PROGRESS, o SUCCEEDED. Nagbabalik ng 0 para sa nabigong FAILED na mga task (ibinabalik ang credits sa pagkabigo).

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
}