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 Lampara API

I-convert ang isang larawan tungo sa isang 3D-printable na lampshade sa dalawang yugto. Ang isang prototype task ay bumubuo ng isang matte-white na larawan ng konsepto at ginagawa itong isang 3D model. Ang isang build task, na kumukuha ng ID ng prototype task bilang input_task_id, ay ginagawang printable na STL parts ang modelong iyon. Gamit ang default na fixture preset, ang mga parts ay isang open-bottom na lampshade na may base plate para sa light fixture, at ang fixture mount.

  • POST /openapi/creative-lab/lamp/v1/prototype
  • POST /openapi/creative-lab/lamp/v1/build

POST/openapi/creative-lab/lamp/v1/prototype

Gumawa ng Lamp prototype task

Gumagawa ng isang matte-white na concept image mula sa isang larawan at ginagawa itong 3D lampshade model. Ibinabalik ng task ang concept image sa image_urls, at ang modelo sa model_urls.glb na may preview sa thumbnail_url. Para buuin ang mga naiprint na bahagi, ipasa ang ID ng task na ito sa build endpoint bilang input_task_id. Para sa mga field ng task, tingnan ang The Lamp prototype task object.

Request

POST
/openapi/creative-lab/lamp/v1/prototype
# Stage 1: concept image + 3D lampshade model from a source photo
curl https://api.meshy.ai/openapi/creative-lab/lamp/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>",
    "image_subject": "character"
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
Halimbawa ng prototype
Magsimula sa isang source photo. Ibinabalik ng prototype ang concept image at ang 3D model na pinoproseso ng build stage.
Source cat photo na ginamit bilang input ng Creative Lab Lamp
Input ng prototype
Output ng Creative Lab Lamp prototype na nabuo mula sa source photo
Output ng prototype

Mga Parameter

  • Name
    image_url
    Type
    string
    Kinakailangan
    Description

    Ang larawang batayan ng lampshade, bilang isang pampublikong URL o 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 lalampas sa 20 MB.

  • Name
    image_subject
    Type
    string
    default character
    Description

    Ang uri ng subject sa larawan, na nagtatakda kung paano ito i-stylize ni Meshy.

    Mga available na value:

    • character: isang solong karakter o bagay, tulad ng isang figurine, isang hayop, o isang mascot
    • landscape: isang panlabas na eksena o panorama, tulad ng isang bundok, isang cityscape, o isang gubat
  • Name
    name
    Type
    string
    Description

    Isang pangalan para sa task, hanggang 100 karakter. Babalik ito sa field na name ng task. Ang mas mahabang pangalan ay nagbabalik ng 400.

  • Name
    remove_background
    Type
    boolean
    default false
    Description

    Kung aalisin ang background mula sa prototype image. Nagbabalik ang true ng transparent RGBA PNG, kaya puwede mong ilagay ang subject sa kahit anong background. Binubuo rin ni Meshy ang 3D model mula sa larawan nang walang background nito. Kung hindi maalis ni Meshy ang background, gagamitin nito ang larawan kasama ang background nito, at magtatagumpay pa rin ang task.

Ibinabalik

Ang field na result 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 patakbuhin ang request. Halimbawa:

    • Kulang ang image_url.
    • Ang larawan ay hindi isang JPG, JPEG, PNG, o WebP file.
    • Masyadong maliit ang larawan, lumampas sa 20 MB, o lumampas sa maximum na bilang ng pixel.
    • Hindi ma-download ni Meshy ang larawan, halimbawa dahil nagbalik ng 404 ang URL o nag-timeout.
    • Ang data URI ay hindi wastong base64.
    • Na-flag ang larawan bilang NSFW.
    • Ang image_subject ay hindi character o landscape.

    Sinasabi ng mensahe ng error kung anong problema ang natagpuan. Ayusin ang request, pagkatapos ay ipadala muli.

  • Name
    401 - Unauthorized
    Description

    Kulang o hindi wasto 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 credits.
    • Nasa free plan ang account.

    Suriin 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 dahil sa intellectual property ng third-party. Magpadala ng larawan na may karapatan kang gamitin.

  • Name
    429 - Too Many Requests
    Description

    Naabot ang isa sa mga sumusunod na limitasyon:

    • 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 naka-queue 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 puwedeng tumakbo nang walang credits. Maghintay hanggang matapos ang isang task, o magdagdag ng credits.
  • Name
    500 - Internal Server Error
    Description

    Nagkaroon ng server error si Meshy, halimbawa dahil hindi nito napatakbo ang intellectual property check sa larawan. Hindi gagawa si Meshy ng task, at irerefund ang anumang credits na singil dito. Subukan muli ang request.


POST/openapi/creative-lab/lamp/v1/build

Gumawa ng Lamp build task

Bumubuo ng mga 3D-printable na parte mula sa isang matagumpay na prototype task. Isinasaayos ni Meshy ang sukat ng modelo ng prototype sa diameter_mm, pinuputol ang ibaba nito para maging patag ayon sa cut_amount_percent, at hinohollow ito hanggang thickness_mm. Kapag may fixture preset, bubuksan din nito ang ibaba, magdaragdag ng base plate na may fixture hole, at gagawa ng hiwalay na mount para sa ilaw. Para sa mga field ng task, tingnan ang The Lamp build task object.

Request

POST
/openapi/creative-lab/lamp/v1/build
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/lamp/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "options": {
      "diameter_mm": 120,
      "thickness_mm": 2,
      "light_source_preset": "bambu_mh001_60mm",
      "cut_amount_percent": 30
    },
    "output": {
      "format": "stl"
    }
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}
Halimbawa ng build
Ginagawang printable na mga parte ng lampshade ng build task ang 3D model ng prototype.
Creative Lab Lamp build model preview
Build model preview

Mga Parameter

  • Name
    input_task_id
    Type
    string
    Kinakailangan
    Description

    Ang ID ng prototype task na bubuuin. Dapat itong isang task na nilikha ng iyong account gamit ang POST /openapi/creative-lab/lamp/v1/prototype, na may status na SUCCEEDED.

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

  • Name
    name
    Type
    string
    Description

    Isang pangalan para sa task, hanggang 100 character. Ito ay babalik sa field na name ng task. Ang mas mahabang pangalan ay magbabalik ng 400.

options

Opsyonal na mga setting para sa hugis ng lampshade. Bawat field ay may default, kaya ipadala lang ang mga gusto mong baguhin.

  • Name
    diameter_mm
    Type
    number
    default 150
    Description

    Ang sukat ng pinakamalaking dimensyon ng lampshade, sa millimeters, mula 50 hanggang 400. Isinasaayos ni Meshy ang modelo nang pantay-pantay para umangkop. Ang 0 ay gumagamit ng default, at anumang ibang value na labas sa saklaw ay magbabalik ng 400.

  • Name
    thickness_mm
    Type
    number
    default 1
    Description

    Ang kapal ng dingding ng lampshade, sa millimeters, hanggang 10. Ang 0 ay gumagamit ng default, at ang negatibong value o value na higit sa 10 ay magbabalik ng 400.

  • Name
    cut_amount_percent
    Type
    number
    default 1
    Description

    Ang porsyento ng taas ng modelo na puputulin para maging patag sa ibaba, mula 1 hanggang 100. Ang patag na ibaba ay nagpapahintulot sa lampshade na maupo sa print bed at nagbibigay ng espasyo para sa fixture. Ang value na labas sa saklaw ay magbabalik ng 400.

  • Name
    light_source_preset
    Type
    string
    default bambu_mh001_60mm
    Description

    Ang preset ng light fixture, na nagtatakda kung paano bubuuin ni Meshy ang ibaba.

    Mga available na value:

    • bambu_mh001_60mm: isang open-bottom na lampshade na may base plate na may 60 mm na fixture hole, parehong nasa model_urls.lamp_stl, at ang fixture mount ay nasa model_urls.base_stl
    • none: isang solong sealed na lampshade sa model_urls.lamp_stl, na walang model_urls.base_stl
  • Name
    fixture_offset_x_mm
    Type
    number
    default 0
    Description

    Gaano kalayo ililipat ang fixture hole sa X axis mula sa sentro ng lampshade, sa millimeters, mula -80 hanggang 80. Naaangkop lamang kapag ang light_source_preset ay hindi none.

  • Name
    fixture_offset_z_mm
    Type
    number
    default 0
    Description

    Gaano kalayo ililipat ang fixture hole sa Z axis (lalim) mula sa sentro ng lampshade, sa millimeters, mula -80 hanggang 80. Naaangkop lamang kapag ang light_source_preset ay hindi none.

  • Name
    rotate_x_deg
    Type
    number
    default 0
    Description

    Ang pag-ikot sa paligid ng X axis na ilalapat sa modelo bago ito iproseso ni Meshy, sa degrees, mula -360 hanggang 360. Inilalapat ni Meshy ang tatlong pag-ikot bilang XYZ Euler angles sa sentro ng modelo.

  • Name
    rotate_y_deg
    Type
    number
    default 0
    Description

    Ang pag-ikot sa paligid ng Y axis na ilalapat sa modelo bago ito iproseso ni Meshy, sa degrees, mula -360 hanggang 360.

  • Name
    rotate_z_deg
    Type
    number
    default 0
    Description

    Ang pag-ikot sa paligid ng Z axis na ilalapat sa modelo bago ito iproseso ni Meshy, sa degrees, mula -360 hanggang 360.

  • Name
    include_result_json
    Type
    boolean
    default false
    Description

    Kung magdadagdag ng file na result.json sa zip bundle, na may pangalan ng pipeline na tumakbo, mga babala, at mga path ng file. Nangangailangan na ang output.format ay naka-set sa zip. Ang true kasama ng stl ay magbabalik ng 400.

output

Opsyonal. Nagtatakda ng mga file na ibabalik ng build.

  • Name
    format
    Type
    string
    default stl
    Description

    Ang mga file na ibabalik ng build.

    Mga available na value:

    • stl: model_urls.lamp_stl, ang lampshade kasama ang base plate nito kapag may fixture preset, at model_urls.base_stl kapag ang light_source_preset ay hindi none
    • zip: isang zip file sa model_urls.bundle_zip, na may lamp.stl, at base.stl at result.json kapag naaangkop ang mga ito

Mga Ibabalik

Hawak ng field na result ang ID ng bagong build task. Kunin ang task o i-stream ito hanggang ang status ay SUCCEEDED. Pagkatapos, i-download ang mga file mula sa model_urls.

Mga paraan ng pagkabigo

  • Name
    400 - Bad Request
    Description

    Hindi matatakbo ang request. Halimbawa:

    • Ang input_task_id ay nawawala o hindi valid na task ID.
    • Ang status ng prototype task ay hindi SUCCEEDED. Kung tumatakbo pa ito, maghintay at subukan muli. Kung nabigo ito o na-cancel, gumawa ng bagong prototype task.
    • Matagumpay ang prototype task ngunit walang 3D model. Gumawa ng bagong prototype task.
    • Ang isang options field ay labas sa saklaw nito o hindi isang available na value.
    • Ang output.format ay hindi stl o zip, o ang include_result_json ay true nang walang zip.

    Sinasabi ng error message kung aling problema ang nahanap nito.

  • Name
    401 - Unauthorized
    Description

    Nawawala o invalid ang API key. Suriin ang header na Authorization.

  • Name
    402 - Payment Required
    Description

    Isa sa mga ito ang naaangkop:

    • 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 credits at plan, pagkatapos ay subukan muli.

  • Name
    404 - Not Found
    Description

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

  • Name
    429 - Too Many Requests
    Description

    Isa sa mga limitasyong ito ang naabot:

    • Nagpadala ka ng higit na requests kaysa sa pinapahintulot ng iyong rate limit. Maghintay ng ilang segundo, pagkatapos ay subukan muli. Tingnan ang Rate limits.
    • Masyadong maraming task mo ang nasa 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.

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

Kunin ang Lamp task

Nagbabalik ng prototype o build task. Ang path ay dapat tumugma sa stage ng task. Ang 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 Lamp prototype task object at The Lamp build task object.

Request

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

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

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-lamp-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": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-lamp-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": 6,
  "model_urls": {
    "lamp_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/lamp.stl?Expires=***",
    "base_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/base.stl?Expires=***"
  }
}

Mga Parameter

  • Name
    id
    Type
    path
    Description

    Ang task ID mula sa create response.

Mga Ibinabalik

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

Mga sitwasyon ng pagkabigo

  • Name
    400 - Bad Request
    Description

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

  • Name
    403 - Forbidden
    Description

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

  • Name
    404 - Not Found
    Description

    Walang Lamp 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 upang itugma sa task.

  • Name
    500 - Internal Server Error
    Description

    Hindi na-run ng Meshy ang pagsusuri sa intellectual property. Subukan muli ang request.


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

Mag-delete ng Lamp task

Kinakansela ang isang Lamp 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 nang nagsimula dito. Ang isang task na may final status (SUCCEEDED, FAILED, o CANCELED) ay hindi na maaaring kanselahin.

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

Request

DELETE
/openapi/creative-lab/lamp/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578
curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/lamp/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 nangyari:

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

    Walang Lamp task na may ID na ito na nabibilang sa account mo, o hindi tumutugma ang stage ng task sa path. Suriin ang ID, at gamitin ang /prototype o /build upang itugma ang task.


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

I-stream ang Lamp task

Ini-stream ang mga update ng Lamp task bilang Server-Sent Events (SSE). Ang path ay dapat tumugma sa yugto (stage) ng task. Kung hindi, halimbawa ang ID ng isang build task sa /prototype/:id/stream, ang stream ay magpapadala ng isang error event na may status_code: 404 at pagkatapos ay magsasara.

Request

GET
/openapi/creative-lab/lamp/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream
curl -N https://api.meshy.ai/openapi/creative-lab/lamp/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-lamp-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 6,
  "model_urls": {
    "lamp_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/lamp.stl?Expires=***",
    "base_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/base.stl?Expires=***"
  }
}

Mga Parameter

  • Name
    id
    Type
    path
    Description

    Ang task ID mula sa create response.

Ibinabalik

Isang stream ng prototype o build na mga task object. Ang bawat event ay naglalaman ng kumpletong task object, tulad ng ibinabalik ito ng Get a Lamp task. Habang ang task ay PENDING o IN_PROGRESS, ang mga output field nito ay wala pang laman (null, [], o {}), at ang finished_at ay null.

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


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

I-list ang mga Lamp task

Ibinabalik ang iyong mga Lamp task para sa isang stage, isang page sa bawat pagkakataon. Ang path ang pumipili sa stage. Ibinabalik ng /prototype ang mga prototype task lamang, at ibinabalik ng /build ang mga build task lamang.

Request

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

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

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-lamp-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": 30,
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "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. Ibinabalik ng 0 ang 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 ginagamit ng 0 ang default. Ang isang value na wala sa 0 hanggang 255 ay nagbabalik ng 400.

  • Name
    sort_by
    Type
    string
    default -created_at
    Description

    Ang pagkakasunod-sunod ng pag-uuri.

    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 sa path.


Ang Lamp prototype task object

Ang isang prototype task ay bumubuo ng isang matte-white na concept image mula sa isang larawan at ginagawa itong 3D model. Upang gawin ang mga nai-print na bahagi, ipasa ang ID ng task sa build endpoint bilang input_task_id.

Mga Katangian

Example Lamp Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-lamp-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": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "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 task type, palaging creative-lab-lamp-prototype.

  • Name
    name
    Type
    string
    Description

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

  • Name
    status
    Type
    string
    Description

    Ang status ng task.

    Mga available na value:

    • PENDING: naghihintay sa queue
    • IN_PROGRESS: ginagawa ang resulta
    • SUCCEEDED: pinal, may resulta
    • FAILED: pinal, may dahilan sa task_error
    • CANCELED: pinal, 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 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 mangyari iyon.

  • Name
    finished_at
    Type
    timestamp
    Description

    Oras na umabot ang task sa pinal na status, sa Unix milliseconds. null hanggang mangyari iyon.

  • Name
    expires_at
    Type
    timestamp
    Description

    Oras na mag-e-expire ang resulta ng task, sa Unix milliseconds. Ito ay 3 araw matapos ang finished_at, o 3 araw matapos ang 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

    Posisyon ng task sa queue habang ito ay PENDING. Ang 1 ay nangangahulugang ito ang susunod na magsisimula. 0 matapos umalis ang task sa queue, at palaging 0 sa mga resulta ng listahan.

  • 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, matapos ang 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 na ito, at magbabalik ng 500 ang list request. Sa ganoong pagkakataon, subukan muli ang request.

  • Name
    model_urls
    Type
    object
    Description

    Mga download URL para sa 3D model na nabuo mula sa concept image. {} hanggang magtagumpay ang task.

    • Name
      glb
      Type
      string
      Description

      Download URL para sa lampshade model, bilang isang GLB file. Ginagawa ng build stage ang model na ito na mga nai-print na bahagi.

  • Name
    thumbnail_url
    Type
    string
    Description

    Download URL para sa preview image ng 3D model. "" hanggang magtagumpay ang task.

  • Name
    image_urls
    Type
    array of strings
    Description

    Mga download URL para sa concept image. Ang array ay may isang URL matapos magtagumpay ang task, at walang laman hanggang mangyari iyon.


Ang Lamp build task object

Ginagawa ng isang build task ang 3D model ng isang matagumpay na prototype task tungo sa mga maaaring i-print na bahagi ng lampshade. Ikinukuhob ng Meshy ang modelo at pinuputol nang patag ang ilalim nito. Kapag may fixture preset, binubuksan din nito ang ilalim at idinaragdag ang base plate at ang fixture mount.

Mga Property

Example Lamp Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-lamp-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": 6,
  "model_urls": {
    "lamp_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/lamp.stl?Expires=***",
    "base_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/base.stl?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-lamp-build.

  • Name
    name
    Type
    string
    Description

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

  • Name
    status
    Type
    string
    Description

    Ang status ng task.

    Mga available na value:

    • PENDING: naghihintay sa queue
    • IN_PROGRESS: ginagawa ang resulta
    • SUCCEEDED: final, kasama ang resulta
    • FAILED: final, kasama ang dahilan sa task_error
    • 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 nang gawin ang task, sa Unix milliseconds.

  • Name
    started_at
    Type
    timestamp
    Description

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

  • Name
    finished_at
    Type
    timestamp
    Description

    Oras nang maabot ng task ang isang final status, sa Unix milliseconds. null hanggang mangyari iyon.

  • Name
    expires_at
    Type
    timestamp
    Description

    Oras nang 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 nag-iingat 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

    Bakit nabigo ang task. null maliban kung ang 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. Ang isang request na nagbabalik ng error ay hindi sinisingil. Ang isang nabigong task ay 0, dahil ire-refund ito ng Meshy. Ang pagkansela ay nagre-refund ng task lamang habang ito ay PENDING. Kung hindi mabasa ng Meshy ang singil, aalisin ng get o stream response ang field na ito, at ang list request ay magbabalik ng 500. Sa kasong iyon, ulitin ang request.

  • Name
    model_urls
    Type
    object
    Description

    Mga download URL para sa mga maaaring i-print na file. Ang mga key na lalabas ay nakadepende sa output.format at options.light_source_preset.

    • Name
      lamp_stl
      Type
      string
      Description

      Download URL para sa lamp.stl. Kapag may fixture preset, ito ay ang open-bottom na lampshade kasama ang base plate na may butas para sa fixture. Kapag ang options.light_source_preset ay nakatakda sa none, ito ay isang solong sealed lampshade. Naroroon kapag ang output.format ay stl.

    • Name
      base_stl
      Type
      string
      Description

      Download URL para sa base.stl, ang mount para sa light fixture. Naroroon kapag ang output.format ay stl at ang options.light_source_preset ay hindi none.

    • Name
      bundle_zip
      Type
      string
      Description

      Download URL para sa isang zip file na may lamp.stl, at may base.stl at result.json kapag naaangkop ang mga ito. Naroroon kapag ang output.format ay zip, at sa gayon ay hindi isinasama ang lamp_stl at base_stl.