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

Creative Lab Brick Figure API

Gawing isang brick-style na nakokolektang 3D minifigure ang isang larawan sa dalawang yugto. Gumagawa ang prototype task ng concept image mula sa larawan. Ginagawang textured 3D model ng build task ang larawang iyon, at kinukuha nito ang ID ng prototype task bilang input_task_id.

  • POST /openapi/creative-lab/brick-figure/v1/prototype
  • POST /openapi/creative-lab/brick-figure/v1/build

POST/openapi/creative-lab/brick-figure/v1/prototype

Create a Brick Figure prototype task

Bumubuo ng isang brick-style na concept image mula sa isang litrato. Para buuin ang 3D model, ipasa ang ID ng task na ito sa build endpoint bilang input_task_id. Para sa mga field ng task, tingnan ang The Brick Figure prototype task object.

Request

POST
/openapi/creative-lab/brick-figure/v1/prototype
# Stage 1: generate a brick-style concept image
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype \
  -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>"
  }'

Response

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

Mga Parameter

  • Name
    image_url
    Type
    string
    Kinakailangan
    Description

    Ang litratong gagawing brick minifigure, bilang isang pampublikong URL o isang data URI (data:image/jpeg;base64,<your base64-encoded image data>).

    Ang larawan ay dapat na isang JPG, JPEG, PNG, o WebP file na hindi hihigit sa 20 MB.

  • Name
    name
    Type
    string
    Description

    Isang pangalan para sa task, hanggang 100 character. Ito ay babalik sa name field ng task. Kung mas mahaba ang pangalan, magbabalik ito ng 400.

  • Name
    remove_background
    Type
    boolean
    default false
    Description

    Kung aalisin ang background mula sa prototype image. Ang true ay nagbabalik ng transparent RGBA PNG, kaya maaari mong ilagay ang subject sa anumang background. Ang build ay magsisimula rin mula sa larawan nang walang background nito. Kung hindi maalis ni Meshy ang background, ibabalik nito ang larawan kasama ang background nito, at magtatagumpay pa rin ang task.

Mga Ibinabalik

Ang result field ay naglalaman ng ID ng bagong prototype task. Kunin ang task o i-stream ito hanggang ang status ay SUCCEEDED. Pagkatapos, ipasa ang ID sa build endpoint bilang input_task_id.

Mga mode ng kabiguan

  • Name
    400 - Bad Request
    Description

    Hindi maaaring tumakbo ang kahilingan. Halimbawa:

    • Nawawala ang image_url.
    • Ang larawan ay hindi isang JPG, JPEG, PNG, o WebP file.
    • Ang larawan ay masyadong maliit, lampas sa 20 MB, o lampas sa maximum na bilang ng pixel.
    • Hindi ma-download ni Meshy ang larawan, halimbawa dahil ang URL ay nagbabalik ng 404 o nag-time out.
    • Ang data URI ay hindi valid na base64.
    • Na-flag ang larawan bilang NSFW.

    Sinasabi ng error message kung aling problema ang natagpuan nito. Ayusin ang kahilingan, pagkatapos ay ipadala itong muli.

  • Name
    401 - Unauthorized
    Description

    Nawawala o invalid ang API key. Tingnan ang Authorization header.

  • Name
    402 - Payment Required
    Description

    Isa sa mga ito ang nagaganap:

    • Hindi sapat ang credits ng account.
    • Naabot ng API key, workspace, o miyembro ang limitasyon ng credit nito.
    • Nasa free plan ang account.

    Tingnan ang iyong credits at plan, pagkatapos ay subukan muli.

  • Name
    403 - Forbidden
    Description

    Naka-on ang IP Filtering ng iyong team, at na-flag ni Meshy ang larawan para sa intellectual property ng ibang partido. Magpadala ng larawan na may karapatan kang gamitin.

  • Name
    429 - Too Many Requests
    Description

    Isa sa mga limitasyong ito ang naabot:

    • Nagpadala ka ng mas maraming kahilingan kaysa sa pinapayagan ng iyong rate limit. Maghintay ng ilang segundo, pagkatapos ay subukan muli. Tingnan ang Rate limits.
    • Masyadong maraming task mo ang naka-queue o tumatakbo. Maghintay hanggang matapos ang ilan, pagkatapos ay subukan muli.
    • Sa isang unlimited plan na walang natitirang credits, naabot mo ang bilang ng mga task na maaaring tumakbo nang walang credits. Maghintay hanggang matapos ang isang task, o magdagdag ng credits.
  • Name
    500 - Internal Server Error
    Description

    Nakatagpo si Meshy ng server error, halimbawa dahil hindi nito matakbo ang pagsusuri sa intellectual property sa larawan. Hindi gagawa si Meshy ng task, at ire-refund ang anumang credits na singilin nito. Subukan muli ang kahilingan.


POST/openapi/creative-lab/brick-figure/v1/build

Gumawa ng Brick Figure build task

Gumagawa ng textured 3D minifigure mula sa isang matagumpay na (succeeded) prototype task. Para sa mga field nito, tingnan ang The Brick Figure build task object.

Request

POST
/openapi/creative-lab/brick-figure/v1/build
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578"
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}

Mga Parameter

  • Name
    input_task_id
    Type
    string
    Kinakailangan
    Description

    Ang ID ng prototype task na ibi-build. Dapat itong isang task na ginawa ng iyong account gamit ang POST /openapi/creative-lab/brick-figure/v1/prototype, na may status na SUCCEEDED.

    Ang isang ID na hindi isa sa iyong mga Brick Figure prototype task mula sa API ay magbabalik ng 404, kabilang ang isang prototype na ginawa sa web app.

  • Name
    name
    Type
    string
    Description

    Isang pangalan para sa task, hanggang 100 character. Makikita ito sa name field ng task. Ang mas mahabang pangalan ay magbabalik ng 400.

Mga Ibinabalik

Ang result field ay naglalaman ng ID ng bagong build task. Kunin ang task o i-stream ito hanggang ang status ay maging SUCCEEDED. Pagkatapos, i-download ang textured GLB mula sa model_urls.glb. Para naman sa OBJ, i-download ang model_urls.obj kasama ang material file nito mula sa model_urls.mtl.

Mga Paraan ng Pagkabigo

  • Name
    400 - Bad Request
    Description

    Hindi matatakbo ang request. Halimbawa:

    • Nawawala ang input_task_id o hindi ito valid na task ID.
    • Ang status ng prototype task ay hindi SUCCEEDED. Kung tumatakbo pa ito, maghintay at subukan muli. Kung nabigo o na-cancel ito, gumawa ng bagong prototype task.
    • Matagumpay ang prototype task ngunit walang imahe. Gumawa ng bagong prototype task.

    Sinasabi ng error message kung aling problema ang nahanap nito.

  • Name
    401 - Unauthorized
    Description

    Nawawala o hindi valid ang API key. Suriin ang Authorization header.

  • Name
    402 - Payment Required
    Description

    Isa sa mga sumusunod ang nangyari:

    • Walang sapat na credits ang account.
    • Naabot ng API key, workspace, o member ang limitasyon nito sa credit.
    • Nasa free plan ang account.

    Suriin ang iyong mga credits at plan, pagkatapos ay subukan muli.

  • Name
    404 - Not Found
    Description

    Ang input_task_id ay hindi tumutugma sa anumang Brick Figure prototype task na ginawa ng iyong account gamit ang API. Ang isang prototype na ginawa sa web app ay magbabalik din ng 404. Ipadala ang result ID mula sa isang prototype create response.

  • Name
    429 - Too Many Requests
    Description

    Isa sa mga sumusunod na limitasyon ang naabot:

    • Nagpadala ka ng mas maraming request kaysa sa pinapayagan ng iyong rate limit. Maghintay ng ilang segundo, pagkatapos ay subukan muli. Tingnan ang Rate limits.
    • Masyadong maraming task mo ang nakapila o tumatakbo. Maghintay hanggang matapos ang ilan, pagkatapos ay subukan muli.
    • Sa isang unlimited plan na walang natitirang credits, naabot mo na ang bilang ng mga task na maaaring tumakbo nang walang credits. Maghintay hanggang matapos ang isang task, o magdagdag ng credits.

GET/openapi/creative-lab/brick-figure/v1/(prototype|build)/:id

Kumuha ng Brick Figure task

Nagbabalik ng prototype o build task. Ang path ay dapat tumugma sa stage ng task. Ang isang build task na hiniling sa pamamagitan ng /prototype/:id ay nagbabalik ng 404, at ganoon din ang prototype task na hiniling sa pamamagitan ng /build/:id.

Para sa mga field, tingnan ang The Brick Figure prototype task object at The Brick Figure build task object.

Request

GET
/openapi/creative-lab/brick-figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578
# Prototype
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-brick-figure-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-brick-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}

Mga Parameter

  • Name
    id
    Type
    path
    Description

    Ang task ID mula sa create response.

Ibinabalik

Ang prototype task object o ang build task object, na tumutugma sa stage sa path.

Mga kaso ng pagkabigo

  • Name
    400 - Bad Request
    Description

    Ang id ay hindi valid na task ID. Ipadala ang result ID mula sa create response.

  • Name
    403 - Forbidden
    Description

    Naka-on ang IP Filtering para sa iyong team, at na-flag ng Meshy ang imahe ng task dahil sa intellectual property ng ibang partido. Hindi nakukuha ng mga team sa Enterprise plan ang error na ito. Gumawa ng prototype task mula sa isang imahe na may karapatan kang gamitin.

  • Name
    404 - Not Found
    Description

    Walang Brick Figure task na may ID na ito na kabilang sa iyong account, o hindi tumutugma ang stage ng task sa path. Suriin ang ID, at gamitin ang /prototype o /build para tumugma sa task.

  • Name
    500 - Internal Server Error
    Description

    Hindi na-run ni Meshy ang intellectual property check. Subukan ulit ang request.


DELETE/openapi/creative-lab/brick-figure/v1/(prototype|build)/:id

Burahin ang Brick Figure task

Kinakansela ang isang Brick Figure task. Ang pagkansela ng PENDING na task ay nagre-refund ng mga credits nito. Ang isang IN_PROGRESS na task ay kinakansela nang walang refund, dahil may worker na nagsimula na nito. Ang isang task na may final status (SUCCEEDED, FAILED, o CANCELED) ay hindi na puwedeng kanselahin.

Ang path ay dapat tumugma sa stage ng task. Halimbawa, ang DELETE sa /prototype/:id gamit ang ID ng build task ay magbabalik ng 404.

Request

DELETE
/openapi/creative-lab/brick-figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578
curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 204 No Content on success (empty body).

Mga path parameter

  • Name
    id
    Type
    path
    Description

    Ang ID ng task na kakanselahin.

Ibinabalik

204 No Content na may walang laman na body.

Mga failure mode

  • Name
    400 - Bad Request
    Description

    Isa sa mga sumusunod ang nalalapat:

    • Ang id ay hindi valid na task ID. Ipadala ang result ID mula sa create response.
    • Ang task ay mayroon nang final status (SUCCEEDED, FAILED, o CANCELED), kaya hindi na ito puwedeng kanselahin.
  • Name
    404 - Not Found
    Description

    Walang Brick Figure task na may ID na ito na kabilang sa iyong account, o ang stage ng task ay hindi tumutugma sa path. Suriin ang ID, at gamitin ang /prototype o /build upang itugma ang task.


GET/openapi/creative-lab/brick-figure/v1/(prototype|build)/:id/stream

Stream a Brick Figure task

Nagsa-stream ng mga update ng isang Brick Figure task bilang Server-Sent Events (SSE). Dapat tumugma ang path sa stage ng task. Kung hindi ito tumugma, halimbawa ang ID ng isang build task sa /prototype/:id/stream, magpapadala ang stream ng isang error event na may status_code: 404 at magsasara.

Request

GET
/openapi/creative-lab/brick-figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream
curl -N https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example (wrong stage or task not found)
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// Every frame is the full task object; fields not yet populated are null / empty.
// The following PENDING frame is shortened to the fields that change.
event: message
data: {
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-brick-figure-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}

Mga Parameter

  • Name
    id
    Type
    path
    Description

    Ang task ID mula sa create response.

Ibinabalik

Isang stream ng prototype o build task object. Ang bawat event ay naglalaman ng buong task object, gaya ng ibinabalik ito ng Get a Brick Figure task. Habang ang task ay PENDING o IN_PROGRESS, ang mga output field nito ay walang laman pa (null, [], o {}), at ang finished_at ay null.

Kung hinaharang ng IP Filtering ang resulta ng task, magpapadala ang stream ng isang error event sa halip nito, kasama ang status_code na ibabalik sana ng isang get request.


GET/openapi/creative-lab/brick-figure/v1/(prototype|build)

List ng mga Brick Figure task

Ibinabalik ang iyong mga Brick Figure task para sa isang stage, isang page sa bawat pagkakataon. Ang path ang pumipili ng stage. Ang /prototype ay nagbabalik lamang ng mga prototype task, at ang /build ay nagbabalik lamang ng mga build task.

Request

GET
/openapi/creative-lab/brick-figure/v1/prototype
# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-brick-figure-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729123456000,
    "started_at": 1729123460000,
    "finished_at": 1729123486000,
    "expires_at": 1729382686000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "image_urls": [
      "https://assets.meshy.ai/***/concept.png?Expires=***"
    ]
  }
]

Mga path parameter

  • Name
    stage
    Type
    path
    Kinakailangan
    Description

    Ang stage na ililista, prototype o build.

Mga query parameter

  • Name
    page_num
    Type
    integer
    default 1
    Description

    Ang page na ibabalik, mula 1 hanggang 255. Ang 0 ay nagbabalik ng unang page. Ang isang value na wala sa 0 hanggang 255 ay nagbabalik ng 400.

  • Name
    page_size
    Type
    integer
    default 10
    Description

    Bilang ng mga task kada page, hanggang 100. Ang isang value mula 101 hanggang 255 ay nagbabalik ng 100 task, at ang 0 ay gumagamit ng default. Ang isang value na wala sa 0 hanggang 255 ay nagbabalik ng 400.

  • Name
    sort_by
    Type
    string
    default -created_at
    Description

    Ang pagkakaayos ng sort.

    Mga available na value:

    • -created_at: pinakabago muna
    • +created_at: pinakaluma muna

Ibinabalik

Isang array ng prototype task objects o build task objects, na tumutugma sa stage na nasa path.


Ang Brick Figure prototype task object

Ang isang prototype task ay bumubuo ng brick-style na konseptong imahe mula sa isang larawan. Upang gawing 3D model ang imahe, ipasa ang ID ng task sa build endpoint bilang input_task_id.

Mga Property

Example Brick Figure Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-brick-figure-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}
  • Name
    id
    Type
    string
    Description

    Ang task ID. Huwag umasa sa format nito.

  • Name
    type
    Type
    string
    Description

    Ang uri ng task, palaging creative-lab-brick-figure-prototype.

  • Name
    name
    Type
    string
    Description

    Ang name na ipinadala mo nang ginawa mo ang task, o "" kung wala kang ipinadalang pangalan.

  • Name
    status
    Type
    string
    Description

    Ang status ng task.

    Mga available na value:

    • PENDING: naghihintay sa queue
    • IN_PROGRESS: bumubuo ng resulta
    • SUCCEEDED: final, may resulta
    • FAILED: final, nasa task_error ang dahilan
    • CANCELED: final, walang resulta
  • Name
    progress
    Type
    integer
    Description

    Porsyento ng natapos na gawain, mula 0 hanggang 100. Ito ay 0 hanggang magsimula ang task at 100 kapag ito ay nagtagumpay.

  • Name
    created_at
    Type
    timestamp
    Description

    Oras na ginawa ang task, sa Unix milliseconds.

  • Name
    started_at
    Type
    timestamp
    Description

    Oras na sinimulan ng isang worker ang task, sa Unix milliseconds. null hanggang dumating ang oras na iyon.

  • Name
    finished_at
    Type
    timestamp
    Description

    Oras na umabot ang task sa final status, sa Unix milliseconds. null hanggang dumating ang oras na iyon.

  • Name
    expires_at
    Type
    timestamp
    Description

    Oras na mag-e-expire ang resulta ng task, sa Unix milliseconds. Ito ay 3 araw pagkatapos ng finished_at, o 3 araw pagkatapos ng created_at hanggang matapos ang task. Para sa mga Enterprise account, na nagpapanatili ng mga resulta ng API nang walang hanggan, ito ay humigit-kumulang 100 taon mamaya. Tingnan ang Asset retention.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Ang posisyon ng task sa queue habang ito ay PENDING. Ang 1 ay nangangahulugang susunod na itong magsisimula. 0 pagkatapos umalis ng task sa queue, at palaging 0 sa mga resulta ng listahan.

  • Name
    task_error
    Type
    object
    Description

    Kung bakit nabigo ang task. null maliban kung status ay FAILED. Tingnan ang Errors.

  • Name
    consumed_credits
    Type
    integer
    Description

    Bilang ng mga credit na sinisingil para sa task, pagkatapos ng anumang refund. Hindi sinisingil ang isang request na nagbabalik ng error. Ang isang nabigong task ay 0, dahil ire-refund ito ng Meshy. Ang pagkansela ay nagre-refund ng isang task lamang habang ito ay PENDING. Kung hindi mabasa ng Meshy ang singil, aalisin ng get o stream response ang field, at magbabalik ng 500 ang isang list request. Sa kasong iyon, subukan muli ang request.

  • Name
    image_urls
    Type
    array of strings
    Description

    Mga download URL para sa konseptong imahe. Ang array ay may isang URL pagkatapos magtagumpay ang task, at walang laman hanggang mangyari iyon.


Ang Brick Figure build task object

Ang isang build task ay bumubuo ng isang textured 3D minifigure mula sa isang matagumpay na prototype task. Ang mga field nitong model_urls, thumbnail_url, at texture_urls ay may parehong format tulad ng nasa Image to 3D task object.

Mga Properties

Example Brick Figure Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-brick-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}
  • Name
    id
    Type
    string
    Description

    Ang task ID. Huwag umasa sa format nito.

  • Name
    type
    Type
    string
    Description

    Ang uri ng task, palaging creative-lab-brick-figure-build.

  • Name
    name
    Type
    string
    Description

    Ang name na ipinadala mo noong ginawa mo ang task, o "" kung hindi ka nagpadala ng isa.

  • Name
    status
    Type
    string
    Description

    Ang status ng task.

    Mga available na value:

    • PENDING: naghihintay sa queue
    • IN_PROGRESS: ginagawa ang resulta
    • SUCCEEDED: final, may resulta
    • FAILED: final, nasa task_error ang dahilan
    • CANCELED: final, walang resulta
  • Name
    progress
    Type
    integer
    Description

    Porsyento ng natapos na trabaho, mula 0 hanggang 100. Ito ay 0 hanggang magsimula ang task at 100 kapag ito ay nagtagumpay.

  • Name
    created_at
    Type
    timestamp
    Description

    Oras na nilikha ang task, sa Unix milliseconds.

  • Name
    started_at
    Type
    timestamp
    Description

    Oras na sinimulan ng isang worker ang task, sa Unix milliseconds. null hanggang sa mangyari iyon.

  • Name
    finished_at
    Type
    timestamp
    Description

    Oras na naabot ng task ang final status, sa Unix milliseconds. null hanggang sa mangyari iyon.

  • Name
    expires_at
    Type
    timestamp
    Description

    Oras na mag-e-expire ang resulta ng task, sa Unix milliseconds. Ito ay 3 araw pagkatapos ng finished_at, o 3 araw pagkatapos ng created_at hanggang matapos ang task. Para sa mga Enterprise account, na nagtatago ng mga resulta ng API nang walang hanggan, ito ay humigit-kumulang 100 taon mamaya. Tingnan ang Asset retention.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Posisyon ng task sa queue habang ito ay PENDING. Ibig sabihin ng 1, ito na ang susunod na magsisimula. 0 kapag umalis na ang task sa queue, at palaging 0 sa mga resulta ng list.

  • Name
    task_error
    Type
    object
    Description

    Dahilan kung bakit nabigo ang task. null maliban kung ang status ay FAILED. Tingnan ang Errors.

  • Name
    consumed_credits
    Type
    integer
    Description

    Bilang ng mga credits na sinisingil para sa task, pagkatapos ng anumang refund. Ang isang request na nagbabalik ng error ay hindi sinisingil. Ang isang nabigong task ay 0, dahil ire-refund ito ni Meshy. Ang pagkansela ay nag-re-refund ng task lamang habang ito ay PENDING. Kung hindi mabasa ni Meshy ang singil, aalisin ng get o stream response ang field, at ang isang list request ay magbabalik ng 500. Sa ganitong pagkakataon, subukan muli ang request.

  • Name
    prompt
    Type
    string
    Description

    Palaging "" para sa isang Brick Figure build task.

  • Name
    negative_prompt
    Type
    string
    Description

    Palaging "" para sa isang Brick Figure build task, tulad ng prompt.

  • Name
    texture_prompt
    Type
    string
    Description

    Palaging "" para sa isang Brick Figure build task, tulad ng prompt.

  • Name
    texture_image_url
    Type
    string
    Description

    Palaging "" para sa isang Brick Figure build task, tulad ng prompt.

  • Name
    model_urls
    Type
    object
    Description

    Mga download URL para sa 3D model, bilang isang textured GLB at bilang isang OBJ file kasama ang MTL file nito.

    • Name
      glb
      Type
      string
      Description

      Download URL para sa textured GLB file.

    • Name
      obj
      Type
      string
      Description

      Download URL para sa OBJ file, kasama ang heometriya at UVs.

    • Name
      mtl
      Type
      string
      Description

      Download URL para sa MTL material file na kasama ng obj. Gamitin ito kasama ng obj at ang texture sa texture_urls[0].base_color.

  • Name
    thumbnail_url
    Type
    string
    Description

    Download URL para sa preview image ng model.

  • Name
    texture_urls
    Type
    array
    Description

    Ang mga texture map, bilang isang array na may isang object na naglalaman ng base color map.

    • Name
      base_color
      Type
      string
      Description

      Download URL para sa base color map.