Creative Lab — Fridge Magnet API

Gawing custom na fridge magnet ang iyong mga larawan — isang rounded-rectangle na kinulayang depth relief na may patag na magnetic back, na naka-sukat para sa fridge — sa dalawang yugto: bubuo ang prototype ng kinulayang concept image mula sa iyong input na larawan, pagkatapos ay gagawing relief 3D model ng build ang concept image na iyon. Ang dalawang yugto ay naka-link sa pamamagitan ng 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

Gumawa ng isang colorized concept image mula sa source photo. Ang ibinalik na task ID ang ipapasa mo bilang input_task_id sa build endpoint. Sumangguni sa The Fridge Magnet Prototype Task Object para sa hugis ng response.

Mga Parameter

Name
image_url
Type
string
Kinakailangan
Description
Source photo na kokolorado ni Meshy patungong fridge-magnet-ready concept image. Kasalukuyang suportado namin ang .jpg, .jpeg, .png, at .webp na format.
May dalawang paraan para maibigay ang image:
- Publicly accessible URL: Isang URL na naaabot mula sa pampublikong internet.
- Data URI: Isang base64-encoded data URI ng image. Halimbawa ng isang data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
Opsyonal na pangalan ng task para sa layuning ipakita. Pinakamataas na 100 na character.
Name
remove_background
Type
boolean
default false
Description
Kapag naitakda sa true, ibinabalik ang prototype image bilang transparent RGBA PNG na may tinanggal na background, para makapag-composite ka ng subject sa kahit anong background.
Ito ay kumokontrol lamang sa image na ibinabalik ng endpoint na ito. Ito ay hiwalay sa build option na may parehong pangalan (default true), na kumokontrol sa pagtanggal ng background bago mag-relief.

Ibinabalik

Ang result property ng response ay naglalaman ng task id ng bagong ginawang fridge magnet prototype task. I-poll ang Get a Task endpoint o mag-subscribe sa stream hanggang maabot ng task ang SUCCEEDED, tapos ipasa ang ID na iyon sa build endpoint bilang input_task_id.

Mga Mode ng Kabiguan

Name
400 - Bad Request
Description
Ang request ay hindi katanggap-tanggap. Karaniwang sanhi:
- Nawawalang parameter: Kinakailangan ang image_url.
- Hindi valid na image format: Ang ibinigay na image_url ay hindi isang suportadong format (.jpg, .jpeg, .png, .webp).
- Ang dimensyon ng image ay wala sa saklaw: Ang image ay masyadong maliit, lumalampas sa pinakamataas na sukat ng file, o lumalampas sa pinakamataas na bilang ng pixel.
- Hindi maabot na URL: Hindi ma-download ang image_url (404 o timeout).
- Hindi valid na Data URI: Ang base64 string ay malformed.
- Naflag na content: Ang input image ay naflag ng NSFW o intellectual property moderation.
Name
401 - Unauthorized
Description
Nabigo ang authentication. Pakisuri ang iyong API key.
Name
402 - Payment Required
Description
Hindi sapat na credits para maisagawa ang task na ito.
Name
429 - Too Many Requests
Description
Lumampas ka sa iyong rate limit.

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"
}

Halimbawa ng prototype

Magsimula sa isang source photo, tapos gumawa ng prototype image na gagamitin ng 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

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

Gumawa ng Fridge Magnet Build Task

Gumawa ng final na 3D-printable fridge magnet mula sa isang matagumpay (succeeded) na prototype task. Ang build ay nagpapatakbo ng depth-map relief pipeline sa kinulayang concept image ng prototype at naghahatid ng iisang mesh artifact sa format na hiniling mo. Sumangguni sa The Fridge Magnet Build Task Object para sa hugis ng response.

Mga Parameter

Name
input_task_id
Type
string
Kinakailangan
Description
Ang task ID ng isang prototype task na ginawa sa parehong OpenAPI endpoint. Dapat ay ginawa ang prototype gamit ang parehong API key, dapat ay naabot na ang SUCCEEDED, at dapat ay nakagawa ng eksaktong isang candidate image.
Ang mga prototype task na ginawa sa pamamagitan ng webapp ay hindi tinatanggap — ang build endpoint ay tumatanggap lamang ng mga prototype task na nagawa ng POST /openapi/creative-lab/fridge-magnet/v1/prototype at tumatanggi sa anumang ibang pinagmulan na may 404.
Name
name
Type
string
Description
Opsyonal na pangalan ng task para sa layuning pagpapakita. Maximum na 100 na character.

`options`

Opsyonal na mga parameter para sa pag-tune ng relief geometry. Bawat field ay may makatwirang default — ipadala lamang ang mga gusto mong i-override.

Name
badge_shape
Type
string
default rounded-rect
Description
Balangkas na silweta ng fridge magnet. Available na mga value:
- circle
- rounded-rect (default)
- hexagon
- shield
- star
Name
size_mm
Type
number
default 60
Description
Haba ng gilid ng bounding square ng fridge magnet, sa millimeters. Saklaw: (0, 400].
Name
relief_height_mm
Type
number
default 3.3
Description
Pinakamataas na taas ng relief sa ibabaw ng base, sa millimeters. Saklaw: [0, 20].
Name
relief_offset_mm
Type
number
default 0
Description
Vertical offset na inilalapat sa relief bago i-extrude, sa millimeters. Saklaw: [0, 20].
Name
base_thickness_mm
Type
number
default 2.0
Description
Kapal ng patag na base plate sa likod ng relief, sa millimeters. Ang default para sa fridge magnet ay mas makapal na 2 mm na base — nagbibigay ito ng sapat na katawan sa magnet para kumapit sa fridge nang hindi pakiramdam na marupok ang relief. Saklaw: [0, 20].
Name
has_closed_back
Type
boolean
default true
Description
Kung ang likod ng fridge magnet ay naka-seal bilang isang saradong ibabaw (ang bahaging idinidikit mo ang magnet). Itakda sa false para sa bukas na shell.
Name
relief_curve
Type
string
default linear
Description
Transfer curve na nag-mamapa ng mga value ng depth-map sa taas ng relief. Available na mga value:
- linear (default)
- gamma
- s-curve
Name
curve_param
Type
number
default 1.0
Description
Shape parameter para sa transfer curve (may saysay lamang kapag ang relief_curve ay gamma). Saklaw: (0, 10].
Name
invert_depth
Type
boolean
default false
Description
I-invert ang interpretasyon ng depth-map upang ang mas madidilim na rehiyon ay maging mas mataas na relief.
Name
smoothing
Type
number
default 0.24
Description
Lakas ng smoothing na inilalapat sa depth map bago kunin ang relief. Saklaw: [0, 10].
Name
relief_scale
Type
number
default 1.0
Description
Vertical scale multiplier na inilalapat sa ibabaw ng relief_height_mm. Saklaw: (0, 10].
Name
depth_threshold
Type
number
default 0.1
Description
Low-pass threshold para sa mga value ng depth-map; anumang mas mababa dito ay ika-clamp sa zero. Saklaw: [0, 1].
Name
remove_background
Type
boolean
default true
Description
Awtomatikong alisin ang background ng concept image ng prototype bago mag-relief.
Hiwalay sa parameter ng prototype na may parehong pangalan (default false), na kumokontrol kung ang mismong prototype image ay ibabalik na may transparency.
Name
export_resolution
Type
integer
default 512
Description
Resolution ng mesh na ginamit para sa export. Saklaw: [64, 2048].

`output`

Opsyonal na selector ng wire-format. Default sa glb.

Name
format
Type
string
default glb
Description
Artifact bundle na ibinabalik ng build. Available na mga value:
- glb (default) — nagbabalik ng iisang model.glb sa ilalim ng model_urls.glb.
- obj — nag-zi-zip ng model.obj + model.mtl + texture.png at nagbabalik ng bundle sa ilalim ng model_urls.obj.
- zip — nag-zi-zip ng bawat artifact na ilinabas ng generator at nagbabalik ng bundle sa ilalim ng model_urls.bundle_zip.

Mga Ibinabalik

Ang result property ng response ay naglalaman ng task id ng bagong nagawang fridge magnet build task. I-poll ang Get a Task endpoint o mag-subscribe sa stream hanggang sa maabot ng task ang SUCCEEDED, pagkatapos ay i-download ang artifact mula sa iisang entry sa model_urls.

Mga Mode ng Pagkabigo

Name
400 - Bad Request
Description
Hindi katanggap-tanggap ang request. Karaniwang mga sanhi:
- Kulang na parameter: Kinakailangan ang input_task_id.
- Invalid na UUID: Ang input_task_id ay hindi wastong UUID.
- Hindi pa succeeded ang parent: Ang tinutukoy na prototype task ay hindi pa naabot ang SUCCEEDED.
- Walang candidate: Nagtagumpay ang prototype task ngunit walang nagawang candidate image.
- Options wala sa saklaw: Isa sa mga field ng options ay lumabas sa pinapayagang saklaw o enum set nito.
Name
401 - Unauthorized
Description
Nabigo ang authentication. Pakisuri ang iyong API key.
Name
402 - Payment Required
Description
Kulang ang credits para maisagawa ang task na ito.
Name
404 - Not Found
Description
Ang tinutukoy na prototype task ay hindi umiiral, pag-aari ng ibang user, o ginawa sa pamamagitan ng webapp (mga prototype task lamang sa API-mode ang maaaring kumadena papunta sa build).
Name
429 - Too Many Requests
Description
Lumagpas ka sa iyong rate limit.

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

Ang build task ay nagpapalit ng napiling prototype image sa isang 3D-printable fridge magnet model.

Creative Lab Fridge Magnet build model preview — Build model preview

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

Kunin ang Fridge Magnet Task

Kunin ang isang prototype o build task gamit ang wastong task id. Ang URL path ay dapat tumugma sa stage ng task — kung ang isang build task ay kinuha gamit ang /prototype/:id, magbabalik ito ng 404, at vice versa.

Sumangguni sa The Fridge Magnet Prototype Task Object at The Fridge Magnet Build Task Object para sa hugis ng response.

Mga Parameter

Name
id
Type
path
Description
Natatanging identifier para sa fridge magnet task na kukunin.

Ibinabalik

Ang response ay naglalaman ng fridge magnet task object. Ang hugis nito ay depende sa stage na hiningi.

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": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

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

Delete a Fridge Magnet Task

Kanselahin ang isang fridge magnet task. Kung ang task ay PENDING pa rin, ang credits na nagastos noong oras ng pagsisimula ay isasauli. Ang mga task na IN_PROGRESS na ay kinakansela nang walang refund (posibleng gumagamit na ng resources ang worker). Ang mga task na naabot na ang isang terminal na estado (SUCCEEDED, FAILED, CANCELED) ay hindi na maaaring kanselahin.

Ang URL path ay dapat tumugma sa stage ng task — ang DELETE sa /prototype/:buildId ay magbabalik ng 404.

Path Parameters

Name
id
Type
path
Description
Natatanging identifier para sa fridge magnet task na kakanselahin.

Returns

Ibabalik ang 204 No Content kapag matagumpay, na may walang laman na body.

Failure Modes

Name
400 - Bad Request
Description
Ang task ay naabot na sa isang terminal na estado at hindi na maaaring kanselahin.
Name
404 - Not Found
Description
Ang task ay hindi umiiral, pag-aari ng ibang user, o ang stage nito ay hindi tumutugma sa URL path.

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

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

I-stream ang Fridge Magnet Task

I-stream ang mga real-time na update para sa isang fridge magnet task sa pamamagitan ng Server-Sent Events (SSE). Ang URL path ay dapat tumugma sa yugto ng task — ang pagbukas ng stream sa /prototype/:buildId/stream ay maglalabas ng iisang event: error na payload na may status_code: 404 at isasara ang stream.

Mga Parameter

Name
id
Type
path
Description
Natatanging identifier para sa fridge magnet task na is-stream.

Mga Ibinabalik

Nagbabalik ng stream ng Fridge Magnet Prototype o Fridge Magnet Build na mga task object bilang Server-Sent Events. Bawat frame ay nagdadala ng kumpletong task object para sa yugto — ang parehong hugis na ibinabalik ng Get endpoint — kaya habang ang task ay PENDING o IN_PROGRESS, ang mga output field ay hindi pa lamang napopopulate (null, [] o {}) at ang finished_at ay null.

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 PENDING frame below is abbreviated 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": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

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

List Fridge Magnet Tasks

Kunin ang isang paginated na listahan ng iyong mga fridge magnet task para sa isang stage. Ang URL path ang pumipili ng stage — ibinabalik ng /prototype ang mga prototype task; ibinabalik naman ng /build ang mga build task. Ang mga task mula sa kabilang stage ay hindi kasama sa alinman sa dalawang tugon.

Path Parameters

Name
stage
Type
path
Kinakailangan
Description
Alinman sa prototype o build. Ibinabalik lamang ng collection ang mga task na ang stage ay tumutugma sa URL — ang pagkuha ng /prototype ay hindi kailanman nagbabalik ng build task at vice versa.

Query Parameters

Name
page_num
Type
integer
default 1
Description
Numero ng page para sa pagination.
Name
page_size
Type
integer
default 10
Description
Limitasyon ng laki ng page. Ang pinakamataas na pinapayagan ay 100 items.
Name
sort_by
Type
string
default -created_at
Description
Field na pagbabatayan ng pag-sort. Mga magagamit na value:
- +created_at: I-sort ayon sa oras ng paglikha nang pataas (ascending).
- -created_at: I-sort ayon sa oras ng paglikha nang pababa (descending).

Ibinabalik

Nagbabalik ng isang paginated na listahan ng per-stage task object — alinman sa the fridge magnet prototype task object kapag nililista ang /prototype o the fridge magnet build task object kapag nililista ang /build.

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=***"
    ]
  }
]

Ang Fridge Magnet Prototype Task Object

Ang Fridge Magnet Prototype Task object ay isang work unit na sinusubaybayan ng Meshy upang makabuo ng kulay na concept image mula sa isang pinagmulang larawan. Ang output ng yugtong ito ay ikinakabit sa yugto ng pagbuo sa pamamagitan ng input_task_id.

Mga Property

Name
id
Type
string
Description
Natatanging identifier para sa task. Bagama't gumagamit kami ng k-sortable UUID para sa mga task id bilang detalye ng implementasyon, hindi ka dapat gumawa ng anumang pagpapalagay tungkol sa format ng id.
Name
type
Type
string
Description
Uri ng task. Ang value ay creative-lab-fridge-magnet-prototype.
Name
name
Type
string
Description
Ang pangalan ng task na ibinigay noong nilikha ang task. Walang laman na string kung walang ibinigay na pangalan.
Name
status
Type
string
Description
Status ng task. Ang mga posibleng value ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress ng task. Kung hindi pa nasisimulan ang task, ang property na ito ay 0. Kapag nagtagumpay na ang task, ito ay magiging 100.
Name
created_at
Type
timestamp
Description
Timestamp kung kailan nilikha ang task, sa milliseconds.
Ang timestamp ay kumakatawan sa bilang ng milliseconds na lumipas mula Enero 1, 1970 UTC, alinsunod sa RFC 3339 standard. Halimbawa, ang Biyernes, Setyembre 1, 2023 12:00:00 PM GMT ay kinakatawan bilang 1693569600000. Ito ay naaangkop sa lahat ng timestamp sa Meshy API.
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 0.
Name
finished_at
Type
timestamp
Description
Timestamp kung kailan natapos ang task, sa milliseconds. Kung hindi pa natatapos ang task, ang property na ito ay 0.
Name
expires_at
Type
timestamp
Description
Timestamp kung kailan mag-e-expire ang resulta ng task, sa milliseconds.
Name
preceding_tasks
Type
integer
Description
Ang bilang ng mga naunang task.
Makabuluhan lamang ang value ng field na ito kung ang status ng task ay PENDING.
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. Naroroon kapag ang status ng task ay PENDING, IN_PROGRESS, o SUCCEEDED. Nagbabalik ng 0 para sa mga FAILED na task (nire-refund ang credits kapag nabigo).
Name
image_urls
Type
array of strings
Description
Mga URL na madada-download para sa mga kandidatong concept image na nabuo ng prototype task na ito. Sa kasalukuyan, palaging nagbabalik ang API ng eksaktong isang kandidato; ang field ay isang array upang ang mga susunod na revision ay makapagpakita ng maraming kandidato nang walang breaking change.

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=***"
  ]
}

Ang Fridge Magnet Build Task Object

Ang Fridge Magnet Build Task object ay isang work unit na sinusubaybayan ng Meshy upang buuin ang pangwakas na 3D fridge magnet mesh mula sa isang matagumpay na prototype task. Nagpapatakbo ang build ng isang depth-map relief pipeline sa concept image ng prototype at naglalathala ng iisang mesh artifact sa format na hiniling ng tumatawag.

Mga Property

Name
id
Type
string
Description
Natatanging identifier para sa task.
Name
type
Type
string
Description
Uri ng task. Ang value ay creative-lab-fridge-magnet-build.
Name
name
Type
string
Description
Ang pangalan ng task na ibinigay noong nilikha ang task. Empty string kung walang ibinigay na pangalan.
Name
status
Type
string
Description
Status ng task. Ang posibleng mga value ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress ng task. Kung hindi pa nasisimulan ang task, ang property na ito ay magiging 0. Kapag naging matagumpay na ang task, ito ay magiging 100.
Name
created_at
Type
timestamp
Description
Timestamp kung kailan nilikha ang task, sa milliseconds.
Name
started_at
Type
timestamp
Description
Timestamp kung kailan sinimulan ang task, sa milliseconds.
Name
finished_at
Type
timestamp
Description
Timestamp kung kailan natapos ang task, sa milliseconds.
Name
expires_at
Type
timestamp
Description
Timestamp kung kailan mag-e-expire ang resulta ng task, sa milliseconds.
Name
preceding_tasks
Type
integer
Description
Ang bilang ng mga naunang task. Makabuluhan lamang kapag ang status ay PENDING.
Name
task_error
Type
object
Description
Detalye ng error para sa mga nabigong task. Tingnan ang Errors para sa buong reference ng task_error object.
Name
consumed_credits
Type
integer
Description
Ang bilang ng credits na nagamit ng task na ito. Nagbabalik ng 0 para sa mga FAILED na task (ang credits ay ire-refund kapag nabigo).
Name
model_urls
Type
object
Description
Mga URL na madado-download para sa nabuong artifact, na naka-key ayon sa pangalan ng artifact. Laging naglalaman ng eksaktong isang entry — ang format na hiniling sa pamamagitan ng output.format ng build request. Ang key ay tumutugma sa hiniling na format:
- Name
  glb
  Type
  string
  Description
  Madado-download na URL sa GLB file. Naroroon kapag ang output.format ay glb (ang default).
- Name
  obj
  Type
  string
  Description
  Madado-download na URL sa isang zip bundle na naglalaman ng model.obj, model.mtl, at texture.png. Naroroon kapag ang output.format ay obj.
- Name
  bundle_zip
  Type
  string
  Description
  Madado-download na URL sa isang zip bundle ng bawat artifact na ibinubunga ng generator. Naroroon kapag ang output.format ay zip.

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": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}