Ubah foto sumber menjadi figur 3D koleksi kepala besar dalam dua tahap: prototipe menghasilkan gambar konsep bergaya dari foto input Anda, kemudian pembangunan mengubah gambar konsep tersebut menjadi model 3D dengan texture. Kedua tahap tersebut dihubungkan melalui input_task_id.
POST /openapi/creative-lab/vinyl-figure/v1/prototype
Hasilkan satu gambar konsep bergaya figur vinyl dari foto sumber. ID tugas yang dikembalikan adalah yang Anda berikan sebagai input_task_id ke endpoint build. Lihat Objek Tugas Prototipe Figur Vinyl untuk bentuk respons.
Parameter
Name
image_url
Type
string
Wajib
Description
Foto sumber untuk Meshy agar diubah menjadi figur vinyl dengan kepala besar. Saat ini kami 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 dienkode 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. Maksimal 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 apa pun.
Mengembalikan
Properti result dari respons berisi id tugas dari tugas prototipe figur vinyl yang baru dibuat. Pantau endpoint Dapatkan Tugas atau berlangganan stream hingga tugas mencapai SUCCEEDED, lalu 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 hak kekayaan 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/vinyl-figure/v1/prototype
# Stage 1: generate a vinyl-figure-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/prototype \-XPOST \-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":"019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de"}
Contoh prototipe
Mulai dengan foto sumber, lalu hasilkan gambar prototipe yang digunakan oleh tahap build.
Hasilkan figur vinyl 3D bertekstur akhir dari tugas prototipe yang berhasil. Pembangunan menjalankan pipeline gambar-ke-3D yang sama seperti Gambar ke 3D, sehingga format objek respons dan daftar URL output cocok persis. Lihat Objek Tugas Pembangunan Figur Vinyl 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/vinyl-figure/v1/prototype dan menolak sumber lain dengan 404.
Name
name
Type
string
Description
Nama tugas opsional untuk tujuan tampilan. Maksimum 100 karakter.
Mengembalikan
Properti result dari respons berisi id tugas dari tugas pembangunan figur vinyl yang baru dibuat. Pantau endpoint Dapatkan Tugas atau berlangganan stream hingga tugas mencapai SUCCEEDED, kemudian unduh GLB bertekstur dari model_urls.glb (atau pasangan OBJ + MTL dari model_urls.obj dan model_urls.mtl jika pipeline hilir Anda lebih memilih OBJ).
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.
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 berantai ke pembangunan).
Name
429 - Too Many Requests
Description
Anda telah melebihi batas laju Anda.
Permintaan
POST
/openapi/creative-lab/vinyl-figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de" }'
Ambil tugas prototipe atau build dengan memberikan id tugas yang valid. Jalur URL
harus sesuai dengan tahap tugas — tugas build yang diambil melalui
/prototype/:id akan mengembalikan 404, dan sebaliknya.
Batalkan tugas vinyl figure. Jika tugas masih PENDING, kredit yang digunakan saat pembuatan akan dikembalikan. Tugas yang sudah IN_PROGRESS dibatalkan tanpa pengembalian dana (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 vinyl figure yang akan dibatalkan.
Pengembalian
Mengembalikan 204 No Content jika berhasil dengan badan 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.
Streaming pembaruan waktu nyata untuk tugas figur vinyl 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 figur vinyl yang akan di-stream.
Mengembalikan
Mengembalikan stream dari objek tugas Vinyl Figure Prototype
atau Vinyl Figure Build sebagai Server-Sent Events. Untuk tugas PENDING atau IN_PROGRESS, stream respons hanya akan menyertakan bidang progress dan status yang diperlukan.
Ambil daftar paginasi dari tugas figur vinyl 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 akan
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.
Objek Tugas Prototipe Figur Vinyl adalah unit kerja yang dilacak oleh Meshy
untuk menghasilkan gambar konsep bergaya figur vinyl dari foto sumber.
Hasil dari tahap ini dihubungkan 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 tersebut.
Name
type
Type
string
Description
Jenis tugas. Nilainya adalah creative-lab-vinyl-figure-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 bernilai 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.
Sebagai contoh, 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 bernilai 0.
Name
finished_at
Type
timestamp
Description
Stempel waktu saat tugas selesai, dalam milidetik. Jika tugas belum selesai, properti ini akan bernilai 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 pada kegagalan).
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.
Objek Tugas Pembuatan Figur Vinyl adalah unit kerja yang dilacak oleh Meshy
untuk menghasilkan figur vinyl 3D bertekstur dari tugas prototipe yang berhasil.
Ini menjalankan pipeline gambar-ke-3D yang sama yang digunakan oleh Gambar ke 3D,
sehingga bidang output mencerminkan objek tugas endpoint tersebut.
Properti
Name
id
Type
string
Description
Pengenal unik untuk tugas tersebut.
Name
type
Type
string
Description
Jenis tugas. Nilainya adalah creative-lab-vinyl-figure-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 tugas. Nilai yang mungkin adalah salah satu dari PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Kemajuan 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 jika gagal).
Name
prompt
Type
string
Description
Selalu kosong untuk pembuatan figur vinyl. Hadir untuk kompatibilitas lintas endpoint dengan bentuk V2ImageTo3DTaskResponse yang digunakan oleh Gambar ke 3D.
Name
negative_prompt
Type
string
Description
Selalu kosong untuk pembuatan figur vinyl. Hadir untuk kompatibilitas lintas endpoint.
Name
texture_prompt
Type
string
Description
Selalu kosong untuk pembuatan figur vinyl. Hadir untuk kompatibilitas lintas endpoint.
Name
texture_image_url
Type
string
Description
Selalu kosong untuk pembuatan figur vinyl. Hadir untuk kompatibilitas lintas endpoint.
Name
model_urls
Type
object
Description
URL yang dapat diunduh untuk model 3D yang dihasilkan. Pembuatan figur vinyl menghasilkan GLB bertekstur ditambah pasangan OBJ + MTL untuk pipeline yang lebih menyukai Wavefront OBJ. Bentuk bidang ini cocok dengan objek model_urls Gambar ke 3D sehingga penambahan format di masa depan dapat dimasukkan tanpa perubahan yang merusak.
Name
glb
Type
string
Description
URL yang dapat diunduh ke file GLB bertekstur.
Name
obj
Type
string
Description
URL yang dapat diunduh ke file Wavefront OBJ (geometri + UV).
Name
mtl
Type
string
Description
URL yang dapat diunduh ke file material MTL pendamping OBJ. Pasangkan dengan obj dan entri dari texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
URL yang dapat diunduh ke gambar thumbnail dari file model.
Name
texture_urls
Type
array
Description
Array dari objek URL tekstur yang dihasilkan oleh tugas ini. Saat ini berisi satu objek dengan peta warna dasar.
Name
base_color
Type
string
Description
URL yang dapat diunduh ke gambar peta warna dasar.