Text to 3D API

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

Gumagamit ang Text to 3D ng dalawang-hakbang na workflow. Una, gumawa ng preview task (mode: "preview") para mag-generate ng 3D mesh na walang texture, upang masuri mo ang hugis. Pagkatapos, ipasa ang task ID ng nakumpletong preview sa isang refine task (mode: "refine") para mag-apply ng texture sa mesh. Parehong gumagamit ang dalawang hakbang ng iisang endpoint.

POST/openapi/v2/text-to-3d

Gumawa ng Text to 3D Preview Task

Gumagawa ang endpoint na ito ng Text to 3D preview task, na bumubuo ng 3D mesh na walang texture (heometriya lamang) mula sa text prompt. Ito ang unang hakbang ng two-step workflow. Kapag matagumpay ang preview, gamitin ang ibinalik na task ID para gumawa ng refine task para sa paglalagay ng texture. Sumangguni sa The Text to 3D Task Object para sa buong response schema.

Mga Parameter

Name
mode
Type
string
Kinakailangan
Description
Dapat itakda ang field na ito sa "preview" kapag gumagawa ng preview task.
Name
prompt
Type
string
Kinakailangan
Description
Ilarawan kung anong uri ng object ang 3D model. Pinakamataas na 600 character.
Name
model_type
Type
string
default standard
Description
Tukuyin ang uri ng Mesh Generation.
Mga available na value:
- standard: Regular na high-detail 3D mesh generation.
- lowpoly: Bumubuo ng low-poly mesh na na-optimize para sa mas malilinis na polygon.
Kapag pinili ang lowpoly, binabalewala ang ai_model, topology, target_polycount, should_remesh.
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_remesh
Type
boolean
default false (meshy-6), true (others)
Description
Kinokontrol kung ie-enable ang Remesh phase. Kapag itinakda sa false, direktang ibabalik ng API ang pinakamataas na precision na triangular mesh.

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 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 aktwal na bilang ng mga polygon mula sa target depende sa kumplikasyon 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, binabalewala ang target_polycount.
Mga available na value:
- 1: Adaptive — ultra polycount.
- 2: Adaptive — high polycount.
- 3: Adaptive — medium polycount.
- 4: Adaptive — low polycount.

Name
symmetry_mode
Type
string
⚠ lipas na
default auto
Description
deprecated. Hindi na nakaaapekto ang parameter na ito sa output.
Kinokontrol ng field na symmetry_mode ang pag-uugali ng simetriya habang nasa proseso ng pagbuo ng model.
Ang mga valid na value ay:
- off: Dini-disable ang simetriya.
- auto: Awtomatikong tinutukoy at inilalapat ang simetriya batay sa input heometriya.
- on: Ipinatutupad ang simetriya habang bumubuo.
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 ang model sa A/T pose.
Name
art_style
Type
string
⚠ lipas na
default realistic
Description
Hindi sinusuportahan ng Meshy-6. Babalewalain ng mga request na gumagamit ng Meshy-6 ang art_style, at maaaring magdulot ng errors ang ilang kombinasyon. Mga available na value: realistic, sculpture.
Dapat itakda ang enable_pbr sa false kapag gumagamit ng Sculpture style, dahil bumubuo ang Sculpture style ng sarili nitong set ng PBR maps.
Name
moderation
Type
boolean
default false
Description
Kapag itinakda sa true, awtomatikong susuriin ang input content para sa potensyal na nakasasamang content. Kung may matukoy na nakasasamang content, hindi magpapatuloy ang task sa generation.
Susuriin ang text mula sa prompt.
Name
target_formats
Type
string[]
Description
Tinutukoy kung aling mga 3D file format ang isasama sa output. Tanging ang mga hiniling na format ang bubuuin at ibabalik, na maaaring makabawas sa task completion time. Kapag hindi inilagay, kasama ang lahat ng suportadong format.
Mga available na value: glb, obj, fbx, stl, usdz, 3mf
Kapag hindi inilagay, bubuuin ang lahat ng format maliban sa 3mf. Isinasama lamang ang 3mf kapag hayagang tinukoy.
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 kasalukuyang field na thumbnail_url.
Name
auto_size
Type
boolean
default false
Description
Kapag itinakda sa true, gumagamit ang service ng AI vision para awtomatikong tantiyahin ang real-world height ng object at i-Resize ang model nang naaayon. Magde-default ang origin sa bottom maliban kung hayagang itinakda ang origin_at.

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.

Ibinabalik

Naglalaman ang property na result ng response ng task id ng bagong ginawang Text to 3D task.

Mga Mode ng Pagkabigo

Name
400 - Bad Request
Description
Hindi katanggap-tanggap ang request. Karaniwang mga sanhi:
- Nawawalang parameter: Nawawala ang isang kinakailangang parameter (hal., prompt, mode).
- Invalid na parameter: Ang art_style ay hindi isa sa mga pinapayagang value.
- Masyadong mahaba ang prompt: Lumalampas ang prompt sa character limit.
Name
401 - Unauthorized
Description
Nabigo ang authentication. Pakisuri ang iyong API key.
Name
402 - Payment Required
Description
Hindi sapat ang credits para maisagawa ang task na ito.
Name
429 - Too Many Requests
Description
Lumampas ka na sa iyong rate limit.

Request

POST

/openapi/v2/text-to-3d

# Simple preview with required params only
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a monster mask"
}'

# Preview with remesh and A-pose
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a futuristic robot warrior",
  "should_remesh": true,
  "target_polycount": 100000,
  "pose_mode": "a-pose",
  "target_formats": ["glb"]
}'

Response

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

POST/openapi/v2/text-to-3d

Gumawa ng Text to 3D Refine Task

Lumilikha ang endpoint na ito ng Text to 3D refine task, na naglalapat ng texture sa isang nakumpletong preview mesh. Dapat mong ibigay ang preview_task_id mula sa isang matagumpay na preview task. Ito ang ikalawang hakbang ng dalawang-hakbang na workflow.

Mga Parameter

Name
mode
Type
string
Kinakailangan
Description
Dapat itakda ang field na ito sa "refine" kapag gumagawa ng refine task.
Name
preview_task_id
Type
string
Kinakailangan
Description
Ang kaukulang preview task id.
Dapat SUCCEEDED ang status ng ibinigay na preview task.
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) na 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 karagdagang text prompt upang gabayan ang proseso ng paglalagay ng texture. Maximum na 600 character.
Name
texture_image_url
Type
string
Description
Magbigay ng 2d image upang gabayan ang proseso ng paglalagay ng texture. Kasalukuyan naming sinusuportahan ang mga format na .jpg, .jpeg, at .png.
May dalawang paraan para ibigay ang image:
- Publicly accessible URL: Isang URL na maa-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 pinakamainam ang image texturing kung may malaking 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 paglalagay ng texture. Kung parehong ibinigay ang dalawang parameter, gagamitin ang texture_prompt para lagyan ng texture ang model bilang default.
Name
ai_model
Type
string
default latest
Description
ID ng model na gagamitin para sa pag-refine. Mga available na value: meshy-5, meshy-6, latest (Meshy 6).
Name
moderation
Type
boolean
default false
Description
Kapag itinakda sa true, awtomatikong susuriin ang input content para sa posibleng mapaminsalang content. Kung may matukoy na mapaminsalang content, hindi magpapatuloy ang task sa generation.
Parehong susuriin ang text mula sa texture_prompt at ang image mula sa texture_image_url.
Name
remove_lighting
Type
boolean
default true
Description
Inaalis ang mga highlight at shadow mula sa base color texture, na lumilikha ng mas malinis na resulta na mas mahusay gumana sa ilalim ng mga custom lighting setup.
Sinusuportahan lang kapag ang ai_model ay meshy-6 o latest.
Name
target_formats
Type
string[]
Description
Tinutukoy kung aling mga 3D file format ang isasama sa output. Tanging ang mga hiniling na format ang bubuuin at ibabalik, na maaaring magpabawas ng oras ng pagkumpleto ng task. Kapag hindi inilagay, kasama 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
alpha_thumbnail
Type
boolean
default false
Description
Kapag itinakda sa true, dagdag na nire-render ng task ang transparent-background (RGBA) na bersyon ng preview at ibinabalik ito bilang alpha_thumbnail_url sa GET response. Hindi nagbabago ang umiiral na field na thumbnail_url.
Name
auto_size
Type
boolean
default false
Description
Kapag itinakda sa true, gumagamit ang service ng AI vision upang awtomatikong tantiyahin ang tunay-sa-mundong taas ng object at i-Resize ang model nang naaayon. Magde-default ang origin sa bottom maliban kung tahasang itinakda ang origin_at.

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 property na result ng response ay naglalaman ng task id ng bagong likhang Text to 3D task.

Mga Mode ng Pagkabigo

Name
400 - Bad Request
Description
Hindi katanggap-tanggap ang request. Mga karaniwang sanhi:
- Di-wastong task ID: Di-wasto ang preview_task_id o hindi ito umiiral.
- Hindi pa handa ang task: Hindi pa nagtatagumpay ang preview task.
- Hindi tugmang model: Hindi compatible ang AI model ng preview task sa hiniling na refine model.
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
404 - Not Found
Description
Hindi nahanap ang preview task na tinukoy ng preview_task_id.
Name
429 - Too Many Requests
Description
Lumampas ka na sa iyong rate limit.

Request

POST

/openapi/v2/text-to-3d

# Basic refine task
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "enable_pbr": true
}'

# Refine with auto-size and GLB format
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "target_formats": ["glb"],
  "auto_size": true
}'

Response

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

GET/openapi/v2/text-to-3d/:id

Kunin ang isang Text to 3D Task

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

Gumagana ang endpoint na ito para sa parehong preview at refine na mga task.

Mga Parameter

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

Mga Ibinabalik

Naglalaman ang response ng object ng Text to 3D task. Tingnan ang seksyong Object ng Text to 3D Task para sa mga detalye.

Mga Halimbawa

mode	Halimbawang Modelo
Preview
Refine

Request

GET

/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-3d-preview",
  "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=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?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=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "prompt": "a monster mask",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 20
}

DELETE/openapi/v2/text-to-3d/:id

Mag-delete ng Text to 3D na Gawain

Permanenteng dine-delete ng endpoint na ito ang isang Text to 3D na gawain, kabilang ang lahat ng nauugnay na modelo at data. Hindi na mababawi ang aksyong ito.

Mga Path Parameter

Name
id
Type
path
Description
Ang ID ng Text to 3D na gawain na ide-delete.

Mga Ibinabalik

Nagbabalik ng 200 OK kapag matagumpay.

Request

DELETE

/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

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

Response

// Returns 200 Ok on success.

GET/openapi/v2/text-to-3d

Ilista ang mga Text to 3D Task

Pinapayagan ka ng endpoint na ito na kunin ang listahan ng mga Text to 3D task.

Mga Parameter

Name
page_num
Type
integer
default 1
Description
Numero ng pahina para sa pagination.
Name
page_size
Type
integer
default 10
Description
Limitasyon sa laki ng pahina. Ang pinakamataas na pinapayagan ay 50 item.
Name
sort_by
Type
string
Description
Field na pagbabatayan ng pag-sort.
Mga available na value:
- +created_at: I-sort ayon sa oras ng paggawa sa pataas na ayos.
- -created_at: I-sort ayon sa oras ng paggawa sa pababang ayos.

Mga Ibinabalik

Nagbabalik ng listahang may pagination ng Mga Text to 3D Task Object.

Request

GET

/openapi/v2/text-to-3d

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

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "text-to-3d-preview",
    "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=***",
      "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "prompt": "a monster mask",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {

      "message": ""

    },

    "consumed_credits": 20
  }
]

GET/openapi/v2/text-to-3d/:id/stream

I-stream ang isang Text to 3D Task

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

Mga Parameter

Name
id
Type
path
Description
Natatanging identifier para sa Text to 3D task na i-stream.

Mga Ibinabalik

Nagbabalik ng stream ng Mga Text to 3D Task Object 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/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v2/text-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",
  "progress": 50,
  "status": "IN_PROGRESS"
}

event: message
data: {
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "text-to-3d-preview",
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1692771650657,
"started_at": 1692771667037,
"finished_at": 1692771669037,
"model_urls": {
  "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
},
"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": 20
}

Ang Text to 3D Task Object

Ang Text to 3D Task object ay isang work unit na sinusubaybayan ng Meshy upang bumuo ng 3D model mula sa text input. May dalawang yugto ang Text to 3D API, preview at refine. Ang preview stage ay para sa pagbuo ng mesh-only na 3D model, at ang refine stage ay para sa pagbuo ng 3D model na may texture batay sa resulta ng preview stage.

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 implementation, hindi ka dapat gumawa ng anumang assumption tungkol sa format ng id.
Name
type
Type
string
Description
Uri ng Text to 3D task. Ang mga posibleng value ay text-to-3d-preview para sa mga task sa preview stage at text-to-3d-refine para sa mga task sa refine stage.
Name
model_urls
Type
object
Description
Nada-download na URL sa textured 3D model file na ginawa ng Meshy. Aalisin ang property para sa isang format kung hindi nagawa ang format sa halip na magbalik ng empty string.
- Name
  glb
  Type
  string
  Description
  Nada-download na URL sa GLB file.
- Name
  fbx
  Type
  string
  Description
  Nada-download na URL sa FBX file.
- Name
  usdz
  Type
  string
  Description
  Nada-download na URL sa USDZ file.
- Name
  obj
  Type
  string
  Description
  Nada-download na URL sa OBJ file.
- Name
  mtl
  Type
  string
  Description
  Nada-download na URL sa MTL file.
- Name
  stl
  Type
  string
  Description
  Nada-download na URL sa STL file.
- Name
  3mf
  Type
  string
  Description
  Nada-download na URL sa 3MF file. Naroroon lamang kapag hiniling ang 3mf sa pamamagitan ng target_formats.
Name
prompt
Type
string
Description
Ito ang hindi binagong prompt na ginamit upang gawin ang task.
Name
negative_prompt
Type
string
⚠ lipas na
Description
Pinananatili para sa backward compatibility. Walang functional na epekto ang field na ito sa mga nabuong model.
Name
art_style
Type
string
⚠ lipas na
Description
Ang hindi binagong art_style na ginamit upang gawin ang preview task. Hindi sinusuportahan ng Meshy-6.
Name
texture_richness
Type
string
⚠ lipas na
Description
Pinananatili para sa backward compatibility. Walang functional na epekto ang field na ito sa mga nabuong model.
Name
texture_prompt
Type
string
Description
Karagdagang text prompt na ibinigay upang gabayan ang proseso ng paglalagay ng texture sa refine stage.
Name
texture_image_url
Type
string
Description
Nada-download na URL sa texture image na ginamit upang gabayan ang proseso ng paglalagay ng texture.
Name
thumbnail_url
Type
string
Description
Nada-download na URL sa thumbnail image ng model file.
Name
alpha_thumbnail_url
Type
string
Description
Nada-download na URL 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, aalisin ang field na ito.
Name
video_url
Type
string
⚠ lipas na
Description
Nada-download na URL sa preview video. Aalisin sa isang release sa hinaharap.
Name
progress
Type
integer
Description
progress ng task. Kung hindi pa nagsisimula ang task, magiging 0 ang property na ito. 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, magiging 0 ang property na ito.
Ang timestamp ay kumakatawan sa bilang ng milliseconds na lumipas mula noong 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
finished_at
Type
timestamp
Description
timestamp kung kailan natapos ang task, sa milliseconds. Kung hindi pa tapos ang task, magiging 0 ang property na ito.
Name
status
Type
string
Description
Katayuan 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 sa base color map image.
- Name
  metallic
  Type
  string
  Description
  Nada-download na URL 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 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 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 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 task_error object reference.
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 Text to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-3d-preview",
  "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=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  },
  "prompt": "a monster mask",
  "texture_prompt": "green slimy skin with scales and warts",
  "texture_image_url": "",
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "progress": 100,
  "seed": 1234,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "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": 20
}