Ireretiro ang lowpoly sa Oct 30, 2026. Lumipat ng modelo bago ang mga petsang ito para maiwasan ang mga error sa request.

Text to 3D API

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

Ginagamit ng Text to 3D ang isang two-step workflow. Una, gumawa ng preview task (mode: "preview") para makabuo ng 3D mesh na walang texture, para masuri mo ang hugis. Pagkatapos, ipasa ang task ID ng natapos na preview sa isang refine task (mode: "refine") para ilapat ang texture sa mesh. Parehong hakbang ay gumagamit ng iisang endpoint.


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

Gumawa ng Text to 3D Preview Task

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

Tumatakbo ang task sa background. Para sa karaniwang tagal nito, tingnan ang Processing Times.

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 bagay ang 3D model. Maximum na 800 na karakter.

  • 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: Piliin ang Smart Topology model gamit ang ai_model (meshy-t2).
    • lowpoly (deprecated, ire-retire sa Oktubre 30, 2026): Bumubuo ng low-poly na mesh na naka-optimize para sa mas malinis na polygons. Inirerekomenda naming Meshy T2 sa halip: smart-topology na may meshy-t2.
  • Name
    ai_model
    Type
    string
    default latest
    Description

    ID ng model na gagamitin. Ang mga available na value ay depende sa model_type.

    Standard na generation (model_type: standard):

    • meshy-6-lite, meshy-6, meshy-7.1, latest (Meshy 7.1)
    • meshy-7 (deprecated): gamitin ang meshy-7.1 sa halip.

    Smart Topology generation (model_type: smart-topology):

    • meshy-t2 (default): ang Smart Topology model — mas malinis na topology, likas na hiwalay na mga bahagi, triangle output, at face count na maaari mong itakda gamit ang target_polycount.
  • Name
    geometry_resolution
    Type
    string
    default standard
    Description

    Geometry generation pass. Pinapatakbo ng 2k ang Ultra pass sa 2048³; pinapatakbo ito ng 4k sa 4096³ para sa pinaka-detalyadong surface.

    Mga available na value: standard, 2k, 4k

  • Name
    ultra_mode
    Type
    boolean
    ⚠ lipas na
    default false
    Description

    Gamitin ang geometry_resolution sa halip. Ang ultra_mode: true ay katumbas ng geometry_resolution: "2k".

  • Name
    should_remesh
    Type
    boolean
    default false (Meshy 6 and Meshy 7 models), true (others)
    Description

    Kinokontrol kung paganahin ang remesh phase. Para sa pinakamataas na kalidad ng model, inirerekomenda naming itakda ang should_remesh sa false.

Naaangkop lamang kapag should_remesh = true
  • Name
    topology
    Type
    string
    default triangle
    Description

    Tukuyin ang topology ng nabuong model.

    Mga available na value:

    • quad: Bumuo ng quad-dominant na mesh.
    • triangle: Bumuo ng decimated na triangle mesh.
  • Name
    decimation_mode
    Type
    integer
    Description

    Paganahin ang adaptive decimation sa pamamagitan ng pagtatakda ng polycount level. Kapag naitakda, hindi pinapansin ang target_polycount.

    Mga available na value:

    • 1: Adaptive — ultra polycount.
    • 2: Adaptive — mataas na polycount.
    • 3: Adaptive — katamtamang polycount.
    • 4: Adaptive — mababang polycount.
  • Name
    target_polycount
    Type
    integer
    Description

    Target na bilang ng polygons (faces) sa output. Maaaring lumihis ang aktwal na bilang mula sa target depende sa heometriya.

    Nagkakabisa ang target_polycount sa dalawang independiyenteng kaso:

    • Remesh — na may should_remesh: true sa isang standard na model. Ang mesh ay nire-remesh (decimated) sa humigit-kumulang na bilang na ito. Saklaw na 100 hanggang 300,000, default na 30,000. Kung naitakda ang decimation_mode, ito ang mangunguna at hindi pinapansin ang target_polycount.
    • Smart Topology — na may model_type: smart-topology at ai_model: meshy-t2. Direktang nabubuo ang model sa face count na ito; 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. Hindi na nakakaapekto ang parameter na ito sa output.

    Kinokontrol ng field na symmetry_mode ang simetriya na pag-uugali sa panahon ng proseso ng pagbuo ng model.

    Ang mga valid na value ay:

    • off: Dine-disable ang simetriya.
    • auto: Awtomatikong tinutukoy at inilalapat ang simetriya batay sa input na heometriya.
    • on: Ipinapatupad ang simetriya sa panahon ng generation.
  • 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.
    • "" (walang laman na 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 bubuo ang model sa A/T pose.

  • Name
    art_style
    Type
    string
    ⚠ lipas na
    default realistic
    Description

    Hindi suportado ng Meshy-6. Babalewalain ng mga request na gumagamit ng Meshy-6 ang art_style, at maaaring magdulot ng mga error ang ilang kombinasyon. Mga available na value: realistic, sculpture.

  • Name
    moderation
    Type
    boolean
    default false
    Description

    Kapag itinakda sa true, awtomatikong sususuriin ang input content para sa potensyal na nakakapinsalang nilalaman. Kung may natuklasang nakakapinsalang nilalaman, hindi magpapatuloy ang task sa generation.

    Ang teksto mula sa prompt ang susuriin.

  • Name
    target_formats
    Type
    string[]
    Description

    Tinutukoy kung aling mga 3D file format ang isasama sa output. Tanging ang mga hiniling na format lamang ang bubuuin at ibabalik, na maaaring magpaikli sa oras ng pagkumpleto ng task. Kapag naiwan na blangko, isinasama ang lahat ng suportadong format.

    Mga available na value: glb, obj, fbx, stl, usdz, 3mf

  • Name
    alpha_thumbnail
    Type
    boolean
    default false
    Description

    Kapag itinakda sa true, karagdagang mag-re-render ang task ng bersyon na transparent-background (RGBA) ng preview at ibabalik 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, gagamitin ng serbisyo ang AI vision para awtomatikong tantyahin ang real-world na taas ng bagay at baguhin ang laki ng model alinsunod dito. Ang origin ay magiging bottom bilang default maliban kung malinaw na 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 gawang Text to 3D task.

Mga Paraan ng Pagkabigo

  • Name
    400 - Bad Request
    Description

    Hindi katanggap-tanggap ang request. Karaniwang mga dahilan:

    • Nawawalang parameter: Isang kinakailangang parameter (hal., prompt, mode) ang nawawala.
    • Hindi valid na parameter: Hindi isa ang art_style sa mga pinapayagang value.
    • Masyadong mahaba ang prompt: Lumampas ang prompt sa limitasyon ng karakter.
    • Hindi suportadong model para sa low poly: Hindi sinusuportahan ng ai_model: "meshy-6-lite" ang model_type: "lowpoly".
    • Hindi suportadong model para sa Ultra: Nangangailangan ang geometry_resolution ng meshy-7.1 o latest.
  • Name
    401 - Unauthorized
    Description

    Nabigo ang authentication. Pakisuri ang iyong API key.

  • Name
    402 - Payment Required
    Description

    Hindi sapat na credits para isagawa ang task na ito.

  • Name
    429 - Too Many Requests
    Description

    Lumampas ka 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 Ultra 4K geometry, 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",
  "ai_model": "meshy-7.1",
  "geometry_resolution": "4k",
  "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

Ang endpoint na ito ay gumagawa ng Text to 3D refine task, na naglalapat ng texture sa isang kumpletong preview mesh. Kailangan mong ibigay ang preview_task_id mula sa isang matagumpay na preview task. Ito ang ikalawang hakbang sa two-step workflow.

Ang task ay tumatakbo sa background. Para sa karaniwang tagal nito, tingnan ang Processing Times.

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 katumbas na preview task id.

    Ang status ng binigay na preview task ay dapat na SUCCEEDED.

  • 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, maliban sa texture_resolution: 8k (walang emission map na gagawin). Ang meshy-6-lite, meshy-7.1, at latest ay hindi gumagawa ng emission map, gayundin ang refine ng isang meshy-t2 preview na hindi nagtatakda ng ai_model.

  • Name
    texture_resolution
    Type
    string
    default 2k
    Description

    Resolution ng base color texture. 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. Nalalapat lamang sa refine mode.

  • Name
    hd_texture
    Type
    boolean
    ⚠ lipas na
    default false
    Description

    Gamitin ang texture_resolution sa halip — katumbas ito ng texture_resolution: "4k". Kapag parehong itinakda, ang texture_resolution ang mananaig.

  • Name
    texture_prompt
    Type
    string
    Description

    Magbigay ng karagdagang text prompt upang gabayan ang proseso ng pag-texture. Maximum na 800 characters.

  • Name
    texture_image_url
    Type
    string
    Description

    Magbigay ng 2d na larawan upang gabayan ang proseso ng pag-texture. Kasalukuyan naming suportado ang mga format na .jpg, .jpeg, .png, at .webp.

    Maximum na laki ng file: 20 MB.

    May dalawang paraan upang ibigay ang larawan:

    • Publicly accessible URL: Isang URL na accessible mula sa public internet
    • Data URI: Isang base64-encoded data URI ng larawan. Halimbawa ng data URI: data:image/jpeg;base64,<your base64-encoded image data>
  • Name
    ai_model
    Type
    string
    default inherited from the preview task
    Description

    ID ng modelo na gagamitin para sa refining.

    Mga magagamit na value:

    • meshy-6-lite, meshy-6, meshy-7.1, latest (Meshy 7.1)
    • meshy-7 (deprecated): gamitin ang meshy-7.1 sa halip.

    Alisin ang parameter na ito upang magmana ng modelo na ginamit ng preview task, na nagpapanatili sa isang preview at sa refine nito sa parehong modelo mula simula hanggang katapusan. Maglagay ng explicit na value upang i-override ang pagmamanang iyon.

  • Name
    moderation
    Type
    boolean
    default false
    Description

    Kapag itinakda sa true, awtomatikong susuriin ang input content para sa posibleng mapaminsalang nilalaman. Kung may matukoy na mapaminsalang nilalaman, hindi magpapatuloy ang task sa generation.

    Parehong susuriin ang text mula sa texture_prompt at ang larawan 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 nagbubunga ng mas malinis na resulta na mas mahusay na gumagana sa ilalim ng custom na lighting setup.

  • Name
    target_formats
    Type
    string[]
    Description

    Tinutukoy kung aling mga 3D file format ang isasama sa output. Ang mga hiniling lamang na format ang bubuuin at ibabalik, na maaaring magpaikli sa oras ng pagkumpleto ng task. Kapag tinanggal, lahat ng suportadong format ay isasama.

    Mga magagamit na value: glb, obj, fbx, stl, usdz, 3mf

  • Name
    alpha_thumbnail
    Type
    boolean
    default false
    Description

    Kapag itinakda sa true, karagdagang gagawa ang task ng transparent-background (RGBA) na bersyon ng preview at ibabalik ito bilang alpha_thumbnail_url sa GET response. Hindi nagbabago ang umiiral na thumbnail_url field.

  • Name
    auto_size
    Type
    boolean
    default false
    Description

    Kapag itinakda sa true, gumagamit ang serbisyo ng AI vision upang awtomatikong tantyahin ang real-world na taas ng object at i-resize ang modelo ayon dito. Ang origin ay magde-default sa bottom maliban kung explicit na 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 magagamit na value: bottom, center.

Mga Ibinabalik

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

Mga Paraan ng Pagkabigo

  • Name
    400 - Bad Request
    Description

    Hindi katanggap-tanggap ang request. Mga karaniwang sanhi:

    • Invalid na task ID: Ang preview_task_id ay invalid o hindi umiiral.
    • Hindi pa handa ang task: Hindi pa nagtatagumpay ang preview task.
    • Hindi tugmang modelo: Hindi tugma ang AI model ng preview task sa hiniling na refine model.
    • Hindi suportadong modelo para sa remove_lighting: Itinakda ang remove_lighting kasama ang ai_model: "meshy-6-lite".
  • Name
    401 - Unauthorized
    Description

    Nabigo ang authentication. Mangyaring suriin ang iyong API key.

  • Name
    402 - Payment Required
    Description

    Hindi sapat na credits upang maisagawa ang task na ito.

  • Name
    404 - Not Found
    Description

    Hindi natagpuan ang preview task na tinukoy ng preview_task_id.

  • Name
    429 - Too Many Requests
    Description

    Nalampasan mo na ang 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

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

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.

Ibinabalik

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

Mga Halimbawa

ModeSample Model
PreviewPreview model
RefineRefined model

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 Task

Permanenteng nagde-delete ang endpoint na ito ng isang Text to 3D task, kabilang ang lahat ng kaugnay na models at data. Hindi na maibabalik ang aksyong ito.

Path Parameters

  • Name
    id
    Type
    path
    Description

    Ang ID ng Text to 3D task na ide-delete.

Katayuan ng Task

Ang task na nasa PENDING pa ay dine-delete at ire-refund ang mga credits na nagamit noong oras ng paggawa nito.

Ang task na IN_PROGRESS na ay hindi maaaring i-delete: tatanggihan ang request na may 409 Conflict at magpapatuloy pa rin ang pagtakbo ng task. Hindi na-rrefund ang mga credits para sa isang task na nasimulan na ng worker, kaya kung ide-delete mo ito habang tumatakbo pa, mawawala sa iyo ang parehong credits at resulta. Hintayin na umabot ito sa SUCCEEDED, FAILED o CANCELED, bago ito i-delete.

Ang task na nasa terminal state (SUCCEEDED, FAILED o CANCELED) ay dine-delete nang walang refund.

Mga Ibinabalik

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

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

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS — the task is left running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}

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

List Text to 3D Tasks

Ang endpoint na ito ay nagbibigay-daan sa iyo na kumuha ng listahan ng mga Text to 3D na gawain.

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 ng laki ng pahina. Ang maximum na pinapayagan ay 100 na items.

  • Name
    sort_by
    Type
    string
    Description

    Field na gagamitin sa pag-sort.

    Mga available na halaga:

    • +created_at: Pagsunud-sunurin ayon sa oras ng paggawa nang pataas (ascending).
    • -created_at: Pagsunud-sunurin ayon sa oras ng paggawa nang pababa (descending).

Ibinabalik

Nagbabalik ng paginated na listahan ng The Text to 3D Task Objects.

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

Stream a Text to 3D Task

Ang endpoint na ito ay nagstistream 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 ististream.

Ibinabalik

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

Para sa mga task na PENDING o IN_PROGRESS, ang response stream ay magsasama lamang ng 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
}

The 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 isang text na input. May dalawang yugto ang Text to 3D API, ang preview at refine. Ang preview stage ay para sa paggawa ng mesh-only na 3D model, at ang refine stage ay para sa paggawa ng textured na 3D model base sa resulta ng preview stage.

Ang object ay may mga sumusunod na properties:

Properties

  • Name
    id
    Type
    string
    Description

    Natatanging identifier para sa task. Bagama't gumagamit kami ng k-sortable UUID para sa mga task id bilang implementation detail, hindi ka dapat gumawa ng anumang palagay 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

    Downloadable URL sa textured na 3D model file na nabuo ng Meshy. Ang property para sa isang format ay aalisin kung hindi nabuo ang format, sa halip na magbalik ng isang walang-lamang string.

    • Name
      glb
      Type
      string
      Description

      Downloadable URL sa GLB file.

    • Name
      fbx
      Type
      string
      Description

      Downloadable URL sa FBX file.

    • Name
      usdz
      Type
      string
      Description

      Downloadable URL sa USDZ file.

    • Name
      obj
      Type
      string
      Description

      Downloadable URL sa OBJ file.

    • Name
      mtl
      Type
      string
      Description

      Downloadable URL sa MTL file.

    • Name
      stl
      Type
      string
      Description

      Downloadable URL sa STL file.

    • Name
      3mf
      Type
      string
      Description

      Downloadable URL sa 3MF file. Lalabas 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

    Pinapanatili para sa backward compatibility. Ang field na ito ay walang functional na epekto 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 suportado ng Meshy-6.

  • Name
    texture_richness
    Type
    string
    ⚠ lipas na
    Description

    Pinapanatili para sa backward compatibility. Ang field na ito ay walang functional na epekto sa mga nabuong model.

  • Name
    texture_prompt
    Type
    string
    Description

    Karagdagang text prompt na ibinigay upang gabayan ang proseso ng pag-texture sa panahon ng refine stage.

  • Name
    ultra_mode
    Type
    boolean
    ⚠ lipas na
    Description

    Deprecated na; basahin na lamang ang geometry_resolution.

  • Name
    geometry_resolution
    Type
    string
    Description

    Ang Ultra tier kung saan pinatakbo ang preview task (2k o 4k); aalisin para sa standard.

  • Name
    texture_image_url
    Type
    string
    Description

    Downloadable URL sa texture image na ginamit upang gabayan ang proseso ng pag-texture.

  • Name
    thumbnail_url
    Type
    string
    Description

    Downloadable URL sa thumbnail image ng model file.

  • Name
    alpha_thumbnail_url
    Type
    string
    Description

    Downloadable URL sa isang bersyon na may transparent na background (RGBA) ng thumbnail_url. Lalabas lamang kapag ang task ay ginawa gamit ang alpha_thumbnail: true at matagumpay na na-render ang transparent na preview; kung hindi, aalisin ang field na ito.

  • Name
    video_url
    Type
    string
    ⚠ lipas na
    Description

    Downloadable URL sa preview video. Aalisin sa isang susunod na release.

  • 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, ito ay magiging 100.

  • 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.

  • Name
    created_at
    Type
    timestamp
    Description

    Timestamp kung kailan nagawa ang task, sa milliseconds.

  • Name
    finished_at
    Type
    timestamp
    Description

    Timestamp kung kailan natapos ang task, sa milliseconds. Kung hindi pa natatapos 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 properties:

    • Name
      base_color
      Type
      string
      Description

      Downloadable URL sa base color map image.

    • Name
      metallic
      Type
      string
      Description

      Downloadable URL sa metallic map image.

    • Name
      normal
      Type
      string
      Description

      Downloadable URL sa normal map image.

    • Name
      roughness
      Type
      string
      Description

      Downloadable URL sa roughness map image.

    • Name
      emission
      Type
      string
      Description

      Downloadable URL sa emission map image.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Ang bilang ng mga naunang task.

  • Name
    task_error
    Type
    object
    Description

    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 mga credits na nagamit ng task na ito. Lalabas kapag ang status ng task ay PENDING, IN_PROGRESS, o SUCCEEDED. Nagbabalik ng 0 para sa mga FAILED na task (ang mga credits ay ire-refund 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,
  "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
}