Creative Lab — Fridge Magnet API

Gawing custom fridge magnets ang iyong mga larawan — isang rounded-rectangle na may kulay na depth relief na may patag na magnetic na likod, na sukat para sa fridge — sa dalawang yugto: prototype ay bumubuo ng may kulay na concept image mula sa iyong input na larawan, pagkatapos ay ang build ay ginagawang relief 3D model ang concept image na iyon. Ang dalawang yugto ay konektado 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 ay ang ipapasa mo bilang input_task_id sa build endpoint. Sumangguni sa The Fridge Magnet Prototype Task Object para sa hugis ng tugon.

Mga Parameter

  • Name
    image_url
    Type
    string
    Kinakailangan
    Description

    Source photo para sa Meshy upang gawing colorized na concept image na handa para sa fridge magnet. Kasalukuyan naming sinusuportahan ang mga format na .jpg, .jpeg, .png, at .webp.

    May dalawang paraan upang ibigay ang imahe:

    • Publicly accessible URL: Isang URL na naa-access mula sa pampublikong internet.
    • Data URI: Isang base64-encoded na data URI ng imahe. 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 layunin ng pagpapakita. Maximum na 100 na karakter.

  • Name
    remove_background
    Type
    boolean
    default false
    Description

    Kapag nakatakda sa true, ang prototype image ay ibinabalik bilang isang transparent na RGBA PNG na may tinanggal na background, upang maaari mong i-composite ang subject sa anumang background.

    Kinokontrol nito lamang ang imahe na ibinabalik ng endpoint na ito. Ito ay hiwalay mula sa opsyon ng build na may parehong pangalan (default true), na kumokontrol sa pagtanggal ng background bago ang reliefing.

Mga Ibinabalik

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

Mga Paraan ng Pagkabigo

  • Name
    400 - Bad Request
    Description

    Ang kahilingan ay hindi katanggap-tanggap. Karaniwang mga sanhi:

    • Missing parameter: Kinakailangan ang image_url.
    • Invalid image format: Ang ibinigay na image_url ay hindi suportadong format (.jpg, .jpeg, .png, .webp).
    • Image dimensions out of range: Ang imahe ay masyadong maliit, lumampas sa maximum na laki ng file, o lumampas sa maximum na bilang ng pixel.
    • Unreachable URL: Ang image_url ay hindi ma-download (404 o timeout).
    • Invalid Data URI: Ang base64 string ay mali ang pagkakabuo.
    • Content flagged: Ang input na imahe ay na-flag 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 upang 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, pagkatapos ay bumuo ng prototype image na ginagamit sa fridge magnet build stage.
Source landscape photo na ginamit bilang Creative Lab Fridge Magnet input
Prototype input
Creative Lab Fridge Magnet prototype output na nabuo mula sa source photo
Prototype output
POST/openapi/creative-lab/fridge-magnet/v1/build

Gumawa ng Fridge Magnet Build Task

Bumuo ng panghuling 3D-printable fridge magnet mula sa isang nagtagumpay na prototype task. Ang build ay nagpapatakbo ng depth-map relief pipeline sa colorized concept image ng prototype at naglalabas ng isang mesh artifact sa format na iyong hinihiling. Sumangguni sa The Fridge Magnet Build Task Object para sa hugis ng tugon.

Mga Parameter

  • Name
    input_task_id
    Type
    string
    Kinakailangan
    Description

    Ang task ID ng isang prototype task na nilikha sa pamamagitan ng parehong OpenAPI endpoint na ito. Ang prototype ay dapat na nilikha gamit ang parehong API key, dapat ay umabot sa SUCCEEDED, at dapat ay nakabuo ng eksaktong isang candidate image.

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

  • Name
    name
    Type
    string
    Description

    Opsyonal na pangalan ng task para sa layunin ng pagpapakita. Maximum na 100 karakter.

options

Opsyonal na mga tuning parameter para sa relief geometry. Ang bawat field ay may makatwirang default — ipadala lamang ang mga nais mong baguhin.

  • Name
    badge_shape
    Type
    string
    default rounded-rect
    Description

    Outline silhouette ng fridge magnet. Mga available na halaga:

    • 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

    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 inilapat 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 — nagbibigay ito ng sapat na katawan sa magnet upang kumapit sa fridge nang hindi nagiging marupok ang relief. Saklaw: [0, 20].

  • Name
    has_closed_back
    Type
    boolean
    default true
    Description

    Kung ang likod ng fridge magnet ay selyado bilang isang saradong ibabaw (ang bahagi kung saan mo ididikit ang magnet). Itakda sa false para sa isang bukas na shell.

  • Name
    relief_curve
    Type
    string
    default linear
    Description

    Transfer curve na nagmamapa ng depth-map values sa relief height. Mga available na halaga:

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

    Shape parameter para sa transfer curve (makabuluhan lamang kapag ang relief_curve ay gamma). Saklaw: (0, 10].

  • Name
    invert_depth
    Type
    boolean
    default false
    Description

    Baligtarin ang interpretasyon ng depth-map upang ang mas madilim na mga rehiyon ay maging mas mataas na relief.

  • Name
    smoothing
    Type
    number
    default 0.24
    Description

    Lakas ng smoothing na inilapat sa depth map bago ang relief extraction. Saklaw: [0, 10].

  • Name
    relief_scale
    Type
    number
    default 1.0
    Description

    Vertical scale multiplier na inilapat 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 dito ay ikinaklamp sa zero. Saklaw: [0, 1].

  • Name
    remove_background
    Type
    boolean
    default true
    Description

    Awtomatikong alisin ang background ng concept image ng prototype bago ang reliefing.

    Hiwalay mula sa prototype parameter ng parehong pangalan (default false), na kumokontrol kung ang prototype image mismo ay ibabalik na may transparency.

  • Name
    export_resolution
    Type
    integer
    default 512
    Description

    Mesh resolution na ginamit 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 ibinalik ng build. Mga available na halaga:

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

Mga Ibinabalik

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

Mga Mode ng Pagkabigo

  • Name
    400 - Bad Request
    Description

    Ang kahilingan ay hindi katanggap-tanggap. Karaniwang mga sanhi:

    • Nawawalang parameter: Kinakailangan ang input_task_id.
    • Invalid UUID: Ang input_task_id ay hindi isang wastong UUID.
    • Parent not succeeded: Ang tinutukoy na prototype task ay hindi pa umabot sa SUCCEEDED.
    • No candidate: Ang prototype task ay nagtagumpay ngunit hindi nakabuo ng candidate image.
    • Options out of range: Isa sa mga field ng options ay lumampas sa pinapayagang saklaw o enum set.
  • Name
    401 - Unauthorized
    Description

    Nabigo ang authentication. Paki-check ang iyong API key.

  • Name
    402 - Payment Required
    Description

    Hindi sapat ang credits upang isagawa ang task na ito.

  • Name
    404 - Not Found
    Description

    Ang tinutukoy na prototype task ay hindi umiiral, pag-aari ng ibang user, o nilikha sa pamamagitan ng webapp (tanging API-mode prototype tasks lamang ang maaaring i-chain sa build).

  • Name
    429 - Too Many Requests
    Description

    Naabot mo na ang 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 nagko-convert 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 isang Fridge Magnet Task

Kunin ang isang prototype o build task gamit ang isang wastong task id. Ang URL path ay dapat tumugma sa yugto ng task — ang isang build task na kinuha sa pamamagitan ng /prototype/:id ay magbabalik ng 404, at kabaligtaran.

Tingnan ang The Fridge Magnet Prototype Task Object at The Fridge Magnet Build Task Object para sa mga hugis ng tugon.

Mga Parameter

  • Name
    id
    Type
    path
    Description

    Natatanging pagkakakilanlan para sa fridge magnet task na kukunin.

Mga Ibinabalik

Ang tugon ay naglalaman ng fridge magnet task object. Ang hugis ay nakadepende sa kung aling yugto 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

Burahin ang isang Fridge Magnet Task

Kanselahin ang isang fridge magnet task. Kung ang task ay nasa PENDING pa, ang credits na nagamit sa oras ng paglikha ay ibabalik. Ang mga task na nasa IN_PROGRESS ay kakanselahin nang walang refund (maaaring gumagamit na ang worker ng resources). Ang mga task na umabot na sa terminal na estado (SUCCEEDED, FAILED, CANCELED) ay hindi na maaaring kanselahin.

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

Mga Parameter ng Path

  • Name
    id
    Type
    path
    Description

    Natatanging pagkakakilanlan para sa fridge magnet task na kakanselahin.

Mga Ibinabalik

Nagbabalik ng 204 No Content sa tagumpay na may walang laman na katawan.

Mga Paraan ng Pagkabigo

  • Name
    400 - Bad Request
    Description

    Ang task ay nasa terminal na estado at hindi na maaaring kanselahin.

  • Name
    404 - Not Found
    Description

    Ang task ay hindi umiiral, pagmamay-ari ng ibang user, o ang yugto 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 isang 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 isang event: error payload na may status_code: 404 at isasara ang stream.

Mga Parameter

  • Name
    id
    Type
    path
    Description

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

Mga Ibinabalik

Nagbabalik ng stream ng mga Fridge Magnet Prototype o Fridge Magnet Build task objects bilang Server-Sent Events. Para sa mga PENDING o IN_PROGRESS na tasks, ang response stream ay maglalaman lamang ng kinakailangang progress at status na mga field.

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)

Listahan ng mga Gawain sa Fridge Magnet

Kunin ang isang listahan ng iyong mga gawain sa fridge magnet para sa isang yugto na may pagination. Ang URL path ay pumipili ng yugto — ang /prototype ay nagbabalik ng mga gawain sa prototype; ang /build ay nagbabalik ng mga gawain sa build. Ang mga gawain mula sa ibang yugto ay hindi kasama sa alinmang tugon.

Mga Parameter ng Path

  • Name
    stage
    Type
    path
    Kinakailangan
    Description

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

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 ng laki ng pahina. Ang pinakamataas na pinapayagan ay 50 na item.

  • Name
    sort_by
    Type
    string
    default -created_at
    Description

    Patlang na gagamitin sa pag-uuri. Mga magagamit na halaga:

    • +created_at: Uriin ayon sa oras ng paglikha sa pataas na pagkakasunod-sunod.
    • -created_at: Uriin ayon sa oras ng paglikha sa pababang pagkakasunod-sunod.

Mga Ibinabalik

Nagbabalik ng isang listahan na may pagination ng object ng gawain sa bawat yugto — alinman ang object ng gawain sa fridge magnet prototype kapag naglilista ng /prototype o ang object ng gawain sa fridge magnet build 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 (Listahan ng mga Gawain sa Prototype)

[
  {
    "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 yunit ng trabaho na sinusubaybayan ng Meshy upang makabuo ng isang colorized concept image mula sa isang source photo. Ang output ng yugtong ito ay nakakadena sa ang build stage sa pamamagitan ng input_task_id.

Mga Katangian

  • Name
    id
    Type
    string
    Description

    Natatanging tagatukoy para sa gawain. Habang gumagamit kami ng k-sortable UUID para sa mga task id bilang detalye ng implementasyon, hindi ka dapat gumawa ng anumang mga palagay tungkol sa format ng id.

  • Name
    type
    Type
    string
    Description

    Uri ng gawain. Ang halaga ay creative-lab-fridge-magnet-prototype.

  • Name
    name
    Type
    string
    Description

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

  • Name
    status
    Type
    string
    Description

    Katayuan ng gawain. Ang mga posibleng halaga ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    progress
    Type
    integer
    Description

    Pag-unlad ng gawain. Kung ang gawain ay hindi pa nasisimulan, ang property na ito ay magiging 0. Kapag ang gawain ay nagtagumpay, ito ay magiging 100.

  • Name
    created_at
    Type
    timestamp
    Description

    Timestamp kung kailan nilikha ang gawain, sa milliseconds.

    Ang timestamp ay kumakatawan sa bilang ng milliseconds na lumipas mula Enero 1, 1970 UTC, alinsunod sa RFC 3339 na pamantayan. Halimbawa, Biyernes, Setyembre 1, 2023 12:00:00 PM GMT ay kinakatawan bilang 1693569600000. Ito ay naaangkop sa lahat ng mga timestamp sa Meshy API.

  • Name
    started_at
    Type
    timestamp
    Description

    Timestamp kung kailan sinimulan ang gawain, sa milliseconds. Kung ang gawain ay hindi pa nasisimulan, ang property na ito ay magiging 0.

  • Name
    finished_at
    Type
    timestamp
    Description

    Timestamp kung kailan natapos ang gawain, sa milliseconds. Kung ang gawain ay hindi pa natatapos, ang property na ito ay magiging 0.

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

    Ang halaga ng field na ito ay makabuluhan lamang kung ang katayuan ng gawain ay PENDING.

  • Name
    task_error
    Type
    object
    Description

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

  • Name
    consumed_credits
    Type
    integer
    Description

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

  • Name
    image_urls
    Type
    array of strings
    Description

    Mga maida-download na URL para sa mga concept image na kandidato na nabuo ng prototype task na ito. Sa kasalukuyan, ang API ay palaging nagbabalik ng eksaktong isang kandidato; ang field ay isang array upang ang mga susunod na bersyon ay makapagpakita ng maraming kandidato nang hindi nagkakaroon ng 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 yunit ng trabaho na sinusubaybayan ng Meshy upang makabuo ng panghuling 3D fridge magnet mesh mula sa isang nagtagumpay na prototype task. Ang build ay nagpapatakbo ng depth-map relief pipeline sa concept image ng prototype at naglalathala ng isang mesh artifact sa format na hiniling ng tumatawag.

Mga Katangian

  • Name
    id
    Type
    string
    Description

    Natatanging pagkakakilanlan para sa task.

  • Name
    type
    Type
    string
    Description

    Uri ng task. Ang halaga ay creative-lab-fridge-magnet-build.

  • 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

    Katayuan ng task. Ang mga posibleng halaga ay isa sa PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    progress
    Type
    integer
    Description

    Pag-unlad ng task. Kung ang task ay hindi pa nasisimulan, ang property na ito ay magiging 0. Kapag ang task ay nagtagumpay na, 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

    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 nagamit ng task na ito. Nagbabalik ng 0 para sa mga FAILED na task (ang credits ay ibinabalik kapag nabigo).

  • Name
    model_urls
    Type
    object
    Description

    Mga downloadable URL para sa nalikhang artifact, na naka-key sa pangalan ng artifact. Palaging naglalaman ng eksaktong isang entry — ang format na hiniling sa pamamagitan ng build request's output.format. Ang key ay tumutugma sa hiniling na format:

    • Name
      glb
      Type
      string
      Description

      Downloadable URL sa GLB file. Naroroon kapag ang output.format ay glb (ang default).

    • Name
      obj
      Type
      string
      Description

      Downloadable 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

      Downloadable URL sa isang 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=***"
  }
}