Tukar foto sumber menjadi figura 3D koleksi berkepala besar dalam dua
peringkat: prototaip menjana imej konsep bergaya dari foto input
anda, kemudian membina menukar imej konsep itu menjadi model 3D bertekstur.
Kedua-dua peringkat dihubungkan melalui input_task_id.
POST /openapi/creative-lab/vinyl-figure/v1/prototype
Hasilkan imej konsep gaya figura-vinyl tunggal daripada foto sumber. ID tugas yang dipulangkan adalah apa yang anda serahkan sebagai input_task_id kepada endpoint bina. Rujuk kepada
Objek Tugas Prototip Figura Vinyl
untuk bentuk respons.
Parameter
Name
image_url
Type
string
Diperlukan
Description
Foto sumber untuk Meshy gayakan sebagai figura vinyl berkepala besar. Kami menyokong format .jpg, .jpeg, .png, dan .webp.
Terdapat dua cara untuk memberikan imej:
URL boleh diakses secara awam: URL yang boleh diakses dari internet awam.
Data URI: Data URI yang dikodkan sebagai base64 bagi imej tersebut. 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
Properti result dalam respons mengandungi id tugas prototip figura vinyl yang baru dicipta. Pantau endpoint Dapatkan Tugas atau langgani strim sehingga tugas mencapai SUCCEEDED, kemudian berikan ID tersebut kepada endpoint bina sebagai input_task_id.
Mod Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak dapat diterima. Sebab biasa:
Parameter hilang: image_url diperlukan.
Format imej tidak sah: image_url yang diberi tidak dalam 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 dapat dicapai: image_url tidak dapat dimuat turun (404 atau timeout).
Data URI tidak sah: String base64 salah bentuk.
Kandungan ditandakan: Imej input ditandakan oleh moderation hak intelektual atau NSFW.
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.
Permintaan
POST
/openapi/creative-lab/vinyl-figure/v1/prototype
# Tahap 1: hasilkan imej konsep gaya figura-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>" }'
Respons
{"result":"019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de"}
Contoh prototaip
Mulakan dengan potret sumber, kemudian jana imej prototaip yang digunakan oleh peringkat binaan.
Menjana figura vinyl 3D bertekstur akhir dari tugas prototaip yang berjaya.
Pembinaan ini menjalankan saluran paip imej-ke-3D yang sama seperti
Imej ke 3D, jadi format objek respons dan
senarai URL output adalah sepadan sepenuhnya. Rujuk kepada
Objek Tugas Pembinaan Figura Vinyl
untuk bentuk respons.
Parameter
Name
input_task_id
Type
string
Diperlukan
Description
ID tugas bagi tugas prototaip yang dicipta melalui endpoint OpenAPI ini. Prototaip mesti telah dicipta dengan kunci API yang sama, mesti telah mencapai SUCCEEDED, dan mesti telah menghasilkan tepat satu imej calon.
Tugas prototaip yang dicipta melalui webapp tidak diterima — endpoint pembinaan hanya menerima tugas prototaip yang dihasilkan oleh POST /openapi/creative-lab/vinyl-figure/v1/prototype dan menolak sumber lain dengan 404.
Name
name
Type
string
Description
Nama tugas pilihan untuk tujuan paparan. Maksimum 100 aksara.
Pengembalian
Harta result dalam respons mengandungi id tugas bagi tugas pembinaan figura vinyl yang baru dicipta. Semak endpoint Dapatkan Tugas atau langgan aliran sehingga tugas mencapai SUCCEEDED, kemudian muat turun GLB bertekstur dari model_urls.glb (atau pasangan OBJ + MTL dari model_urls.obj dan model_urls.mtl jika saluran paip bawah anda lebih suka OBJ).
Mod Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak diterima. Punca biasa:
Parameter hilang: input_task_id diperlukan.
UUID tidak sah: input_task_id bukan UUID yang sah.
Induk tidak berjaya: Tugas prototaip yang dirujuk belum mencapai SUCCEEDED.
Tiada calon: Tugas prototaip berjaya tetapi tidak menghasilkan imej calon.
Name
401 - Unauthorized
Description
Pengesahan gagal. Sila periksa 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, adalah milik pengguna lain, atau dicipta melalui webapp (hanya tugas prototaip mod API yang dapat disambungkan ke pembinaan).
Name
429 - Too Many Requests
Description
Anda telah melebihi had kadar anda.
Request
POST
/openapi/creative-lab/vinyl-figure/v1/build
# Peringkat 2: sambung bina daripada tugas prototaip yang berjayacurl 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" }'
Mendapatkan tugas prototaip atau binaan dengan memberikan id tugas yang sah. Laluan URL mesti sepadan dengan peringkat tugas — tugas binaan yang diambil melalui
/prototype/:id mengembalikan 404, dan sebaliknya.
Batal tugas vinyl figura. Jika tugas masih PENDING, kredit yang digunakan semasa membuat akan dikembalikan. Tugas yang sudah IN_PROGRESS dibatalkan tanpa pengembalian (pekerja mungkin sudah menggunakan sumber). Tugas yang telah mencapai keadaan terminal (SUCCEEDED, FAILED, CANCELED) tidak dapat dibatalkan.
Laluan URL mesti sepadan dengan tahap tugas — DELETE pada /prototype/:buildId akan mengembalikan 404.
Parameter Laluan
Name
id
Type
path
Description
Pengenal pasti unik untuk tugas vinyl figura yang ingin dibatalkan.
Pemulangan
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 tahapnya tidak sepadan dengan laluan URL.
Strim kemas kini masa nyata untuk tugas figura vinyl melalui Server-Sent Events
(SSE). Laluan URL mesti memadankan peringkat tugas — membuka strim di
/prototype/:buildId/stream menjana satu event: error payload dengan
status_code: 404 dan menutup strim.
Parameter
Name
id
Type
path
Description
Pengecam unik untuk tugas figura vinyl yang akan di-stream.
Return
Mengembalikan strim objek tugas Prototaip Figura Vinyl
atau Bina Figura Vinyl sebagai Server-Sent Events.
Untuk tugas PENDING atau IN_PROGRESS, strim respons hanya akan merangkumi medan progress dan status yang diperlukan.
// Contoh acara Ralat (peringkat salah atau tugas tidak dijumpai)event: errordata: {"status_code": 404,"message": "Task not found"}// Contoh acara Mesej menggambarkan kemajuan tugas.// Untuk tugas PENDING atau IN_PROGRESS, strim respons tidak akan merangkumi semua medan.event: messagedata: {"id": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef","progress": 0,"status": "PENDING"}event: messagedata: {"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=***" } ]}
Mendapatkan senarai tugas figura vinil anda yang dipenomboran halaman untuk satu peringkat.
Laluan URL memilih peringkat — /prototype memulangkan tugas prototaip;
/build memulangkan tugas pembinaan. Tugas dari peringkat lain tidak termasuk
dalam mana-mana jawapan.
Parameter Laluan
Name
stage
Type
path
Diperlukan
Description
Sama ada prototype atau build. Koleksi hanya memulangkan tugas
yang peringkatnya sepadan dengan URL — mendapatkan /prototype tidak akan memulangkan
tugas pembinaan dan sebaliknya.
Parameter Query
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 dibenarkan ialah 50 item.
Name
sort_by
Type
string
lalai -created_at
Description
Medan untuk disusun. Nilai yang tersedia:
+created_at: Susun mengikut masa penciptaan dalam urutan menaik.
-created_at: Susun mengikut masa penciptaan dalam urutan menurun.
Objekt Tugasan Prototip Figura Vinyl adalah unit kerja yang Meshy pantau
untuk menjana imej konsep gaya figura-vinyl daripada foto sumber.
Hasil peringkat ini disambungkan ke
peringkat binaan melalui input_task_id.
Properties
Name
id
Type
string
Description
Pengecam unik untuk tugasan. Walaupun kita menggunakan UUID yang dapat disusun k-mengikut butiran pelaksanaan untuk id tugasan, anda tidak seharusnya membuat sebarang andaian tentang format id tersebut.
Name
type
Type
string
Description
Jenis tugasan. Nilai ialah creative-lab-vinyl-figure-prototype.
Name
name
Type
string
Description
Nama tugasan yang dibekalkan semasa tugasan itu dicipta. Rentetan kosong jika tiada nama dibekalkan.
Name
status
Type
string
Description
Status tugasan. Nilai yang mungkin adalah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Kemajuan tugasan. Jika tugasan belum bermula, sifat ini akan menjadi 0. Setelah tugasan berjaya, ini akan menjadi 100.
Name
created_at
Type
timestamp
Description
Cap masa ketika tugasan dicipta, dalam milisaat.
Cap masa mewakili bilangan milisaat yang berlalu sejak 1 Januari 1970 UTC, mengikut
standard RFC 3339.
Sebagai contoh, Jumaat, 1 September 2023 12:00:00 PM GMT diwakili sebagai 1693569600000. Ini terpakai
kepada semua cap masa dalam Meshy API.
Name
started_at
Type
timestamp
Description
Cap masa ketika tugasan dimulakan, dalam milisaat. Jika tugasan belum dimulakan, sifat ini akan menjadi 0.
Name
finished_at
Type
timestamp
Description
Cap masa ketika tugasan diselesaikan, dalam milisaat. Jika tugasan belum selesai, sifat ini akan menjadi 0.
Name
expires_at
Type
timestamp
Description
Cap masa apabila hasil tugasan luput, dalam milisaat.
Name
preceding_tasks
Type
integer
Description
Bilangan tugasan terdahulu.
Nilai medan ini bermakna hanya jika status tugasan adalah 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 digunakan oleh tugasan ini. Hadir apabila status tugasan adalah PENDING, IN_PROGRESS, atau SUCCEEDED. Kembali 0 untuk tugasan FAILED (kredit dikembalikan pada kegagalan).
Name
image_urls
Type
array of strings
Description
URL muat turun untuk calon imej konsep yang dihasilkan oleh tugasan prototaip ini. Pada masa ini API sentiasa mengembalikan tepat satu calon; medan ini adalah senarai supaya semakan masa depan boleh menunjukkan banyak calon tanpa perubahan yang merosakkan.
Objek Tugasan Pembinaan Figura Vinyl adalah unit kerja yang Meshy jejak untuk menjana figura vinyl 3D bersalut dari tugasan prototaip yang berjaya. Ia menjalankan aliran imej-ke-3D yang sama digunakan oleh Imej ke 3D, jadi medan output mencerminkan objek tugasan endpoint objek tugasan tersebut.
Properties
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 semasa tugas tersebut dicipta. String kosong jika tiada nama yang diberikan.
Name
status
Type
string
Description
Status tugas. Nilai-nilai yang mungkin adalah salah satu dari PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Kemajuan tugas. Jika tugas belum dimulakan, properti ini akan menjadi 0. Setelah tugas berjaya, ini akan menjadi 100.
Name
created_at
Type
timestamp
Description
Cap masa ketika tugas itu dicipta, dalam milisaat.
Name
started_at
Type
timestamp
Description
Cap masa ketika tugas itu dimulakan, dalam milisaat.
Name
finished_at
Type
timestamp
Description
Cap masa ketika tugas itu diselesaikan, dalam milisaat.
Name
expires_at
Type
timestamp
Description
Cap masa ketika hasil tugas tersebut luput, dalam milisaat.
Name
preceding_tasks
Type
integer
Description
Bilangan tugas yang mendahului. Bermakna hanya bila status adalah PENDING.
Name
task_error
Type
object
Description
Butiran ralat untuk tugas yang gagal. Lihat Ralat untuk rujukan objek task_error penuh.
Name
consumed_credits
Type
integer
Description
Jumlah kredit yang digunakan oleh tugas ini. Kembali 0 untuk tugas FAILED (kredit dikembalikan jika gagal).
Name
prompt
Type
string
Description
Sentiasa kosong untuk bina figura vinyl. Ada untuk keserasian rentas endpoint dengan bentuk V2ImageTo3DTaskResponse yang dikongsi digunakan oleh Imej ke 3D.
Name
negative_prompt
Type
string
Description
Sentiasa kosong untuk bina figura vinyl. Ada untuk keserasian rentas endpoint.
Name
texture_prompt
Type
string
Description
Sentiasa kosong untuk bina figura vinyl. Ada untuk keserasian rentas endpoint.
Name
texture_image_url
Type
string
Description
Sentiasa kosong untuk bina figura vinyl. Ada untuk keserasian rentas endpoint.
Name
model_urls
Type
object
Description
URL yang boleh dimuat turun untuk model 3D yang dihasilkan. Bina figura vinyl menghasilkan GLB bertekstur ditambah dengan pasangan OBJ + MTL untuk rangkaian kerja yang lebih suka OBJ Wavefront. Bentuk medan sepadan dengan objek Imej ke 3D model_urls supaya penambahan format masa depan dapat disesuaikan tanpa perubahan besar.
Name
glb
Type
string
Description
URL yang boleh dimuat turun untuk fail GLB bertekstur.
Name
obj
Type
string
Description
URL yang boleh dimuat turun untuk fail Wavefront OBJ (geometri + UV).
Name
mtl
Type
string
Description
URL yang boleh dimuat turun untuk fail bahan MTL rakan OBJ. Pasangkan dengan obj dan entri dari texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
URL yang boleh dimuat turun untuk imej kecil fail model.
Name
texture_urls
Type
array
Description
Sebuah tatasusunan objek URL tekstur yang dihasilkan oleh tugas ini. Saat ini mengandungi satu objek dengan peta warna asas.
Name
base_color
Type
string
Description
URL yang boleh dimuat turun untuk imej peta warna asas.