Creative Lab — API magnet peti sejuk

Tukar foto anda menjadi magnet peti sejuk tersuai — relief kedalaman berwarna berbentuk segi empat tepat membulat dengan belakang magnetik rata, bersaiz untuk peti sejuk — dalam dua peringkat: prototaip menjana imej konsep berwarna daripada foto input anda, kemudian bina menukar imej konsep itu menjadi model 3D relief. Kedua-dua peringkat dipautkan melalui 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

Cipta Tugas Prototaip magnet peti sejuk

Jana satu imej konsep berwarna daripada foto sumber. ID tugas yang dikembalikan ialah nilai yang anda hantar sebagai input_task_id kepada endpoint binaan. Rujuk Objek Tugas Prototaip magnet peti sejuk untuk bentuk respons.

Parameter

  • Name
    image_url
    Type
    string
    Diperlukan
    Description

    Foto sumber untuk Meshy warnakan menjadi imej konsep yang sedia untuk magnet peti sejuk. Kami kini menyokong format .jpg, .jpeg, .png, dan .webp.

    Terdapat dua cara untuk menyediakan imej:

    • URL yang boleh diakses secara umum: URL yang boleh diakses daripada internet awam.
    • Data URI: Data URI imej yang dikodkan base64. Contoh Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
  • Name
    name
    Type
    string
    Description

    Nama tugas pilihan untuk tujuan paparan. Maksimum 100 aksara.

Pulangan

Sifat result dalam respons mengandungi id tugas bagi tugas prototaip magnet peti sejuk yang baru dicipta. Tinjau endpoint Dapatkan Tugas atau langgan strim sehingga tugas mencapai SUCCEEDED, kemudian hantar ID tersebut kepada endpoint binaan sebagai input_task_id.

Mod Kegagalan

  • Name
    400 - Bad Request
    Description

    Permintaan tidak boleh diterima. Punca biasa:

    • Parameter tiada: image_url diperlukan.
    • Format imej tidak sah: image_url yang diberikan bukan format yang disokong (.jpg, .jpeg, .png, .webp).
    • Dimensi imej di luar julat: Imej terlalu kecil, melebihi saiz fail maksimum, atau melebihi kiraan piksel maksimum.
    • URL tidak boleh dicapai: image_url tidak dapat dimuat turun (404 atau timeout).
    • Data URI tidak sah: Rentetan base64 salah bentuk.
    • Kandungan dibenderakan: Imej input dibenderakan oleh moderation NSFW atau harta intelek.
  • Name
    401 - Unauthorized
    Description

    Pengesahan gagal. Sila semak kunci API anda.

  • Name
    402 - Payment Required
    Description

    Kredit tidak mencukupi untuk melaksanakan tugas ini.

  • Name
    429 - Too Many Requests
    Description

    Anda telah melebihi had kadar anda.

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

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

Cipta Tugas Binaan Magnet Peti Sejuk

Jana magnet peti sejuk akhir yang boleh dicetak 3D daripada tugas prototaip yang berjaya. Binaan menjalankan saluran paip timbulan peta kedalaman pada imej konsep prototaip yang diwarnakan dan menghantar satu artifak jejaring tunggal dalam format yang anda minta. Rujuk kepada Objek Tugas Binaan Magnet Peti Sejuk untuk bentuk respons.

Parameter

  • Name
    input_task_id
    Type
    string
    Diperlukan
    Description

    ID tugas bagi tugas prototaip yang dicipta melalui endpoint OpenAPI yang sama ini. Prototaip mestilah telah dicipta dengan kunci API yang sama, mestilah telah mencapai SUCCEEDED, dan mestilah telah menghasilkan tepat satu imej calon.

    Tugas prototaip yang dicipta melalui aplikasi web tidak diterima — endpoint binaan hanya menerima tugas prototaip yang dihasilkan oleh POST /openapi/creative-lab/fridge-magnet/v1/prototype dan menolak sebarang sumber lain dengan 404.

  • Name
    name
    Type
    string
    Description

    Nama tugas pilihan untuk tujuan paparan. Maksimum 100 aksara.

options

Parameter penalaan pilihan untuk geometri timbulan. Setiap medan mempunyai lalai yang munasabah — hantar hanya yang anda mahu atasi.

  • Name
    badge_shape
    Type
    string
    lalai rounded-rect
    Description

    Siluet garisan luar magnet peti sejuk. Nilai yang tersedia:

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

    Panjang sisi segi empat sama pembatas magnet peti sejuk, dalam milimeter. Julat: (0, 400].

  • Name
    relief_height_mm
    Type
    number
    lalai 3.3
    Description

    Ketinggian timbulan maksimum di atas tapak, dalam milimeter. Julat: [0, 20].

  • Name
    relief_offset_mm
    Type
    number
    lalai 0
    Description

    Ofset menegak yang digunakan pada timbulan sebelum penyemperitan, dalam milimeter. Julat: [0, 20].

  • Name
    base_thickness_mm
    Type
    number
    lalai 2.0
    Description

    Ketebalan plat tapak rata di belakang timbulan, dalam milimeter. Lalai magnet peti sejuk ialah tapak 2 mm yang lebih tebal — memberikan magnet cukup badan untuk mencengkam peti sejuk tanpa membuat timbulan terasa rapuh. Julat: [0, 20].

  • Name
    has_closed_back
    Type
    boolean
    lalai true
    Description

    Sama ada bahagian belakang magnet peti sejuk dimeterai sebagai permukaan tertutup (sisi tempat anda melekatkan magnet). Tetapkan kepada false untuk kelongsong terbuka.

  • Name
    relief_curve
    Type
    string
    lalai linear
    Description

    Lengkung pemindahan yang memetakan nilai peta kedalaman kepada ketinggian timbulan. Nilai yang tersedia:

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

    Parameter bentuk untuk lengkung pemindahan (hanya bermakna apabila relief_curve ialah gamma). Julat: (0, 10].

  • Name
    invert_depth
    Type
    boolean
    lalai false
    Description

    Songsangkan tafsiran peta kedalaman supaya kawasan yang lebih gelap menjadi timbulan yang lebih tinggi.

  • Name
    smoothing
    Type
    number
    lalai 0.24
    Description

    Kekuatan pelicinan yang digunakan pada peta kedalaman sebelum pengekstrakan timbulan. Julat: [0, 10].

  • Name
    relief_scale
    Type
    number
    lalai 1.0
    Description

    Pengganda skala menegak yang digunakan di atas relief_height_mm. Julat: (0, 10].

  • Name
    depth_threshold
    Type
    number
    lalai 0.1
    Description

    Ambang laluan rendah untuk nilai peta kedalaman; apa-apa di bawah ini dikapit kepada sifar. Julat: [0, 1].

  • Name
    remove_background
    Type
    boolean
    lalai true
    Description

    Alih keluar latar belakang imej konsep prototaip secara automatik sebelum membuat timbulan.

  • Name
    export_resolution
    Type
    integer
    lalai 512
    Description

    Resolusi jejaring yang digunakan untuk eksport. Julat: [64, 2048].

output

Pemilih format penghantaran pilihan. Lalai kepada glb.

  • Name
    format
    Type
    string
    lalai glb
    Description

    Berkas artifak yang dikembalikan oleh binaan. Nilai yang tersedia:

    • glb (lalai) — mengembalikan satu model.glb di bawah model_urls.glb.
    • obj — memampatkan model.obj + model.mtl + texture.png dan mengembalikan berkas di bawah model_urls.obj.
    • zip — memampatkan setiap artifak yang dipancarkan oleh penjana dan mengembalikan berkas di bawah model_urls.bundle_zip.

Mengembalikan

Sifat result bagi respons mengandungi id tugas bagi tugas binaan magnet peti sejuk yang baru dicipta. Tinjau endpoint Dapatkan Tugas atau langgan strim sehingga tugas mencapai SUCCEEDED, kemudian muat turun artifak daripada entri tunggal dalam model_urls.

Mode Kegagalan

  • Name
    400 - Bad Request
    Description

    Permintaan tidak boleh diterima. Punca lazim:

    • Parameter tiada: input_task_id diperlukan.
    • UUID tidak sah: input_task_id bukan UUID yang sah.
    • Induk belum berjaya: Tugas prototaip yang dirujuk belum mencapai SUCCEEDED lagi.
    • Tiada calon: Tugas prototaip berjaya tetapi tidak menghasilkan imej calon.
    • Pilihan di luar julat: Salah satu medan options berada di luar julat yang dibenarkan atau set enum.
  • Name
    401 - Unauthorized
    Description

    Pengesahan gagal. Sila semak kunci API anda.

  • Name
    402 - Payment Required
    Description

    Kredit tidak mencukupi untuk melaksanakan tugas ini.

  • Name
    404 - Not Found
    Description

    Tugas prototaip yang dirujuk tidak wujud, milik pengguna lain, atau telah dicipta melalui aplikasi web (hanya tugas prototaip mode API boleh dirantaikan ke binaan).

  • Name
    429 - Too Many Requests
    Description

    Anda telah melebihi had kadar anda.

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

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

Dapatkan Semula Tugas magnet peti sejuk

Dapatkan semula tugas prototaip atau binaan dengan id tugas yang sah. Laluan URL mesti sepadan dengan peringkat tugas — tugas binaan yang diambil melalui /prototype/:id mengembalikan 404, dan sebaliknya.

Rujuk Objek Tugas Prototaip magnet peti sejuk dan Objek Tugas Binaan magnet peti sejuk untuk bentuk respons.

Parameter

  • Name
    id
    Type
    path
    Description

    Pengecam unik untuk tugas magnet peti sejuk yang ingin didapatkan semula.

Pulangan

Respons mengandungi objek tugas magnet peti sejuk. Bentuknya bergantung pada peringkat yang diminta.

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

Padamkan Tugas magnet peti sejuk

Batalkan tugas magnet peti sejuk. Jika tugas masih PENDING, kredit yang digunakan pada masa penciptaan akan dikembalikan. Tugas yang sudah IN_PROGRESS dibatalkan tanpa bayaran balik (pekerja mungkin sudah menggunakan sumber). Tugas yang sudah mencapai keadaan terminal (SUCCEEDED, FAILED, CANCELED) tidak boleh dibatalkan.

Laluan URL mesti sepadan dengan peringkat tugas — DELETE pada /prototype/:buildId mengembalikan 404.

Parameter Laluan

  • Name
    id
    Type
    path
    Description

    Pengecam unik untuk tugas magnet peti sejuk yang hendak dibatalkan.

Pulangan

Mengembalikan 204 No Content apabila berjaya dengan badan kosong.

Mod Kegagalan

  • Name
    400 - Bad Request
    Description

    Tugas sudah berada dalam keadaan terminal dan tidak boleh dibatalkan.

  • Name
    404 - Not Found
    Description

    Tugas tidak wujud, milik pengguna lain, atau peringkatnya tidak sepadan dengan laluan URL.

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

Strim Tugas magnet peti sejuk

Strim kemas kini masa nyata untuk tugas magnet peti sejuk melalui Server-Sent Events (SSE). Laluan URL mesti sepadan dengan peringkat tugas — membuka strim di /prototype/:buildId/stream memancarkan satu event: error payload dengan status_code: 404 dan menutup strim.

Parameter

  • Name
    id
    Type
    path
    Description

    Pengecam unik untuk tugas magnet peti sejuk yang akan distrim.

Pulangan

Mengembalikan strim objek tugas Prototaip magnet peti sejuk atau Binaan magnet peti sejuk sebagai Server-Sent Events. Untuk tugas PENDING atau IN_PROGRESS, strim respons hanya akan menyertakan medan progress dan status yang diperlukan.

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)

Senaraikan Tugas magnet peti sejuk

Dapatkan senarai tugas magnet peti sejuk anda dengan penomboran halaman untuk satu peringkat. Laluan URL memilih peringkat — /prototype mengembalikan tugas prototaip; /build mengembalikan tugas binaan. Tugas daripada peringkat lain tidak disertakan dalam mana-mana respons.

Parameter Laluan

  • Name
    stage
    Type
    path
    Diperlukan
    Description

    Sama ada prototype atau build. Koleksi hanya mengembalikan tugas yang peringkatnya sepadan dengan URL — mengambil /prototype tidak akan mengembalikan tugas binaan dan begitu juga sebaliknya.

Parameter Pertanyaan

  • Name
    page_num
    Type
    integer
    lalai 1
    Description

    Nombor halaman untuk penomboran halaman.

  • Name
    page_size
    Type
    integer
    lalai 10
    Description

    Had saiz halaman. Maksimum yang dibenarkan ialah 50 item.

  • Name
    sort_by
    Type
    string
    lalai -created_at
    Description

    Medan untuk diisih mengikutnya. Nilai yang tersedia:

    • +created_at: Isih mengikut masa penciptaan dalam tertib menaik.
    • -created_at: Isih mengikut masa penciptaan dalam tertib menurun.

Pulangan

Mengembalikan senarai dengan penomboran halaman bagi objek tugas mengikut peringkat — sama ada objek tugas prototaip magnet peti sejuk apabila menyenaraikan /prototype atau objek tugas binaan magnet peti sejuk apabila menyenaraikan /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=***"
    ]
  }
]

Objek Tugas Prototaip magnet peti sejuk

Objek Tugas Prototaip magnet peti sejuk ialah unit kerja yang dijejaki oleh Meshy untuk menjana imej konsep berwarna daripada foto sumber. Output daripada peringkat ini dirangkaikan ke dalam peringkat binaan melalui input_task_id.

Sifat

  • Name
    id
    Type
    string
    Description

    Pengecam unik untuk tugasan. Walaupun kami menggunakan UUID k-sortable untuk id tugasan sebagai butiran pelaksanaan, anda tidak seharusnya membuat sebarang andaian tentang format id tersebut.

  • Name
    type
    Type
    string
    Description

    Jenis tugasan. Nilainya ialah creative-lab-fridge-magnet-prototype.

  • Name
    name
    Type
    string
    Description

    Nama tugasan yang diberikan apabila tugasan dicipta. Rentetan kosong jika tiada nama diberikan.

  • Name
    status
    Type
    string
    Description

    Status tugasan. Nilai yang mungkin ialah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    progress
    Type
    integer
    Description

    Progress tugasan. Jika tugasan belum dimulakan lagi, sifat ini akan menjadi 0. Setelah tugasan berjaya, ini akan menjadi 100.

  • Name
    created_at
    Type
    timestamp
    Description

    Cap masa apabila tugasan dicipta, dalam milisaat.

  • Name
    started_at
    Type
    timestamp
    Description

    Cap masa apabila tugasan dimulakan, dalam milisaat. Jika tugasan belum dimulakan lagi, sifat ini akan menjadi 0.

  • Name
    finished_at
    Type
    timestamp
    Description

    Cap masa apabila tugasan selesai, dalam milisaat. Jika tugasan belum selesai lagi, sifat ini akan menjadi 0.

  • Name
    expires_at
    Type
    timestamp
    Description

    Cap masa apabila hasil tugasan tamat tempoh, dalam milisaat.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Kiraan tugasan terdahulu.

  • Name
    task_error
    Type
    object
    Description

    Butiran ralat untuk tugasan yang gagal. Lihat Ralat untuk rujukan objek task_error penuh.

  • Name
    consumed_credits
    Type
    integer
    Description

    Bilangan kredit yang digunakan oleh tugasan ini. Hadir apabila status tugasan ialah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugasan FAILED (kredit dibayar balik apabila gagal).

  • Name
    image_urls
    Type
    array of strings
    Description

    URL yang boleh dimuat turun untuk calon imej konsep yang dijana oleh tugasan prototaip ini. Pada masa ini API sentiasa mengembalikan tepat satu calon; medan ini ialah tatasusunan supaya semakan masa hadapan boleh memaparkan berbilang calon tanpa perubahan yang memecahkan keserasian.

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

Objek Tugas Binaan magnet peti sejuk

Objek Tugas Binaan magnet peti sejuk ialah unit kerja yang Meshy jejaki untuk menjana jejaring magnet peti sejuk 3D akhir daripada tugas prototaip yang berjaya. Binaan menjalankan saluran paip relief peta kedalaman pada imej konsep prototaip dan menerbitkan satu artifak jejaring dalam format yang diminta oleh pemanggil.

Sifat

  • Name
    id
    Type
    string
    Description

    Pengecam unik untuk tugasan.

  • Name
    type
    Type
    string
    Description

    Jenis tugasan. Nilainya ialah creative-lab-fridge-magnet-build.

  • Name
    name
    Type
    string
    Description

    Nama tugasan yang diberikan semasa tugasan dicipta. Rentetan kosong jika tiada nama diberikan.

  • Name
    status
    Type
    string
    Description

    Status tugasan. Nilai yang mungkin ialah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    progress
    Type
    integer
    Description

    Progress tugasan. Jika tugasan belum dimulakan lagi, sifat ini akan menjadi 0. Setelah tugasan berjaya, nilai ini akan menjadi 100.

  • Name
    created_at
    Type
    timestamp
    Description

    Cap masa apabila tugasan dicipta, dalam milisaat.

  • Name
    started_at
    Type
    timestamp
    Description

    Cap masa apabila tugasan dimulakan, dalam milisaat.

  • Name
    finished_at
    Type
    timestamp
    Description

    Cap masa apabila tugasan diselesaikan, dalam milisaat.

  • Name
    expires_at
    Type
    timestamp
    Description

    Cap masa apabila hasil tugasan tamat tempoh, dalam milisaat.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Bilangan tugasan terdahulu. Hanya bermakna apabila status ialah PENDING.

  • Name
    task_error
    Type
    object
    Description

    Butiran ralat untuk tugasan yang gagal. Lihat Ralat untuk rujukan penuh objek task_error.

  • Name
    consumed_credits
    Type
    integer
    Description

    Bilangan kredit yang digunakan oleh tugasan ini. Mengembalikan 0 untuk tugasan FAILED (kredit dibayar balik apabila gagal).

  • Name
    model_urls
    Type
    object
    Description

    URL yang boleh dimuat turun untuk artifak yang dijana, dikunci mengikut nama artifak. Sentiasa mengandungi tepat satu entri — format yang diminta melalui output.format permintaan binaan. Kunci sepadan dengan format yang diminta:

    • Name
      glb
      Type
      string
      Description

      URL yang boleh dimuat turun ke fail GLB. Hadir apabila output.format ialah glb (lalai).

    • Name
      obj
      Type
      string
      Description

      URL yang boleh dimuat turun ke berkas zip yang mengandungi model.obj, model.mtl, dan texture.png. Hadir apabila output.format ialah obj.

    • Name
      bundle_zip
      Type
      string
      Description

      URL yang boleh dimuat turun ke berkas zip bagi setiap artifak yang dikeluarkan oleh penjana. Hadir apabila output.format ialah 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=***"
  }
}