API Magnet Peti Sejuk Creative Lab

Tukar foto kepada magnet peti sejuk yang boleh dicetak dalam 3D dengan relief berwarna dan bahagian belakang rata, dalam dua peringkat. Tugas prototaip menghasilkan imej konsep berwarna daripada foto tersebut. Tugas binaan menukar imej tersebut kepada model 3D relief, dan menggunakan ID tugas prototaip sebagai 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

Create a Fridge Magnet prototype task

Menjana satu imej konsep berwarna daripada foto. Untuk membina model 3D, hantar ID tugas ini ke build endpoint sebagai input_task_id. Untuk medan tugas ini, lihat 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

Parameter

Name
image_url
Type
string
Diperlukan
Description
Foto untuk dijadikan imej konsep magnet peti sejuk, sebagai URL awam atau data URI (data:image/jpeg;base64,<data imej anda yang dikodkan base64>).
Imej mestilah fail JPG, JPEG, PNG, atau WebP dengan saiz maksimum 20 MB.
Name
name
Type
string
Description
Nama untuk tugas, sehingga 100 aksara. Ia akan dikembalikan dalam medan name tugas tersebut. Nama yang lebih panjang akan mengembalikan 400.
Name
remove_background
Type
boolean
lalai false
Description
Sama ada untuk mengalih keluar latar belakang daripada imej prototaip. true mengembalikan PNG RGBA telus yang mengekalkan keseluruhan magnet, supaya anda boleh meletakkannya pada sebarang latar belakang. Pembinaan juga bermula daripada imej tanpa latar belakangnya. Jika Meshy tidak dapat mengalih keluar latar belakang, ia akan mengembalikan imej berserta latar belakangnya, dan tugas itu tetap berjaya.
Pilihan remove_background bagi pembinaan adalah berasingan.

Returns

Medan result menyimpan ID tugas prototaip baharu. Dapatkan tugas atau strim tugas sehingga status menjadi SUCCEEDED. Kemudian hantar ID tersebut ke build endpoint sebagai input_task_id.

Failure modes

Name
400 - Bad Request
Description
Permintaan tidak dapat dijalankan. Contohnya:
- image_url tiada.
- Imej bukan fail JPG, JPEG, PNG, atau WebP.
- Imej terlalu kecil, melebihi 20 MB, atau melebihi kiraan piksel maksimum.
- Meshy tidak dapat memuat turun imej, contohnya kerana URL mengembalikan 404 atau tamat masa.
- Data URI bukan base64 yang sah.
- Imej ditanda sebagai NSFW.
Mesej ralat menyatakan masalah yang dijumpai. Betulkan permintaan, kemudian hantar semula.
Name
401 - Unauthorized
Description
Kunci API tiada atau tidak sah. Semak header Authorization.
Name
402 - Payment Required
Description
Salah satu daripada perkara berikut berlaku:
- Akaun tidak mempunyai kredit yang mencukupi.
- Kunci API, ruang kerja, atau ahli telah mencapai had kreditnya.
- Akaun berada pada pelan percuma.
Semak kredit dan pelan anda, kemudian cuba semula.
Name
403 - Forbidden
Description
Pasukan anda telah menghidupkan IP Filtering, dan Meshy menandakan imej tersebut mengandungi harta intelek pihak ketiga. Hantar imej yang anda mempunyai hak untuk menggunakannya.
Name
429 - Too Many Requests
Description
Salah satu had berikut telah dicapai:
- Anda menghantar lebih banyak permintaan daripada yang dibenarkan oleh had kadar anda. Tunggu beberapa saat, kemudian cuba semula. Lihat Rate limits.
- Terlalu banyak tugas anda sedang dalam baris gilir atau sedang berjalan. Tunggu sehingga beberapa selesai, kemudian cuba semula.
- Pada pelan tanpa had tanpa baki kredit, anda telah mencapai bilangan tugas yang boleh berjalan tanpa kredit. Tunggu sehingga satu tugas selesai, atau tambah kredit.
Name
500 - Internal Server Error
Description
Meshy mengalami ralat pelayan, contohnya kerana ia tidak dapat menjalankan pemeriksaan harta intelek pada imej tersebut. Meshy tidak mencipta tugas tersebut, dan memulangkan semula sebarang kredit yang telah dicaj. Cuba semula permintaan tersebut.

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

Cipta tugas pembinaan Fridge Magnet

Menjana magnet peti sejuk yang boleh dicetak dalam 3D daripada tugas prototaip yang berjaya. Meshy mengubah imej konsep prototaip menjadi relief peta kedalaman, dan mengembalikan satu fail model dalam format pilihan anda. Untuk medan tugas, lihat Objek tugas pembinaan Fridge Magnet.

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

Parameter

Name
input_task_id
Type
string
Diperlukan
Description
ID tugas prototaip yang hendak dibina. Ia mestilah tugas yang dicipta oleh akaun anda dengan POST /openapi/creative-lab/fridge-magnet/v1/prototype, dengan status SUCCEEDED.
ID yang bukan salah satu daripada tugas prototaip Fridge Magnet anda dari API akan mengembalikan 404, termasuk prototaip yang dibuat dalam aplikasi web.
Name
name
Type
string
Description
Nama untuk tugas, sehingga 100 aksara. Ia akan kembali dalam medan name tugas tersebut. Nama yang lebih panjang akan mengembalikan 400.

`options`

Tetapan pilihan untuk bentuk relief. Setiap medan mempunyai nilai lalai, jadi hantar hanya yang anda ingin ubah. Nilai di luar julat sesuatu medan akan mengembalikan 400.

Name
badge_shape
Type
string
lalai rounded-rect
Description
Garis luar magnet apabila Meshy tidak menjejak garis luarnya daripada subjek. Meshy menggunakannya apabila remove_background adalah false, atau apabila ia tidak dapat mengesan garis luar subjek.
Nilai yang tersedia:
- circle
- rounded-rect
- hexagon
- shield
- star
Name
size_mm
Type
number
lalai 60
Description
Panjang tepi segi empat sama sempadan magnet, dalam milimeter, sehingga 400. 0 menggunakan nilai lalai.
Name
relief_height_mm
Type
number
lalai 3.3
Description
Ketinggian maksimum relief di atas asas, dalam milimeter, dari 0 hingga 20.
Name
relief_offset_mm
Type
number
lalai 0
Description
Sejauh mana untuk merendahkan relief, dalam milimeter, dari 0 hingga 20. Meshy menolaknya daripada ketinggian relief di mana-mana sahaja, sehingga ke asas.
Name
base_thickness_mm
Type
number
lalai 2.0
Description
Ketebalan plat asas rata di belakang relief, dalam milimeter, dari 0 hingga 20. Asas lalai 2 mm memberikan magnet badan yang cukup untuk melekap pada peti sejuk, supaya relief tidak terasa rapuh.
Name
has_closed_back
Type
boolean
lalai true
Description
Sama ada untuk menutup bahagian belakang magnet, iaitu sisi yang anda gam magnet tersebut. false membiarkan bahagian belakang terbuka, sebagai cangkerang.
Name
relief_curve
Type
string
lalai linear
Description
Lengkung yang memetakan nilai peta kedalaman kepada ketinggian relief.
Nilai yang tersedia:
- linear
- gamma
- s-curve
Name
curve_param
Type
number
lalai 1.0
Description
Kekuatan lengkung, sehingga 10. Lengkung gamma dan s-curve menggunakannya, manakala linear mengabaikannya. 0 menggunakan nilai lalai.
Name
invert_depth
Type
boolean
lalai false
Description
Sama ada untuk menyongsangkan peta kedalaman, supaya kawasan yang lebih gelap menjadi relief yang lebih tinggi.
Name
smoothing
Type
number
lalai 0.24
Description
Berapa banyak untuk melicinkan peta kedalaman sebelum Meshy membina relief, dari 0 hingga 10.
Name
relief_scale
Type
number
lalai 1.0
Description
Berapa banyak untuk mengzum relief dan tekstur di dalam garis luar, mengelilingi pusat, sehingga 10. Nilai melebihi 1 membesarkan subjek, dan nilai bawah 1 mengecilkannya. Ia tidak mengubah ketinggian relief. 0 menggunakan nilai lalai.
Name
depth_threshold
Type
number
lalai 0.1
Description
Nilai peta kedalaman yang di bawahnya Meshy menetapkan kedalaman kepada sifar, dari 0 hingga 1.
Name
remove_background
Type
boolean
lalai true
Description
Sama ada untuk menjejak garis luar magnet daripada subjek, supaya magnet mengikut bentuk subjek. false menggunakan garis luar badge_shape sebagai gantinya. Meshy juga menggunakan badge_shape apabila ia tidak dapat mengesan garis luar subjek.
Ini berasingan daripada parameter remove_background prototaip, yang menetapkan sama ada imej prototaip mempunyai latar belakang lutsinar.
Name
export_resolution
Type
integer
lalai 512
Description
Resolusi jejaring model yang dieksport, dari 64 hingga 512. Meshy membina geometri daripada peta kedalaman 512 piksel, jadi jejaring yang lebih halus hanya akan menambah permukaan tanpa menambah perincian. 0 menggunakan nilai lalai.

`output`

Pilihan. Menetapkan format fail yang dikembalikan oleh pembinaan.

Name
format
Type
string
lalai glb
Description
Format fail yang dikembalikan oleh pembinaan.
Nilai yang tersedia:
- glb: satu fail model.glb, dalam model_urls.glb
- obj: fail zip dengan model.obj, model.mtl, dan texture.png, dalam model_urls.obj
- zip: fail zip dengan setiap fail yang dijana oleh Meshy, dalam model_urls.bundle_zip

Nilai kembali

Medan result menyimpan ID tugas pembinaan baharu. Dapatkan tugas tersebut atau strim ia sehingga status adalah SUCCEEDED. Kemudian muat turun fail daripada satu-satunya entri dalam model_urls.

Mod kegagalan

Name
400 - Bad Request
Description
Permintaan tidak dapat dijalankan. Contohnya:
- input_task_id tiada atau bukan ID tugas yang sah.
- Status tugas prototaip bukan SUCCEEDED. Jika ia masih berjalan, tunggu dan cuba semula. Jika ia gagal atau dibatalkan, cipta tugas prototaip baharu.
- Tugas prototaip berjaya tetapi tiada imej. Cipta tugas prototaip baharu.
- Medan options berada di luar julatnya atau bukan nilai yang tersedia.
Mesej ralat menyatakan masalah yang ditemuinya.
Name
401 - Unauthorized
Description
Kunci API tiada atau tidak sah. Semak pengepala Authorization.
Name
402 - Payment Required
Description
Salah satu daripada perkara berikut berlaku:
- Akaun tidak mempunyai kredit yang mencukupi.
- Kunci API, ruang kerja, atau ahli telah mencapai had kreditnya.
- Akaun berada pada pelan percuma.
Semak kredit dan pelan anda, kemudian cuba semula.
Name
404 - Not Found
Description
input_task_id tidak sepadan dengan mana-mana tugas prototaip Fridge Magnet yang dicipta oleh akaun anda dengan API. Prototaip yang dibuat dalam aplikasi web juga mengembalikan 404. Hantar ID result daripada respons cipta prototaip.
Name
429 - Too Many Requests
Description
Salah satu had berikut telah dicapai:
- Anda menghantar lebih banyak permintaan daripada yang dibenarkan oleh had kadar anda. Tunggu beberapa saat, kemudian cuba semula. Lihat Had kadar.
- Terlalu banyak tugas anda sedang beratur atau berjalan. Tunggu sehingga sebahagian selesai, kemudian cuba semula.
- Pada pelan tanpa had dengan tiada kredit lagi, anda telah mencapai bilangan tugas yang boleh berjalan tanpa kredit. Tunggu sehingga satu tugas selesai, atau tambah kredit.

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

Dapatkan tugas magnet peti sejuk

Mengembalikan tugas prototaip atau tugas build. Laluan mesti sepadan dengan peringkat tugas tersebut. Tugas build yang diminta melalui /prototype/:id akan mengembalikan 404, begitu juga tugas prototaip yang diminta melalui /build/:id.

Untuk medan-medannya, lihat Objek tugas prototaip magnet peti sejuk dan Objek tugas build magnet peti sejuk.

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

Parameter

Name
id
Type
path
Description
ID tugas daripada respons create.

Hasil Kembali

Objek tugas prototaip atau objek tugas build, yang sepadan dengan peringkat dalam laluan.

Mod kegagalan

Name
400 - Bad Request
Description
id bukan ID tugas yang sah. Hantar ID result daripada respons create.
Name
403 - Forbidden
Description
Pasukan anda telah mengaktifkan IP Filtering, dan Meshy telah menandakan imej tugas prototaip tersebut berkaitan hak harta intelek pihak ketiga. Tugas build dan pasukan pada pelan Enterprise tidak akan mendapat ralat ini. Cipta tugas prototaip daripada imej yang anda mempunyai hak untuk menggunakannya.
Name
404 - Not Found
Description
Tiada tugas magnet peti sejuk dengan ID ini yang dimiliki oleh akaun anda, atau peringkat tugas tersebut tidak sepadan dengan laluan. Semak ID tersebut, dan gunakan /prototype atau /build untuk menyepadankan tugas tersebut.
Name
500 - Internal Server Error
Description
Meshy tidak dapat menjalankan semakan hak harta intelek. Cuba semula permintaan tersebut.

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

Padam tugas Magnet Peti Sejuk

Membatalkan tugas magnet peti sejuk. Membatalkan tugas PENDING akan memulangkan semula kreditnya. Tugas IN_PROGRESS dibatalkan tanpa bayaran balik, kerana pekerja telah pun memulakannya. Tugas yang mempunyai status akhir (SUCCEEDED, FAILED, atau CANCELED) tidak boleh dibatalkan.

Laluan tersebut mesti sepadan dengan peringkat tugas. Sebagai contoh, DELETE pada /prototype/:id dengan ID tugas pembinaan akan memulangkan 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).

Parameter laluan

Name
id
Type
path
Description
ID tugas yang hendak dibatalkan.

Pulangan

204 No Content dengan badan yang kosong.

Mod kegagalan

Name
400 - Bad Request
Description
Salah satu daripada berikut berlaku:
- id bukan ID tugas yang sah. Hantar ID result daripada respons create.
- Tugas tersebut sudah mempunyai status akhir (SUCCEEDED, FAILED, atau CANCELED), jadi ia tidak boleh dibatalkan.
Name
404 - Not Found
Description
Tiada tugas magnet peti sejuk dengan ID ini yang dimiliki oleh akaun anda, atau peringkat tugas tersebut tidak sepadan dengan laluan. Semak ID tersebut, dan gunakan /prototype atau /build untuk memadankan tugas.

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

Strim tugasan magnet peti sejuk

Menstrim kemas kini tugasan magnet peti sejuk sebagai Server-Sent Events (SSE). Laluan tersebut mesti sepadan dengan peringkat tugasan. Jika tidak, contohnya ID tugasan build di /prototype/:id/stream, strim tersebut menghantar satu peristiwa error dengan status_code: 404 dan ditutup.

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

Parameter

Name
id
Type
path
Description
ID tugasan daripada respons create.

Pulangan

Satu strim objek tugasan prototype atau build. Setiap peristiwa mengandungi objek tugasan penuh, sebagaimana yang dipulangkan oleh Dapatkan tugasan magnet peti sejuk. Semasa tugasan berstatus PENDING atau IN_PROGRESS, medan outputnya masih kosong (null, [], atau {}), dan finished_at adalah null.

Jika IP Filtering menyekat hasil tugasan, strim tersebut menghantar satu peristiwa error sebagai gantinya, dengan status_code yang sama seperti yang akan dipulangkan oleh permintaan get.

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

Senaraikan tugas Magnet Peti Sejuk

Mengembalikan tugas Magnet Peti Sejuk anda bagi satu peringkat, satu halaman pada satu masa. Laluan menentukan peringkat tersebut. /prototype hanya mengembalikan tugas prototaip, dan /build hanya mengembalikan tugas pembinaan.

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

Parameter laluan

Name
stage
Type
path
Diperlukan
Description
Peringkat yang hendak disenaraikan, prototype atau build.

Parameter pertanyaan

Name
page_num
Type
integer
lalai 1
Description
Halaman yang hendak dikembalikan, dari 1 hingga 255. 0 mengembalikan halaman pertama. Nilai di luar 0 hingga 255 mengembalikan 400.
Name
page_size
Type
integer
lalai 10
Description
Bilangan tugas setiap halaman, sehingga 100. Nilai dari 101 hingga 255 mengembalikan 100 tugas, dan 0 menggunakan nilai lalai. Nilai di luar 0 hingga 255 mengembalikan 400.
Name
sort_by
Type
string
lalai -created_at
Description
Susunan isihan.
Nilai yang tersedia:
- -created_at: terbaharu dahulu
- +created_at: terlama dahulu

Nilai pulangan

Satu array objek tugas prototaip atau objek tugas pembinaan, mengikut peringkat dalam laluan.

Objek tugas prototaip Magnet Peti Sejuk

Tugas prototaip menjana imej konsep berwarna daripada sebuah foto. Untuk menukar imej tersebut kepada model 3D, hantar ID tugas itu kepada endpoint build sebagai input_task_id.

Sifat

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
ID tugas. Jangan bergantung pada formatnya.
Name
type
Type
string
Description
Jenis tugas, sentiasa creative-lab-fridge-magnet-prototype.
Name
name
Type
string
Description
name yang anda hantar semasa mencipta tugas, atau "" jika anda tidak menghantarnya.
Name
status
Type
string
Description
Status tugas tersebut.
Nilai yang tersedia:
- PENDING: menunggu dalam baris gilir
- IN_PROGRESS: sedang menjana hasil
- SUCCEEDED: muktamad, dengan hasil
- FAILED: muktamad, dengan sebab dalam task_error
- CANCELED: muktamad, tanpa hasil
Name
progress
Type
integer
Description
Peratusan kerja yang telah siap, dari 0 hingga 100. Nilainya 0 sehingga tugas bermula dan 100 apabila ia berjaya.
Name
created_at
Type
timestamp
Description
Masa tugas dicipta, dalam milisaat Unix.
Name
started_at
Type
timestamp
Description
Masa seorang pekerja memulakan tugas, dalam milisaat Unix. null sehingga ketika itu.
Name
finished_at
Type
timestamp
Description
Masa tugas mencapai status muktamad, dalam milisaat Unix. null sehingga ketika itu.
Name
expires_at
Type
timestamp
Description
Masa hasil tugas tamat tempoh, dalam milisaat Unix. Ia adalah 3 hari selepas finished_at, atau 3 hari selepas created_at sehingga tugas selesai. Bagi akaun Enterprise, yang menyimpan hasil API secara tidak terhad, ia adalah kira-kira 100 tahun kemudian. Lihat Pengekalan Aset.
Name
preceding_tasks
Type
integer
Description
Kedudukan tugas dalam baris gilir semasa ia PENDING. 1 bermaksud ia akan bermula seterusnya. 0 selepas tugas keluar daripada baris gilir, dan sentiasa 0 dalam hasil senarai.
Name
task_error
Type
object
Description
Sebab tugas gagal. null kecuali status ialah FAILED. Lihat Ralat.
Name
consumed_credits
Type
integer
Description
Bilangan kredit yang dicaj untuk tugas tersebut, selepas sebarang bayaran balik. Permintaan yang mengembalikan ralat tidak dicaj. Tugas yang gagal adalah 0, kerana Meshy membayar baliknya. Membatalkan hanya membayar balik tugas semasa ia PENDING. Jika Meshy tidak dapat membaca caj tersebut, respons get atau stream akan meninggalkan medan ini, dan permintaan senarai akan mengembalikan 500. Dalam kes itu, cuba semula permintaan tersebut.
Name
image_urls
Type
array of strings
Description
URL muat turun untuk imej konsep. Array ini mempunyai satu URL selepas tugas berjaya, dan kosong sehingga ketika itu.

Objek tugas pembinaan Fridge Magnet

Tugas pembinaan menjana magnet peti sejuk 3D daripada tugas prototaip yang berjaya. Ia mengembalikan satu fail model dalam format yang anda minta.

Properties

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
ID tugas. Jangan bergantung pada formatnya.
Name
type
Type
string
Description
Jenis tugas, sentiasa creative-lab-fridge-magnet-build.
Name
name
Type
string
Description
name yang anda hantar semasa mencipta tugas, atau "" jika anda tidak menghantarnya.
Name
status
Type
string
Description
Status tugas tersebut.
Nilai yang tersedia:
- PENDING: menunggu dalam baris gilir
- IN_PROGRESS: sedang menjana hasil
- SUCCEEDED: muktamad, dengan hasil
- FAILED: muktamad, dengan sebab dalam task_error
- CANCELED: muktamad, tanpa hasil
Name
progress
Type
integer
Description
Peratusan kerja yang telah selesai, dari 0 hingga 100. Nilainya 0 sehingga tugas bermula dan 100 apabila ia berjaya.
Name
created_at
Type
timestamp
Description
Masa tugas dicipta, dalam milisaat Unix.
Name
started_at
Type
timestamp
Description
Masa seorang pekerja memulakan tugas, dalam milisaat Unix. null sehingga itu.
Name
finished_at
Type
timestamp
Description
Masa tugas mencapai status muktamad, dalam milisaat Unix. null sehingga itu.
Name
expires_at
Type
timestamp
Description
Masa hasil tugas tamat tempoh, dalam milisaat Unix. Ia adalah 3 hari selepas finished_at, atau 3 hari selepas created_at sehingga tugas selesai. Untuk akaun Enterprise, yang menyimpan hasil API tanpa had masa, ia adalah lebih kurang 100 tahun kemudian. Lihat Pengekalan Aset.
Name
preceding_tasks
Type
integer
Description
Kedudukan tugas dalam baris gilir semasa ia PENDING. 1 bermaksud ia akan bermula seterusnya. 0 selepas tugas keluar daripada baris gilir, dan sentiasa 0 dalam hasil senarai.
Name
task_error
Type
object
Description
Sebab tugas gagal. null kecuali status adalah FAILED. Lihat Ralat.
Name
consumed_credits
Type
integer
Description
Bilangan kredit yang dicaj untuk tugas, selepas sebarang bayaran balik. Permintaan yang mengembalikan ralat tidak dicaj. Tugas yang gagal adalah 0, kerana Meshy membayar baliknya. Membatalkan hanya membayar balik tugas semasa ia PENDING. Jika Meshy tidak dapat membaca caj tersebut, respons get atau stream akan mengetepikan medan tersebut, dan permintaan senarai akan mengembalikan 500. Dalam kes itu, cuba semula permintaan tersebut.
Name
model_urls
Type
object
Description
URL muat turun untuk fail model, dengan satu entri untuk output.format yang anda minta. {} sehingga tugas berjaya.
- Name
  glb
  Type
  string
  Description
  URL muat turun untuk fail GLB. Hadir apabila output.format adalah glb.
- Name
  obj
  Type
  string
  Description
  URL muat turun untuk fail zip dengan model.obj, model.mtl, dan texture.png. Hadir apabila output.format adalah obj.
- Name
  bundle_zip
  Type
  string
  Description
  URL muat turun untuk fail zip dengan setiap fail yang dijana oleh Meshy. Hadir apabila output.format adalah zip.