lowpoly dihentikan pada 30 Okt 2026. Ganti model sebelum tanggal-tanggal ini agar permintaan tidak error. Lihat semua penghentian

Creative Lab Fridge Magnet API

Ubah sebuah foto menjadi magnet kulkas yang dapat dicetak 3D dengan relief berwarna dan bagian belakang yang rata, melalui dua tahap. Task prototype menghasilkan gambar konsep berwarna dari foto tersebut. Task build mengubah gambar tersebut menjadi model 3D relief, dan mengambil ID dari task prototype 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

Menghasilkan satu gambar konsep berwarna dari sebuah foto. Untuk membangun model 3D, kirimkan ID task ini ke build endpoint sebagai input_task_id. Untuk field-field task, 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"
}
Contoh prototipe
Mulai dengan foto sumber, lalu hasilkan gambar prototipe yang digunakan oleh tahap build magnet kulkas.
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
    Wajib
    Description

    Foto yang akan diubah menjadi gambar konsep magnet kulkas, berupa URL publik atau data URI (data:image/jpeg;base64,<data gambar Anda yang dienkode base64>).

    Gambar harus berupa file JPG, JPEG, PNG, atau WebP berukuran maksimal 20 MB.

  • Name
    name
    Type
    string
    Description

    Nama untuk task, hingga 100 karakter. Nama ini dikembalikan pada field name milik task. Nama yang lebih panjang akan mengembalikan 400.

  • Name
    remove_background
    Type
    boolean
    default false
    Description

    Apakah akan menghapus latar belakang dari gambar prototipe. true mengembalikan PNG RGBA transparan yang tetap mempertahankan seluruh bentuk magnet, sehingga Anda dapat menempatkannya pada latar belakang apa pun. Proses build juga dimulai dari gambar tanpa latar belakangnya. Jika Meshy tidak dapat menghapus latar belakang, gambar akan dikembalikan beserta latar belakangnya, dan task tetap berhasil.

    Opsi remove_background pada build bersifat terpisah.

Hasil

Field result menyimpan ID dari task prototipe yang baru. Dapatkan task atau streaming task tersebut hingga status bernilai SUCCEEDED. Kemudian kirimkan ID tersebut ke build endpoint sebagai input_task_id.

Mode kegagalan

  • Name
    400 - Bad Request
    Description

    Permintaan tidak dapat dijalankan. Misalnya:

    • image_url tidak ada.
    • Gambar bukan file JPG, JPEG, PNG, atau WebP.
    • Gambar terlalu kecil, melebihi 20 MB, atau melebihi jumlah piksel maksimum.
    • Meshy tidak dapat mengunduh gambar, misalnya karena URL mengembalikan 404 atau timeout.
    • Data URI bukan base64 yang valid.
    • Gambar ditandai sebagai NSFW.

    Pesan error menunjukkan masalah apa yang ditemukan. Perbaiki permintaan, lalu kirim ulang.

  • Name
    401 - Unauthorized
    Description

    Kunci API tidak ada atau tidak valid. Periksa header Authorization.

  • Name
    402 - Payment Required
    Description

    Salah satu dari hal berikut berlaku:

    • Akun tidak memiliki cukup kredit.
    • Kunci API, ruang kerja, atau anggota telah mencapai batas kreditnya.
    • Akun menggunakan paket gratis.

    Periksa kredit dan paket Anda, lalu coba lagi.

  • Name
    403 - Forbidden
    Description

    Tim Anda mengaktifkan IP Filtering, dan Meshy menandai gambar tersebut terkait kekayaan intelektual pihak ketiga. Kirimkan gambar yang Anda memiliki hak untuk menggunakannya.

  • Name
    429 - Too Many Requests
    Description

    Salah satu batas berikut telah tercapai:

    • Anda mengirim lebih banyak permintaan daripada yang diizinkan oleh batas laju Anda. Tunggu beberapa detik, lalu coba lagi. Lihat Rate limits.
    • Terlalu banyak task Anda yang sedang antre atau berjalan. Tunggu hingga beberapa selesai, lalu coba lagi.
    • Pada paket tak terbatas tanpa sisa kredit, Anda telah mencapai jumlah task yang dapat berjalan tanpa kredit. Tunggu hingga sebuah task selesai, atau tambahkan kredit.
  • Name
    500 - Internal Server Error
    Description

    Meshy mengalami error server, misalnya karena tidak dapat menjalankan pemeriksaan kekayaan intelektual pada gambar. Meshy tidak membuat task tersebut, dan mengembalikan kredit yang telah dibebankan. Coba lagi permintaan tersebut.


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

Buat task build magnet kulkas

Menghasilkan magnet kulkas yang siap cetak 3D dari task prototype yang berhasil. Meshy mengubah gambar konsep dari prototype menjadi relief peta kedalaman, dan mengembalikan satu file model dalam format pilihan Anda. Untuk kolom-kolom task ini, lihat Objek task build magnet kulkas.

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
    Wajib
    Description

    ID dari task prototype yang akan di-build. ID ini harus berupa task yang dibuat oleh akun Anda dengan POST /openapi/creative-lab/fridge-magnet/v1/prototype, dengan status SUCCEEDED.

    ID yang bukan merupakan salah satu task prototype magnet kulkas Anda dari API akan mengembalikan 404, termasuk prototype yang dibuat di aplikasi web.

  • Name
    name
    Type
    string
    Description

    Nama untuk task, hingga 100 karakter. Nama ini akan muncul kembali di kolom name pada task. Nama yang lebih panjang akan mengembalikan 400.

options

Pengaturan opsional untuk bentuk relief. Setiap kolom memiliki nilai default, jadi kirimkan hanya kolom yang ingin Anda ubah. Nilai di luar rentang suatu kolom akan mengembalikan 400.

  • Name
    badge_shape
    Type
    string
    default rounded-rect
    Description

    Garis luar magnet ketika Meshy tidak melacaknya dari subjek. Meshy menggunakan ini ketika remove_background bernilai false, atau ketika Meshy tidak dapat menemukan garis luar subjek.

    Nilai yang tersedia:

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

    Panjang sisi dari kotak pembatas magnet, dalam milimeter, hingga 400. 0 menggunakan nilai default.

  • Name
    relief_height_mm
    Type
    number
    default 3.3
    Description

    Ketinggian maksimum relief di atas dasar, dalam milimeter, dari 0 hingga 20.

  • Name
    relief_offset_mm
    Type
    number
    default 0
    Description

    Seberapa jauh menurunkan relief, dalam milimeter, dari 0 hingga 20. Meshy mengurangkan nilai ini dari ketinggian relief di semua bagian, hingga ke dasar.

  • Name
    base_thickness_mm
    Type
    number
    default 2.0
    Description

    Ketebalan pelat dasar datar di belakang relief, dalam milimeter, dari 0 hingga 20. Dasar default 2 mm memberi magnet cukup badan untuk menempel pada kulkas, sehingga relief tidak terasa rapuh.

  • Name
    has_closed_back
    Type
    boolean
    default true
    Description

    Apakah akan menutup bagian belakang magnet, sisi tempat Anda merekatkan magnet. false membiarkan bagian belakang terbuka, seperti cangkang.

  • Name
    relief_curve
    Type
    string
    default linear
    Description

    Kurva yang memetakan nilai peta kedalaman ke ketinggian relief.

    Nilai yang tersedia:

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

    Kekuatan kurva, hingga 10. Kurva gamma dan s-curve menggunakannya, sedangkan linear mengabaikannya. 0 menggunakan nilai default.

  • Name
    invert_depth
    Type
    boolean
    default false
    Description

    Apakah akan membalik peta kedalaman, sehingga area yang lebih gelap menjadi relief yang lebih tinggi.

  • Name
    smoothing
    Type
    number
    default 0.24
    Description

    Seberapa besar penghalusan peta kedalaman sebelum Meshy membangun relief, dari 0 hingga 10.

  • Name
    relief_scale
    Type
    number
    default 1.0
    Description

    Seberapa besar zoom pada relief dan teksturnya di dalam garis luar, dari titik pusat, hingga 10. Nilai di atas 1 memperbesar subjek, dan nilai di bawah 1 memperkecilnya. Ini tidak mengubah ketinggian relief. 0 menggunakan nilai default.

  • Name
    depth_threshold
    Type
    number
    default 0.1
    Description

    Nilai peta kedalaman yang di bawahnya Meshy menetapkan kedalaman menjadi nol, dari 0 hingga 1.

  • Name
    remove_background
    Type
    boolean
    default true
    Description

    Apakah akan melacak garis luar magnet dari subjek, sehingga magnet mengikuti bentuk subjek. false menggunakan garis luar badge_shape sebagai gantinya. Meshy juga menggunakan badge_shape ketika tidak dapat menemukan garis luar subjek.

    Ini terpisah dari parameter remove_background pada prototype, yang menentukan apakah gambar prototype memiliki latar belakang transparan.

  • Name
    export_resolution
    Type
    integer
    default 512
    Description

    Resolusi mesh dari model yang diekspor, dari 64 hingga 512. Meshy membangun geometri dari peta kedalaman 512 piksel, sehingga mesh yang lebih halus akan menambah faces tanpa menambah detail. 0 menggunakan nilai default.

output

Opsional. Menetapkan format file yang dikembalikan oleh build.

  • Name
    format
    Type
    string
    default glb
    Description

    Format file yang dikembalikan oleh build.

    Nilai yang tersedia:

    • glb: satu file model.glb, di model_urls.glb
    • obj: file zip berisi model.obj, model.mtl, dan texture.png, di model_urls.obj
    • zip: file zip berisi setiap file yang dihasilkan Meshy, di model_urls.bundle_zip

Returns

Kolom result menyimpan ID dari task build yang baru. Dapatkan task tersebut atau streaming task tersebut hingga status bernilai SUCCEEDED. Kemudian unduh file dari satu-satunya entri di model_urls.

Mode kegagalan

  • Name
    400 - Bad Request
    Description

    Permintaan tidak dapat dijalankan. Contohnya:

    • input_task_id hilang atau bukan ID task yang valid.
    • Status task prototype bukan SUCCEEDED. Jika masih berjalan, tunggu lalu coba lagi. Jika gagal atau dibatalkan, buat task prototype baru.
    • Task prototype berhasil tetapi tidak memiliki gambar. Buat task prototype baru.
    • Sebuah kolom options berada di luar rentangnya atau bukan nilai yang tersedia.

    Pesan error menunjukkan masalah yang ditemukan.

  • Name
    401 - Unauthorized
    Description

    Kunci API hilang atau tidak valid. Periksa header Authorization.

  • Name
    402 - Payment Required
    Description

    Salah satu dari hal berikut berlaku:

    • Akun tidak memiliki cukup kredit.
    • Kunci API, ruang kerja, atau anggota telah mencapai batas kreditnya.
    • Akun berada pada paket gratis.

    Periksa kredit dan paket Anda, lalu coba lagi.

  • Name
    404 - Not Found
    Description

    input_task_id tidak cocok dengan task prototype magnet kulkas mana pun yang dibuat akun Anda melalui API. Prototype yang dibuat di aplikasi web juga akan mengembalikan 404. Kirimkan ID result dari respons pembuatan prototype.

  • Name
    429 - Too Many Requests
    Description

    Salah satu batas berikut tercapai:

    • Anda mengirim lebih banyak permintaan daripada yang diizinkan oleh batas laju Anda. Tunggu beberapa detik, lalu coba lagi. Lihat Batas laju.
    • Terlalu banyak task Anda yang berada dalam antrean atau sedang berjalan. Tunggu hingga beberapa selesai, lalu coba lagi.
    • Pada paket tak terbatas tanpa sisa kredit, Anda telah mencapai jumlah task yang dapat berjalan tanpa kredit. Tunggu hingga sebuah task selesai, atau tambahkan kredit.

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

Mendapatkan tugas Fridge Magnet

Mengembalikan tugas prototype atau build. Path harus sesuai dengan tahap tugas tersebut. Tugas build yang diminta melalui /prototype/:id akan mengembalikan 404, begitu pula tugas prototype yang diminta melalui /build/:id.

Untuk kolom-kolomnya, lihat Objek tugas prototype Fridge Magnet dan Objek tugas build Fridge Magnet.

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 dari respons pembuatan.

Returns

Objek tugas prototype atau objek tugas build, sesuai dengan tahap pada path.

Mode kegagalan

  • Name
    400 - Bad Request
    Description

    id bukan ID tugas yang valid. Kirim ID result dari respons pembuatan.

  • Name
    403 - Forbidden
    Description

    Tim Anda mengaktifkan IP Filtering, dan Meshy menandai gambar pada tugas prototype karena hak kekayaan intelektual pihak ketiga. Tugas build dan tim pada paket Enterprise tidak mendapatkan error ini. Buat tugas prototype dari gambar yang Anda miliki haknya untuk digunakan.

  • Name
    404 - Not Found
    Description

    Tidak ada tugas Fridge Magnet dengan ID ini yang dimiliki akun Anda, atau tahap tugas tidak cocok dengan path. Periksa ID-nya, dan gunakan /prototype atau /build yang sesuai dengan tugas tersebut.

  • Name
    500 - Internal Server Error
    Description

    Meshy tidak dapat menjalankan pemeriksaan hak kekayaan intelektual. Coba lagi permintaan tersebut.


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

Hapus task magnet kulkas

Membatalkan task magnet kulkas. Membatalkan task PENDING akan mengembalikan kreditnya. Task IN_PROGRESS dibatalkan tanpa pengembalian kredit, karena worker sudah mulai mengerjakannya. Task dengan status akhir (SUCCEEDED, FAILED, atau CANCELED) tidak dapat dibatalkan.

Path harus sesuai dengan tahap task tersebut. Misalnya, DELETE pada /prototype/:id dengan ID task build akan mengembalikan 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 path

  • Name
    id
    Type
    path
    Description

    ID task yang akan dibatalkan.

Returns

204 No Content dengan body kosong.

Mode kegagalan

  • Name
    400 - Bad Request
    Description

    Salah satu dari berikut ini berlaku:

    • id bukan ID task yang valid. Kirim ID result dari respons pembuatan (create).
    • Task sudah memiliki status akhir (SUCCEEDED, FAILED, atau CANCELED), sehingga tidak dapat dibatalkan.
  • Name
    404 - Not Found
    Description

    Tidak ada task magnet kulkas dengan ID ini yang dimiliki oleh akun Anda, atau tahap task tidak cocok dengan path. Periksa ID, dan gunakan /prototype atau /build yang sesuai dengan task tersebut.


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

Stream tugas Fridge Magnet

Melakukan streaming pembaruan tugas magnet kulkas sebagai Server-Sent Events (SSE). Path harus sesuai dengan tahap tugas tersebut. Jika tidak, misalnya ID tugas build berada di /prototype/:id/stream, stream akan mengirim satu event error dengan status_code: 404 lalu 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 tugas dari respons pembuatan.

Return

Sebuah stream objek tugas prototype atau build. Setiap event berisi objek tugas secara lengkap, sebagaimana dikembalikan oleh Get a Fridge Magnet task. Selama tugas berstatus PENDING atau IN_PROGRESS, field output-nya masih kosong (null, [], atau {}), dan finished_at bernilai null.

Jika IP Filtering memblokir hasil tugas, stream akan mengirim satu event error sebagai gantinya, dengan status_code yang sama seperti yang akan dikembalikan oleh permintaan get.


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

List tugas Fridge Magnet

Mengembalikan tugas magnet kulkas Anda untuk satu tahap, satu halaman dalam satu waktu. Path menentukan tahapnya. /prototype hanya mengembalikan tugas prototype, dan /build hanya mengembalikan tugas 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=***"
    ]
  }
]

Parameter path

  • Name
    stage
    Type
    path
    Wajib
    Description

    Tahap yang akan ditampilkan, prototype atau build.

Parameter query

  • Name
    page_num
    Type
    integer
    default 1
    Description

    Halaman yang akan dikembalikan, dari 1 sampai 255. 0 mengembalikan halaman pertama. Nilai di luar 0 sampai 255 akan mengembalikan 400.

  • Name
    page_size
    Type
    integer
    default 10
    Description

    Jumlah tugas per halaman, hingga 100. Nilai dari 101 sampai 255 akan mengembalikan 100 tugas, dan 0 menggunakan nilai default. Nilai di luar 0 sampai 255 akan mengembalikan 400.

  • Name
    sort_by
    Type
    string
    default -created_at
    Description

    Urutan pengurutan.

    Nilai yang tersedia:

    • -created_at: terbaru lebih dulu
    • +created_at: terlama lebih dulu

Hasil

Sebuah array berisi objek tugas prototype atau objek tugas build, sesuai dengan tahap pada path.


Objek tugas prototipe Fridge Magnet

Tugas prototipe menghasilkan gambar konsep berwarna dari sebuah foto. Untuk mengubah gambar tersebut menjadi model 3D, kirimkan ID tugas ke build endpoint sebagai input_task_id.

Properties

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, selalu creative-lab-fridge-magnet-prototype.

  • Name
    name
    Type
    string
    Description

    name yang Anda kirim saat membuat tugas, atau "" jika Anda tidak mengirimkannya.

  • Name
    status
    Type
    string
    Description

    Status tugas.

    Nilai yang tersedia:

    • PENDING: menunggu dalam antrean
    • IN_PROGRESS: sedang menghasilkan hasil
    • SUCCEEDED: final, dengan hasil
    • FAILED: final, dengan alasan pada task_error
    • CANCELED: final, tanpa hasil
  • Name
    progress
    Type
    integer
    Description

    Persentase pekerjaan yang selesai, dari 0 hingga 100. Nilainya 0 sampai tugas dimulai dan 100 saat berhasil.

  • Name
    created_at
    Type
    timestamp
    Description

    Waktu tugas dibuat, dalam milidetik Unix.

  • Name
    started_at
    Type
    timestamp
    Description

    Waktu sebuah worker memulai tugas, dalam milidetik Unix. null sebelum itu.

  • Name
    finished_at
    Type
    timestamp
    Description

    Waktu tugas mencapai status final, dalam milidetik Unix. null sebelum itu.

  • Name
    expires_at
    Type
    timestamp
    Description

    Waktu hasil tugas kedaluwarsa, dalam milidetik Unix. Nilainya 3 hari setelah finished_at, atau 3 hari setelah created_at sampai tugas selesai. Untuk akun Enterprise, yang menyimpan hasil API tanpa batas waktu, nilainya sekitar 100 tahun kemudian. Lihat Asset retention.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Posisi tugas dalam antrean selama berstatus PENDING. 1 berarti tugas akan dimulai berikutnya. 0 setelah tugas keluar dari antrean, dan selalu 0 pada hasil daftar.

  • Name
    task_error
    Type
    object
    Description

    Alasan tugas gagal. null kecuali status adalah FAILED. Lihat Kesalahan.

  • Name
    consumed_credits
    Type
    integer
    Description

    Jumlah kredit yang dikenakan untuk tugas, setelah pengembalian dana (jika ada). Permintaan yang mengembalikan kesalahan tidak dikenakan biaya. Tugas yang gagal bernilai 0, karena Meshy mengembalikan kreditnya. Membatalkan tugas hanya mengembalikan kredit selama tugas masih PENDING. Jika Meshy tidak dapat membaca biaya yang dikenakan, respons get atau stream akan menghilangkan field ini, dan permintaan daftar akan mengembalikan 500. Dalam kasus ini, coba ulangi permintaan.

  • Name
    image_urls
    Type
    array of strings
    Description

    URL unduhan untuk gambar konsep. Array ini berisi satu URL setelah tugas berhasil, dan kosong sebelum itu.


Objek task build Fridge Magnet

Sebuah build task menghasilkan magnet kulkas 3D dari prototype task yang berhasil (succeeded). Task ini mengembalikan satu file 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 task. Jangan bergantung pada formatnya.

  • Name
    type
    Type
    string
    Description

    Tipe task, selalu creative-lab-fridge-magnet-build.

  • Name
    name
    Type
    string
    Description

    name yang Anda kirim saat membuat task, atau "" jika Anda tidak mengirimkannya.

  • Name
    status
    Type
    string
    Description

    Status task tersebut.

    Nilai yang tersedia:

    • PENDING: menunggu dalam antrean
    • IN_PROGRESS: sedang menghasilkan hasil
    • SUCCEEDED: final, dengan hasil
    • FAILED: final, dengan alasan di task_error
    • CANCELED: final, tanpa hasil
  • Name
    progress
    Type
    integer
    Description

    Persentase pekerjaan yang telah selesai, dari 0 hingga 100. Nilainya 0 sampai task dimulai dan 100 ketika berhasil.

  • Name
    created_at
    Type
    timestamp
    Description

    Waktu task dibuat, dalam milidetik Unix.

  • Name
    started_at
    Type
    timestamp
    Description

    Waktu worker memulai task, dalam milidetik Unix. null sampai saat itu.

  • Name
    finished_at
    Type
    timestamp
    Description

    Waktu task mencapai status final, dalam milidetik Unix. null sampai saat itu.

  • Name
    expires_at
    Type
    timestamp
    Description

    Waktu hasil task kedaluwarsa, dalam milidetik Unix. Nilainya 3 hari setelah finished_at, atau 3 hari setelah created_at sampai task selesai. Untuk akun Enterprise, yang menyimpan hasil API tanpa batas waktu, nilainya sekitar 100 tahun kemudian. Lihat Retensi aset.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Posisi task dalam antrean selagi berstatus PENDING. 1 berarti task akan dimulai berikutnya. 0 setelah task keluar dari antrean, dan selalu 0 dalam hasil daftar (list).

  • Name
    task_error
    Type
    object
    Description

    Alasan kegagalan task. null kecuali status adalah FAILED. Lihat Kesalahan.

  • Name
    consumed_credits
    Type
    integer
    Description

    Jumlah kredit yang dikenakan untuk task tersebut, setelah pengembalian dana (refund) jika ada. Permintaan yang mengembalikan error tidak dikenakan biaya. Task yang gagal bernilai 0, karena Meshy mengembalikan kreditnya. Membatalkan task hanya mengembalikan kredit selagi task berstatus PENDING. Jika Meshy tidak dapat membaca biaya yang dikenakan, respons get atau stream akan menghilangkan field ini, dan permintaan list akan mengembalikan 500. Dalam kasus ini, coba ulangi permintaan tersebut.

  • Name
    model_urls
    Type
    object
    Description

    URL unduhan untuk file model, dengan satu entri untuk output.format yang Anda minta. {} sampai task berhasil.

    • Name
      glb
      Type
      string
      Description

      URL unduhan untuk file GLB. Muncul ketika output.format adalah glb.

    • Name
      obj
      Type
      string
      Description

      URL unduhan untuk file zip berisi model.obj, model.mtl, dan texture.png. Muncul ketika output.format adalah obj.

    • Name
      bundle_zip
      Type
      string
      Description

      URL unduhan untuk file zip berisi semua file yang dihasilkan Meshy. Muncul ketika output.format adalah zip.