Text to 3D API

Ang Text to 3D API ay isang feature na nagbibigay-daan sa iyo na i-integrate 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.

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


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

Create a Text to 3D Preview Task

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

Mga Parameter

  • Name
    mode
    Type
    string
    Kinakailangan
    Description

    Ang field na ito ay dapat na "preview" kapag gumagawa ng preview task.

  • Name
    prompt
    Type
    string
    Kinakailangan
    Description

    Ilarawan kung anong uri ng bagay ang 3D model. Maximum na 800 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 3D mesh generation.
    • smart-topology: Piliin ang Smart Topology model gamit ang ai_model (meshy-t2).
    • lowpoly (deprecated): Naglilikha ng low-poly mesh na na-optimize para sa mas malinis na polygons. Inirerekomenda naming gamitin ang smart-topology sa halip.
  • Name
    ai_model
    Type
    string
    default latest
    Description

    ID ng model na 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, natural na hiwalay na mga bahagi, triangle output, at isang face count na maitatakda mo gamit ang target_polycount.
  • Name
    ultra_mode
    Type
    boolean
    default false
    Description

    Nagpapagana ng Ultra generation para sa mas mataas na kalidad na heometriya na may mas pinong detalye sa ibabaw. Mas matagal ang pagbuo at nagdaragdag ng 5 credits.

  • Name
    should_remesh
    Type
    boolean
    default false (meshy-6, meshy-7), true (others)
    Description

    Kinokontrol kung papaganahin 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: Buuin ang isang quad-dominant mesh.
    • triangle: Buuin ang isang decimated triangle mesh.
  • Name
    decimation_mode
    Type
    integer
    Description

    Paganahin ang adaptive decimation sa pagtakda ng isang polycount level. Kapag naitakda ito, hindi ginagamit ang target_polycount.

    Mga available na value:

    • 1: Adaptive — ultra polycount.
    • 2: Adaptive — high polycount.
    • 3: Adaptive — medium polycount.
    • 4: Adaptive — low polycount.
  • Name
    target_polycount
    Type
    integer
    Description

    Target na bilang ng polygons (faces) sa output. Ang aktwal na bilang ay maaaring mag-iba mula sa target depende sa heometriya.

    Ang target_polycount ay may bisa sa dalawang independiyenteng kaso:

    • Remesh — kasama ang should_remesh: true sa isang standard model. Ang mesh ay ni-remesh (decimated) sa humigit-kumulang na bilang na ito. Saklaw na 100 hanggang 300,000, default na 30,000. Kapag naitakda ang decimation_mode, ito ang mananaig at hindi ginagamit ang target_polycount.
    • Smart Topology — kasama ang model_type: smart-topology at ai_model: meshy-t2. Ang model ay direktang binubuo sa bilang ng face 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. Ang parameter na ito ay hindi na nakaaapekto sa output.

    Ang field na symmetry_mode ay kinokontrol ang paggana ng simetriya sa proseso ng generation ng model.

    Ang mga valid na value ay:

    • off: Hindi pinagana ang simetriya.
    • auto: Awtomatikong tinutukoy at ikinakapit ang simetriya batay sa input geometry.
    • 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: Buuin ang model sa A pose.
    • t-pose: Buuin ang model sa T pose.
    • "" (empty string): Walang partikular na pose na ikakapit.
  • Name
    is_a_t_pose
    Type
    boolean
    lipas na
    default false
    Description

    Gamitin ang pose_mode sa halip. Kung buuin ba ang model sa A/T pose.

  • Name
    art_style
    Type
    string
    lipas na
    default realistic
    Description

    Hindi suportado ng Meshy-6. Ang mga request na gumagamit ng Meshy-6 ay hindi papansinin ang art_style, at ang ilang kombinasyon ay maaaring magdulot ng errors. Mga available na value: realistic, sculpture.

  • Name
    moderation
    Type
    boolean
    default false
    Description

    Kapag itinakda sa true, ang input content ay awtomatikong susuriin para sa potensyal na nakapipinsalang nilalaman. Kapag natukoy ang nakapipinsalang 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 mabawasan ang oras ng pagkumpleto ng task. Kapag hindi ito isinama, lahat ng suportadong format ay isasama.

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

  • Name
    alpha_thumbnail
    Type
    boolean
    default false
    Description

    Kapag itinakda sa true, ang task ay bubuo pa ng bersyon ng preview na may transparent-background (RGBA) at ibabalik ito bilang alpha_thumbnail_url sa GET response. Ang umiiral na field na thumbnail_url ay hindi nagbabago.

  • Name
    auto_size
    Type
    boolean
    default false
    Description

    Kapag itinakda sa true, gagamit ang serbisyo ng AI vision upang awtomatikong tantyahin ang real-world na taas ng bagay at ayusin ang laki ng model alinsunod dito. Ang origin ay magiging bottom bilang default 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 pinagana ang auto_size.

    Mga available na value: bottom, center.

Ibinabalik

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

Mga Mode ng Kabiguan

  • Name
    400 - Bad Request
    Description

    Ang request ay hindi katanggap-tanggap. Karaniwang mga sanhi:

    • Nawawalang parameter: Ang isang kinakailangang parameter (hal., prompt, mode) ay nawawala.
    • Di-wastong parameter: Ang art_style ay hindi isa sa mga pinapayagang value.
    • Masyadong mahaba ang prompt: Ang prompt ay lumampas sa limitasyon ng karakter.
  • Name
    401 - Unauthorized
    Description

    Nabigo ang authentication. Mangyaring suriin 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 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

Create a 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.

Mga Parameter

  • Name
    mode
    Type
    string
    Kinakailangan
    Description

    Ang field na ito ay dapat na naka-set sa "refine" kapag gumagawa ng refine task.

  • Name
    preview_task_id
    Type
    string
    Kinakailangan
    Description

    Ang katumbas na preview task id.

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

  • Name
    enable_pbr
    Type
    boolean
    default false
    Description

    Gumawa ng PBR maps (metallic, roughness, normal) bilang karagdagan sa base color. Isang emission map din ang isinasama kapag ang ai_model ay meshy-6, maliban sa texture_resolution: 8k (walang emission map na nabubuo). Ang meshy-7 (at latest) ay hindi gumagawa ng emission map.

  • 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 nakakakuha ng mas maraming detalye ng surface. Naaangkop lamang sa refine mode.

  • Name
    hd_texture
    Type
    boolean
    lipas na
    default false
    Description

    Gamitin ang texture_resolution sa halip — katumbas ng texture_resolution: "4k". Kapag pareho itong naka-set, ang texture_resolution ang mananaig.

  • Name
    texture_prompt
    Type
    string
    Description

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

  • Name
    texture_image_url
    Type
    string
    Description

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

    Mayroong dalawang paraan upang ibigay ang larawan:

    • Publicly accessible URL: Isang URL na naa-access mula sa pampublikong 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 latest
    Description

    ID ng model na gagamitin para sa pag-re-refine. Mga available na value: meshy-5, meshy-6, meshy-7, latest (Meshy 7).

  • Name
    moderation
    Type
    boolean
    default false
    Description

    Kapag naka-set sa true, awtomatikong susuriin ang input content para sa posibleng mapaminsalang nilalaman. Kung may natukoy na mapaminsalang nilalaman, hindi magpapatuloy ang task sa generation.

    Pareho ang text mula sa texture_prompt at ang larawan mula sa texture_image_url ay susuriin.

  • Name
    remove_lighting
    Type
    boolean
    default true
    Description

    Inaalis ang mga highlight at anino mula sa base color texture, na nagbubunga ng mas malinis na resulta na mas mahusay gumana sa custom na lighting setups.

  • 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 magpabawas sa oras ng pagkumpleto ng task. Kapag hindi ibinigay, 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 naka-set sa true, karagdagang nagre-render ang task ng transparent-background (RGBA) na bersyon ng preview at ibinabalik ito bilang alpha_thumbnail_url sa GET response. Ang umiiral na thumbnail_url field ay hindi nagbabago.

  • Name
    auto_size
    Type
    boolean
    default false
    Description

    Kapag naka-set sa true, ginagamit ng serbisyo ang AI vision upang awtomatikong tantiyahin ang real-world na taas ng object at i-resize ang model nang naaayon. Ang origin ay magiging bottom bilang default maliban kung tahasang naka-set 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 result property ng response ay naglalaman ng task id ng bagong ginawang Text to 3D task.

Mga Failure Mode

  • Name
    400 - Bad Request
    Description

    Hindi katanggap-tanggap ang request. Karaniwang mga sanhi:

    • Invalid task ID: Ang preview_task_id ay hindi wasto o hindi umiiral.
    • Task not ready: Ang preview task ay hindi pa nagtagumpay.
    • Model mismatch: Ang AI model ng preview task ay hindi tugma sa hiniling na refine model.
  • 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
    404 - Not Found
    Description

    Hindi natagpuan ang preview task na tinukoy ng preview_task_id.

  • Name
    429 - Too Many Requests
    Description

    Nalagpasan 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 isang wastong id ng task. Sumangguni sa The Text to 3D Task Object upang makita kung aling mga property 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 tugon ay naglalaman ng Text to 3D task object. Tingnan ang seksyong The Text to 3D Task Object 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 dine-delete ng endpoint na ito ang isang Text to 3D task, kasama ang lahat ng kaugnay na mga modelo 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.

Returns

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

List Text to 3D Tasks

Ang endpoint na ito ay nagbibigay-daan sa iyo na kunin ang isang 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 ng laki ng pahina. Ang pinakamataas na pinapayagan ay 50 na item.

  • Name
    sort_by
    Type
    string
    Description

    Field na gagamitin sa pag-aayos.

    Mga available na value:

    • +created_at: Iayos ayon sa oras ng paggawa nang paakyat (ascending).
    • -created_at: Iayos ayon sa oras ng paggawa nang pababa (descending).

Ibinabalik

Nagbabalik ng isang paginated na listahan 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 Text to 3D Task

Ang endpoint na ito ay nag-stream ng real-time na mga 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 Ibabalik

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 mga kinakailangang 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 yunit ng trabaho na sinusubaybayan ng Meshy upang bumuo ng 3D model mula sa text na input. May dalawang yugto ang Text to 3D API, 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 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. Bagaman gumagamit kami ng k-sortable UUID para sa mga task id bilang detalye ng implementasyon, hindi ka dapat gumawa ng anumang palagay tungkol sa format ng id.

  • Name
    type
    Type
    string
    Description

    Uri ng Text to 3D task. Ang mga posibleng value ay text-to-3d-preview para sa mga preview stage task at text-to-3d-refine para sa mga refine stage task.

  • Name
    model_urls
    Type
    object
    Description

    Downloadable URL patungo sa textured na 3D model file na ginawa ng Meshy. Ang property para sa isang format ay hindi isasama kung hindi nabuo ang format, sa halip na magbalik ng walang laman na string.

    • Name
      glb
      Type
      string
      Description

      Downloadable URL patungo sa GLB file.

    • Name
      fbx
      Type
      string
      Description

      Downloadable URL patungo sa FBX file.

    • Name
      usdz
      Type
      string
      Description

      Downloadable URL patungo sa USDZ file.

    • Name
      obj
      Type
      string
      Description

      Downloadable URL patungo sa OBJ file.

    • Name
      mtl
      Type
      string
      Description

      Downloadable URL patungo sa MTL file.

    • Name
      stl
      Type
      string
      Description

      Downloadable URL patungo sa STL file.

    • Name
      3mf
      Type
      string
      Description

      Downloadable URL patungo sa 3MF file. Naipapakita lang ito kapag hiningi ang 3mf sa pamamagitan ng target_formats.

  • Name
    prompt
    Type
    string
    Description

    Ito ang hindi binagong prompt na ginamit upang likhain ang task.

  • Name
    negative_prompt
    Type
    string
    lipas na
    Description

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

  • Name
    art_style
    Type
    string
    lipas na
    Description

    Ang hindi binagong art_style na ginamit upang likhain 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 epekto sa paggana ng mga nabuong model.

  • Name
    texture_prompt
    Type
    string
    Description

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

  • Name
    ultra_mode
    Type
    boolean
    Description

    Ipinapakita ang value ng ultra_mode na ginamit noong nilikha ang preview task. Naipapakita lang ito para sa meshy-7 (o latest) na mga preview task na tahasang nagtakda ng ultra_mode; hindi isinasama kung hindi.

  • Name
    texture_image_url
    Type
    string
    Description

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

  • Name
    thumbnail_url
    Type
    string
    Description

    Downloadable URL patungo sa thumbnail image ng model file.

  • Name
    alpha_thumbnail_url
    Type
    string
    Description

    Downloadable URL patungo sa bersyon na may transparent background (RGBA) ng thumbnail_url. Naipapakita lang ito kapag ang task ay nilikha gamit ang alpha_thumbnail: true at matagumpay na na-render ang transparent na preview; kung hindi, hindi isasama ang field na ito.

  • Name
    video_url
    Type
    string
    lipas na
    Description

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

  • Name
    progress
    Type
    integer
    Description

    Progreso ng task. Kung hindi pa nasisimulan 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 sinimulan ang task, sa milliseconds. Kung hindi pa nasisimulan ang task, ang property na ito ay magiging 0.

  • Name
    created_at
    Type
    timestamp
    Description

    Timestamp kung kailan nilikha ang task, sa milliseconds.

  • Name
    finished_at
    Type
    timestamp
    Description

    Timestamp kung kailan natapos ang task, sa milliseconds. Kung hindi pa tapos ang task, ang property na ito ay magiging 0.

  • Name
    status
    Type
    string
    Description

    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, iisang texture URL object lang ang laman nito. Ang bawat texture URL ay may mga sumusunod na property:

    • Name
      base_color
      Type
      string
      Description

      Downloadable URL patungo sa base color map image.

    • Name
      metallic
      Type
      string
      Description

      Downloadable URL patungo sa metallic map image.

    • Name
      normal
      Type
      string
      Description

      Downloadable URL patungo sa normal map image.

    • Name
      roughness
      Type
      string
      Description

      Downloadable URL patungo sa roughness map image.

    • Name
      emission
      Type
      string
      Description

      Downloadable URL patungo sa emission map image.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Ang bilang ng mga naunang task.

  • Name
    task_error
    Type
    object
    Description

    Mga detalye ng error para sa mga nabigong task. Tingnan ang Errors para sa buong reference ng task_error object.

  • Name
    consumed_credits
    Type
    integer
    Description

    Ang bilang ng credits na ginamit ng task na ito. Naipapakita kapag ang status ng task ay PENDING, IN_PROGRESS, o SUCCEEDED. Nagbabalik ng 0 para sa mga FAILED na task (ang 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
}