Creative Lab — API Gantungan Kunci

Ubah foto sumber menjadi medali gantungan kunci yang dapat dicetak dalam 3D — relief kedalaman berwarna berbentuk lencana — dalam dua tahap: prototipe menghasilkan gambar konsep berwarna dari foto input Anda, kemudian pembangunan mengubah gambar konsep tersebut menjadi model 3D relief. Kedua tahap ini dihubungkan melalui input_task_id.

  • POST /openapi/creative-lab/keychain/v1/prototype
  • POST /openapi/creative-lab/keychain/v1/build
POST/openapi/creative-lab/keychain/v1/prototype

Buat Tugas Prototipe Gantungan Kunci

Hasilkan gambar konsep berwarna tunggal dari foto sumber. ID tugas yang dikembalikan adalah yang Anda berikan sebagai input_task_id ke endpoint build. Lihat Objek Tugas Prototipe Gantungan Kunci untuk bentuk respons.

Parameter

  • Name
    image_url
    Type
    string
    Wajib
    Description

    Foto sumber untuk Meshy untuk diwarnai menjadi gambar konsep siap gantungan kunci. Kami saat ini mendukung format .jpg, .jpeg, .png, dan .webp.

    Ada dua cara untuk menyediakan gambar:

    • URL yang dapat diakses publik: URL yang dapat diakses dari internet publik.
    • Data URI: Data URI yang dikodekan base64 dari gambar. Contoh Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
  • Name
    name
    Type
    string
    Description

    Nama tugas opsional untuk tujuan tampilan. Maksimum 100 karakter.

  • Name
    remove_background
    Type
    boolean
    default false
    Description

    Ketika diatur ke true, gambar prototipe dikembalikan sebagai PNG RGBA transparan dengan latar belakang dihapus, sehingga Anda dapat menggabungkan subjek ke latar belakang mana pun.

    Ini hanya mengontrol gambar yang dikembalikan oleh endpoint ini. Ini terpisah dari opsi build dengan nama yang sama (default true), yang mengontrol penghapusan latar belakang sebelum reliefing.

Mengembalikan

Properti result dari respons berisi id tugas dari tugas prototipe gantungan kunci yang baru dibuat. Polling endpoint Dapatkan Tugas atau berlangganan stream sampai tugas mencapai SUCCEEDED, kemudian berikan ID tersebut ke endpoint build sebagai input_task_id.

Mode Kegagalan

  • Name
    400 - Bad Request
    Description

    Permintaan tidak dapat diterima. Penyebab umum:

    • Parameter hilang: image_url diperlukan.
    • Format gambar tidak valid: image_url yang diberikan bukan format yang didukung (.jpg, .jpeg, .png, .webp).
    • Dimensi gambar di luar jangkauan: Gambar terlalu kecil, melebihi ukuran file maksimum, atau melebihi jumlah piksel maksimum.
    • URL tidak dapat dijangkau: image_url tidak dapat diunduh (404 atau timeout).
    • Data URI tidak valid: String base64 rusak.
    • Konten ditandai: Gambar input ditandai oleh moderasi NSFW atau properti intelektual.
  • Name
    401 - Unauthorized
    Description

    Autentikasi gagal. Silakan periksa kunci API Anda.

  • Name
    402 - Payment Required
    Description

    Kredit tidak mencukupi untuk melakukan tugas ini.

  • Name
    429 - Too Many Requests
    Description

    Anda telah melebihi batas laju Anda.

Permintaan

POST
/openapi/creative-lab/keychain/v1/prototype
# Stage 1: generate a colorized keychain concept image
curl https://api.meshy.ai/openapi/creative-lab/keychain/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>"
  }'

Respons

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
Contoh prototipe
Mulailah dengan foto sumber, kemudian hasilkan gambar prototipe yang digunakan oleh tahap build gantungan kunci.
Foto sumber yang digunakan sebagai input Creative Lab Gantungan Kunci
Input prototipe
Output prototipe Creative Lab Gantungan Kunci yang dihasilkan dari foto sumber
Output prototipe
POST/openapi/creative-lab/keychain/v1/build

Membuat Tugas Pembangunan Gantungan Kunci

Menghasilkan medali gantungan kunci 3D yang dapat dicetak dari tugas prototipe yang berhasil. Pembangunan menjalankan pipeline relief peta kedalaman pada gambar konsep berwarna dari prototipe dan mengirimkan satu artefak mesh dalam format yang Anda minta. Lihat Objek Tugas Pembangunan Gantungan Kunci untuk bentuk respons.

Parameter

  • Name
    input_task_id
    Type
    string
    Wajib
    Description

    ID tugas dari tugas prototipe yang dibuat melalui endpoint OpenAPI ini. Prototipe harus dibuat dengan kunci API yang sama, harus mencapai SUCCEEDED, dan harus menghasilkan tepat satu gambar kandidat.

    Tugas prototipe yang dibuat melalui webapp tidak diterima — endpoint pembangunan hanya menerima tugas prototipe yang dihasilkan oleh POST /openapi/creative-lab/keychain/v1/prototype dan menolak sumber lain dengan 404.

  • Name
    name
    Type
    string
    Description

    Nama tugas opsional untuk tujuan tampilan. Maksimum 100 karakter.

options

Parameter penyetelan opsional untuk geometri relief. Setiap bidang memiliki nilai default yang masuk akal — kirim hanya yang ingin Anda ganti.

  • Name
    badge_shape
    Type
    string
    default circle
    Description

    Siluet garis luar dari medali gantungan kunci. Nilai yang tersedia:

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

    Panjang sisi persegi pembatas dari gantungan kunci, dalam milimeter. Rentang: (0, 400].

  • Name
    relief_height_mm
    Type
    number
    default 2.2
    Description

    Tinggi relief maksimum di atas dasar, dalam milimeter. Rentang: [0, 20].

  • Name
    relief_offset_mm
    Type
    number
    default 0
    Description

    Offset vertikal yang diterapkan pada relief sebelum ekstrusi, dalam milimeter. Rentang: [0, 20].

  • Name
    base_thickness_mm
    Type
    number
    default 0.1
    Description

    Ketebalan pelat dasar datar di belakang relief, dalam milimeter. Rentang: [0, 20].

  • Name
    has_closed_back
    Type
    boolean
    default true
    Description

    Apakah bagian belakang medali tertutup sebagai permukaan tertutup. Atur ke false untuk cangkang terbuka.

  • Name
    relief_curve
    Type
    string
    default linear
    Description

    Kurva transfer yang memetakan nilai peta kedalaman ke tinggi relief. Nilai yang tersedia:

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

    Parameter bentuk untuk kurva transfer (hanya berarti ketika relief_curve adalah gamma). Rentang: (0, 10].

  • Name
    invert_depth
    Type
    boolean
    default false
    Description

    Membalikkan interpretasi peta kedalaman sehingga daerah yang lebih gelap menjadi relief yang lebih tinggi.

  • Name
    smoothing
    Type
    number
    default 0.24
    Description

    Kekuatan penghalusan yang diterapkan pada peta kedalaman sebelum ekstraksi relief. Rentang: [0, 10].

  • Name
    relief_scale
    Type
    number
    default 1.0
    Description

    Pengganda skala vertikal yang diterapkan di atas relief_height_mm. Rentang: (0, 10].

  • Name
    depth_threshold
    Type
    number
    default 0.1
    Description

    Ambang batas low-pass untuk nilai peta kedalaman; apa pun di bawah ini dijepit ke nol. Rentang: [0, 1].

  • Name
    remove_background
    Type
    boolean
    default true
    Description

    Secara otomatis menghapus latar belakang dari gambar konsep prototipe sebelum membuat relief.

    Terpisah dari parameter prototipe dengan nama yang sama (default false), yang mengontrol apakah gambar prototipe itu sendiri dikembalikan dengan transparansi.

  • Name
    export_resolution
    Type
    integer
    default 512
    Description

    Resolusi mesh yang digunakan untuk ekspor. Rentang: [64, 2048].

output

Pemilih format kabel opsional. Default ke glb.

  • Name
    format
    Type
    string
    default glb
    Description

    Bundel artefak yang dikembalikan oleh pembangunan. Nilai yang tersedia:

    • glb (default) — mengembalikan satu model.glb di bawah model_urls.glb.
    • obj — mengompres model.obj + model.mtl + texture.png dan mengembalikan bundel di bawah model_urls.obj.
    • zip — mengompres setiap artefak yang dihasilkan generator dan mengembalikan bundel di bawah model_urls.bundle_zip.

Mengembalikan

Properti result dari respons berisi id tugas dari tugas pembangunan gantungan kunci yang baru dibuat. Polling endpoint Dapatkan Tugas atau berlangganan stream sampai tugas mencapai SUCCEEDED, kemudian unduh artefak dari satu entri di model_urls.

Mode Kegagalan

  • Name
    400 - Bad Request
    Description

    Permintaan tidak dapat diterima. Penyebab umum:

    • Parameter hilang: input_task_id diperlukan.
    • UUID tidak valid: input_task_id bukan UUID yang valid.
    • Induk tidak berhasil: Tugas prototipe yang dirujuk belum mencapai SUCCEEDED.
    • Tidak ada kandidat: Tugas prototipe berhasil tetapi tidak menghasilkan gambar kandidat.
    • Opsi di luar jangkauan: Salah satu bidang options berada di luar jangkauan atau set enum yang diizinkan.
  • Name
    401 - Unauthorized
    Description

    Autentikasi gagal. Silakan periksa kunci API Anda.

  • Name
    402 - Payment Required
    Description

    Kredit tidak mencukupi untuk melakukan tugas ini.

  • Name
    404 - Not Found
    Description

    Tugas prototipe yang dirujuk tidak ada, milik pengguna lain, atau dibuat melalui webapp (hanya tugas prototipe mode API yang dapat dirantai ke pembangunan).

  • Name
    429 - Too Many Requests
    Description

    Anda telah melebihi batas laju Anda.

Permintaan

POST
/openapi/creative-lab/keychain/v1/build
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "options": {
      "badge_shape": "circle",
      "size_mm": 40,
      "relief_height_mm": 2.5
    },
    "output": {
      "format": "glb"
    }
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}
Contoh Pembangunan
Tugas pembangunan mengubah gambar prototipe yang dipilih menjadi model gantungan kunci yang dapat dicetak 3D.
Pratinjau model pembangunan Creative Lab Keychain
Pratinjau model pembangunan
GET/openapi/creative-lab/keychain/v1/(prototype|build)/:id

Mengambil Tugas Gantungan Kunci

Ambil tugas prototipe atau build yang diberikan id tugas yang valid. Jalur URL harus sesuai dengan tahap tugas — tugas build yang diambil melalui /prototype/:id akan mengembalikan 404, dan sebaliknya.

Lihat Objek Tugas Prototipe Gantungan Kunci dan Objek Tugas Build Gantungan Kunci untuk bentuk respons.

Parameter

  • Name
    id
    Type
    path
    Description

    Pengenal unik untuk tugas gantungan kunci yang akan diambil.

Mengembalikan

Respons berisi objek tugas gantungan kunci. Bentuknya tergantung pada tahap mana yang diminta.

Permintaan

GET
/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578
# Prototype
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Respons Prototipe

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-keychain-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Respons Build

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-keychain-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}
DELETE/openapi/creative-lab/keychain/v1/(prototype|build)/:id

Menghapus Tugas Gantungan Kunci

Batalkan tugas gantungan kunci. Jika tugas masih PENDING, kredit yang digunakan saat pembuatan akan dikembalikan. Tugas yang sudah IN_PROGRESS dibatalkan tanpa pengembalian (pekerja mungkin sudah menggunakan sumber daya). Tugas yang sudah mencapai status akhir (SUCCEEDED, FAILED, CANCELED) tidak dapat dibatalkan.

Jalur URL harus sesuai dengan tahap tugas — DELETE pada /prototype/:buildId mengembalikan 404.

Parameter Jalur

  • Name
    id
    Type
    path
    Description

    Pengenal unik untuk tugas gantungan kunci yang akan dibatalkan.

Mengembalikan

Mengembalikan 204 No Content pada keberhasilan dengan tubuh kosong.

Mode Kegagalan

  • Name
    400 - Bad Request
    Description

    Tugas sudah dalam status akhir dan tidak dapat dibatalkan.

  • Name
    404 - Not Found
    Description

    Tugas tidak ada, milik pengguna lain, atau tahapannya tidak sesuai dengan jalur URL.

Permintaan

DELETE
/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578
curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Respon

// Returns 204 No Content on success (empty body).
GET/openapi/creative-lab/keychain/v1/(prototype|build)/:id/stream

Streaming Tugas Gantungan Kunci

Streaming pembaruan real-time untuk tugas gantungan kunci melalui Server-Sent Events (SSE). Jalur URL harus sesuai dengan tahap tugas — membuka stream di /prototype/:buildId/stream akan mengeluarkan satu event: error payload dengan status_code: 404 dan menutup stream.

Parameter

  • Name
    id
    Type
    path
    Description

    Pengenal unik untuk tugas gantungan kunci yang akan di-stream.

Mengembalikan

Mengembalikan stream dari objek tugas Prototype Gantungan Kunci atau Build Gantungan Kunci sebagai Server-Sent Events. Untuk tugas PENDING atau IN_PROGRESS, stream respons hanya akan menyertakan bidang progress dan status yang diperlukan.

Permintaan

GET
/openapi/creative-lab/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream
curl -N https://api.meshy.ai/openapi/creative-lab/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/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": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-keychain-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}
GET/openapi/creative-lab/keychain/v1/(prototype|build)

Daftar Tugas Gantungan Kunci

Ambil daftar paginasi dari tugas gantungan kunci Anda untuk satu tahap. Jalur URL memilih tahap — /prototype mengembalikan tugas prototipe; /build mengembalikan tugas build. Tugas dari tahap lain tidak termasuk dalam kedua respons.

Parameter Jalur

  • Name
    stage
    Type
    path
    Wajib
    Description

    Baik prototype atau build. Koleksi hanya mengembalikan tugas yang tahapnya sesuai dengan URL — mengambil /prototype tidak pernah mengembalikan tugas build dan sebaliknya.

Parameter Kuery

  • Name
    page_num
    Type
    integer
    default 1
    Description

    Nomor halaman untuk paginasi.

  • Name
    page_size
    Type
    integer
    default 10
    Description

    Batas ukuran halaman. Maksimum yang diizinkan adalah 50 item.

  • Name
    sort_by
    Type
    string
    default -created_at
    Description

    Bidang untuk diurutkan. Nilai yang tersedia:

    • +created_at: Urutkan berdasarkan waktu pembuatan dalam urutan naik.
    • -created_at: Urutkan berdasarkan waktu pembuatan dalam urutan turun.

Mengembalikan

Mengembalikan daftar paginasi dari objek tugas per-tahap — baik objek tugas prototipe gantungan kunci saat mendaftar /prototype atau objek tugas build gantungan kunci saat mendaftar /build.

Permintaan

GET
/openapi/creative-lab/keychain/v1/prototype
# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/build?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Respons (Daftar Tugas Prototipe)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-keychain-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729123456000,
    "started_at": 1729123460000,
    "finished_at": 1729123486000,
    "expires_at": 1729382686000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "image_urls": [
      "https://assets.meshy.ai/***/concept.png?Expires=***"
    ]
  }
]

Objek Tugas Prototipe Gantungan Kunci

Objek Tugas Prototipe Gantungan Kunci adalah unit kerja yang dilacak oleh Meshy untuk menghasilkan gambar konsep berwarna dari foto sumber. Hasil dari tahap ini dirantai ke tahap pembangunan melalui input_task_id.

Properti

  • Name
    id
    Type
    string
    Description

    Pengenal unik untuk tugas. Meskipun kami menggunakan UUID yang dapat diurutkan secara k untuk id tugas sebagai detail implementasi, Anda tidak boleh membuat asumsi apapun tentang format id.

  • Name
    type
    Type
    string
    Description

    Jenis tugas. Nilainya adalah creative-lab-keychain-prototype.

  • Name
    name
    Type
    string
    Description

    Nama tugas yang diberikan saat tugas dibuat. String kosong jika tidak ada nama yang diberikan.

  • Name
    status
    Type
    string
    Description

    Status tugas. Nilai yang mungkin adalah salah satu dari PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    progress
    Type
    integer
    Description

    Progress dari tugas. Jika tugas belum dimulai, properti ini akan menjadi 0. Setelah tugas berhasil, ini akan menjadi 100.

  • Name
    created_at
    Type
    timestamp
    Description

    Stempel waktu saat tugas dibuat, dalam milidetik.

    Stempel waktu mewakili jumlah milidetik yang berlalu sejak 1 Januari 1970 UTC, mengikuti standar RFC 3339. Misalnya, Jumat, 1 September 2023 12:00:00 PM GMT diwakili sebagai 1693569600000. Ini berlaku untuk semua stempel waktu dalam Meshy API.

  • Name
    started_at
    Type
    timestamp
    Description

    Stempel waktu saat tugas dimulai, dalam milidetik. Jika tugas belum dimulai, properti ini akan menjadi 0.

  • Name
    finished_at
    Type
    timestamp
    Description

    Stempel waktu saat tugas selesai, dalam milidetik. Jika tugas belum selesai, properti ini akan menjadi 0.

  • Name
    expires_at
    Type
    timestamp
    Description

    Stempel waktu saat hasil tugas kedaluwarsa, dalam milidetik.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Jumlah tugas sebelumnya.

    Nilai dari bidang ini hanya berarti jika status tugas adalah PENDING.

  • Name
    task_error
    Type
    object
    Description

    Detail kesalahan untuk tugas yang gagal. Lihat Kesalahan untuk referensi lengkap objek task_error.

  • Name
    consumed_credits
    Type
    integer
    Description

    Jumlah kredit yang dikonsumsi oleh tugas ini. Ada ketika status tugas adalah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugas FAILED (kredit dikembalikan jika gagal).

  • Name
    image_urls
    Type
    array of strings
    Description

    URL yang dapat diunduh untuk kandidat gambar konsep yang dihasilkan oleh tugas prototipe ini. Saat ini API selalu mengembalikan tepat satu kandidat; bidang ini adalah array sehingga revisi di masa depan dapat menampilkan beberapa kandidat tanpa perubahan yang merusak.

Contoh Objek Tugas Prototipe Gantungan Kunci

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-keychain-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Objek Tugas Pembangunan Gantungan Kunci

Objek Tugas Pembangunan Gantungan Kunci adalah unit kerja yang dilacak oleh Meshy untuk menghasilkan mesh gantungan kunci 3D akhir dari tugas prototipe yang berhasil. Pembangunan ini menjalankan pipeline relief peta kedalaman pada gambar konsep prototipe dan menerbitkan satu artefak mesh dalam format yang diminta oleh pemanggil.

Properti

  • Name
    id
    Type
    string
    Description

    Pengenal unik untuk tugas tersebut.

  • Name
    type
    Type
    string
    Description

    Jenis tugas. Nilainya adalah creative-lab-keychain-build.

  • Name
    name
    Type
    string
    Description

    Nama tugas yang diberikan saat tugas dibuat. String kosong jika tidak ada nama yang diberikan.

  • Name
    status
    Type
    string
    Description

    Status dari tugas. Nilai yang mungkin adalah salah satu dari PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    progress
    Type
    integer
    Description

    Progress dari tugas. Jika tugas belum dimulai, properti ini akan bernilai 0. Setelah tugas berhasil, ini akan menjadi 100.

  • Name
    created_at
    Type
    timestamp
    Description

    Stempel waktu saat tugas dibuat, dalam milidetik.

  • Name
    started_at
    Type
    timestamp
    Description

    Stempel waktu saat tugas dimulai, dalam milidetik.

  • Name
    finished_at
    Type
    timestamp
    Description

    Stempel waktu saat tugas selesai, dalam milidetik.

  • Name
    expires_at
    Type
    timestamp
    Description

    Stempel waktu saat hasil tugas kedaluwarsa, dalam milidetik.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Jumlah tugas sebelumnya. Bermakna hanya ketika status adalah PENDING.

  • Name
    task_error
    Type
    object
    Description

    Detail kesalahan untuk tugas yang gagal. Lihat Kesalahan untuk referensi lengkap objek task_error.

  • Name
    consumed_credits
    Type
    integer
    Description

    Jumlah kredit yang dikonsumsi oleh tugas ini. Mengembalikan 0 untuk tugas FAILED (kredit dikembalikan pada kegagalan).

  • Name
    model_urls
    Type
    object
    Description

    URL yang dapat diunduh untuk artefak yang dihasilkan, diindeks berdasarkan nama artefak. Selalu berisi tepat satu entri — format yang diminta melalui permintaan pembangunan output.format. Kunci sesuai dengan format yang diminta:

    • Name
      glb
      Type
      string
      Description

      URL yang dapat diunduh ke file GLB. Ada ketika output.format adalah glb (default).

    • Name
      obj
      Type
      string
      Description

      URL yang dapat diunduh ke bundel zip yang berisi model.obj, model.mtl, dan texture.png. Ada ketika output.format adalah obj.

    • Name
      bundle_zip
      Type
      string
      Description

      URL yang dapat diunduh ke bundel zip dari setiap artefak yang dihasilkan oleh generator. Ada ketika output.format adalah zip.

Contoh Objek Tugas Pembangunan Gantungan Kunci

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-keychain-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}