Image to 3D API

Ang Image to 3D API ay isang tampok na nagbibigay-daan sa iyo na isama ang mga kakayahan ng Meshy na Image to 3D sa iyong sariling 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 para makita kung anong mga property ang kasama sa Image to 3D task object.

Mga Parameter

Isa lamang sa input_task_id o image_url ang kinakailangan. Kapag 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 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 na-run sa pamamagitan ng API, may status na SUCCEEDED, at nakabuo ng eksaktong isang larawan.

Name
image_url
Type
string
Kinakailangan
Description
Magbigay ng larawan na gagamitin ng Meshy sa paggawa ng modelo. Sinusuportahan namin sa kasalukuyan ang mga format na .jpg, .jpeg, at .png.
Mayroong dalawang paraan upang magbigay ng larawan:
- Publicly accessible URL: Isang URL na maa-access mula sa publikong internet.
- Data URI: Isang base64-encoded data URI ng larawan. 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.
- smart-topology: Pumili ng Smart Topology model gamit ang ai_model (meshy-t2).
- lowpoly (deprecated): Gumagawa ng low-poly mesh na naka-optimize para sa mas malinis na polygon. Inirerekomenda naming gamitin ang 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 value ay depende 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): ang Smart Topology model — mas malinis na topology, likas na hiwalay na mga bahagi, triangle output, at isang face count na maaari mong itakda gamit ang target_polycount.
Name
ultra_mode
Type
boolean
default false
Description
Nagbibigay-daan sa Ultra generation para sa mas mataas na kalidad ng 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 gagawa ng mga texture. Kapag itinakda sa false, laktawan ang yugto ng texture, 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 ang kasama rin kapag ang ai_model ay meshy-6, maliban sa 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 kumukuha ng mas maraming detalye sa ibabaw.
Ang 4k at 8k ay hindi available sa ai_model: meshy-5. Sa 8k, walang emission map na nabubuo.
Name
hd_texture
Type
boolean
⚠ lipas na
default false
Description
Gamitin ang texture_resolution sa halip — katumbas ng texture_resolution: "4k". Kapag parehong itinakda, ang texture_resolution ang mananaig.
Name
texture_prompt
Type
string
Description
Magbigay ng text prompt upang gabayan ang proseso ng pag-texture. Maximum na 800 na karakter.
Name
texture_image_url
Type
string
Description
Magbigay ng 2d na larawan upang gabayan ang proseso ng pag-texture. Sinusuportahan namin sa kasalukuyan ang mga format na .jpg, .jpeg, at .png.
Mayroong dalawang paraan upang magbigay ng larawan:
- Publicly accessible URL: Isang URL na maa-access mula sa publikong internet
- Data URI: Isang base64-encoded data URI ng larawan. Halimbawa ng data URI: data:image/jpeg;base64,<your base64-encoded image data>
Maaaring hindi optimal ang image texturing kung may malaking pagkakaiba sa heometriya sa pagitan ng orihinal na asset at ng na-upload na larawan. Isa lamang sa texture_image_url o texture_prompt ang maaaring gamitin upang gabayan ang proseso ng pag-texture. Kapag parehong ibinigay ang mga parameter, ang texture_prompt ang gagamitin upang i-texture ang modelo bilang default. Ang pag-texture sa pamamagitan ng teksto o larawan ay magkakahalaga ng 10 credits kada task.

Name
should_remesh
Type
boolean
default false (meshy-6, meshy-7), true (others)
Description
Kinokontrol kung papaganahin ang yugto ng remesh. Para sa pinakamataas na kalidad ng modelo, 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 modelo.
Mga available na value:
- quad: Gumawa ng quad-dominant na mesh.
- triangle: Gumawa ng decimated na triangle mesh.
Name
decimation_mode
Type
integer
Description
Paganahin ang adaptive decimation sa pamamagitan ng pagtatakda ng antas ng polycount. Kapag itinakda, ang target_polycount ay hindi pinapansin.
Mga available 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 yugto ng remesh.

Name
target_polycount
Type
integer
Description
Target na bilang ng mga polygon (faces) sa output. Maaaring lumihis ang aktwal na bilang mula sa target depende sa heometriya.
Ang target_polycount ay may epekto sa dalawang independiyenteng kaso:
- Remesh — kasama ang should_remesh: true sa isang standard na modelo. Ang mesh ay ni-remesh (decimated) sa humigit-kumulang sa bilang na ito. Saklaw na 100 hanggang 300,000, default na 30,000. Kapag itinakda ang decimation_mode, ito ang mananaig at ang target_polycount ay hindi pinapansin.
- Smart Topology — kasama ang model_type: smart-topology at ai_model: meshy-t2. Ang modelo ay direktang nabubuo sa bilang na ito ng face; walang tumatakbong remesh at hindi kinakailangan ang should_remesh. Saklaw na 100 hanggang 15,000, default na 4,000.

Name
symmetry_mode
Type
string
⚠ lipas na
default auto
Description
Deprecated na. Ang parameter na ito ay hindi na nakakaapekto sa output.
Ang field na symmetry_mode ay kumokontrol sa gawi ng simetriya sa panahon ng proseso ng paggawa ng modelo.
Ang mga valid na value ay:
- off: Hindi paganahin ang simetriya.
- auto: Awtomatikong tinutukoy at inilalapat ang simetriya batay sa input na heometriya.
- on: Ipinapatupad ang simetriya sa panahon ng paggawa.
Name
pose_mode
Type
string
default ""
Description
Tukuyin ang pose mode para sa nabuong modelo.
Mga available na value:
- a-pose: Gumawa ng modelo sa A pose.
- t-pose: Gumawa ng modelo sa T pose.
- "" (walang laman na string): Walang partikular na inilapat na pose.
Name
is_a_t_pose
Type
boolean
⚠ lipas na
default false
Description
Gamitin ang pose_mode sa halip. Kung gagawa ng modelo sa A/T pose.
Name
image_enhancement
Type
boolean
default true
Description
Ino-optimize ang input na larawan para sa mas magandang resulta. Itakda sa false upang mapanatili ang eksaktong hitsura ng input na larawan nang walang anumang pagproseso ng estilo.
Sinusuportahan lamang kapag ang ai_model ay meshy-6, meshy-7, o latest.
Name
remove_lighting
Type
boolean
default true
Description
Inaalis ang mga highlight at shadow mula sa base color texture, na nagbubunga ng mas malinis na resulta na mas mahusay gumagana sa ilalim ng custom na setup ng ilaw.
Sinusuportahan lamang kapag ang ai_model ay meshy-6.
Name
moderation
Type
boolean
default false
Description
Kapag itinakda sa true, ang input na content ay awtomatikong susuriin para sa posibleng mapanganib na content. Kung may natukoy na mapanganib na content, ang task ay hindi magpapatuloy sa generation.
Ang content mula sa mga input na image_url, texture_image_url, at texture_prompt ay susuriin.
Name
target_formats
Type
string[]
Description
Tinutukoy kung aling mga 3D file format ang isasama sa output. Ang mga hiniling na format lamang ang gagawin at ibabalik, na maaaring magpababa sa oras ng pagkumpleto ng task. Kapag hindi isinama, lahat ng suportadong format ay isasama.
Mga available na value: glb, obj, fbx, stl, usdz, 3mf
Kapag hindi isinama, lahat ng format maliban sa 3mf ang nabubuo. Ang 3mf ay isinasama lamang kapag tahasang itinakda.
Name
auto_size
Type
boolean
default false
Description
Kapag itinakda sa true, ginagamit ng serbisyo ang AI vision upang awtomatikong tantiyahin ang real-world na taas ng bagay at baguhin ang laki ng modelo alinsunod dito. Ang origin ay default sa bottom maliban kung tahasang itinakda ang origin_at.
Name
alpha_thumbnail
Type
boolean
default false
Description
Kapag itinakda sa true, ang task ay karagdagang nagre-render ng bersyon na may transparent-background (RGBA) ng preview at ibinabalik ito bilang alpha_thumbnail_url sa tugon ng GET. Ang umiiral na field na thumbnail_url ay hindi nagbabago.
Name
multi_view_thumbnails
Type
boolean
default false
Description
Kapag itinakda sa true, ang task ay karagdagang nagre-render ng apat na cardinal-view thumbnail (front, right, back, left) at ibinabalik ang mga ito sa ilalim ng thumbnail_urls sa tugon ng GET. Ang umiiral na field na thumbnail_url ay hindi nagbabago at patuloy na tumuturo sa front view, kaya hindi naaapektuhan ang mga umiiral na kliyente.
Nagdaragdag ng humigit-kumulang 3 segundo sa latency ng task.

Naaangkop lamang kapag auto_size = true

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

Mga Ibabalik

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

Mga Failure Mode

Name
400 - Bad Request
Description
Ang kahilingan ay hindi katanggap-tanggap. Karaniwang mga sanhi:
- Missing parameter: Alinman sa image_url o input_task_id ang dapat ibigay.
- Invalid input task: Ang input_task_id ay dapat tumutukoy sa isang SUCCEEDED na Text to Image o Image to Image na task na nakabubuo ng eksaktong isang larawan.
- Invalid image format: Ang ibinigay na image_url ay hindi suportadong format (.jpg, .jpeg, .png).
- Unreachable URL: Hindi ma-download ang image_url (404 o timeout).
- Invalid Data URI: Hindi wasto ang base64 string.
- Invalid parameter combination: Ang enable_pbr ay sinusuportahan lamang kapag ang should_texture ay true.
Name
401 - Unauthorized
Description
Nabigo ang authentication. Pakisuri ang iyong API key.
Name
402 - Payment Required
Description
Hindi sapat na credits upang 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 na Gawain

Ang endpoint na ito ay nagbibigay-daan sa iyo na kunin ang isang Image to 3D na gawain gamit ang isang wastong id ng gawain. Sumangguni sa The Image to 3D Task Object upang makita kung aling mga katangian ang kasama sa Image to 3D na gawain na bagay.

Mga Parameter

Name
id
Type
path
Description
Natatanging pagkakakilanlan para sa Image to 3D na gawain na kukunin.

Mga Ibinabalik

Ang tugon ay naglalaman ng Image to 3D na gawain na bagay. Suriin ang The Image to 3D Task Object na seksyon 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 na Gawain

Ang endpoint na ito ay permanenteng bubura ng isang Image to 3D na gawain, kasama ang lahat ng kaugnay na modelo at datos. Ang aksyong ito ay hindi na mababawi.

Mga Parameter ng Landas

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

Mga 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

Listahan ng mga Image to 3D na Gawain

Ang endpoint na ito ay nagbibigay-daan sa iyo na makuha ang listahan ng mga Image to 3D na gawain.

Mga Parameter

Opsyonal na mga katangian

Name
page_num
Type
integer
Description
Numero ng pahina para sa pagination. Nagsisimula at default sa 1.
Name
page_size
Type
integer
Description
Limitasyon ng laki ng pahina. Default sa 10 na item. Ang maximum na pinapayagan ay 50 na item.
Name
sort_by
Type
string
Description
Patlang na gagamitin para sa pag-aayos. Mga magagamit na halaga:
- +created_at: Ayusin ayon sa oras ng paglikha sa pataas na pagkakasunod-sunod.
- -created_at: Ayusin ayon sa oras ng paglikha sa pababang pagkakasunod-sunod.

Mga Ibinabalik

Nagbabalik ng isang listahan na may pagination 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 updates 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 PENDING o IN_PROGRESS na tasks, ang response stream ay maglalaman lamang ng kinakailangang progress at status fields.

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 unit ng trabaho na sinusubaybayan ng Meshy upang makabuo ng 3D model mula sa input na larawan. Ang object ay may mga sumusunod na katangian:

Mga Katangian

Name
id
Type
string
Description
Natatanging identifier para sa gawain. Habang gumagamit kami ng k-sortable UUID para sa mga task id bilang detalye ng implementasyon, hindi ka dapat gumawa ng anumang mga pagpapalagay tungkol sa format 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 URL sa textured 3D model file na nabuo ng Meshy. Ang property para sa isang format ay hindi isasama kung ang format ay hindi nabuo sa halip na magbalik ng isang walang laman na string.
- Name
  glb
  Type
  string
  Description
  Downloadable URL sa GLB file.
- Name
  fbx
  Type
  string
  Description
  Downloadable URL sa FBX file.
- Name
  obj
  Type
  string
  Description
  Downloadable URL sa OBJ file.
- Name
  usdz
  Type
  string
  Description
  Downloadable URL sa USDZ file.
- Name
  mtl
  Type
  string
  Description
  Downloadable URL sa MTL file, ibinabalik kasama ng OBJ exports kapag may mga texture.
- Name
  stl
  Type
  string
  Description
  Downloadable URL sa STL file.
- Name
  3mf
  Type
  string
  Description
  Downloadable URL sa 3MF file. Tanging naroroon kapag ang 3mf ay hiniling sa pamamagitan ng target_formats.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  Downloadable URL sa orihinal na GLB output bago ang remeshing.
  Available lamang kapag ang gawain ay nilikha na may parehong should_remesh: true at save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Downloadable URL sa thumbnail image ng model file. Katumbas ng thumbnail_urls.front kapag naroroon, pinanatili para sa backwards compatibility.
Name
alpha_thumbnail_url
Type
string
Description
Downloadable URL sa isang transparent-background (RGBA) na bersyon ng thumbnail_url. Tanging naroroon kapag ang gawain ay nilikha na may alpha_thumbnail: true at ang transparent preview ay matagumpay na na-render; kung hindi, ang field na ito ay hindi isasama.
Name
thumbnail_urls
Type
object
Description
Downloadable URLs para sa apat na cardinal-view thumbnails ng nabuo na 3D model. Ang bawat halaga ay isang signed URL sa isang 512×512 PNG na na-render gamit ang parehong mga materyales at ilaw tulad ng thumbnail_url. Kapaki-pakinabang para sa pag-preview ng modelo mula sa maraming anggulo sa batch pipelines nang hindi nagda-download ng GLB.
Tanging naroroon kapag ang gawain ay nilikha na may multi_view_thumbnails: true at umabot sa SUCCEEDED. Ang mga lumang gawain at mga gawain na nilikha nang walang opt-in ay hindi isasama ang field na ito.
- Name
  front
  Type
  string
  Description
  Front view, 0° rotation sa paligid ng vertical axis (katumbas ng 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
Description
Ibinabalik ang ultra_mode value na nilikha ang gawain. Tanging naroroon para sa meshy-7 (o latest) na mga gawain na tahasang nagtakda ng ultra_mode; kung hindi, hindi isasama.
Name
progress
Type
integer
Description
Pag-unlad ng gawain. Kung ang gawain ay hindi pa nasisimulan, ang property na ito ay magiging 0. Kapag ang gawain ay nagtagumpay, ito ay magiging 100.
Name
started_at
Type
timestamp
Description
Timestamp kung kailan nagsimula ang gawain, sa milliseconds. Kung ang gawain ay hindi pa nasisimulan, ang property na ito ay magiging 0.
Ang timestamp ay kumakatawan sa bilang ng milliseconds na lumipas mula Enero 1, 1970 UTC, alinsunod sa 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 kung kailan nilikha ang gawain, sa milliseconds.
Name
expires_at
Type
timestamp
Description
Timestamp kung kailan mag-e-expire ang resulta ng gawain, sa milliseconds.
Name
finished_at
Type
timestamp
Description
Timestamp kung kailan natapos ang gawain, sa milliseconds. Kung ang gawain ay hindi pa natatapos, ang property na ito ay magiging 0.
Name
status
Type
string
Description
Status ng gawain. Ang mga posibleng halaga ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Isang array ng texture URL objects na nabuo mula sa gawain. Karaniwan ito ay naglalaman lamang ng isang texture URL object. Ang bawat texture URL ay may mga sumusunod na katangian:
- 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 gawain ay nilikha na may enable_pbr: false, ang property na ito ay hindi isasama.
- Name
  normal
  Type
  string
  Description
  Downloadable URL sa normal map image.
  Kung ang gawain ay nilikha na may enable_pbr: false, ang property na ito ay hindi isasama.
- Name
  roughness
  Type
  string
  Description
  Downloadable URL sa roughness map image.
  Kung ang gawain ay nilikha na may enable_pbr: false, ang property na ito ay hindi isasama.
- Name
  emission
  Type
  string
  Description
  Downloadable URL sa emission map image.
  Kung ang gawain ay nilikha na may enable_pbr: false, o ai_model ay meshy-5, meshy-7, o latest, ang property na ito ay hindi isasama.
Name
preceding_tasks
Type
integer
Description
Ang bilang ng mga naunang gawain.
Ang halaga ng field na ito ay makabuluhan lamang kung ang status ng gawain ay PENDING.
Name
task_error
Type
object
Description
Mga detalye ng error para sa mga nabigong gawain. Tingnan ang Errors para sa buong task_error object reference.
Name
consumed_credits
Type
integer
Description
Ang bilang ng mga credits na nagamit ng gawain na ito. Naroroon kapag ang status ng gawain ay PENDING, IN_PROGRESS, o SUCCEEDED. Nagbabalik ng 0 para sa FAILED na mga gawain (ang mga credits ay naibabalik 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
}