Tukarkan foto sumber kepada minifigura koleksi 3D bergaya bata 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.
POST /openapi/creative-lab/brick-figure/v1/prototype
Jana satu imej konsep bergaya bata daripada foto sumber. ID tugas yang
dikembalikan itulah yang anda hantar sebagai input_task_id kepada endpoint
build. Rujuk
The Brick Figure Prototype Task Object
untuk bentuk respons.
Parameter
Name
image_url
Type
string
Diperlukan
Description
Foto sumber untuk Meshy stylize sebagai minifigure bata. Kami kini menyokong format .jpg, .jpeg, .png, dan .webp.
Terdapat dua cara untuk memberikan 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 terenkod base64 anda>.
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 brick figure yang baru dicipta. 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. 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 kiraan 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 ditanda oleh moderation NSFW.
Name
401 - Unauthorized
Description
Pengesahan gagal. Sila semak kunci API anda.
Name
402 - Payment Required
Description
Kredit tidak mencukupi untuk melaksanakan tugas ini.
Name
403 - Forbidden
Description
Imej input ditanda kerana pelanggaran harta intelek.
Name
429 - Too Many Requests
Description
Anda telah melebihi had kadar anda.
Request
POST
/openapi/creative-lab/brick-figure/v1/prototype
# Stage 1: generate a brick-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/brick-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>" }'
Jana figura bata 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 Bata 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 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/brick-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 pembinaan figura bata yang baru dicipta. Poll endpoint Dapatkan Tugas atau langgan aliran 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 huluan 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 tidak berjaya: Tugas prototaip yang dirujuk belum lagi 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, dimiliki oleh pengguna lain, atau dicipta melalui webapp (hanya tugas prototaip mod API boleh dirangkaikan ke pembinaan).
Name
429 - Too Many Requests
Description
Anda telah melebihi had kadar anda.
Request
POST
/openapi/creative-lab/brick-figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578" }'
Dapatkan semula tugas prototaip atau build dengan id tugas yang sah. Laluan URL
mesti sepadan dengan peringkat tugas — tugas build yang diambil melalui
/prototype/:id akan mengembalikan 404, dan begitu juga sebaliknya.
Batalkan tugasan brick figure. Jika tugasan masih PENDING, kredit
yang digunakan pada masa pembuatan akan dikembalikan. Tugasan yang sudah
IN_PROGRESS dibatalkan tanpa bayaran balik (pekerja mungkin sudah
menggunakan sumber). Tugasan yang sudah mencapai keadaan akhir
(SUCCEEDED, FAILED, CANCELED) tidak boleh dibatalkan.
Laluan URL mesti sepadan dengan peringkat tugasan — DELETE pada
/prototype/:buildId akan mengembalikan 404.
Parameter Laluan
Name
id
Type
path
Description
Pengenal unik untuk tugasan brick figure yang hendak dibatalkan.
Pulangan
Mengembalikan 204 No Content apabila berjaya dengan badan kosong.
Mod Kegagalan
Name
400 - Bad Request
Description
Tugasan sudah berada dalam keadaan akhir dan tidak boleh dibatalkan.
Name
404 - Not Found
Description
Tugasan tidak wujud, dimiliki oleh pengguna lain, atau peringkatnya tidak sepadan dengan laluan URL.
Strim kemas kini masa nyata untuk tugas brick figure melalui Server-Sent Events (SSE).
Laluan URL mesti sepadan dengan peringkat tugas — membuka strim di
/prototype/:buildId/stream akan menghasilkan satu event: error payload dengan
status_code: 404 dan menutup strim tersebut.
Parameter
Name
id
Type
path
Description
Pengenal unik untuk tugas brick figure yang akan distrim.
Pulangan
Mengembalikan strim objek tugas Brick Figure Prototype
atau Brick Figure Build sebagai
Server-Sent Events. Setiap frame 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 tugas figura bata anda yang telah dibahagikan kepada halaman bagi satu peringkat. Laluan URL
memilih peringkat tersebut — /prototype mengembalikan tugas prototaip; /build
mengembalikan tugas binaan. Tugas dari 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 tugas
yang peringkatnya sepadan dengan URL — mengambil /prototype tidak akan pernah 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 adalah 100 item.
Name
sort_by
Type
string
lalai -created_at
Description
Medan untuk disusun mengikut. Nilai yang tersedia:
+created_at: Susun mengikut masa penciptaan secara menaik.
-created_at: Susun mengikut masa penciptaan secara menurun.
Objek Task Prototaip Brick Figure ialah unit kerja yang dikesan oleh Meshy untuk
menjana imej konsep bergaya brick daripada foto sumber. Output peringkat
ini dirantai ke dalam peringkat pembinaan
melalui input_task_id.
Ciri-ciri
Name
id
Type
string
Description
Pengecam unik untuk task. Walaupun kami menggunakan UUID yang boleh disusun-k (k-sortable) untuk id task sebagai butiran pelaksanaan, anda tidak seharusnya membuat sebarang andaian tentang format id tersebut.
Name
type
Type
string
Description
Jenis task. Nilainya ialah creative-lab-brick-figure-prototype.
Name
name
Type
string
Description
Nama task yang diberikan semasa task dicipta. Rentetan kosong jika tiada nama diberikan.
Name
status
Type
string
Description
Status task. Nilai yang mungkin ialah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress task. Jika task belum bermula lagi, ciri ini akan menjadi 0. Setelah task berjaya, ini akan menjadi 100.
Name
created_at
Type
timestamp
Description
Cap masa bila task 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 bila task dimulakan, dalam milisaat. Jika task belum dimulakan lagi, ciri ini akan menjadi null.
Name
finished_at
Type
timestamp
Description
Cap masa bila task selesai, dalam milisaat. Jika task belum selesai lagi, ciri ini akan menjadi null.
Name
expires_at
Type
timestamp
Description
Cap masa bila hasil task tamat tempoh, dalam milisaat.
Name
preceding_tasks
Type
integer
Description
Bilangan task terdahulu.
Nilai medan ini hanya bermakna jika status task ialah PENDING.
Name
task_error
Type
object
Description
Butiran ralat untuk task yang gagal. Lihat Ralat untuk rujukan penuh objek task_error.
Name
consumed_credits
Type
integer
Description
Bilangan kredit yang digunakan oleh task ini. Wujud apabila status task ialah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk task FAILED (kredit dikembalikan semula apabila gagal).
Name
image_urls
Type
array of strings
Description
URL yang boleh dimuat turun untuk calon imej konsep yang dijana oleh task prototaip ini. Pada masa ini API sentiasa mengembalikan tepat satu calon; medan ini adalah array supaya semakan masa hadapan boleh memaparkan pelbagai calon tanpa perubahan yang memecahkan keserasian.
Objek Tugas Bina Figura Bata ialah unit kerja yang dijejaki oleh Meshy untuk
menghasilkan figura bata 3D bertekstur daripada tugas prototaip yang berjaya. Ia
menjalankan saluran paip imej-ke-3D yang sama seperti yang digunakan oleh Imej ke 3D,
jadi medan output mencerminkan objek tugas endpoint tersebut.
Sifat
Name
id
Type
string
Description
Pengenal unik untuk tugas.
Name
type
Type
string
Description
Jenis tugas. Nilainya ialah creative-lab-brick-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 dimulakan, sifat ini akan menjadi 0. Setelah tugas berjaya, ia akan menjadi 100.
Name
created_at
Type
timestamp
Description
Cap masa tugas dicipta, dalam milisaat.
Name
started_at
Type
timestamp
Description
Cap masa tugas dimulakan, dalam milisaat.
Name
finished_at
Type
timestamp
Description
Cap masa tugas selesai, dalam milisaat.
Name
expires_at
Type
timestamp
Description
Cap masa hasil tugas tamat tempoh, dalam milisaat.
Name
preceding_tasks
Type
integer
Description
Bilangan tugas yang mendahului. Bermakna hanya apabila status 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. Mengembalikan 0 untuk tugas FAILED (kredit dikembalikan apabila gagal).
Name
prompt
Type
string
Description
Sentiasa kosong untuk bina figura bata. Hadir 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 bata. Hadir untuk keserasian merentas endpoint.
Name
texture_prompt
Type
string
Description
Sentiasa kosong untuk bina figura bata. Hadir untuk keserasian merentas endpoint.
Name
texture_image_url
Type
string
Description
Sentiasa kosong untuk bina figura bata. Hadir untuk keserasian merentas endpoint.
Name
model_urls
Type
object
Description
URL yang boleh dimuat turun untuk model 3D yang dihasilkan. Bina figura bata menghasilkan GLB bertekstur ditambah pasangan OBJ + MTL untuk saluran paip yang lebih suka Wavefront OBJ. Bentuk medan 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 rakan OBJ. Padankan 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 dihasilkan oleh tugas 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.