Ubah foto sumber menjadi figur collectible 3D berkepala besar dalam dua
tahap: prototipe menghasilkan gambar konsep berstilisasi dari foto
masukan Anda, kemudian pembangunan mengubah gambar konsep tersebut menjadi model 3D dengan texture.
Kedua tahap 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 sampaikan 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 bergaya menjadi figur vinyl berkepala besar. Kami saat ini mendukung format .jpg, .jpeg, .png, dan .webp.
Ada dua cara untuk menyediakan gambar:
URL yang dapat diakses secara publik: URL yang dapat diakses dari internet publik.
Data URI: Data URI yang dikodekan dalam 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.
Pengembalian
Properti result dari respons berisi id tugas dari tugas prototipe figur vinyl yang baru dibuat. Laporkan ke Dapatkan Tugas endpoint atau berlangganan stream sampai tugas mencapai SUCCEEDED, kemudian kirimkan ID itu ke build endpoint sebagai input_task_id.
Mode Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak dapat diterima. Penyebab umum:
Parameter yang hilang: image_url diperlukan.
Format gambar tidak valid: image_url yang disediakan 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 moderation 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.
Request
POST
/openapi/creative-lab/vinyl-figure/v1/prototype
# Tahap 1: menghasilkan gambar konsep bergaya figur vinylcurl 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"}
Prototype example
Start with a source portrait, then generate the prototype image used by the build stage.
Hasilkan figur vinil 3D bertekstur akhir dari task prototipe yang sukses. Pembuatan menjalankan pipeline gambar-ke-3D yang sama seperti Gambar ke 3D, sehingga format objek respons dan daftar URL keluaran cocok persis. Lihat Objek Task Pembuatan Figur Vinil untuk bentuk respons.
Parameter
Name
input_task_id
Type
string
Wajib
Description
ID task dari task prototipe yang dibuat melalui endpoint OpenAPI yang sama ini. Prototipe harus dibuat dengan kunci API yang sama, harus mencapai SUCCEEDED, dan harus menghasilkan tepat satu gambar kandidat.
Task prototipe yang dibuat melalui aplikasi web tidak diterima — endpoint pembuatan hanya menerima task prototipe yang dihasilkan oleh POST /openapi/creative-lab/vinyl-figure/v1/prototype dan menolak sumber lain dengan 404.
Name
name
Type
string
Description
Nama task opsional untuk tujuan tampilan. Maksimum 100 karakter.
Pengembalian
Properti result dari respons berisi id task dari task pembuatan figur vinil yang baru dibuat. Poll endpoint Dapatkan Task atau berlangganan pada stream hingga task 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 menyukai 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 belum sukses: Task prototipe yang direferensikan belum mencapai SUCCEEDED.
Tidak ada kandidat: Task prototipe sukses 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 melaksanakan task ini.
Name
404 - Not Found
Description
Task prototipe yang direferensikan tidak ada, milik pengguna yang berbeda, atau dibuat melalui aplikasi web (hanya task prototipe mode-API yang dapat dihubungkan ke pembuatan).
Name
429 - Too Many Requests
Description
Anda telah melampaui batas laju Anda.
Request
POST
/openapi/creative-lab/vinyl-figure/v1/build
# Tahap 2: buat kaitan dari task prototipe yang suksescurl 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" }'
Ambil tugas prototype atau build dengan memberikan id tugas yang valid. Jalur URL
harus sesuai dengan tahap tugas — tugas build yang diambil melalui
/prototype/:id 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 mulai 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 akan mengembalikan 404.
Parameter Jalur
Name
id
Type
path
Description
Pengenal unik untuk tugas vinyl figure yang akan dibatalkan.
Mengembalikan
Mengembalikan 204 No Content saat berhasil dengan isi 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 real-time untuk tugas figur vinyl melalui Server-Sent Events
(SSE). Jalur URL harus sesuai dengan tahap tugas — membuka aliran di
/prototype/:buildId/stream memancarkan satu event: error payload dengan
status_code: 404 dan menutup aliran.
Parameter
Name
id
Type
path
Description
Pengenal unik untuk tugas figur vinyl yang akan di-stream.
Mengembalikan
Mengembalikan sebuah streaming dari objek-objek tugas Vinyl Figure Prototype
atau Vinyl Figure Build sebagai Server-Sent Events. Untuk tugas-tugas PENDING atau IN_PROGRESS, streaming respons hanya akan menyertakan bidang progress dan status yang diperlukan.
Mengambil daftar tugas vinyl figure Anda dengan paginasi untuk satu tahap.
Jalur URL memilih tahap — /prototype mengembalikan tugas prototipe;
/build mengembalikan tugas bangunan. Tugas dari tahap lain tidak termasuk
dalam respons.
Parameter Jalur
Name
stage
Type
path
Wajib
Description
Baik prototype atau build. Koleksi mengembalikan hanya 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 diperbolehkan adalah 50 item.
Name
sort_by
Type
string
default -created_at
Description
Bidang untuk diurutkan. Nilai yang tersedia:
+created_at: Urutkan berdasarkan waktu pembuatan secara ascending.
-created_at: Urutkan berdasarkan waktu pembuatan secara descending.
# Daftar tugas prototipecurl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/prototype?page_size=10 \ -H "Authorization: Bearer ${YOUR_API_KEY}"# Daftar tugas buildcurl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build?page_size=10 \ -H "Authorization: Bearer ${YOUR_API_KEY}"
Obyek Tugas Prototipe Figur Vinyl adalah unit kerja yang diikuti oleh Meshy
untuk menghasilkan gambar konsep bergaya figur vinyl dari foto sumber.
Hasil dari tahap ini digabungkan ke
tahap pembuatan melalui input_task_id.
Properti
Name
id
Type
string
Description
Pengenal unik untuk tugas. Meskipun kami menggunakan UUID k-sortable untuk id tugas sebagai rincian implementasi, Anda tidak boleh membuat asumsi tentang format id tersebut.
Name
type
Type
string
Description
Jenis dari tugas. Nilainya adalah creative-lab-vinyl-figure-prototype.
Name
name
Type
string
Description
Nama tugas yang disediakan saat tugas dibuat. String kosong jika tidak ada nama yang disediakan.
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 menjadi 0. Setelah tugas berhasil, ini akan menjadi 100.
Name
created_at
Type
timestamp
Description
Stempel waktu kapan tugas dibuat, dalam milidetik.
Sebuah stempel waktu merepresentasikan jumlah milidetik yang telah berlalu sejak 1 Januari 1970 UTC, mengikuti
standar RFC 3339.
Sebagai contoh, Jumat, 1 September 2023 12:00:00 PM GMT direpresentasikan sebagai 1693569600000. Ini berlaku
untuk semua stempel waktu dalam Meshy API.
Name
started_at
Type
timestamp
Description
Stempel waktu kapan tugas dimulai, dalam milidetik. Jika tugas belum dimulai, properti ini akan menjadi 0.
Name
finished_at
Type
timestamp
Description
Stempel waktu kapan tugas selesai, dalam milidetik. Jika tugas belum selesai, properti ini akan menjadi 0.
Name
expires_at
Type
timestamp
Description
Stempel waktu kapan hasil tugas kedaluwarsa, dalam milidetik.
Name
preceding_tasks
Type
integer
Description
Jumlah tugas sebelumnya.
Nilai dari bidang ini berarti hanya jika status tugas adalah PENDING.
Name
task_error
Type
object
Description
Detail kesalahan untuk tugas yang gagal. Lihat Kesalahan untuk referensi objek task_error lengkap.
Name
consumed_credits
Type
integer
Description
Jumlah kredit yang dikonsumsi oleh tugas ini. Hadir 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 merupakan array sehingga revisi 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 yang dipasangi tekstur dari tugas prototipe yang SUCCEEDED. Ini menjalankan pipeline gambar-ke-3D yang sama digunakan oleh Gambar ke 3D, sehingga bidang output mencerminkan objek tugas dari endpoint tersebut.
Properties
Name
id
Type
string
Description
Pengenal unik untuk tugas ini.
Name
type
Type
string
Description
Tipe 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 dari tugas. Nilai yang mungkin adalah salah satu dari PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Kemajuan 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 ketika tugas dibuat, dalam milidetik.
Name
started_at
Type
timestamp
Description
Stempel waktu ketika tugas dimulai, dalam milidetik.
Name
finished_at
Type
timestamp
Description
Stempel waktu ketika tugas selesai, dalam milidetik.
Name
expires_at
Type
timestamp
Description
Stempel waktu ketika hasil tugas kadaluarsa, dalam milidetik.
Name
preceding_tasks
Type
integer
Description
Jumlah tugas pendahulu. 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 akan dikembalikan jika gagal).
Name
prompt
Type
string
Description
Selalu kosong untuk pembangunan figur vinil. Ada untuk kompatibilitas endpoint silang dengan bentuk yang sama V2ImageTo3DTaskResponse yang digunakan oleh Gambar ke 3D.
Name
negative_prompt
Type
string
Description
Selalu kosong untuk pembangunan figur vinil. Ada untuk kompatibilitas endpoint silang.
Name
texture_prompt
Type
string
Description
Selalu kosong untuk pembangunan figur vinil. Ada untuk kompatibilitas endpoint silang.
Name
texture_image_url
Type
string
Description
Selalu kosong untuk pembangunan figur vinil. Ada untuk kompatibilitas endpoint silang.
Name
model_urls
Type
object
Description
URL yang dapat diunduh untuk model 3D yang dihasilkan. Pembangunan figur vinil menghasilkan GLB dengan tekstur plus pasangan OBJ + MTL untuk pipeline yang lebih suka Wavefront OBJ. Bentuk bidangnya cocok dengan Image to 3D model_urls sehingga penambahan format di masa depan dapat dimasukkan tanpa perubahan yang merusak.
Name
glb
Type
string
Description
URL yang dapat diunduh ke file GLB dengan tekstur.
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
Sebuah array 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.