Creative Lab — fridge magnet API

Gawing custom na fridge magnet ang iyong mga larawan — isang rounded-rectangle na may kulay na depth relief na may patag na magnetic na likod, sukat para sa fridge — sa dalawang yugto: ang prototype ay gumagawa ng may kulay na concept image mula sa iyong input na larawan, pagkatapos ay ginagawang relief na 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

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

Mga Parameter

  • Name
    image_url
    Type
    string
    Kinakailangan
    Description

    Source photo para i-colorize ng Meshy bilang concept image na handa para sa fridge magnet. Kasalukuyan naming sinusuportahan ang mga format na .jpg, .jpeg, .png, at .webp.

    May dalawang paraan para ibigay ang image:

    • URL na accessible sa publiko: Isang URL na accessible mula sa public internet.
    • Data URI: Isang base64-encoded na Data URI ng image. Halimbawa ng Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
  • Name
    name
    Type
    string
    Description

    Opsyonal na pangalan ng task para sa display purposes. Maximum na 100 character.

Mga Ibinabalik

Ang result property ng response ay naglalaman ng task id ng bagong likhang fridge magnet prototype task. I-poll ang Kumuha ng Task endpoint o mag-subscribe sa stream hanggang umabot ang task sa SUCCEEDED, pagkatapos ay ipasa ang ID na iyon sa build endpoint bilang input_task_id.

Mga Failure Mode

  • Name
    400 - Bad Request
    Description

    Hindi katanggap-tanggap ang request. Mga karaniwang sanhi:

    • Nawawalang parameter: Kinakailangan ang image_url.
    • Invalid na image format: Ang ibinigay na image_url ay hindi suportadong format (.jpg, .jpeg, .png, .webp).
    • Labas sa range ang dimensions ng image: Masyadong maliit ang image, lumalampas sa maximum file size, o lumalampas sa maximum pixel count.
    • Hindi maabot na URL: Hindi ma-download ang image_url (404 o timeout).
    • Invalid na Data URI: Mali ang pagkaka-format ng base64 string.
    • Na-flag na content: Na-flag ang input image 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 ang credits para isagawa 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"
}
Prototype example
Start with a source photo, then generate the prototype image used by the fridge magnet build stage.
Source na landscape photo na ginamit bilang input ng Creative Lab Fridge Magnet
Prototype input
Creative Lab Fridge Magnet prototype output na binuo mula sa source photo
Prototype output
POST/openapi/creative-lab/fridge-magnet/v1/build

Gumawa ng Build Task ng fridge magnet

I-generate ang final na 3D-printable na fridge magnet mula sa isang matagumpay na prototype task. Pinapatakbo ng build ang isang depth-map relief pipeline sa colorized concept image ng prototype at naghahatid ng iisang mesh artifact sa format na hinihingi 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 pamamagitan ng parehong OpenAPI endpoint na ito. Dapat nagawa ang prototype gamit ang parehong API key, dapat umabot na sa SUCCEEDED, at dapat nakagawa ng eksaktong isang candidate image.

    Ang mga prototype task na ginawa sa pamamagitan ng webapp ay hindi tinatanggap — tumatanggap lamang ang build endpoint ng mga prototype task na ginawa ng POST /openapi/creative-lab/fridge-magnet/v1/prototype at tinatanggihan ang anumang ibang source gamit ang 404.

  • Name
    name
    Type
    string
    Description

    Opsyonal na pangalan ng task para sa display. Maximum na 100 character.

options

Mga opsyonal na tuning parameter para sa relief heometriya. Bawat field ay may makatuwirang default — ipadala lamang ang mga gusto mong i-override.

  • Name
    badge_shape
    Type
    string
    default rounded-rect
    Description

    Outline silhouette ng fridge magnet. Mga available na value:

    • circle
    • rounded-rect (default)
    • hexagon
    • shield
    • star
  • Name
    size_mm
    Type
    number
    default 60
    Description

    Haba ng edge ng bounding square ng fridge magnet, sa millimeters. Saklaw: (0, 400].

  • Name
    relief_height_mm
    Type
    number
    default 3.3
    Description

    Maximum 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 ang extrusion, sa millimeters. Saklaw: [0, 20].

  • Name
    base_thickness_mm
    Type
    number
    default 2.0
    Description

    Kapal ng flat base plate sa likod ng relief, sa millimeters. Ang default ng fridge-magnet ay mas makapal na 2 mm base — binibigyan nito ang magnet ng sapat na katawan para kumapit sa fridge nang hindi nararamdamang marupok ang relief. Saklaw: [0, 20].

  • Name
    has_closed_back
    Type
    boolean
    default true
    Description

    Kung ang likod ng fridge magnet ay sealed bilang closed surface (ang side kung saan mo ididikit ang magnet). Itakda sa false para sa open shell.

  • Name
    relief_curve
    Type
    string
    default linear
    Description

    Transfer curve na nagma-map ng depth-map values sa relief height. Mga available na value:

    • linear (default)
    • gamma
    • s-curve
  • Name
    curve_param
    Type
    number
    default 1.0
    Description

    Shape parameter para sa transfer curve (may kabuluhan 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 region ay maging mas mataas na relief.

  • Name
    smoothing
    Type
    number
    default 0.24
    Description

    Lakas ng smoothing na inilalapat sa depth map bago ang relief extraction. 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 depth-map values; anumang mas mababa rito ay naka-clamp sa zero. Saklaw: [0, 1].

  • Name
    remove_background
    Type
    boolean
    default true
    Description

    Awtomatikong alisin ang background ng concept image ng prototype bago gumawa ng relief.

  • Name
    export_resolution
    Type
    integer
    default 512
    Description

    Mesh resolution na ginagamit para sa export. Saklaw: [64, 2048].

output

Opsyonal na wire-format selector. Default sa glb.

  • Name
    format
    Type
    string
    default glb
    Description

    Artifact bundle na ibinabalik ng build. Mga available na value:

    • glb (default) — nagbabalik ng iisang model.glb sa ilalim ng model_urls.glb.
    • obj — ini-zip ang model.obj + model.mtl + texture.png at ibinabalik ang bundle sa ilalim ng model_urls.obj.
    • zip — ini-zip ang bawat artifact na inilalabas ng generator at ibinabalik ang bundle sa ilalim ng model_urls.bundle_zip.

Ibinabalik

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

Mga Failure Mode

  • Name
    400 - Bad Request
    Description

    Hindi katanggap-tanggap ang request. Mga karaniwang sanhi:

    • Kulang na parameter: kinakailangan ang input_task_id.
    • Di-wastong UUID: Ang input_task_id ay hindi valid na UUID.
    • Hindi pa nag-succeed ang parent: Ang nire-reference na prototype task ay hindi pa umaabot sa SUCCEEDED.
    • Walang candidate: Nagtagumpay ang prototype task ngunit walang nagawang candidate image.
    • Options out of range: Isa sa mga options field ay lumampas sa pinapayagang saklaw o enum set nito.
  • Name
    401 - Unauthorized
    Description

    Nabigo ang authentication. Pakisuri ang iyong API key.

  • Name
    402 - Payment Required
    Description

    Hindi sapat ang credits para isagawa ang task na ito.

  • Name
    404 - Not Found
    Description

    Ang nire-reference na prototype task ay hindi umiiral, pag-aari ng ibang user, o ginawa sa pamamagitan ng webapp (tanging mga API-mode prototype task lang ang nakakadena papunta sa build).

  • Name
    429 - Too Many Requests
    Description

    Lumampas 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
The build task turns the selected prototype image into a 3D-printable fridge magnet model.
Preview ng Creative Lab fridge magnet build model
Build model preview
GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id

Kunin ang isang fridge magnet Task

Kunin ang isang prototype o build task gamit ang valid na task id. Ang URL path ay dapat tumugma sa stage ng task — ang build task na kinuha sa pamamagitan ng /prototype/:id ay nagbabalik ng 404, at ganoon din sa kabaligtaran.

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

Mga Parameter

  • Name
    id
    Type
    path
    Description

    Natatanging identifier para sa fridge magnet task na kukunin.

Ibinabalik

Naglalaman ang response ng fridge magnet task object. Ang hugis ay nakadepende sa kung aling stage ang hiniling.

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

Mag-delete ng Gawain ng fridge magnet

Kanselahin ang isang gawain ng fridge magnet. Kung ang gawain ay PENDING pa rin, ang credits na nagamit sa oras ng paggawa ay ire-refund. Ang mga gawaing nasa IN_PROGRESS na ay kinakansela nang walang refund (maaaring gumagamit na ang worker ng resources). Ang mga gawaing nakarating na sa terminal state (SUCCEEDED, FAILED, CANCELED) ay hindi na maaaring kanselahin.

Dapat tumugma ang URL path sa stage ng gawain — ang DELETE sa /prototype/:buildId ay nagbabalik ng 404.

Mga Parameter ng Path

  • Name
    id
    Type
    path
    Description

    Natatanging identifier para sa gawain ng fridge magnet na kakanselahin.

Ibinabalik

Nagbabalik ng 204 No Content kapag matagumpay, na may empty body.

Mga Mode ng Pagkabigo

  • Name
    400 - Bad Request
    Description

    Ang gawain ay nasa terminal state na at hindi na maaaring kanselahin.

  • Name
    404 - Not Found
    Description

    Ang gawain 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

Mag-stream ng fridge magnet task

Mag-stream ng mga real-time na update para sa isang fridge magnet task sa pamamagitan ng Server-Sent Events (SSE). Dapat tumugma ang URL path sa stage ng task — ang pagbubukas ng stream sa /prototype/:buildId/stream ay naglalabas ng isang event: error payload na may status_code: 404 at isinasara ang stream.

Mga Parameter

  • Name
    id
    Type
    path
    Description

    Natatanging identifier para sa fridge magnet task na i-stream.

Mga Ibinabalik

Nagbabalik ng stream ng mga task object ng fridge magnet Prototype o fridge magnet Build bilang Server-Sent Events. Para sa mga task na PENDING o IN_PROGRESS, ang response stream ay isasama lamang ang kinakailangang mga field na progress at status.

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.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
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)

Ilista ang mga Gawain sa fridge magnet

Kunin ang naka-pagination na listahan ng iyong mga gawain sa fridge magnet para sa iisang yugto. Pinipili ng path ng URL ang yugto — ang /prototype ay nagbabalik ng mga prototype na gawain; ang /build ay nagbabalik ng mga build na gawain. Ang mga gawain mula sa ibang yugto ay hindi isinasama sa alinmang tugon.

Mga Parameter ng Path

  • Name
    stage
    Type
    path
    Kinakailangan
    Description

    Alinman sa prototype o build. Ibinabalik lamang ng koleksyon ang mga gawain na ang yugto ay tumutugma sa URL — ang pagkuha ng /prototype ay hindi kailanman nagbabalik ng mga build na gawain at kabaliktaran.

Mga Parameter ng Query

  • Name
    page_num
    Type
    integer
    default 1
    Description

    Numero ng pahina para sa pagination.

  • Name
    page_size
    Type
    integer
    default 10
    Description

    Limitasyon sa laki ng pahina. Ang pinakamataas na pinapayagan ay 50 item.

  • Name
    sort_by
    Type
    string
    default -created_at
    Description

    Field na pagbabatayan ng pag-uuri. Mga available na halaga:

    • +created_at: Ayusin ayon sa oras ng paggawa sa pataas na pagkakasunod-sunod.
    • -created_at: Ayusin ayon sa oras ng paggawa sa pababang pagkakasunod-sunod.

Mga Ibinabalik

Nagbabalik ng naka-pagination na listahan ng object ng gawain bawat yugto — alinman sa object ng prototype na gawain sa fridge magnet kapag naglilista ng /prototype o object ng build na gawain sa fridge magnet kapag naglilista ng /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 Object ng Gawain ng Prototype ng fridge magnet

Ang object ng Gawain ng Prototype ng fridge magnet ay isang yunit ng trabaho na sinusubaybayan ng Meshy upang bumuo ng may-kulay na larawang konsepto mula sa pinagmulang larawan. Ang output ng yugtong ito ay ikinakadena sa yugto ng build 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 palagay 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 ginawa ang task. Empty 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 nagsisimula ang task, ang property na ito ay magiging 0. Kapag nagtagumpay na ang task, magiging 100 ito.

  • Name
    created_at
    Type
    timestamp
    Description

    timestamp kung kailan ginawa ang task, sa milliseconds.

    Ang timestamp ay kumakatawan sa bilang ng milliseconds na lumipas mula noong Enero 1, 1970 UTC, na sumusunod sa RFC 3339 na pamantayan. Halimbawa, ang Biyernes, Setyembre 1, 2023 12:00:00 PM GMT ay kinakatawan bilang 1693569600000. Nalalapat ito sa lahat ng timestamp sa Meshy API.

  • Name
    started_at
    Type
    timestamp
    Description

    timestamp kung kailan sinimulan ang task, sa milliseconds. Kung hindi pa nagsisimula ang task, ang property na ito ay magiging 0.

  • Name
    finished_at
    Type
    timestamp
    Description

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

  • Name
    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 nauunang 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 task_error object reference.

  • Name
    consumed_credits
    Type
    integer
    Description

    Ang bilang ng credits na nakonsumo ng task na ito. Naroroon kapag ang status ng task ay PENDING, IN_PROGRESS, o SUCCEEDED. Nagbabalik ng 0 para sa mga FAILED task (ibinabalik ang credits kapag nabigo).

  • Name
    image_urls
    Type
    array of strings
    Description

    Mga nada-download na URL para sa mga kandidatong concept image na nabuo ng prototype task na ito. Sa kasalukuyan, palaging nagbabalik ang API ng eksaktong isang kandidato; array ang field upang maipakita ng mga susunod na rebisyon ang 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 Object ng Build Task ng fridge magnet

Ang object ng Build Task ng fridge magnet ay isang work unit na sinusubaybayan ng Meshy upang bumuo ng final na 3D fridge magnet mesh mula sa matagumpay na prototype task. Ang build ay nagpapatakbo ng depth-map relief pipeline sa concept image ng prototype at nagpa-publish ng isang mesh artifact sa format na hiniling ng caller.

Mga Property

  • Name
    id
    Type
    string
    Description

    Natatanging identifier para sa gawain.

  • Name
    type
    Type
    string
    Description

    Uri ng gawain. Ang value ay creative-lab-fridge-magnet-build.

  • Name
    name
    Type
    string
    Description

    Ang pangalan ng gawain na ibinigay noong nilikha ang gawain. Empty string kung walang ibinigay na pangalan.

  • Name
    status
    Type
    string
    Description

    Status ng gawain. Ang mga posibleng value ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    progress
    Type
    integer
    Description

    progress ng gawain. Kung hindi pa nagsisimula ang gawain, ang property na ito ay magiging 0. Kapag nagtagumpay na ang gawain, magiging 100 ito.

  • Name
    created_at
    Type
    timestamp
    Description

    timestamp kung kailan nilikha ang gawain, sa milliseconds.

  • Name
    started_at
    Type
    timestamp
    Description

    timestamp kung kailan sinimulan ang gawain, sa milliseconds.

  • Name
    finished_at
    Type
    timestamp
    Description

    timestamp kung kailan natapos ang gawain, sa milliseconds.

  • Name
    expires_at
    Type
    timestamp
    Description

    timestamp kung kailan mag-e-expire ang resulta ng gawain, sa milliseconds.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Ang bilang ng mga naunang gawain. May kahulugan lamang kapag ang status ay PENDING.

  • Name
    task_error
    Type
    object
    Description

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

  • Name
    consumed_credits
    Type
    integer
    Description

    Ang bilang ng credits na nagamit ng gawaing ito. Nagbabalik ng 0 para sa mga FAILED na gawain (ibinabalik ang credits kapag nabigo).

  • Name
    model_urls
    Type
    object
    Description

    Mga nada-download na URL para sa nabuong artifact, naka-key ayon sa pangalan ng artifact. Palaging naglalaman ng eksaktong isang entry — ang format na hiniling sa pamamagitan ng output.format ng build request. Tumutugma ang key sa hiniling na format:

    • Name
      glb
      Type
      string
      Description

      Nada-download na URL papunta sa GLB file. Naroroon kapag ang output.format ay glb (ang default).

    • Name
      obj
      Type
      string
      Description

      Nada-download na URL papunta sa 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

      Nada-download na URL papunta sa zip bundle ng bawat artifact na inilalabas 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=***"
  }
}