Ubah foto sumber menjadi minifigur 3D koleksi bergaya bata dalam dua tahap: prototipe menghasilkan gambar konsep yang bergaya dari foto input Anda, kemudian build mengubah gambar konsep tersebut menjadi model 3D yang memiliki texture. Kedua tahap ini terhubung melalui input_task_id.
POST /openapi/creative-lab/brick-figure/v1/prototype
Hasilkan gambar konsep gaya brick dari foto sumber. ID tugas yang dikembalikan adalah yang Anda berikan sebagai input_task_id ke endpoint bangun. Lihat
The Brick Figure Prototype Task Object
untuk bentuk responsnya.
Parameter
Name
image_url
Type
string
Wajib
Description
Foto sumber untuk Meshy agar dapat dibuat menjadi minifigure brick. Saat ini kami mendukung format .jpg, .jpeg, .png, dan .webp.
Ada dua cara untuk menyediakan gambar:
URL yang dapat diakses publik: URL yang dapat diakses dari internet publik.
Data URI: URI data yang dikodekan dalam base64 dari gambar. Contoh Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
Nama tugas opsional untuk keperluan tampilan. Maksimum 100 karakter.
Mengembalikan
Properti result dari respons berisi ID tugas id dari tugas prototipe figur brick yang baru dibuat. Lakukan polling pada endpoint Dapatkan Tugas atau berlangganan ke stream sampai tugas mencapai SUCCEEDED, kemudian berikan ID tersebut ke endpoint bangun sebagai input_task_id.
Mode Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak dapat diterima. Penyebab umum:
Parameter hilang: image_url diperlukan.
Format gambar tidak valid: image_url yang diberikan bukan format yang didukung (.jpg, .jpeg, .png, .webp).
Dimensi gambar di luar jangkauan: Gambar terlalu kecil, melebihi ukuran file maksimum, atau melebihi jumlah piksel maksimum.
URL tidak dapat dijangkau: image_url tidak bisa diunduh (404 atau timeout).
Data URI tidak valid: String base64 rusak.
Konten ditandai: Gambar input ditandai oleh moderation NSFW atau hak kekayaan intelektual.
Name
401 - Unauthorized
Description
Autentikasi gagal. Silakan periksa kunci API Anda.
Name
402 - Payment Required
Description
Kredit tidak mencukupi untuk melakukan tugas ini.
Name
403 - Forbidden
Description
Gambar input ditandai karena pelanggaran kekayaan intelektual.
Name
429 - Too Many Requests
Description
Anda telah melebihi batas laju Anda.
Request
POST
/openapi/creative-lab/brick-figure/v1/prototype
# Tahap 1: hasilkan gambar konsep gaya brickcurl 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>" }'
Menghasilkan figur bata 3D bertekstur akhir dari tugas prototipe yang berhasil. Pembangunan menjalankan alur kerja gambar-ke-3D yang sama seperti Gambar ke 3D, sehingga format objek respons dan daftar URL output cocok persis. Merujuk ke Objek Tugas Pembangunan Figur Bata untuk bentuk respons.
Parameter
Name
input_task_id
Type
string
Wajib
Description
ID tugas dari tugas prototipe yang dibuat melalui endpoint OpenAPI yang sama ini. Prototipe harus telah dibuat dengan kunci API yang sama, harus mencapai SUCCEEDED, dan harus memproduksi satu gambar kandidat.
Tugas prototipe yang dibuat melalui aplikasi web tidak diterima — endpoint pembangunan hanya menerima tugas prototipe yang dihasilkan oleh POST /openapi/creative-lab/brick-figure/v1/prototype dan menolak sumber lain dengan 404.
Name
name
Type
string
Description
Nama tugas opsional untuk tujuan tampilan. Maksimal 100 karakter.
Pengembalian
Properti result dari respons berisi id tugas dari tugas pembangunan figur bata baru yang dibuat. Memantau Dapatkan Tugas endpoint atau berlangganan ke stream sampai tugas mencapai SUCCEEDED, lalu unduh GLB bertekstur dari model_urls.glb (atau pasangan OBJ + MTL dari model_urls.obj dan model_urls.mtl jika alur kerja hilir Anda lebih memilih OBJ).
Mode Kegagalan
Name
400 - Bad Request
Description
Permintaan tidak dapat diterima. Penyebab umum:
Parameter hilang: input_task_id diperlukan.
UUID tidak valid: input_task_id bukan UUID yang valid.
Induk tidak berhasil: Tugas prototipe yang direferensikan belum mencapai SUCCEEDED.
Tidak ada kandidat: Tugas prototipe berhasil tetapi tidak menghasilkan gambar kandidat.
Name
401 - Unauthorized
Description
Autentikasi gagal. Silakan periksa kunci API Anda.
Name
402 - Payment Required
Description
Kredit tidak mencukupi untuk melakukan tugas ini.
Name
404 - Not Found
Description
Tugas prototipe yang direferensikan tidak ada, milik pengguna lain, atau dibuat melalui aplikasi web (hanya tugas prototipe mode API yang berantai ke pembangunan).
Name
429 - Too Many Requests
Description
Anda telah melebihi batas laju.
Request
POST
/openapi/creative-lab/brick-figure/v1/build
# Tahap 2: melanjutkan pembangunan dari tugas prototipe yang berhasilcurl 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" }'
Mengambil tugas prototipe atau build yang diberikan id tugas yang valid. Jalur URL
harus sesuai dengan tahapan tugas — tugas build yang diambil melalui
/prototype/:id akan mengembalikan 404, dan sebaliknya.
Batalkan tugas figur brick. Jika tugas masih PENDING, kredit yang digunakan pada saat pembuatan akan dikembalikan. Tugas yang sudah IN_PROGRESS dibatalkan tanpa pengembalian dana (pekerja mungkin sudah mulai menggunakan sumber daya). Tugas yang sudah mencapai status akhir (SUCCEEDED, FAILED, CANCELED) tidak dapat dibatalkan.
Jalur URL harus sesuai dengan tahap tugas — DELETE pada
/prototype/:buildId akan mengembalikan 404.
Parameter Jalur
Name
id
Type
path
Description
Pengidentifikasi unik untuk tugas figur brick yang akan dibatalkan.
Pengembalian
Mengembalikan 204 No Content pada keberhasilan dengan isi kosong.
Mode Kegagalan
Name
400 - Bad Request
Description
Tugas sudah dalam status akhir dan tidak dapat dibatalkan.
Name
404 - Not Found
Description
Tugas tidak ada, milik pengguna lain, atau tahapannya tidak sesuai dengan jalur URL.
Streaming pembaruan waktu nyata untuk tugas figur batu bata melalui Server-Sent Events (SSE).
Jalur URL harus sesuai dengan tahapan tugas — membuka stream di
/prototype/:buildId/stream akan mengirimkan satu event: error payload dengan
status_code: 404 dan menutup stream.
Parameter
Name
id
Type
path
Description
Pengidentifikasi unik untuk tugas figur batu bata yang akan di-stream.
Mengembalikan
Mengembalikan stream dari objek tugas Prototipe Figur Batu Bata
atau Bangunan Figur Batu Bata sebagai
Server-Sent Events. Untuk tugas PENDING atau IN_PROGRESS, stream respons
hanya akan menyertakan bidang progress dan status yang diperlukan.
Ambil daftar paginasi dari tugas figur brick Anda untuk satu tahap. Jalur URL
memilih tahap — /prototype mengembalikan tugas prototipe; /build
mengembalikan tugas build. Tugas dari tahap lain tidak termasuk dalam
masing-masing tanggapan.
Parameter Jalur
Name
stage
Type
path
Wajib
Description
Baik prototype maupun build. Koleksi hanya mengembalikan tugas
yang tahapannya cocok dengan URL — mengambil /prototype tidak pernah mengembalikan
tugas build dan sebaliknya.
Parameter Query
Name
page_num
Type
integer
default 1
Description
Nomor halaman untuk paginasi.
Name
page_size
Type
integer
default 10
Description
Batas ukuran halaman. Maksimum yang diizinkan adalah 100 item.
Name
sort_by
Type
string
default -created_at
Description
Bidang untuk mengurutkan. Nilai yang tersedia:
+created_at: Urutkan berdasarkan waktu pembuatan dalam urutan naik.
-created_at: Urutkan berdasarkan waktu pembuatan dalam urutan turun.
# Daftar tugas prototipecurl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype?page_size=10 \ -H "Authorization: Bearer ${YOUR_API_KEY}"# Daftar tugas buildcurl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build?page_size=10 \ -H "Authorization: Bearer ${YOUR_API_KEY}"
Objek Tugas Prototipe Figur Bata adalah unit kerja yang dicatat oleh Meshy untuk
menghasilkan gambar konsep bergaya bata dari foto sumber. Hasil dari
tahap ini digabungkan ke tahap pembangunan
melalui input_task_id.
Properti
Name
id
Type
string
Description
Pengidentifikasi unik untuk tugas. Meskipun kami menggunakan UUID yang dapat diurutkan secara k untuk id tugas sebagai detail implementasi, Anda tidak seharusnya membuat asumsi apapun tentang format id tersebut.
Name
type
Type
string
Description
Tipe dari tugas. Nilainya adalah creative-lab-brick-figure-prototype.
Name
name
Type
string
Description
Nama tugas yang diberikan saat tugas dibuat. String kosong jika tidak ada nama yang disediakan.
Name
status
Type
string
Description
Status dari tugas. Nilai yang mungkin adalah salah satu dari PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress dari tugas. Jika tugas belum dimulai, properti ini akan bernilai 0. Setelah tugas berhasil, ini akan menjadi 100.
Name
created_at
Type
timestamp
Description
Stempel waktu saat tugas dibuat, dalam milidetik.
Stempel waktu merepresentasikan jumlah milidetik yang berlalu sejak 1 Januari 1970 UTC, mengikuti
standar RFC 3339.
Sebagai contoh, Jumat, 1 September 2023 12:00:00 PM GMT direpresentasikan sebagai 1693569600000. Ini berlaku
untuk semua stempel waktu dalam Meshy API.
Name
started_at
Type
timestamp
Description
Stempel waktu saat tugas dimulai, dalam milidetik. Jika tugas belum dimulai, properti ini akan bernilai null.
Name
finished_at
Type
timestamp
Description
Stempel waktu saat tugas selesai, dalam milidetik. Jika tugas belum selesai, properti ini akan bernilai null.
Name
expires_at
Type
timestamp
Description
Stempel waktu saat hasil tugas kedaluwarsa, dalam milidetik.
Name
preceding_tasks
Type
integer
Description
Jumlah tugas sebelumnya.
Nilai dari bidang ini bermakna hanya jika status tugas adalah PENDING.
Name
task_error
Type
object
Description
Detail kesalahan untuk tugas yang gagal. Lihat Kesalahan untuk referensi lengkap objek task_error.
Name
consumed_credits
Type
integer
Description
Jumlah kredit yang dikonsumsi oleh tugas ini. Ada saat 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 yang dapat diunduh untuk kandidat gambar konsep yang dihasilkan oleh tugas prototipe ini. Saat ini API selalu mengembalikan tepat satu kandidat; bidang ini adalah array sehingga revisi di masa mendatang dapat menampilkan beberapa kandidat tanpa perubahan yang merusak.
Objek Tugas Pembangunan Figur Batu Bata adalah unit kerja yang dipantau oleh Meshy untuk
menghasilkan figur batu bata 3D dengan tekstur dari tugas prototipe yang SUCCEEDED. Ini
menggunakan jalur gambar-ke-3D yang sama seperti yang digunakan oleh Gambar ke 3D,
sehingga field outputnya mencerminkan objek tugas dari endpoint tersebut.
Properti
Name
id
Type
string
Description
Pengenal unik untuk tugas tersebut.
Name
type
Type
string
Description
Tipe tugas. Nilainya adalah creative-lab-brick-figure-build.
Name
name
Type
string
Description
Nama tugas yang disediakan saat tugas dibuat. String kosong jika tidak ada nama yang disediakan.
Name
status
Type
string
Description
Status tugas. Nilai yang mungkin adalah salah satu PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Kemajuan tugas. Jika tugas belum dimulai, properti ini akan bernilai 0. Setelah tugas berhasil, nilai ini akan menjadi 100.
Name
created_at
Type
timestamp
Description
Stempel waktu saat tugas dibuat, dalam milidetik.
Name
started_at
Type
timestamp
Description
Stempel waktu saat tugas dimulai, dalam milidetik.
Name
finished_at
Type
timestamp
Description
Stempel waktu saat tugas selesai, dalam milidetik.
Name
expires_at
Type
timestamp
Description
Stempel waktu saat hasil tugas akan kedaluwarsa, dalam milidetik.
Name
preceding_tasks
Type
integer
Description
Jumlah tugas yang ada sebelumnya. Bermakna hanya saat status adalah PENDING.
Name
task_error
Type
object
Description
Detail kesalahan untuk tugas yang gagal. Lihat Errors untuk referensi objek task_error lengkap.
Name
consumed_credits
Type
integer
Description
Jumlah kredit yang digunakan oleh tugas ini. Mengembalikan 0 untuk tugas FAILED (kredit dikembalikan jika gagal).
Name
prompt
Type
string
Description
Selalu kosong untuk pembangunan figur bata. Ada untuk kompatibilitas antar endpoint dengan bentuk V2ImageTo3DTaskResponse yang digunakan oleh Gambar ke 3D.
Name
negative_prompt
Type
string
Description
Selalu kosong untuk pembangunan figur bata. Ada untuk kompatibilitas antar endpoint.
Name
texture_prompt
Type
string
Description
Selalu kosong untuk pembangunan figur bata. Ada untuk kompatibilitas antar endpoint.
Name
texture_image_url
Type
string
Description
Selalu kosong untuk pembangunan figur bata. Ada untuk kompatibilitas antar endpoint.
Name
model_urls
Type
object
Description
URL yang dapat diunduh untuk model 3D yang dihasilkan. Pembangunan figur bata mengeluarkan GLB bertekstur plus pasangan OBJ + MTL untuk pipeline yang lebih memilih Wavefront OBJ. Bentuk bidang sesuai dengan objek Image to 3D model_urls sehingga penambahan format di masa depan tidak menyebabkan perubahan yang memutus.
Name
glb
Type
string
Description
URL yang dapat diunduh ke file GLB bertekstur.
Name
obj
Type
string
Description
URL yang dapat diunduh ke file Wavefront OBJ (geometri + UV).
Name
mtl
Type
string
Description
URL yang dapat diunduh ke file material MTL pasangan OBJ. Pasangkan dengan obj dan entri dari texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
URL yang dapat diunduh ke gambar thumbnail file model.
Name
texture_urls
Type
array
Description
Sebuah array objek URL tekstur yang dihasilkan oleh tugas ini. Saat ini berisi satu objek dengan peta warna dasar.
Name
base_color
Type
string
Description
URL yang dapat diunduh ke gambar peta warna dasar.