Tukar foto sumber kepada figura 3D gaya chibi yang boleh dikumpul dalam dua peringkat: prototaip menjana imej konsep bergaya daripada foto input anda, kemudian bina menukar imej konsep itu kepada model 3D dengan texture. Kedua-dua peringkat dihubungkan melalui input_task_id.
Hasilkan satu imej konsep gaya chibi daripada foto sumber. ID tugas yang dikembalikan adalah apa yang anda serahkan sebagai input_task_id kepada endpoint binaan. Rujuk kepada Objek Tugas Prototip Figura untuk bentuk respons.
Parameter
Name
image_url
Type
string
Diperlukan
Description
Foto sumber untuk Meshy gayakan sebagai figura chibi. Kami kini menyokong format .jpg, .jpeg, .png, dan .webp.
Terdapat dua cara untuk menyediakan imej:
URL boleh diakses secara umum: URL yang boleh diakses dari internet awam.
Data URI: URI data yang dikodkan base64 bagi imej. 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.
Name
remove_background
Type
boolean
lalai false
Description
Apabila ditetapkan kepada true, imej prototip dikembalikan sebagai PNG RGBA telus dengan latar belakang dikeluarkan, supaya anda boleh menggabungkan subjek ke mana-mana latar belakang.
Mengembalikan
Properti result dalam respons mengandungi ID tugas id bagi tugas prototip figura yang baru dicipta. Poll endpoint Dapatkan Tugas atau langgan aliran sehingga tugas mencapai SUCCEEDED, kemudian serahkan ID tersebut kepada endpoint binaan sebagai input_task_id.
Mod Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak dapat 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 jumlah piksel maksimum.
URL tidak dapat dicapai: image_url tidak dapat dimuat turun (404 atau timeout).
Data URI tidak sah: Rentetan base64 rosak.
Kandungan ditandakan: Imej input 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.
Permintaan
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>" }'
Respons
{"result":"018a210d-8ba4-705c-b111-1f1776f7f578"}
Contoh prototip
Mulakan dengan potret sumber, kemudian hasilkan imej prototip yang digunakan oleh peringkat binaan.
Hasilkan figura 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 sepadan dengan tepat. Rujuk kepada Objek Tugas Pembinaan 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 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 aplikasi web tidak diterima — endpoint pembinaan 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
Properti result dalam respons mengandungi id tugas bagi tugas pembinaan figura yang baru dicipta. Poll endpoint Dapatkan Tugas atau langgan stream 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 hiliran anda lebih suka OBJ).
Mod Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak dapat 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 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, milik pengguna lain, atau dicipta melalui aplikasi web (hanya tugas prototaip mod API yang berantai ke pembinaan).
Name
429 - Too Many Requests
Description
Anda telah melebihi had kadar anda.
Permintaan
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" }'
Respons
{"result":"019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"}
Contoh Pembinaan
Tugas pembinaan menukar imej prototaip terpilih menjadi model 3D bertekstur yang boleh dimuat turun.
Dapatkan tugas prototaip atau binaan dengan memberikan id tugas yang sah. Laluan URL mesti sepadan dengan peringkat tugas — tugas binaan yang diambil melalui /prototype/:id akan mengembalikan 404, dan sebaliknya.
Batalkan tugas figura. Jika tugas masih PENDING, kredit yang digunakan semasa penciptaan 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 boleh dibatalkan.
Laluan URL mesti sepadan dengan peringkat tugas — DELETE pada
/prototype/:buildId mengembalikan 404.
Parameter Laluan
Name
id
Type
path
Description
Pengenal pasti unik untuk tugas figura yang hendak dibatalkan.
Pemulangan
Mengembalikan 204 No Content pada kejayaan 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 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 akan mengeluarkan satu event: error payload dengan status_code: 404 dan menutup strim.
Parameter
Name
id
Type
path
Description
Pengenal pasti unik untuk tugas figura yang hendak distrim.
Pulangan
Mengembalikan strim objek tugas Figure Prototype atau Figure Build sebagai Server-Sent Events. Untuk tugas PENDING atau IN_PROGRESS, strim respons hanya akan menyertakan medan progress dan status yang diperlukan.
Dapatkan senarai berpenomboran halaman bagi tugas figura anda untuk satu peringkat. Laluan URL
memilih peringkat — /prototype mengembalikan tugas prototaip; /build
mengembalikan tugas binaan. Tugas dari peringkat lain tidak termasuk dalam mana-mana
respons.
Parameter Laluan
Name
stage
Type
path
Diperlukan
Description
Sama ada prototype atau build. Koleksi hanya mengembalikan tugas
yang peringkatnya sepadan dengan URL — mendapatkan /prototype tidak akan mengembalikan
tugas binaan 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 50 item.
Name
sort_by
Type
string
lalai -created_at
Description
Medan untuk disusun. Nilai yang tersedia:
+created_at: Susun mengikut masa penciptaan dalam susunan menaik.
-created_at: Susun mengikut masa penciptaan dalam susunan menurun.
Objek Tugas Prototip Figura adalah unit kerja yang Meshy jejak untuk menghasilkan imej konsep gaya chibi dari foto sumber. Hasil dari tahap ini dihubungkan ke tahap binaan melalui input_task_id.
Sifat-sifat
Name
id
Type
string
Description
Pengenal unik untuk tugas. Walaupun kami menggunakan UUID yang boleh diurutkan k-sebagai perincian pelaksanaan, anda tidak seharusnya membuat sebarang andaian tentang format id.
Name
type
Type
string
Description
Jenis tugas. Nilainya adalah 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 adalah salah satu dari PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Kemajuan tugas. Jika tugas belum dimulakan, sifat ini akan menjadi 0. Setelah tugas berjaya, ini akan menjadi 100.
Name
created_at
Type
timestamp
Description
Cap masa ketika 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 ketika tugas dimulakan, dalam milisaat. Jika tugas belum dimulakan, sifat ini akan menjadi 0.
Name
finished_at
Type
timestamp
Description
Cap masa ketika tugas selesai, dalam milisaat. Jika tugas belum selesai, sifat ini akan menjadi 0.
Name
expires_at
Type
timestamp
Description
Cap masa ketika hasil tugas tamat tempoh, dalam milisaat.
Name
preceding_tasks
Type
integer
Description
Bilangan tugas terdahulu.
Nilai medan ini hanya bermakna jika status tugas 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. Hadir apabila status tugas adalah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugas FAILED (kredit dikembalikan jika gagal).
Name
image_urls
Type
array of strings
Description
URL boleh dimuat turun untuk calon imej konsep yang dihasilkan oleh tugas prototip ini. Pada masa ini API sentiasa mengembalikan tepat satu calon; medan ini adalah array supaya semakan masa depan dapat menampilkan pelbagai calon tanpa perubahan yang merosakkan.
Objek Tugas Bina Figura adalah unit kerja yang Meshy jejak 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
Pengenal pasti unik untuk tugas ini.
Name
type
Type
string
Description
Jenis tugas. Nilainya adalah 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 adalah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Kemajuan tugas. Jika tugas belum dimulakan, sifat 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 dimulakan, 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 terdahulu. Bermakna hanya 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 semasa kegagalan).
Name
prompt
Type
string
Description
Sentiasa kosong untuk bina figura. Hadir 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. Hadir untuk keserasian rentas endpoint.
Name
texture_prompt
Type
string
Description
Sentiasa kosong untuk bina figura. Hadir untuk keserasian rentas endpoint.
Name
texture_image_url
Type
string
Description
Sentiasa kosong untuk bina figura. Hadir untuk keserasian rentas endpoint.
Name
model_urls
Type
object
Description
URL yang boleh dimuat turun untuk model 3D yang dijana. Bina figura mengeluarkan GLB bertekstur serta pasangan OBJ + MTL untuk saluran paip yang lebih suka Wavefront OBJ. Bentuk medan sepadan dengan objek Imej ke 3D model_urls supaya penambahan format masa depan boleh dimasukkan tanpa perubahan yang memecahkan.
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 pasangan OBJ. Pasangkan dengan obj dan entri dari 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
Satu array objek URL tekstur yang dijana oleh tugas 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.