Tukar foto sumber menjadi figura mini 3D gaya bata secara koleksi dalam dua peringkat:
prototaip menjana imej konsep berstail daripada foto input anda, kemudian
pembinaan menukarkan imej konsep itu menjadi model 3D bertekstur. Kedua-dua peringkat
dihubungkan melalui input_task_id.
POST /openapi/creative-lab/brick-figure/v1/prototype
Hasilkan imej konsep gaya bata daripada foto sumber. ID tugas yang dikembalikan adalah apa yang anda berikan sebagai input_task_id kepada endpoint pembangunan. Rujuk kepada Objek Tugas Prototaip Figura Bata untuk bentuk respons.
Parameter
Name
image_url
Type
string
Diperlukan
Description
Foto sumber untuk Meshy gayakan sebagai minifigure bata. Kami kini menyokong format .jpg, .jpeg, .png, dan .webp.
Terdapat dua cara untuk memberikan imej:
URL boleh diakses secara public: URL yang boleh diakses dari internet awam.
Data URI: Data URI yang dikodkan base64 bagi imej. Contoh Data URI: data:image/jpeg;base64,<data imej yang dikodkan base64 anda>.
Name
name
Type
string
Description
Nama tugas pilihan untuk tujuan paparan. Maksimum 100 aksara.
Mengembalikan
Harta result daripada respons mengandungi ID tugas id tugas prototaip figura bata yang baru dibuat. Meminta kepada endpoint Get a Task atau langgan kepada stream sehingga tugas mencapai SUCCEEDED, kemudian berikan ID itu kepada endpoint pembangunan sebagai input_task_id.
Mod Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak boleh diterima. Penyebab umum:
Parameter hilang: image_url diperlukan.
Format imej tidak sah: image_url yang disediakan bukan format yang disokong (.jpg, .jpeg, .png, .webp).
Dimensi imej di luar jangkauan: 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.
Konten ditandai: Imej input ditandai oleh moderation NSFW atau harta intelektual.
Name
401 - Unauthorized
Description
Pengesahan gagal. Sila periksa kunci API anda.
Name
402 - Payment Required
Description
Kredit tidak mencukupi untuk melaksanakan tugas ini.
Name
403 - Forbidden
Description
Imej input telah ditandai kerana pelanggaran harta intelek.
Name
429 - Too Many Requests
Description
Anda telah melebihi had kadar anda.
Permintaan
POST
/openapi/creative-lab/brick-figure/v1/prototype
# Peringkat 1: hasilkan imej konsep gaya batacurl https://api.meshy.ai/openapi/creative-lab/brick-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>" }'
Hasilkan figura batu bata 3D terakhir yang mempunyai tekstur daripada tugas prototaip yang berjaya. Pembinaan menjalankan aliran kerja imej-ke-3D yang sama seperti Imej ke 3D, jadi format objek respons dan senarai URL output adalah sama. Rujuk kepada Objek Tugas Membina Figura Batu Bata untuk bentuk respons.
Parameter
Name
input_task_id
Type
string
Diperlukan
Description
ID tugas bagi tugas prototaip yang dibuat melalui endpoint OpenAPI ini. Prototaip mesti telah dicipta dengan kunci API yang sama, mesti telah mencapai SUCCEEDED, dan mesti menghasilkan tepat satu imej calon.
Tugas prototaip yang dibuat melalui aplikasi web tidak diterima — endpoint binaan hanya menerima tugas prototaip yang dihasilkan oleh POST /openapi/creative-lab/brick-figure/v1/prototype dan menolak sebarang 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 binaan figura batu bata yang baru dicipta. Polling endpoint Dapatkan Tugas atau melanggan aliran sehingga tugas mencapai SUCCEEDED, kemudian muat turun GLB tekstur daripada model_urls.glb (atau pasangan OBJ + MTL daripada model_urls.obj dan model_urls.mtl jika aliran kerja 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 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, milik pengguna lain, atau dicipta melalui aplikasi web (hanya tugas prototaip mode API bersarang dalam binaan).
Name
429 - Too Many Requests
Description
Anda telah melebihi had kadar anda.
Request
POST
/openapi/creative-lab/brick-figure/v1/build
# Stage 2: sambungkan binaan dari tugas prototaip yang berjayacurl https://api.meshy.ai/openapi/creative-lab/brick-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" }'
Mendapatkan tugas prototaip atau binaan yang diberikan id tugas yang sah. Laluan URL
mesti sepadan dengan tahap tugas — tugas binaan yang diambil melalui
/prototype/:id akan mengembalikan 404, dan sebaliknya.
Batalkan tugasan figura batu bata. Jika tugas tersebut masih PENDING, kredit yang
digunakan semasa buat-masa akan dikembalikan. Tugasan yang sudah
IN_PROGRESS dibatalkan tanpa bayaran balik (pekerja mungkin sudah menggunakan sumber). Tugasan yang telah mencapai keadaan terminal
(SUCCEEDED, FAILED, CANCELED) tidak boleh dibatalkan.
Laluan URL mesti memadankan peringkat tugas — DELETE pada
/prototype/:buildId mengembalikan 404.
Parameter Laluan
Name
id
Type
path
Description
Pengenal unik untuk tugas figura batu bata untuk dibatalkan.
Pemulangan
Mengembalikan 204 No Content apabila berjaya dengan badan kosong.
Mod Kegagalan
Name
400 - Bad Request
Description
Tugasan sudah berada dalam keadaan terminal dan tidak dapat dibatalkan.
Name
404 - Not Found
Description
Tugasan tidak wujud, milik pengguna lain, atau tahapnya tidak sepadan dengan laluan URL.
Menstrim perkembangan masa nyata bagi tugas figura batu bata melalui Server-Sent Events (SSE).
Laluan URL mesti sepadan dengan peringkat tugas — membuka aliran pada
/prototype/:buildId/stream mengeluarkan event: error payload dengan
status_code: 404 dan menutup aliran.
Parameter
Name
id
Type
path
Description
Pengenal unik untuk tugas figura batu bata untuk menstrim.
Pulangan
Mengembalikan aliran objek tugas Brick Figure Prototype
atau Brick Figure Build sebagai
Server-Sent Events. Untuk tugas PENDING atau IN_PROGRESS, aliran 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 menunjukkan kemajuan tugas.// Untuk tugas PENDING atau IN_PROGRESS, aliran respons tidak akan merangkumi semua medan.event: messagedata: {"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb","progress": 0,"status": "PENDING"}event: messagedata: {"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb","type": "creative-lab-brick-figure-build","status": "SUCCEEDED","progress": 100,"created_at": 1729123500000,"started_at": 1729123510000,"finished_at": 1729123535000,"expires_at": 1729382735000,"task_error": null,"consumed_credits": 30,"prompt": "","negative_prompt": "","texture_prompt": "","texture_image_url": "","model_urls": {"glb":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***","obj":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***","mtl":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***" },"thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***","texture_urls": [ {"base_color":"https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***" } ]}
Dapatkan senarai berpenomboran halaman tugasan figura brick anda untuk satu peringkat. Laluan URL
memilih peringkat — /prototype memulangkan tugasan prototype; /build
memulangkan tugasan bina. Tugasan dari peringkat lain tidak disertakan dalam kedua-dua
respons.
Parameter Laluan
Name
stage
Type
path
Diperlukan
Description
Sama ada prototype atau build. Koleksi ini hanya memulangkan tugasan
yang peringkatnya sama dengan URL — mendapatkan /prototype tidak akan memulangkan
tugasan build dan sebaliknya.
Parameter Pertanyaan
Name
page_num
Type
integer
lalai 1
Description
Nombor muka surat untuk penomboran halaman.
Name
page_size
Type
integer
lalai 10
Description
Had saiz muka surat. Maksimum dibenarkan adalah 100 item.
Name
sort_by
Type
string
lalai -created_at
Description
Medan untuk pengisihan. Nilai yang tersedia:
+created_at: Selesaikan mengikut masa penciptaan dalam tertib menaik.
-created_at: Selesaikan mengikut masa penciptaan dalam tertib menurun.
Objek Tugasan Prototaip Figura Bata adalah unit kerja yang Meshy pantau untuk
menjana imej konsep gaya bata daripada foto sumber. Hasil daripada
tahap ini dirangkaikan kepada tahap bina
melalui input_task_id.
Properti
Name
id
Type
string
Description
Pengenal unik untuk tugasan. Walaupun kami menggunakan UUID yang boleh disusun untuk id tugasan sebagai perincian pelaksanaan, anda tidak perlu membuat sebarang andaian tentang format id tersebut.
Name
type
Type
string
Description
Jenis tugasan. Nilainya adalah creative-lab-brick-figure-prototype.
Name
name
Type
string
Description
Nama tugasan yang diberikan semasa tugas dicipta. String kosong jika tiada nama diberikan.
Name
status
Type
string
Description
Status tugasan. Nilai yang mungkin adalah salah satu PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Kemajuan tugasan. Jika tugasan belum bermula, properti 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, properti ini akan menjadi null.
Name
finished_at
Type
timestamp
Description
Cap masa apabila tugasan selesai, dalam milisaat. Jika tugasan belum selesai, properti ini akan menjadi null.
Name
expires_at
Type
timestamp
Description
Cap masa apabila hasil tugasan tamat, dalam milisaat.
Name
preceding_tasks
Type
integer
Description
Bilangan tugasan terdahulu.
Nilai bagi medan ini hanya bermakna 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 yang digunakan oleh tugasan ini. Hadir apabila status tugasan adalah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugasan FAILED (kredit akan dikembalikan jika gagal).
Name
image_urls
Type
array of strings
Description
URL boleh dimuat turun untuk calon imej konsep yang dijana oleh tugasan prototaip ini. Pada masa ini, API sentiasa mengembalikan tepat satu calon; medan ini adalah array supaya semakan masa hadapan dapat menampilkan beberapa calon tanpa perubahan besar.
Objek Tugasan Bina Figura Bata adalah unit kerja yang Meshy pantau untuk menghasilkan figura bata 3D bertekstur daripada tugasan prototaip yang SUCCEEDED. Ia menggunakan saluran paip imej-ke-3D yang sama seperti yang digunakan oleh Imej ke 3D, jadi medan keluaran mencerminkan objek tugasan endpoint tersebut.
Properties
Name
id
Type
string
Description
Pengenal unik untuk tugasan ini.
Name
type
Type
string
Description
Jenis tugasan. Nilainya adalah creative-lab-brick-figure-build.
Name
name
Type
string
Description
Nama tugasan yang diberikan semasa tugasan dicipta. Rentetan kosong jika tiada nama yang diberikan.
Name
status
Type
string
Description
Status tugasan. Nilai yang mungkin adalah salah satu dari PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress tugasan. Jika tugasan belum bermula, nilai ini akan menjadi 0. Setelah tugasan berjaya, nilai ini akan menjadi 100.
Name
created_at
Type
timestamp
Description
Cap masa ketika tugasan dicipta, dalam milisaat.
Name
started_at
Type
timestamp
Description
Cap masa ketika tugasan dimulakan, dalam milisaat.
Name
finished_at
Type
timestamp
Description
Cap masa ketika tugasan selesai, dalam milisaat.
Name
expires_at
Type
timestamp
Description
Cap masa ketika hasil tugasan akan tamat, dalam milisaat.
Name
preceding_tasks
Type
integer
Description
Bilangan tugasan terdahulu. Bermakna hanya apabila status adalah PENDING.
Name
task_error
Type
object
Description
Butiran ralat untuk tugasan yang gagal. Lihat Ralat untuk rujukan objek lengkap task_error.
Name
consumed_credits
Type
integer
Description
Bilangan kredit yang digunakan oleh tugasan ini. Mengembalikan 0 untuk tugasan FAILED (kredit dikembalikan jika gagal).
Name
prompt
Type
string
Description
Sentiasa kosong untuk pembinaan figura bata. Hadir untuk keserasian antara endpoint dengan bentuk V2ImageTo3DTaskResponse yang dikongsi digunakan oleh Imej ke 3D.
Name
negative_prompt
Type
string
Description
Sentiasa kosong untuk pembinaan figura bata. Hadir untuk keserasian antara endpoint.
Name
texture_prompt
Type
string
Description
Sentiasa kosong untuk pembinaan figura bata. Hadir untuk keserasian antara endpoint.
Name
texture_image_url
Type
string
Description
Sentiasa kosong untuk pembinaan figura bata. Hadir untuk keserasian antara endpoint.
Name
model_urls
Type
object
Description
URL yang boleh dimuat turun untuk model 3D yang dihasilkan. Pembinaan figura bata menghasilkan GLB tekstur serta pasangan OBJ + MTL untuk saluran paip yang lebih memilih Wavefront OBJ. Bentuk medan memadankan Imej ke 3D model_urls supaya penambahan format masa depan dapat disertakan tanpa perubahan besar.
Name
glb
Type
string
Description
URL yang boleh dimuat turun untuk fail GLB tekstur.
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 teman 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
Array 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 untuk imej peta warna asas.