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

API Figur Vinil Creative Lab

Ubah sebuah foto menjadi figur koleksi vinil 3D berkepala besar dalam dua tahap. Tugas prototipe menghasilkan sebuah gambar konsep dari foto tersebut. Tugas build mengubah gambar tersebut menjadi model 3D bertekstur, dan menggunakan ID tugas prototipe sebagai input_task_id.

  • POST /openapi/creative-lab/vinyl-figure/v1/prototype
  • POST /openapi/creative-lab/vinyl-figure/v1/build

POST/openapi/creative-lab/vinyl-figure/v1/prototype

Buat tugas prototipe Vinyl Figure

Menghasilkan satu gambar konsep bergaya vinyl figure dari sebuah foto. Untuk membangun model 3D, kirimkan ID tugas ini ke endpoint build sebagai input_task_id. Untuk field tugas ini, lihat Objek tugas prototipe Vinyl Figure.

Request

POST
/openapi/creative-lab/vinyl-figure/v1/prototype
# Stage 1: generate a vinyl-figure-style concept image
curl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/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": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de"
}
Contoh prototipe
Mulai dengan foto sumber, lalu hasilkan gambar prototipe yang digunakan oleh tahap build.
Source photo used as the Creative Lab Vinyl Figure input
Prototype input
Big-head vinyl figure prototype image generated from the source photo
Prototype output

Parameter

  • Name
    image_url
    Type
    string
    Wajib
    Description

    Foto yang akan diubah menjadi vinyl figure berkepala besar, 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 tugas, hingga 100 karakter. Nama ini dikembalikan pada field name tugas. 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, sehingga Anda dapat menempatkan subjek 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 tugas tetap berhasil.

Hasil

Field result berisi ID dari tugas prototipe baru. Ambil tugas atau streaming tugas tersebut hingga status bernilai SUCCEEDED. Kemudian kirimkan ID tersebut ke endpoint build sebagai input_task_id.

Mode kegagalan

  • Name
    400 - Bad Request
    Description

    Permintaan tidak dapat dijalankan. Misalnya:

    • image_url hilang.
    • Gambar bukan file JPG, JPEG, PNG, atau WebP.
    • Gambar terlalu kecil, lebih dari 20 MB, atau melebihi jumlah piksel maksimum.
    • Meshy tidak dapat mengunduh gambar, misalnya karena URL mengembalikan 404 atau waktu habis (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 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
    403 - Forbidden
    Description

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

  • 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 tugas 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 tugas yang dapat berjalan tanpa kredit. Tunggu hingga sebuah tugas selesai, atau tambahkan kredit.
  • Name
    500 - Internal Server Error
    Description

    Meshy mengalami kesalahan server, misalnya karena tidak dapat menjalankan pemeriksaan kekayaan intelektual pada gambar. Meshy tidak membuat tugas tersebut, dan mengembalikan kredit apa pun yang telah dibebankan. Coba kirim ulang permintaan.


POST/openapi/creative-lab/vinyl-figure/v1/build

Membuat Vinyl Figure build task

Menghasilkan vinyl figure 3D bertekstur dari prototype task yang berhasil. Untuk kolomnya, lihat The Vinyl Figure build task object.

Request

POST
/openapi/creative-lab/vinyl-figure/v1/build
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de"
  }'

Response

{
  "result": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef"
}

Parameter

  • Name
    input_task_id
    Type
    string
    Wajib
    Description

    ID dari prototype task yang akan dibuild. ID ini harus berupa task yang dibuat oleh akun Anda dengan POST /openapi/creative-lab/vinyl-figure/v1/prototype, dengan status SUCCEEDED.

    ID yang bukan merupakan salah satu prototype task Vinyl Figure 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.

Hasil

Kolom result berisi ID dari build task baru. Ambil task atau streaming task tersebut hingga status menjadi SUCCEEDED. Kemudian unduh GLB bertekstur dari model_urls.glb. Untuk OBJ, unduh model_urls.obj beserta file material-nya dari model_urls.mtl.

Mode kegagalan

  • Name
    400 - Bad Request
    Description

    Permintaan tidak dapat dijalankan. Misalnya:

    • input_task_id tidak ada atau bukan ID task yang valid.
    • Status prototype task bukan SUCCEEDED. Jika masih berjalan, tunggu dan coba lagi. Jika gagal atau dibatalkan, buat prototype task baru.
    • Prototype task berhasil tetapi tidak memiliki gambar. Buat prototype task baru.

    Pesan error akan menunjukkan masalah apa yang ditemukan.

  • 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
    404 - Not Found
    Description

    input_task_id tidak cocok dengan prototype task Vinyl Figure mana pun yang dibuat oleh 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 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 dalam antrean atau berjalan. Tunggu hingga beberapa selesai, lalu coba lagi.
    • Pada paket tanpa batas dengan sisa kredit habis, Anda telah mencapai jumlah task yang dapat berjalan tanpa kredit. Tunggu hingga sebuah task selesai, atau tambahkan kredit.

GET/openapi/creative-lab/vinyl-figure/v1/(prototype|build)/:id

Mendapatkan task Vinyl Figure

Mengembalikan task prototype atau build. Path harus sesuai dengan tahap task tersebut. Task build yang diminta melalui /prototype/:id akan mengembalikan 404, begitu juga task prototype yang diminta melalui /build/:id.

Untuk kolom-kolomnya, lihat The Vinyl Figure prototype task object dan The Vinyl Figure build task object.

Request

GET
/openapi/creative-lab/vinyl-figure/v1/prototype/019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de
# Prototype
curl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/prototype/019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de",
  "type": "creative-lab-vinyl-figure-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1752969600000,
  "started_at": 1752969604000,
  "finished_at": 1752969630000,
  "expires_at": 1753228830000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef",
  "type": "creative-lab-vinyl-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1752969700000,
  "started_at": 1752969710000,
  "finished_at": 1752969735000,
  "expires_at": 1753228935000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/texture_0.png?Expires=***"
    }
  ]
}

Parameter

  • Name
    id
    Type
    path
    Description

    ID task dari respons pembuatan.

Hasil yang dikembalikan

Objek prototype task atau build task, sesuai dengan tahap pada path.

Mode kegagalan

  • Name
    400 - Bad Request
    Description

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

  • Name
    403 - Forbidden
    Description

    Tim Anda mengaktifkan IP Filtering, dan Meshy menandai gambar task ini karena kekayaan intelektual pihak ketiga. Tim pada paket Enterprise tidak mendapatkan error ini. Buat task prototype dari gambar yang hak penggunaannya Anda miliki.

  • Name
    404 - Not Found
    Description

    Tidak ada task Vinyl Figure dengan ID ini yang dimiliki akun Anda, atau tahap task tidak sesuai dengan path. Periksa ID-nya, dan gunakan /prototype atau /build yang sesuai dengan task tersebut.

  • Name
    500 - Internal Server Error
    Description

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


DELETE/openapi/creative-lab/vinyl-figure/v1/(prototype|build)/:id

Hapus task Vinyl Figure

Membatalkan task Vinyl Figure. 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/vinyl-figure/v1/prototype/019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de
curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/prototype/019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de \
  -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.
    • Task sudah memiliki status akhir (SUCCEEDED, FAILED, atau CANCELED), sehingga tidak dapat dibatalkan.
  • Name
    404 - Not Found
    Description

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


GET/openapi/creative-lab/vinyl-figure/v1/(prototype|build)/:id/stream

Streaming tugas Vinyl Figure

Melakukan streaming pembaruan tugas Vinyl Figure sebagai Server-Sent Events (SSE). Path harus sesuai dengan tahap tugas tersebut. Jika tidak, misalnya ID tugas build di /prototype/:id/stream, stream akan mengirim satu event error dengan status_code: 404 lalu ditutup.

Request

GET
/openapi/creative-lab/vinyl-figure/v1/build/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/stream
curl -N https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/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": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef",
  "type": "creative-lab-vinyl-figure-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1752969700000,
  "started_at": 1752969710000,
  "finished_at": 1752969735000,
  "expires_at": 1753228935000,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/texture_0.png?Expires=***"
    }
  ]
}

Parameter

  • Name
    id
    Type
    path
    Description

    ID tugas dari respons pembuatan.

Returns

Sebuah stream objek tugas prototype atau build. Setiap event berisi objek tugas lengkap, sebagaimana dikembalikan oleh Get a Vinyl Figure task. Selama tugas berstatus PENDING atau IN_PROGRESS, kolom 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/vinyl-figure/v1/(prototype|build)

List tugas Vinyl Figure

Mengembalikan tugas Vinyl Figure Anda dari 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/vinyl-figure/v1/prototype
# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/prototype?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

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

Response (List Prototype Tasks)

[
  {
    "id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de",
    "type": "creative-lab-vinyl-figure-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1752969600000,
    "started_at": 1752969604000,
    "finished_at": 1752969630000,
    "expires_at": 1753228830000,
    "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 hingga 255. 0 mengembalikan halaman pertama. Nilai di luar 0 hingga 255 akan mengembalikan 400.

  • Name
    page_size
    Type
    integer
    default 10
    Description

    Jumlah tugas per halaman, hingga 100. Nilai dari 101 hingga 255 akan mengembalikan 100 tugas, dan 0 menggunakan nilai default. Nilai di luar 0 hingga 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

Mengembalikan

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


Objek task prototipe Vinyl Figure

Task prototipe menghasilkan gambar konsep bergaya vinyl figure dari sebuah foto. Untuk mengubah gambar tersebut menjadi model 3D, kirimkan ID task ke endpoint build sebagai input_task_id.

Properti

Example Vinyl Figure Prototype Task Object

{
  "id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de",
  "type": "creative-lab-vinyl-figure-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1752969600000,
  "started_at": 1752969604000,
  "finished_at": 1752969630000,
  "expires_at": 1753228830000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}
  • Name
    id
    Type
    string
    Description

    ID task. Jangan bergantung pada formatnya.

  • Name
    type
    Type
    string
    Description

    Jenis task, selalu creative-lab-vinyl-figure-prototype.

  • Name
    name
    Type
    string
    Description

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

  • Name
    status
    Type
    string
    Description

    Status task.

    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 saat berhasil.

  • Name
    created_at
    Type
    timestamp
    Description

    Waktu task dibuat, dalam milidetik Unix.

  • Name
    started_at
    Type
    timestamp
    Description

    Waktu sebuah 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 kedaluwarsa hasil task, 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 selama berstatus PENDING. 1 berarti task akan dimulai berikutnya. 0 setelah task keluar dari antrean, dan selalu 0 pada hasil daftar.

  • 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, setelah pengembalian dana (jika ada). Permintaan yang mengembalikan kesalahan tidak dikenakan biaya. Task yang gagal bernilai 0, karena Meshy mengembalikan dananya. Membatalkan task hanya mengembalikan dana selama task masih PENDING. Jika Meshy tidak dapat membaca biaya tersebut, respons get atau stream akan menghilangkan field ini, dan permintaan list akan mengembalikan 500. Dalam hal ini, coba lagi permintaan tersebut.

  • Name
    image_urls
    Type
    array of strings
    Description

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


Objek tugas build Vinyl Figure

Sebuah build task menghasilkan figur vinyl 3D bertekstur dari sebuah prototype task yang berhasil (succeeded). Bidang model_urls, thumbnail_url, dan texture_urls memiliki format yang sama seperti pada objek Image to 3D task.

Properti

Example Vinyl Figure Build Task Object

{
  "id": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef",
  "type": "creative-lab-vinyl-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1752969700000,
  "started_at": 1752969710000,
  "finished_at": 1752969735000,
  "expires_at": 1753228935000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/texture_0.png?Expires=***"
    }
  ]
}
  • Name
    id
    Type
    string
    Description

    ID task. Jangan bergantung pada formatnya.

  • Name
    type
    Type
    string
    Description

    Jenis task, selalu creative-lab-vinyl-figure-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.

    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 selesai, dari 0 hingga 100. Nilainya 0 hingga task dimulai dan 100 saat berhasil.

  • Name
    created_at
    Type
    timestamp
    Description

    Waktu task dibuat, dalam milidetik Unix.

  • Name
    started_at
    Type
    timestamp
    Description

    Waktu sebuah 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 saat statusnya 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 task gagal. null kecuali status adalah FAILED. Lihat Kesalahan.

  • Name
    consumed_credits
    Type
    integer
    Description

    Jumlah kredit yang dikenakan untuk task, setelah pengembalian dana (refund) apa pun. Permintaan yang mengembalikan kesalahan tidak dikenakan biaya. Task yang gagal bernilai 0, karena Meshy mengembalikan dananya. Membatalkan hanya mengembalikan dana task selama statusnya masih PENDING. Jika Meshy tidak dapat membaca biaya yang dikenakan, respons get atau stream akan menghilangkan bidang ini, dan permintaan list akan mengembalikan 500. Dalam kasus ini, coba lagi permintaan tersebut.

  • Name
    prompt
    Type
    string
    Description

    Selalu "" untuk Vinyl Figure build task.

  • Name
    negative_prompt
    Type
    string
    Description

    Selalu "" untuk Vinyl Figure build task, seperti prompt.

  • Name
    texture_prompt
    Type
    string
    Description

    Selalu "" untuk Vinyl Figure build task, seperti prompt.

  • Name
    texture_image_url
    Type
    string
    Description

    Selalu "" untuk Vinyl Figure build task, seperti prompt.

  • Name
    model_urls
    Type
    object
    Description

    URL unduhan untuk model 3D, sebagai GLB bertekstur dan sebagai file OBJ dengan file MTL-nya.

    • Name
      glb
      Type
      string
      Description

      URL unduhan untuk file GLB bertekstur.

    • Name
      obj
      Type
      string
      Description

      URL unduhan untuk file OBJ, dengan geometri dan UV.

    • Name
      mtl
      Type
      string
      Description

      URL unduhan untuk file material MTL yang menyertai obj. Gunakan bersama obj dan tekstur di texture_urls[0].base_color.

  • Name
    thumbnail_url
    Type
    string
    Description

    URL unduhan untuk gambar pratinjau model.

  • Name
    texture_urls
    Type
    array
    Description

    Peta tekstur, sebagai array dengan satu objek yang menyimpan peta warna dasar (base color).

    • Name
      base_color
      Type
      string
      Description

      URL unduhan untuk peta warna dasar.