Tukarkan foto sumber kepada figura koleksi 3D vinil berkepala besar dalam dua
peringkat: prototype menjana imej konsep bergaya daripada foto input
anda, kemudian build menukarkan imej konsep itu kepada model 3D
bertekstur. Kedua-dua peringkat ini dihubungkan melalui input_task_id.
POST /openapi/creative-lab/vinyl-figure/v1/prototype
Jana satu imej konsep bergaya figura-vinyl daripada foto sumber. ID tugas
yang dikembalikan adalah yang anda hantar sebagai input_task_id kepada
endpoint build. Rujuk
The Vinyl Figure Prototype Task Object
untuk bentuk respons.
Parameter
Name
image_url
Type
string
Diperlukan
Description
Foto sumber untuk Meshy stailkan sebagai figura vinyl berkepala-besar. Kami kini menyokong format .jpg, .jpeg, .png, dan .webp.
Terdapat dua cara untuk menyediakan imej:
URL yang boleh diakses secara umum: URL yang boleh diakses daripada internet awam.
Data URI: Data URI imej yang dikodkan base64. Contoh data URI: data:image/jpeg;base64,<data imej anda yang dikodkan base64>.
Name
name
Type
string
Description
Nama tugas pilihan untuk tujuan paparan. Maksimum 100 aksara.
Name
remove_background
Type
boolean
lalai false
Description
Apabila ditetapkan kepada true, imej prototaip dikembalikan sebagai PNG RGBA lutsinar dengan latar belakang dibuang, supaya anda boleh menggabungkan subjek ke atas mana-mana latar belakang.
Pulangan
Sifat result bagi respons mengandungi id tugas bagi tugas prototaip figura vinyl yang baru dicipta. Undi (poll) endpoint Get a Task atau langgan stream sehingga tugas mencapai SUCCEEDED, kemudian hantar ID tersebut kepada endpoint build sebagai input_task_id.
Mod Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak boleh diterima. Sebab umum:
Parameter tiada: image_url diperlukan.
Format imej tidak sah: image_url yang diberikan bukan format yang disokong (.jpg, .jpeg, .png, .webp).
Dimensi imej luar julat: Imej terlalu kecil, melebihi saiz fail maksimum, atau melebihi bilangan piksel maksimum.
URL tidak dapat dicapai: image_url tidak dapat dimuat turun (404 atau timeout).
Data URI tidak sah: Rentetan base64 tidak sah bentuknya.
Kandungan dibenderakan: Imej input dibenderakan oleh moderation NSFW atau harta intelek.
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.
Request
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>" }'
Response
{"result":"019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de"}
Prototype example
Start with a source photo, then generate the prototype image used by the build stage.
Menjana figura vinil 3D bertekstur akhir daripada 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
Objek Tugas Pembinaan Figura Vinil
untuk bentuk respons.
Parameter
Name
input_task_id
Type
string
Diperlukan
Description
ID tugas bagi tugas prototaip yang dicipta melalui endpoint OpenAPI yang sama ini. Prototaip tersebut mestilah 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 mana-mana sumber lain dengan 404.
Name
name
Type
string
Description
Nama tugas pilihan untuk tujuan paparan. Maksimum 100 aksara.
Returns
Sifat result bagi respons mengandungi id tugas bagi tugas pembinaan figura vinil yang baru dicipta. Tinjau endpoint Get a Task atau langgan stream sehingga tugas mencapai SUCCEEDED, kemudian muat turun GLB bertekstur daripada model_urls.glb (atau pasangan OBJ + MTL daripada model_urls.obj dan model_urls.mtl jika saluran paip hiliran anda lebih menggemari OBJ).
Failure Modes
Name
400 - Bad Request
Description
Permintaan tidak boleh 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 lagi.
Tiada calon: Tugas prototaip berjaya tetapi tidak menghasilkan sebarang imej calon.
Name
401 - Unauthorized
Description
Pengesahan gagal. Sila semak 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, dimiliki oleh pengguna lain, atau dicipta melalui webapp (hanya tugas prototaip mod API yang boleh dirantai ke dalam pembinaan).
Name
429 - Too Many Requests
Description
Anda telah melebihi had kadar anda.
Request
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" }'
Dapatkan semula tugas prototaip atau bina dengan memberikan id tugas yang sah. Laluan URL
mesti sepadan dengan peringkat tugas tersebut — tugas bina yang diambil melalui
/prototype/:id akan mengembalikan 404, dan sebaliknya.
Batalkan tugas vinyl figure. Jika tugas masih PENDING, kredit
yang digunakan pada masa penciptaan akan dikembalikan. Tugas yang sudah
IN_PROGRESS akan dibatalkan tanpa bayaran balik (worker mungkin sudah
menggunakan sumber). Tugas yang sudah mencapai keadaan terminal
(SUCCEEDED, FAILED, CANCELED) tidak dapat dibatalkan.
Laluan URL mestilah sepadan dengan peringkat tugas — DELETE pada
/prototype/:buildId mengembalikan 404.
Parameter Laluan
Name
id
Type
path
Description
Pengecam unik untuk tugas vinyl figure yang akan dibatalkan.
Pulangan
Mengembalikan 204 No Content apabila berjaya dengan badan kosong.
Mod Kegagalan
Name
400 - Bad Request
Description
Tugas sudah berada dalam keadaan terminal dan tidak dapat dibatalkan.
Name
404 - Not Found
Description
Tugas tidak wujud, dimiliki oleh pengguna lain, atau peringkatnya tidak sepadan dengan laluan URL.
Alirkan kemas kini masa nyata untuk tugas vinyl figure melalui Server-Sent Events
(SSE). Laluan URL mesti sepadan dengan peringkat tugas — membuka strim di
/prototype/:buildId/stream mengeluarkan satu payload event: error dengan
status_code: 404 dan menutup strim tersebut.
Parameter
Name
id
Type
path
Description
Pengecam unik untuk tugas vinyl figure yang hendak dialirkan.
Pulangan
Mengembalikan strim objek tugas Vinyl Figure Prototype
atau Vinyl Figure Build sebagai Server-Sent Events.
Setiap bingkai membawa objek tugas penuh untuk peringkat tersebut — bentuk yang sama seperti yang
dikembalikan oleh endpoint Get — jadi semasa tugas berstatus PENDING atau IN_PROGRESS,
medan output hanya belum diisi (null, [] atau {}) dan
finished_at adalah null.
Dapatkan senarai bernomborkan halaman bagi tugas vinyl figure anda untuk satu peringkat.
Laluan URL memilih peringkat tersebut — /prototype mengembalikan tugas prototaip;
/build mengembalikan tugas pembinaan. Tugas daripada peringkat yang lain tidak disertakan
dalam mana-mana respons.
Parameter Laluan
Name
stage
Type
path
Diperlukan
Description
Sama ada prototype atau build. Koleksi ini hanya mengembalikan tugas
yang peringkatnya sepadan dengan URL — pengambilan /prototype tidak akan sekali-kali mengembalikan
tugas pembinaan dan sebaliknya.
Parameter Pertanyaan
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 yang dibenarkan ialah 100 item.
Name
sort_by
Type
string
lalai -created_at
Description
Medan untuk diisih. Nilai yang tersedia:
+created_at: Isih mengikut masa penciptaan secara menaik.
-created_at: Isih mengikut masa penciptaan secara menurun.
Objek Tugas Prototaip Figura Vinyl ialah unit kerja yang dijejaki oleh Meshy
untuk menjana imej konsep bergaya figura vinyl daripada foto sumber.
Output peringkat ini dirantai ke
peringkat pembinaan melalui input_task_id.
Ciri-ciri
Name
id
Type
string
Description
Pengecam unik untuk tugas. Walaupun kami menggunakan UUID yang boleh disusun-k (k-sortable) sebagai butiran pelaksanaan untuk id tugas, anda tidak patut membuat sebarang andaian tentang format id tersebut.
Name
type
Type
string
Description
Jenis tugas. Nilainya ialah creative-lab-vinyl-figure-prototype.
Name
name
Type
string
Description
Nama tugas yang diberikan semasa tugas dicipta. Rentetan kosong jika tiada nama diberikan.
Name
status
Type
string
Description
Status tugas. Nilai yang mungkin ialah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress tugas. Jika tugas belum bermula, ciri ini akan bernilai 0. Setelah tugas berjaya, nilai ini akan menjadi 100.
Name
created_at
Type
timestamp
Description
Cap masa bila tugas dicipta, dalam milisaat.
Cap masa mewakili bilangan milisaat yang telah berlalu sejak 1 Januari 1970 UTC, mengikut
piawaian RFC 3339.
Sebagai contoh, Jumaat, 1 September 2023 12:00:00 PM GMT diwakili sebagai 1693569600000. Ini terpakai
untuk semua cap masa dalam Meshy API.
Name
started_at
Type
timestamp
Description
Cap masa bila tugas dimulakan, dalam milisaat. Jika tugas belum bermula, ciri ini akan bernilai 0.
Name
finished_at
Type
timestamp
Description
Cap masa bila tugas selesai, dalam milisaat. Jika tugas belum selesai, ciri ini akan bernilai 0.
Name
expires_at
Type
timestamp
Description
Cap masa bila hasil tugas akan tamat tempoh, dalam milisaat.
Name
preceding_tasks
Type
integer
Description
Bilangan tugas yang mendahului.
Nilai medan ini hanya bermakna jika status tugas ialah PENDING.
Name
task_error
Type
object
Description
Butiran ralat untuk tugas yang gagal. Lihat Ralat untuk rujukan penuh objek task_error.
Name
consumed_credits
Type
integer
Description
Bilangan kredit yang digunakan oleh tugas ini. Hadir apabila status tugas ialah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugas FAILED (kredit dikembalikan apabila gagal).
Name
image_urls
Type
array of strings
Description
URL yang boleh dimuat turun untuk calon imej konsep yang dijana oleh tugas prototaip ini. Buat masa ini, API sentiasa mengembalikan tepat satu calon; medan ini berbentuk tatasusunan supaya versi masa hadapan boleh memaparkan beberapa calon tanpa perubahan yang memecahkan keserasian.
Objek Tugasan Bina Figura Vinil ialah unit kerja yang dijejaki oleh Meshy
untuk menjana figura vinil 3D bertekstur daripada tugasan prototaip yang berjaya.
Ia menjalankan saluran paip image-to-3D yang sama seperti yang digunakan oleh Imej ke 3D,
jadi medan output mencerminkan objek tugasan endpoint tersebut.
Sifat
Name
id
Type
string
Description
Pengecam unik untuk tugasan.
Name
type
Type
string
Description
Jenis tugasan. Nilainya ialah creative-lab-vinyl-figure-build.
Name
name
Type
string
Description
Nama tugasan yang diberikan semasa tugasan dicipta. String kosong jika tiada nama diberikan.
Name
status
Type
string
Description
Status tugasan. Nilai yang mungkin ialah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress 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 bila tugasan dicipta, dalam milisaat.
Name
started_at
Type
timestamp
Description
Cap masa bila tugasan dimulakan, dalam milisaat.
Name
finished_at
Type
timestamp
Description
Cap masa bila tugasan selesai, dalam milisaat.
Name
expires_at
Type
timestamp
Description
Cap masa bila hasil tugasan luput, dalam milisaat.
Name
preceding_tasks
Type
integer
Description
Bilangan tugasan terdahulu. Hanya bermakna apabila status ialah 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 yang digunakan oleh tugasan ini. Mengembalikan 0 untuk tugasan FAILED (kredit dikembalikan apabila gagal).
Name
prompt
Type
string
Description
Sentiasa kosong untuk bina figura vinil. Wujud untuk keserasian merentas endpoint dengan bentuk V2ImageTo3DTaskResponse yang dikongsi dan digunakan oleh Imej ke 3D.
Name
negative_prompt
Type
string
Description
Sentiasa kosong untuk bina figura vinil. Wujud untuk keserasian merentas endpoint.
Name
texture_prompt
Type
string
Description
Sentiasa kosong untuk bina figura vinil. Wujud untuk keserasian merentas endpoint.
Name
texture_image_url
Type
string
Description
Sentiasa kosong untuk bina figura vinil. Wujud untuk keserasian merentas endpoint.
Name
model_urls
Type
object
Description
URL yang boleh dimuat turun untuk model 3D yang dijana. Bina figura vinil menghasilkan GLB bertekstur beserta pasangan OBJ + MTL untuk saluran paip yang lebih gemar Wavefront OBJ. Bentuk medan ini sepadan dengan objek model_urls Imej ke 3D supaya penambahan format pada masa hadapan boleh disesuaikan tanpa perubahan yang memecahkan keserasian.
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 pengiring OBJ. Pasangkan dengan obj dan entri daripada 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
Susunan objek URL tekstur yang dijana oleh tugasan ini. Pada masa ini mengandungi satu objek sahaja dengan peta warna asas.
Name
base_color
Type
string
Description
URL yang boleh dimuat turun untuk imej peta warna asas.