Tukar foto sumber kepada figura koleksi 3D bergaya chibi dalam dua peringkat:
prototaip menjana imej konsep bergaya daripada foto input anda, kemudian
binaan menukar imej konsep tersebut kepada model 3D bertekstur. Kedua-dua peringkat
dihubungkan melalui input_task_id.
Jana imej konsep bergaya chibi tunggal daripada foto sumber. ID tugasan yang dikembalikan adalah apa yang anda hantar sebagai input_task_id kepada build endpoint. Rujuk
The Figure Prototype Task Object
untuk bentuk respons.
Parameter
Name
image_url
Type
string
Diperlukan
Description
Foto sumber untuk Meshy stylize sebagai figura chibi. Kami kini menyokong format .jpg, .jpeg, .png, dan .webp.
Terdapat dua cara untuk menyediakan imej:
URL yang boleh diakses secara umum: Satu 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 tugasan 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 telus dengan latar belakang dialih keluar, supaya anda boleh menggabungkan subjek ke atas mana-mana latar belakang.
Pulangan
Sifat result bagi respons mengandungi id tugasan bagi tugasan prototaip figura yang baru dicipta. Tinjau endpoint Get a Task atau langgan stream sehingga tugasan mencapai SUCCEEDED, kemudian hantar ID tersebut kepada build endpoint sebagai input_task_id.
Mod Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak boleh diterima. Punca biasa:
Parameter hilang: image_url diperlukan.
Format imej tidak sah: image_url yang diberikan bukan format yang disokong (.jpg, .jpeg, .png, .webp).
Dimensi imej di luar julat: Imej terlalu kecil, melebihi saiz fail maksimum, atau melebihi bilangan piksel maksimum.
URL tidak boleh dicapai: image_url tidak dapat dimuat turun (404 atau timeout).
Data URI tidak sah: Rentetan base64 tidak sah bentuknya.
Kandungan ditanda: Imej input telah ditanda 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 tugasan ini.
Name
429 - Too Many Requests
Description
Anda telah melebihi had kadar anda.
Request
POST
/openapi/creative-lab/figure/v1/prototype
# Stage 1: generate a chibi-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/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":"018a210d-8ba4-705c-b111-1f1776f7f578"}
Prototype example
Start with a source portrait, then generate the prototype image used by the build stage.
Hasilkan figura 3D bertekstur akhir daripada tugas prototaip yang berjaya.
Proses build menjalankan saluran paip image-to-3D yang sama seperti
Imej ke 3D, jadi format objek respons dan
senarai URL output adalah sama persis. Rujuk
Objek Tugas Build Figura untuk
bentuk respons.
Parameter
Name
input_task_id
Type
string
Diperlukan
Description
ID tugas bagi tugas prototaip yang dicipta melalui endpoint OpenAPI yang sama. Prototaip tersebut mesti 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 build hanya menerima tugas prototaip yang dihasilkan oleh POST /openapi/creative-lab/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.
Pulangan
Sifat result bagi respons mengandungi id tugas bagi tugas build figura yang baharu dicipta. Tinjau (poll) endpoint Dapatkan Tugas 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 suka OBJ).
Mod Kegagalan
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 belum berjaya: Tugas prototaip yang dirujuk belum mencapai SUCCEEDED.
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, tergolong kepada pengguna lain, atau dicipta melalui webapp (hanya tugas prototaip mod API boleh disambungkan ke build).
Name
429 - Too Many Requests
Description
Anda telah melebihi had kadar anda.
Request
POST
/openapi/creative-lab/figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578" }'
Response
{"result":"019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"}
Build example
Tugas build menukar imej prototaip yang dipilih menjadi model 3D bertekstur yang boleh dimuat turun.
Dapatkan semula tugas prototaip atau build dengan id tugas yang sah. Laluan URL
mesti sepadan dengan peringkat tugas tersebut — tugas build yang diambil melalui
/prototype/:id akan mengembalikan 404, dan begitu juga sebaliknya.
Batalkan satu tugas figure. Jika tugas masih PENDING, kredit
yang digunakan semasa penciptaan akan dikembalikan. Tugas yang sudah
IN_PROGRESS dibatalkan tanpa bayaran balik (pekerja mungkin sudah
menggunakan sumber). Tugas yang telah mencapai keadaan terminal
(SUCCEEDED, FAILED, CANCELED) tidak dapat dibatalkan.
Laluan URL mesti sepadan dengan peringkat tugas — DELETE pada
/prototype/:buildId mengembalikan 404.
Parameter Laluan
Name
id
Type
path
Description
Pengenal unik untuk tugas figure yang hendak 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 figura melalui Server-Sent Events (SSE).
Laluan URL mesti sepadan dengan peringkat tugas — membuka strim di
/prototype/:buildId/stream akan menghantar satu payload event: error dengan
status_code: 404 dan menutup strim tersebut.
Parameter
Name
id
Type
path
Description
Pengecam unik untuk tugas figura yang hendak dialirkan.
Pulangan
Mengembalikan strim objek tugas Figure Prototype
atau 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 lagi (null, [] atau {}) dan
finished_at adalah null.
Dapatkan senarai bernombor halaman bagi tugasan figura anda untuk satu peringkat. Laluan URL
memilih peringkat tersebut — /prototype mengembalikan tugasan prototaip; /build
mengembalikan tugasan pembinaan. Tugasan daripada peringkat yang satu lagi tidak disertakan dalam mana-mana
respons.
Parameter Laluan
Name
stage
Type
path
Diperlukan
Description
Sama ada prototype atau build. Koleksi ini hanya mengembalikan tugasan
yang peringkatnya sepadan dengan URL — mendapatkan /prototype tidak akan mengembalikan
tugasan 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 penyusunan. Nilai yang tersedia:
+created_at: Susun mengikut masa penciptaan secara menaik.
-created_at: Susun mengikut masa penciptaan secara menurun.
Objek Tugas Prototaip Figura ialah unit kerja yang dijejaki oleh Meshy untuk
menjana imej konsep bergaya chibi daripada foto sumber. Output peringkat ini
dirantaikan ke peringkat pembinaan
melalui input_task_id.
Ciri-ciri
Name
id
Type
string
Description
Pengenal unik untuk tugas tersebut. Walaupun kami menggunakan UUID yang boleh disusun-k (k-sortable) untuk id tugas sebagai butiran pelaksanaan, anda tidak patut membuat sebarang andaian tentang format id tersebut.
Name
type
Type
string
Description
Jenis tugas. Nilainya ialah creative-lab-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 lagi, ciri ini akan menjadi 0. Sebaik sahaja tugas berjaya, ini akan menjadi 100.
Name
created_at
Type
timestamp
Description
Cap masa apabila tugas dicipta, dalam milisaat.
Cap masa mewakili bilangan milisaat yang 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
kepada semua cap masa dalam Meshy API.
Name
started_at
Type
timestamp
Description
Cap masa apabila tugas bermula, dalam milisaat. Jika tugas belum bermula lagi, ciri ini akan menjadi 0.
Name
finished_at
Type
timestamp
Description
Cap masa apabila tugas selesai, dalam milisaat. Jika tugas belum selesai lagi, ciri ini akan menjadi 0.
Name
expires_at
Type
timestamp
Description
Cap masa apabila hasil tugas luput, dalam milisaat.
Name
preceding_tasks
Type
integer
Description
Bilangan tugas terdahulu.
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. Pada masa ini API sentiasa mengembalikan tepat satu calon; medan ini berbentuk array supaya semakan masa depan dapat memaparkan berbilang calon tanpa perubahan yang memecahkan keserasian.
Objek Tugas Bina Figura ialah unit kerja yang dijejaki oleh Meshy untuk
menjana figura 3D bertekstur daripada tugas prototaip yang berjaya. Ia
menjalankan pepaip imej-ke-3D yang sama seperti yang digunakan oleh Imej ke 3D,
jadi medan output mencerminkan objek tugas endpoint tersebut.
Ciri-ciri
Name
id
Type
string
Description
Pengecam unik untuk tugas ini.
Name
type
Type
string
Description
Jenis tugas. Nilainya ialah creative-lab-figure-build.
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 menjadi 0. Setelah tugas berjaya, ini akan menjadi 100.
Name
created_at
Type
timestamp
Description
Cap masa apabila tugas dicipta, dalam milisaat.
Name
started_at
Type
timestamp
Description
Cap masa apabila tugas bermula, dalam milisaat.
Name
finished_at
Type
timestamp
Description
Cap masa apabila tugas selesai, dalam milisaat.
Name
expires_at
Type
timestamp
Description
Cap masa apabila hasil tugas tamat tempoh, dalam milisaat.
Name
preceding_tasks
Type
integer
Description
Bilangan tugas yang mendahului. Hanya bermakna apabila status adalah 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. Mengembalikan 0 untuk tugas FAILED (kredit dikembalikan apabila gagal).
Name
prompt
Type
string
Description
Sentiasa kosong untuk bina figura. Wujud untuk keserasian merentas endpoint dengan bentuk V2ImageTo3DTaskResponse yang dikongsi, digunakan oleh Imej ke 3D.
Name
negative_prompt
Type
string
Description
Sentiasa kosong untuk bina figura. Wujud untuk keserasian merentas endpoint.
Name
texture_prompt
Type
string
Description
Sentiasa kosong untuk bina figura. Wujud untuk keserasian merentas endpoint.
Name
texture_image_url
Type
string
Description
Sentiasa kosong untuk bina figura. Wujud untuk keserasian merentas endpoint.
Name
model_urls
Type
object
Description
URL yang boleh dimuat turun untuk model 3D yang dijana. Bina figura menghasilkan GLB bertekstur berserta pasangan OBJ + MTL untuk pepaip 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 merosakkan.
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. Gandingkan 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
Satu tatasusunan objek URL tekstur yang dijana oleh tugas ini. Pada masa ini mengandungi satu objek tunggal dengan peta warna asas.
Name
base_color
Type
string
Description
URL yang boleh dimuat turun untuk imej peta warna asas.