Tukar foto sumber menjadi figura 3D koleksi bergaya chibi dalam dua peringkat:
prototaip menjana imej konsep bergaya daripada foto input anda, kemudian
binaan menukar imej konsep itu menjadi model 3D dengan peta tekstur. Dua peringkat ini
dipautkan melalui input_task_id.
Jana satu imej konsep gaya chibi daripada foto sumber. ID tugas yang
dikembalikan ialah apa yang anda hantar sebagai input_task_id kepada endpoint
binaan. Rujuk
Objek Tugas Prototaip figura
untuk bentuk respons.
Parameter
Name
image_url
Type
string
Diperlukan
Description
Foto sumber untuk Meshy gayakan sebagai figura chibi. Pada masa ini kami menyokong format .jpg, .jpeg, .png, dan .webp.
Terdapat dua cara untuk menyediakan imej:
URL yang boleh diakses secara awam: URL yang boleh diakses daripada internet awam.
Data URI: Data URI imej yang dikodkan base64. 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
Sifat result dalam respons mengandungi id tugas bagi tugas prototaip figura yang baru dicipta. Tinjau endpoint Dapatkan Tugas atau langgan strim sehingga tugas mencapai SUCCEEDED, kemudian hantar ID itu kepada endpoint binaan sebagai input_task_id.
Mod Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak boleh diterima. Punca biasa:
Parameter tiada: image_url diperlukan.
Format imej tidak sah: image_url yang disediakan bukan 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 boleh dicapai: image_url tidak dapat dimuat turun (404 atau timeout).
Data URI tidak sah: Rentetan base64 cacat bentuk.
Kandungan ditandakan: Imej input telah ditandakan 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/figure/v1/prototype
# Stage 1: generate a chibi-style concept imagecurl https://api.meshy.ai/openapi/creative-lab/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":"018a210d-8ba4-705c-b111-1f1776f7f578"}
Contoh prototaip
Mulakan dengan potret sumber, kemudian jana imej prototaip yang digunakan oleh peringkat binaan.
Jana figura 3D bertekstur akhir daripada tugasan prototaip yang berjaya.
Binaan 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 Tugasan Binaan figura untuk
bentuk respons.
Parameter
Name
input_task_id
Type
string
Diperlukan
Description
ID tugasan bagi tugasan prototaip yang dicipta melalui endpoint OpenAPI yang sama ini. Prototaip mesti telah dicipta dengan kunci API yang sama, mesti telah mencapai SUCCEEDED, dan mesti telah menghasilkan tepat satu imej calon.
Tugasan prototaip yang dicipta melalui webapp tidak diterima — endpoint binaan hanya menerima tugasan prototaip yang dihasilkan oleh POST /openapi/creative-lab/figure/v1/prototype dan menolak sebarang sumber lain dengan 404.
Name
name
Type
string
Description
Nama tugasan pilihan untuk tujuan paparan. Maksimum 100 aksara.
Mengembalikan
Sifat result dalam respons mengandungi id tugasan bagi tugasan binaan figura yang baru dicipta. Tinjau endpoint Dapatkan Tugasan atau langgan strim sehingga tugasan 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 mengutamakan OBJ).
Mode Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak boleh diterima. Punca biasa:
Parameter tiada: input_task_id diperlukan.
UUID tidak sah: input_task_id bukan UUID yang sah.
Induk belum berjaya: Tugasan prototaip yang dirujuk belum mencapai SUCCEEDED lagi.
Tiada calon: Tugasan prototaip berjaya tetapi tidak menghasilkan imej calon.
Name
401 - Unauthorized
Description
Pengesahan gagal. Sila semak kunci API anda.
Name
402 - Payment Required
Description
Kredit tidak mencukupi untuk melaksanakan tugasan ini.
Name
404 - Not Found
Description
Tugasan prototaip yang dirujuk tidak wujud, dimiliki oleh pengguna lain, atau dicipta melalui webapp (hanya tugasan prototaip mode API boleh dirantai ke binaan).
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 taskcurl https://api.meshy.ai/openapi/creative-lab/figure/v1/build \ -X POST \ -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
The build task turns the selected prototype image into a downloadable textured 3D model.
Dapatkan tugasan prototaip atau binaan dengan id tugasan yang sah. Laluan URL
mesti sepadan dengan peringkat tugasan — tugasan binaan yang diambil melalui
/prototype/:id mengembalikan 404, dan begitu juga sebaliknya.
Batalkan tugas figura. Jika tugas masih PENDING, kredit
yang digunakan pada masa penciptaan akan dipulangkan. Tugas yang sudah
IN_PROGRESS dibatalkan tanpa bayaran balik (pekerja mungkin sudah
menggunakan sumber). Tugas yang sudah mencapai keadaan terminal
(SUCCEEDED, FAILED, CANCELED) tidak boleh dibatalkan.
Laluan URL mesti sepadan dengan peringkat tugas — DELETE pada
/prototype/:buildId mengembalikan 404.
Parameter Laluan
Name
id
Type
path
Description
Pengecam unik untuk tugas figura 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 boleh dibatalkan.
Name
404 - Not Found
Description
Tugas tidak wujud, dimiliki oleh pengguna lain, atau peringkatnya tidak sepadan dengan laluan URL.
Strim 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 memancarkan satu payload event: error dengan
status_code: 404 dan menutup strim.
Parameter
Name
id
Type
path
Description
Pengecam unik untuk tugas figura yang hendak distrim.
Pulangan
Mengembalikan strim objek tugas Prototaip figura
atau Binaan figura sebagai
Server-Sent Events. Untuk tugas PENDING atau IN_PROGRESS, strim respons
hanya akan menyertakan medan progress dan status yang diperlukan.
Dapatkan senarai tugasan figura anda yang dipenomborkan halaman untuk satu peringkat. Laluan
URL memilih peringkat — /prototype mengembalikan tugasan prototaip; /build
mengembalikan tugasan binaan. Tugasan daripada peringkat lain 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 pernah mengembalikan
tugasan binaan dan begitu juga 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 50 item.
Name
sort_by
Type
string
lalai -created_at
Description
Medan untuk diisih mengikut. Nilai yang tersedia:
+created_at: Isih mengikut masa penciptaan dalam tertib menaik.
-created_at: Isih mengikut masa penciptaan dalam tertib menurun.
Objek Tugasan Prototaip figura ialah unit kerja yang dijejaki oleh Meshy untuk
menjana imej konsep bergaya chibi daripada foto sumber. Output daripada
peringkat ini dirangkaikan ke dalam peringkat binaan
melalui input_task_id.
Sifat
Name
id
Type
string
Description
Pengecam unik untuk tugasan. Walaupun kami menggunakan UUID boleh diisih-k untuk id tugasan sebagai butiran pelaksanaan, anda tidak patut membuat sebarang andaian tentang format id tersebut.
Name
type
Type
string
Description
Jenis tugasan. Nilainya ialah creative-lab-figure-prototype.
Name
name
Type
string
Description
Nama tugasan yang diberikan apabila tugasan dicipta. Rentetan 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 dimulakan, sifat ini akan menjadi 0. Setelah tugasan berjaya, ini akan menjadi 100.
Name
created_at
Type
timestamp
Description
Cap masa apabila tugasan 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
kepada semua cap masa dalam Meshy API.
Name
started_at
Type
timestamp
Description
Cap masa apabila tugasan dimulakan, dalam milisaat. Jika tugasan belum dimulakan, sifat ini akan menjadi 0.
Name
finished_at
Type
timestamp
Description
Cap masa apabila tugasan selesai, dalam milisaat. Jika tugasan belum selesai, sifat ini akan menjadi 0.
Name
expires_at
Type
timestamp
Description
Cap masa apabila hasil tugasan tamat tempoh, dalam milisaat.
Name
preceding_tasks
Type
integer
Description
Bilangan tugasan terdahulu.
Nilai medan ini hanya bermakna jika status tugasan ialah PENDING.
Name
task_error
Type
object
Description
Butiran ralat untuk tugasan yang gagal. Lihat Ralat untuk rujukan objek task_error penuh.
Name
consumed_credits
Type
integer
Description
Bilangan kredit yang digunakan oleh tugasan ini. Tersedia apabila status tugasan ialah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugasan FAILED (kredit dipulangkan semula apabila gagal).
Name
image_urls
Type
array of strings
Description
URL yang boleh dimuat turun untuk calon imej konsep yang dijana oleh tugasan prototaip ini. Pada masa ini API sentiasa mengembalikan tepat satu calon; medan ini ialah tatasusunan supaya semakan masa hadapan boleh memaparkan berbilang calon tanpa perubahan yang memecahkan keserasian.
Objek Tugas Binaan figura ialah unit kerja yang dijejaki oleh Meshy untuk
menjana figura 3D bertekstur daripada tugas prototaip yang berjaya. Ia
menjalankan saluran paip imej-ke-3D yang sama digunakan oleh Imej ke 3D,
jadi medan output mencerminkan objek tugas endpoint tersebut.
Sifat
Name
id
Type
string
Description
Pengecam unik untuk tugasan.
Name
type
Type
string
Description
Jenis tugasan. Nilainya ialah creative-lab-figure-build.
Name
name
Type
string
Description
Nama tugasan yang diberikan apabila tugasan dicipta. Rentetan 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 dimulakan lagi, sifat ini akan menjadi 0. Setelah tugasan berjaya, ini akan menjadi 100.
Name
created_at
Type
timestamp
Description
Cap masa apabila tugasan dicipta, dalam milisaat.
Name
started_at
Type
timestamp
Description
Cap masa apabila tugasan dimulakan, dalam milisaat.
Name
finished_at
Type
timestamp
Description
Cap masa apabila tugasan diselesaikan, dalam milisaat.
Name
expires_at
Type
timestamp
Description
Cap masa apabila hasil tugasan tamat tempoh, dalam milisaat.
Name
preceding_tasks
Type
integer
Description
Bilangan tugasan terdahulu. Bermakna hanya apabila status ialah PENDING.
Name
task_error
Type
object
Description
Butiran ralat untuk tugasan yang gagal. Lihat Ralat untuk rujukan objek task_error penuh.
Name
consumed_credits
Type
integer
Description
Bilangan kredit yang digunakan oleh tugasan ini. Mengembalikan 0 untuk tugasan FAILED (kredit dipulangkan semula apabila gagal).
Name
prompt
Type
string
Description
Sentiasa kosong untuk pembinaan figura. Hadir untuk keserasian merentas endpoint dengan bentuk V2ImageTo3DTaskResponse dikongsi yang digunakan oleh Imej ke 3D.
Name
negative_prompt
Type
string
Description
Sentiasa kosong untuk pembinaan figura. Hadir untuk keserasian merentas endpoint.
Name
texture_prompt
Type
string
Description
Sentiasa kosong untuk pembinaan figura. Hadir untuk keserasian merentas endpoint.
Name
texture_image_url
Type
string
Description
Sentiasa kosong untuk pembinaan figura. Hadir untuk keserasian merentas endpoint.
Name
model_urls
Type
object
Description
URL yang boleh dimuat turun untuk model 3D yang dijana. Pembinaan figura menghasilkan GLB bertekstur serta pasangan OBJ + MTL untuk saluran kerja yang lebih mengutamakan Wavefront OBJ. Bentuk medan sepadan dengan objek Imej ke 3D model_urls supaya penambahan format pada masa hadapan dapat dimasukkan tanpa perubahan yang memutuskan keserasian.
Name
glb
Type
string
Description
URL yang boleh dimuat turun ke fail GLB bertekstur.
Name
obj
Type
string
Description
URL yang boleh dimuat turun ke fail Wavefront OBJ (geometri + UV).
Name
mtl
Type
string
Description
URL yang boleh dimuat turun ke fail bahan MTL pendamping OBJ. Pasangkan dengan obj dan entri daripada texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
URL yang boleh dimuat turun ke imej kecil fail model.
Name
texture_urls
Type
array
Description
Tatasusunan objek URL tekstur yang dijana oleh tugasan ini. Pada masa ini mengandungi satu objek dengan peta warna asas.
Name
base_color
Type
string
Description
URL yang boleh dimuat turun ke imej peta warna asas.