Creative Lab Fridge Magnet API

Gawing isang 3D-printable na fridge magnet ang isang larawan na may kulay na relief at patag na likod, sa dalawang yugto. Ang isang prototype task ay bumubuo ng isang kinulayang konsepto na imahe mula sa larawan. Ang isang build task ay ginagawang 3D relief model ang imaheng iyon, at ginagamit ang ID ng prototype task bilang input_task_id.

POST /openapi/creative-lab/fridge-magnet/v1/prototype
POST /openapi/creative-lab/fridge-magnet/v1/build

POST/openapi/creative-lab/fridge-magnet/v1/prototype

Gumawa ng Fridge Magnet prototype task

Gumagawa ng isang colorized na concept image mula sa isang larawan. 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 Fridge Magnet prototype task object.

Request

POST

/openapi/creative-lab/fridge-magnet/v1/prototype

# Stage 1: generate a colorized fridge magnet concept image
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/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": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9"
}

Prototype example

Start with a source photo, then generate the prototype image used by the fridge magnet build stage.

Source landscape photo used as the Creative Lab Fridge Magnet input — Prototype input

Creative Lab Fridge Magnet prototype output generated from the source photo — Prototype output

Mga Parameter

Name
image_url
Type
string
Kinakailangan
Description
Ang larawang gagawing fridge magnet concept image, 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 na file na hindi hihigit sa 20 MB.
Name
name
Type
string
Description
Pangalan para sa task, hanggang 100 karakter. Babalik ito sa name field ng task. Kapag mas mahaba ang pangalan, magbabalik ito ng 400.
Name
remove_background
Type
boolean
default false
Description
Kung aalisin ba ang background mula sa prototype image. Ang true ay nagbabalik ng isang transparent RGBA PNG na pinapanatili ang buong magnet, para mailagay mo ito sa kahit anong background. Ang build ay nagsisimula rin mula sa larawan na walang background nito. Kung hindi maalis ni Meshy ang background, ibabalik nito ang larawan kasama ang background nito, at magtatagumpay pa rin ang task.
Hiwalay ang remove_background na opsyon ng build.

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 Paraan ng Pagkabigo

Name
400 - Bad Request
Description
Hindi matakbo ang request. Halimbawa:
- Nawawala ang image_url.
- Hindi JPG, JPEG, PNG, o WebP file ang larawan.
- Masyadong maliit ang larawan, 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.
- Hindi valid na base64 ang data URI.
- Na-flag ang larawan bilang NSFW.
Sinasabi ng error message kung aling problema ang natagpuan nito. Ayusin ang request, pagkatapos ay ipadala itong muli.
Name
401 - Unauthorized
Description
Nawawala o hindi valid ang API key. Tingnan ang Authorization header.
Name
402 - Payment Required
Description
Isa sa mga ito ay nangyayari:
- Hindi sapat ang credits ng account.
- Umabot na sa credit limit nito ang API key, workspace, o miyembro.
- 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 dahil 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 ay naabot:
- Nagpadala ka ng higit pang requests kaysa sa pinapahintulutan ng iyong rate limit. Maghintay ng ilang segundo, pagkatapos ay subukan muli. Tingnan ang Rate limits.
- Masyadong maraming task mo ang nasa pila 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.
Name
500 - Internal Server Error
Description
Nakatagpo si Meshy ng server error, halimbawa dahil hindi nito matakbo ang intellectual property check sa larawan. Hindi gagawa si Meshy ng task, at ire-refund ang anumang credits na singil nito. Subukan muli ang request.

POST/openapi/creative-lab/fridge-magnet/v1/build

Gumawa ng Fridge Magnet build task

Gumagawa ng 3D-printable fridge magnet mula sa isang matagumpay na prototype task. Ginagawa ng Meshy ang concept image ng prototype na isang depth-map relief, at nagbabalik ng isang model file sa format na piniling mo. Para sa mga field ng task, tingnan ang The Fridge Magnet build task object.

Request

POST

/openapi/creative-lab/fridge-magnet/v1/build

# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
    "options": {
      "badge_shape": "rounded-rect",
      "size_mm": 60,
      "relief_height_mm": 3.3
    },
    "output": {
      "format": "glb"
    }
  }'

Response

{
  "result": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0"
}

Build example

The build task turns the selected prototype image into a 3D-printable fridge magnet model.

Creative Lab Fridge Magnet build model preview — Build model preview

Mga Parameter

Name
input_task_id
Type
string
Kinakailangan
Description
Ang ID ng prototype task na gagawin. Dapat itong isang task na ginawa ng iyong account gamit ang POST /openapi/creative-lab/fridge-magnet/v1/prototype, na may status na SUCCEEDED.
Ang ID na hindi isa sa iyong mga Fridge Magnet prototype task mula sa API ay nagbabalik ng 404, kasama na ang prototype na ginawa sa web app.
Name
name
Type
string
Description
Isang pangalan para sa task, hanggang 100 characters. Makikita ito sa name field ng task. Ang mas mahabang pangalan ay nagbabalik ng 400.

`options`

Opsyonal na mga setting para sa hugis ng relief. Bawat field ay may default, kaya ipadala lamang ang mga gusto mong baguhin. Ang isang value na wala sa saklaw ng isang field ay nagbabalik ng 400.

Name
badge_shape
Type
string
default rounded-rect
Description
Ang outline ng magnet kapag hindi ito tina-trace ng Meshy mula sa subject. Ginagamit ito ng Meshy kapag ang remove_background ay false, o kapag hindi nito mahanap ang outline ng subject.
Mga magagamit na value:
- circle
- rounded-rect
- hexagon
- shield
- star
Name
size_mm
Type
number
default 60
Description
Ang edge length ng bounding square ng magnet, sa millimeters, hanggang 400. Ginagamit ng 0 ang default.
Name
relief_height_mm
Type
number
default 3.3
Description
Ang maximum na taas ng relief sa itaas ng base, sa millimeters, mula 0 hanggang 20.
Name
relief_offset_mm
Type
number
default 0
Description
Gaano kababa ibababa ang relief, sa millimeters, mula 0 hanggang 20. Ibinabawas ito ng Meshy sa taas ng relief sa lahat ng dako, hanggang sa base.
Name
base_thickness_mm
Type
number
default 2.0
Description
Ang kapal ng patag na base plate sa likod ng relief, sa millimeters, mula 0 hanggang 20. Ang default na 2 mm na base ay nagbibigay sa magnet ng sapat na katawan para humawak sa fridge, kaya hindi pakiramdam na marupok ang relief.
Name
has_closed_back
Type
boolean
default true
Description
Kung isasara ang likod ng magnet, ang bahaging kinadidikitan ng magnet. Iniiwan ng false ang likod na bukas, bilang isang shell.
Name
relief_curve
Type
string
default linear
Description
Ang curve na nagmamapa ng mga value ng depth-map sa taas ng relief.
Mga magagamit na value:
- linear
- gamma
- s-curve
Name
curve_param
Type
number
default 1.0
Description
Ang lakas ng curve, hanggang 10. Ginagamit ito ng mga curve na gamma at s-curve, at hindi pinapansin ng linear. Ginagamit ng 0 ang default.
Name
invert_depth
Type
boolean
default false
Description
Kung babaliktarin ang depth map, kaya ang mas madidilim na bahagi ay magiging mas mataas na relief.
Name
smoothing
Type
number
default 0.24
Description
Gaano kakinis gagawin ang depth map bago buuin ng Meshy ang relief, mula 0 hanggang 10.
Name
relief_scale
Type
number
default 1.0
Description
Gaano kalaki i-zoom ang relief at ang texture nito sa loob ng outline, mula sa gitna, hanggang 10. Ang value na higit sa 1 ay nagpapalaki sa subject, at ang value na mas mababa sa 1 ay nagpapaliit dito. Hindi nito binabago ang taas ng relief. Ginagamit ng 0 ang default.
Name
depth_threshold
Type
number
default 0.1
Description
Ang value ng depth-map kung saan itinatakda ng Meshy ang depth sa zero, mula 0 hanggang 1.
Name
remove_background
Type
boolean
default true
Description
Kung tina-trace ang outline ng magnet mula sa subject, kaya sinusunod ng magnet ang hugis ng subject. Ginagamit ng false ang outline ng badge_shape sa halip. Ginagamit din ng Meshy ang badge_shape kapag hindi nito mahanap ang outline ng subject.
Hiwalay ito sa remove_background parameter ng prototype, na nagtatakda kung ang prototype image ay may transparent na background.
Name
export_resolution
Type
integer
default 512
Description
Ang mesh resolution ng na-export na model, mula 64 hanggang 512. Binubuo ng Meshy ang heometriya mula sa isang 512-pixel na depth map, kaya ang mas pinong mesh ay magdaragdag ng mga face nang hindi nagdaragdag ng detalye. Ginagamit ng 0 ang default.

`output`

Opsyonal. Itinatakda ang file format na ibinabalik ng build.

Name
format
Type
string
default glb
Description
Ang file format na ibinabalik ng build.
Mga magagamit na value:
- glb: isang model.glb file, sa model_urls.glb
- obj: isang zip file na may model.obj, model.mtl, at texture.png, sa model_urls.obj
- zip: isang zip file na may bawat file na ginagawa ng Meshy, sa model_urls.bundle_zip

Mga Ibinabalik

Ang result field ay may hawak ng ID ng bagong build task. Kunin ang task o i-stream ito hanggang ang status ay SUCCEEDED. Pagkatapos, i-download ang file mula sa nag-iisang entry sa model_urls.

Mga Mode ng Kabiguan

Name
400 - Bad Request
Description
Hindi matatakbo ang request. Halimbawa:
- Ang input_task_id ay nawawala o hindi isang valid na task ID.
- Ang status ng prototype task ay hindi SUCCEEDED. Kung tumatakbo pa ito, maghintay at subukang muli. Kung nabigo ito o kinansela, gumawa ng bagong prototype task.
- Matagumpay ang prototype task pero walang image. Gumawa ng bagong prototype task.
- Ang isang options field ay wala sa saklaw nito o hindi isang magagamit na value.
Sinasabi ng error message kung aling problema ang natagpuan nito.
Name
401 - Unauthorized
Description
Nawawala o invalid ang API key. Tingnan ang Authorization header.
Name
402 - Payment Required
Description
Isa sa mga ito ang nangyayari:
- Walang sapat na credits ang account.
- Naabot ng API key, workspace, o miyembro ang credit limit nito.
- Ang account ay nasa free plan.
Suriin ang iyong credits at plan, pagkatapos ay subukang muli.
Name
404 - Not Found
Description
Ang input_task_id ay hindi tumutugma sa anumang Fridge Magnet prototype task na ginawa ng iyong account gamit ang API. Ang prototype na ginawa sa web app ay nagbabalik din ng 404. Ipadala ang result ID mula sa tugon ng paggawa ng prototype.
Name
429 - Too Many Requests
Description
Isa sa mga limitasyong ito ang naabot:
- Nagpadala ka ng mas maraming request kaysa sa pinapayagan ng iyong rate limit. Maghintay ng ilang segundo, pagkatapos ay subukang muli. Tingnan ang Rate limits.
- Masyadong maraming task mo ang naka-queue o tumatakbo. Maghintay hanggang matapos ang ilan, pagkatapos ay subukang 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/fridge-magnet/v1/(prototype|build)/:id

Kumuha ng Fridge Magnet 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 magbabalik ng 404, at ganoon din ang prototype task na hiniling sa pamamagitan ng /build/:id.

Para sa mga field, tingnan ang The Fridge Magnet prototype task object at The Fridge Magnet build task object.

Request

GET

/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9

# Prototype
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
  "type": "creative-lab-fridge-magnet-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543210000,
  "started_at": 1729543215000,
  "finished_at": 1729543242000,
  "expires_at": 1729802442000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?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, ayon sa stage na nasa path.

Mga mode ng kabiguan

Name
400 - Bad Request
Description
Hindi valid na task ID ang 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 third-party. Hindi natatanggap ng build tasks at ng mga team na nasa Enterprise plan ang error na ito. Gumawa ng prototype task mula sa larawan na may karapatan kang gamitin.
Name
404 - Not Found
Description
Walang Fridge Magnet 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 ang task.
Name
500 - Internal Server Error
Description
Hindi mapatakbo ng Meshy ang pagsusuri ng intellectual property. Ulitin ang request.

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

I-delete ang isang fridge magnet na task

Kinakansela ang isang fridge magnet na task. Ang pagkansela sa isang PENDING na task ay nagre-refund ng mga credits nito. Ang isang IN_PROGRESS na task ay kinakansela nang walang refund, dahil nakapagsimula na ang isang worker dito. Ang isang task na may final na status (SUCCEEDED, FAILED, o CANCELED) ay hindi maaaring kanselahin.

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

Request

DELETE

/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9 \
  -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 pagkakataon ng kabiguan

Name
400 - Bad Request
Description
Isa sa mga sumusunod ang nangyayari:
- Ang id ay hindi isang valid na task ID. Ipadala ang result ID mula sa create response.
- Mayroon nang final na status ang task (SUCCEEDED, FAILED, o CANCELED), kaya hindi na ito maaaring kanselahin.
Name
404 - Not Found
Description
Walang fridge magnet na 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.

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

I-stream ang isang Fridge Magnet task

Nag-i-stream ng mga update ng Fridge Magnet task bilang Server-Sent Events (SSE). Dapat tumugma ang path sa yugto (stage) ng task. Kung hindi, 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/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/stream

curl -N https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/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": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?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 may kumpletong task object, gaya ng ibinabalik ito ng Kunin ang isang Fridge Magnet 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 lugar nito, na may status_code na ibabalik sana ng isang get request.

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

I-list ang mga Fridge Magnet task

Ibinabalik ang iyong mga fridge magnet 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/fridge-magnet/v1/prototype

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

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

Response (List Prototype Tasks)

[
  {
    "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
    "type": "creative-lab-fridge-magnet-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729543210000,
    "started_at": 1729543215000,
    "finished_at": 1729543242000,
    "expires_at": 1729802442000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "image_urls": [
      "https://assets.meshy.ai/***/concept.png?Expires=***"
    ]
  }
]

Path parameters

Name
stage
Type
path
Kinakailangan
Description
Ang stage na ililista, prototype o build.

Query parameters

Name
page_num
Type
integer
default 1
Description
Ang page na ibabalik, mula 1 hanggang 255. Ang 0 ay nagbabalik ng unang page. Ang value na wala sa 0 hanggang 255 ay nagbabalik ng 400.
Name
page_size
Type
integer
default 10
Description
Bilang ng mga task bawat page, hanggang 100. Ang value mula 101 hanggang 255 ay nagbabalik ng 100 task, at ang 0 ay gumagamit ng default. Ang 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 object o build task object, ayon sa stage na nasa path.

Ang object ng prototype task ng Fridge Magnet

Ang isang prototype task ay bumubuo ng isang kinulayang konsepto ng imahe mula sa isang larawan. Para gawing 3D model ang imahe, ipasa ang ID ng task sa build endpoint bilang input_task_id.

Mga Katangian

Example Fridge Magnet Prototype Task Object

{
  "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
  "type": "creative-lab-fridge-magnet-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543210000,
  "started_at": 1729543215000,
  "finished_at": 1729543242000,
  "expires_at": 1729802442000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Name
id
Type
string
Description
Ang ID ng task. Huwag umasa sa kaniyang format.
Name
type
Type
string
Description
Ang uri ng task, laging creative-lab-fridge-magnet-prototype.
Name
name
Type
string
Description
Ang name na ipinadala mo noong 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 pila
- IN_PROGRESS: ginagawa ang resulta
- SUCCEEDED: pinal, kasama ang resulta
- FAILED: pinal, kasama ang dahilan sa task_error
- CANCELED: pinal, walang resulta
Name
progress
Type
integer
Description
Porsiyento ng natapos na trabaho, mula 0 hanggang 100. 0 ito hanggang magsimula ang task at 100 kapag nagtagumpay ito.
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 isang pinal na 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. 3 araw ito 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, mga 100 taon ito mamaya. Tingnan ang Asset retention.
Name
preceding_tasks
Type
integer
Description
Ang posisyon ng task sa pila habang ito ay PENDING. Ibig sabihin ng 1, susunod itong magsisimula. 0 pagkatapos umalis ang task sa pila, at laging 0 sa mga resulta ng listahan.
Name
task_error
Type
object
Description
Kung bakit nabigo ang task. null maliban kung ang status ay FAILED. Tingnan ang Errors.
Name
consumed_credits
Type
integer
Description
Bilang ng 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 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 na response ang field, at ang isang list request ay magbabalik ng 500. Sa ganitong kaso, subukan muli ang request.
Name
image_urls
Type
array of strings
Description
Mga download URL para sa konsepto ng imahe. Ang array ay may isang URL pagkatapos magtagumpay ang task, at walang laman hanggang dumating ang oras na iyon.

Ang Fridge Magnet build task object

Ang isang build task ay bumubuo ng 3D fridge magnet mula sa isang matagumpay na prototype task. Nagbabalik ito ng isang model file sa format na hiniling mo.

Mga Property

Example Fridge Magnet Build Task Object

{
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?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-fridge-magnet-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 pila
- IN_PROGRESS: ginagawa ang resulta
- SUCCEEDED: final, mayroong 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 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 sa oras na iyon.
Name
finished_at
Type
timestamp
Description
Oras na umabot ang task sa isang final status, sa Unix milliseconds. null hanggang sa 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 nagtatago ng mga resulta ng API nang walang hanggan, ito ay humigit-kumulang 100 taon mula ngayon. Tingnan ang Asset retention.
Name
preceding_tasks
Type
integer
Description
Ang posisyon ng task sa pila habang ito ay PENDING. Ang 1 ay nangangahulugang susunod na itong magsisimula. 0 pagkatapos umalis ang task sa pila, at palaging 0 sa mga resulta ng listahan.
Name
task_error
Type
object
Description
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 nagbalik ng error ay hindi sinisingil. 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 na ito, at magbabalik ng 500 ang isang list request. Sa kasong iyon, subukan muli ang request.
Name
model_urls
Type
object
Description
Mga URL para sa pag-download ng model file, na may isang entry para sa output.format na hiniling mo. {} hanggang magtagumpay ang task.
- Name
  glb
  Type
  string
  Description
  Download URL para sa GLB file. Naroroon kapag ang output.format ay glb.
- Name
  obj
  Type
  string
  Description
  Download URL para sa isang zip file na may model.obj, model.mtl, at texture.png. Naroroon kapag ang output.format ay obj.
- Name
  bundle_zip
  Type
  string
  Description
  Download URL para sa isang zip file na may bawat file na nabuo ng Meshy. Naroroon kapag ang output.format ay zip.