API Lampu Creative Lab

Foto yang menjadi dasar kap lampu, berupa URL publik atau data URI (data:image/jpeg;base64,<data gambar Anda yang dienkode base64>).

Gambar harus berupa file JPG, JPEG, PNG, atau WebP dengan ukuran maksimal 20 MB.

Jenis subjek dalam foto, yang menentukan bagaimana Meshy menstilasikannya.

Nilai yang tersedia:

• character: satu karakter atau objek tunggal, seperti figur, hewan, atau maskot
• landscape: sebuah pemandangan luar ruangan atau panorama, seperti gunung, lanskap kota, atau hutan

Nama untuk tugas, hingga 100 karakter. Nama ini dikembalikan pada kolom name tugas. Nama yang lebih panjang akan mengembalikan 400.

Apakah akan menghapus latar belakang dari gambar prototipe. true mengembalikan PNG RGBA transparan, sehingga Anda dapat menempatkan subjek pada latar belakang apa pun. Meshy juga membangun model 3D dari gambar tanpa latar belakangnya. Jika Meshy tidak dapat menghapus latar belakang, Meshy akan menggunakan gambar dengan latar belakangnya, dan tugas tetap berhasil.

Permintaan tidak dapat dijalankan. Misalnya:

• image_url tidak ada.
• Gambar bukan file JPG, JPEG, PNG, atau WebP.
• Gambar terlalu kecil, lebih dari 20 MB, atau melebihi jumlah piksel maksimum.
• Meshy tidak dapat mengunduh gambar, misalnya karena URL mengembalikan 404 atau waktu habis (timeout).
• Data URI bukan base64 yang valid.
• Gambar ditandai sebagai NSFW.
• image_subject bukan character atau landscape.

Pesan error menunjukkan masalah apa yang ditemukan. Perbaiki permintaan, lalu kirim ulang.

Kunci API tidak ada atau tidak valid. Periksa header Authorization.

Salah satu dari hal berikut berlaku:

• Akun tidak memiliki cukup kredit.
• Kunci API, ruang kerja, atau anggota telah mencapai batas kreditnya.
• Akun menggunakan paket gratis.

Periksa kredit dan paket Anda, lalu coba lagi.

Tim Anda mengaktifkan IP Filtering, dan Meshy menandai gambar tersebut terkait kekayaan intelektual pihak ketiga. Kirim gambar yang memang berhak Anda gunakan.

Salah satu batas berikut telah tercapai:

• Anda mengirim lebih banyak permintaan daripada yang diizinkan oleh batas laju Anda. Tunggu beberapa detik, lalu coba lagi. Lihat Batas laju.
• Terlalu banyak tugas Anda yang sedang antre atau berjalan. Tunggu hingga beberapa selesai, lalu coba lagi.
• Pada paket tak terbatas tanpa sisa kredit, Anda telah mencapai jumlah tugas yang dapat berjalan tanpa kredit. Tunggu hingga sebuah tugas selesai, atau tambahkan kredit.

Meshy mengalami kesalahan server, misalnya karena tidak dapat menjalankan pemeriksaan kekayaan intelektual pada gambar. Meshy tidak membuat tugas tersebut, dan mengembalikan kredit apa pun yang telah dibebankan. Coba kirim ulang permintaan tersebut.

ID dari tugas prototipe yang akan di-build. ID ini harus berupa tugas yang dibuat oleh akun Anda dengan POST /openapi/creative-lab/lamp/v1/prototype, dengan status SUCCEEDED.

ID yang bukan merupakan salah satu tugas prototipe Lamp Anda dari API akan mengembalikan 404, termasuk prototipe yang dibuat di aplikasi web.

Nama untuk tugas tersebut, hingga 100 karakter. Nama ini akan muncul kembali di kolom name tugas. Nama yang lebih panjang akan mengembalikan 400.

Ukuran dimensi terbesar kap lampu, dalam milimeter, dari 50 hingga 400. Meshy menskalakan model secara merata agar sesuai. 0 menggunakan nilai default, dan nilai lain di luar rentang akan mengembalikan 400.

Ketebalan dinding kap lampu, dalam milimeter, hingga 10. 0 menggunakan nilai default, dan nilai negatif atau nilai di atas 10 akan mengembalikan 400.

Persentase tinggi model yang dipotong rata di bagian bawah, dari 1 hingga 100. Bagian bawah yang rata memungkinkan kap lampu berdiri di atas print bed dan menyisakan ruang untuk fixture. Nilai di luar rentang akan mengembalikan 400.

Preset fixture lampu, yang menentukan bagaimana Meshy membangun bagian bawah.

Nilai yang tersedia:

• bambu_mh001_60mm: kap lampu dengan bagian bawah terbuka dengan pelat dasar yang memiliki lubang fixture 60 mm, keduanya ada di model_urls.lamp_stl, dan dudukan fixture di model_urls.base_stl
• none: satu kap lampu tertutup tunggal di model_urls.lamp_stl, tanpa model_urls.base_stl

Seberapa jauh menggeser lubang fixture sepanjang sumbu X dari pusat kap lampu, dalam milimeter, dari -80 hingga 80. Berlaku hanya ketika light_source_preset bukan none.

Seberapa jauh menggeser lubang fixture sepanjang sumbu Z (kedalaman) dari pusat kap lampu, dalam milimeter, dari -80 hingga 80. Berlaku hanya ketika light_source_preset bukan none.

Rotasi di sekitar sumbu X yang diterapkan pada model sebelum Meshy memprosesnya, dalam derajat, dari -360 hingga 360. Meshy menerapkan ketiga rotasi sebagai sudut Euler XYZ di sekitar pusat model.

Rotasi di sekitar sumbu Y yang diterapkan pada model sebelum Meshy memprosesnya, dalam derajat, dari -360 hingga 360.

Rotasi di sekitar sumbu Z yang diterapkan pada model sebelum Meshy memprosesnya, dalam derajat, dari -360 hingga 360.

Apakah akan menambahkan berkas result.json ke paket zip, dengan nama pipeline yang dijalankan, peringatan, dan jalur berkas. Memerlukan output.format disetel ke zip. true dengan stl akan mengembalikan 400.

Berkas yang dikembalikan oleh build.

Nilai yang tersedia:

• stl: model_urls.lamp_stl, kap lampu beserta pelat dasarnya ketika ada preset fixture, dan model_urls.base_stl ketika light_source_preset bukan none
• zip: satu berkas zip di model_urls.bundle_zip, dengan lamp.stl, dan base.stl serta result.json ketika berlaku

Permintaan tidak dapat dijalankan. Contohnya:

• input_task_id hilang atau bukan ID tugas yang valid.
• Status tugas prototipe bukan SUCCEEDED. Jika masih berjalan, tunggu dan coba lagi. Jika gagal atau dibatalkan, buat tugas prototipe baru.
• Tugas prototipe berhasil tetapi tidak memiliki model 3D. Buat tugas prototipe baru.
• Kolom options berada di luar rentangnya atau bukan nilai yang tersedia.
• output.format bukan stl atau zip, atau include_result_json bernilai true tanpa zip.

Pesan error menunjukkan masalah mana yang ditemukan.

Kunci API hilang atau tidak valid. Periksa header Authorization.

Salah satu dari berikut ini berlaku:

• Akun tidak memiliki kredit yang cukup.
• Kunci API, ruang kerja, atau anggota telah mencapai batas kreditnya.
• Akun menggunakan paket gratis.

Periksa kredit dan paket Anda, lalu coba lagi.

input_task_id tidak cocok dengan tugas prototipe Lamp mana pun yang dibuat oleh akun Anda dengan API. Prototipe yang dibuat di aplikasi web juga akan mengembalikan 404. Kirimkan ID result dari respons pembuatan prototipe.

Salah satu batas berikut telah tercapai:

• Anda mengirim lebih banyak permintaan daripada yang diizinkan oleh batas laju Anda. Tunggu beberapa detik, lalu coba lagi. Lihat Rate limits.
• Terlalu banyak tugas Anda yang antre atau sedang berjalan. Tunggu hingga beberapa selesai, lalu coba lagi.
• Pada paket unlimited tanpa sisa kredit, Anda telah mencapai jumlah tugas yang dapat berjalan tanpa kredit. Tunggu hingga sebuah tugas selesai, atau tambahkan kredit.

ID task dari respons pembuatan (create).

id bukan ID task yang valid. Kirim ID result dari respons pembuatan (create).

Tim Anda telah mengaktifkan IP Filtering, dan Meshy menandai gambar task prototype tersebut karena mengandung kekayaan intelektual pihak ketiga. Task build dan tim pada paket Enterprise tidak mendapatkan error ini. Buat task prototype dari gambar yang hak penggunaannya Anda miliki.

Tidak ada Lamp task dengan ID ini yang dimiliki akun Anda, atau tahap task tidak sesuai dengan path. Periksa ID-nya, dan gunakan /prototype atau /build yang sesuai dengan task tersebut.

Meshy tidak dapat menjalankan pemeriksaan kekayaan intelektual. Coba lagi permintaan tersebut.

ID tugas yang akan dibatalkan.

Salah satu dari berikut berlaku:

• id bukan ID tugas yang valid. Kirimkan ID result dari respons pembuatan.
• Tugas sudah memiliki status akhir (SUCCEEDED, FAILED, atau CANCELED), sehingga tidak dapat dibatalkan.

Tidak ada tugas Lamp dengan ID ini yang dimiliki akun Anda, atau tahap tugas tidak cocok dengan path. Periksa ID, dan gunakan /prototype atau /build yang sesuai dengan tugas tersebut.

ID tugas dari respons pembuatan.

Tahap yang akan didaftar, prototype atau build.

Halaman yang akan dikembalikan, dari 1 hingga 255. 0 mengembalikan halaman pertama. Nilai di luar 0 hingga 255 akan mengembalikan 400.

Jumlah tugas per halaman, hingga 100. Nilai dari 101 hingga 255 akan mengembalikan 100 tugas, dan 0 menggunakan nilai default. Nilai di luar 0 hingga 255 akan mengembalikan 400.

Urutan pengurutan.

Nilai yang tersedia:

• -created_at: terbaru lebih dulu
• +created_at: terlama lebih dulu

ID tugas. Jangan bergantung pada formatnya.

Jenis tugas, selalu creative-lab-lamp-prototype.

name yang Anda kirim saat membuat tugas, atau "" jika Anda tidak mengirimkannya.

Status tugas.

Nilai yang tersedia:

• PENDING: menunggu di antrean
• IN_PROGRESS: sedang menghasilkan hasil
• SUCCEEDED: final, dengan hasil
• FAILED: final, dengan alasan di task_error
• CANCELED: final, tanpa hasil

Persentase pekerjaan yang telah selesai, dari 0 hingga 100. Nilainya 0 sampai tugas dimulai dan 100 saat berhasil.

Waktu tugas dibuat, dalam milidetik Unix.

Waktu sebuah worker memulai tugas, dalam milidetik Unix. null sebelum itu.

Waktu tugas mencapai status final, dalam milidetik Unix. null sebelum itu.

Waktu hasil tugas kedaluwarsa, dalam milidetik Unix. Nilainya 3 hari setelah finished_at, atau 3 hari setelah created_at hingga tugas selesai. Untuk akun Enterprise, yang menyimpan hasil API tanpa batas waktu, nilainya sekitar 100 tahun kemudian. Lihat Retensi aset.

Posisi tugas dalam antrean selama berstatus PENDING. 1 berarti tugas ini akan dimulai berikutnya. 0 setelah tugas keluar dari antrean, dan selalu 0 pada hasil daftar.

Alasan kegagalan tugas. null kecuali status adalah FAILED. Lihat Kesalahan.

Jumlah kredit yang dikenakan untuk tugas, setelah dikurangi pengembalian dana jika ada. Permintaan yang mengembalikan kesalahan tidak dikenakan biaya. Tugas yang gagal bernilai 0, karena Meshy mengembalikan dananya. Pembatalan hanya mengembalikan dana tugas selama tugas masih PENDING. Jika Meshy tidak dapat membaca biaya tersebut, respons get atau stream akan mengabaikan bidang ini, dan permintaan daftar akan mengembalikan 500. Dalam kasus itu, coba ulangi permintaannya.

URL unduhan untuk model 3D yang dihasilkan dari gambar konsep. {} hingga tugas berhasil.

URL unduhan untuk gambar pratinjau model 3D. "" hingga tugas berhasil.

URL unduhan untuk gambar konsep. Larik ini memiliki satu URL setelah tugas berhasil, dan kosong sebelum itu.

ID tugas. Jangan bergantung pada formatnya.

Jenis tugas, selalu creative-lab-lamp-build.

name yang Anda kirim saat membuat tugas, atau "" jika Anda tidak mengirimkannya.

Status tugas tersebut.

Nilai yang tersedia:

• PENDING: menunggu dalam antrean
• IN_PROGRESS: sedang menghasilkan hasil
• SUCCEEDED: final, dengan hasil
• FAILED: final, dengan alasan di task_error
• CANCELED: final, tanpa hasil

Persentase pekerjaan yang telah selesai, dari 0 hingga 100. Nilainya 0 hingga tugas dimulai dan 100 saat berhasil.

Waktu tugas dibuat, dalam milidetik Unix.

Waktu sebuah worker memulai tugas, dalam milidetik Unix. null hingga saat itu.

Waktu tugas mencapai status final, dalam milidetik Unix. null hingga saat itu.

Waktu hasil tugas kedaluwarsa, dalam milidetik Unix. Nilainya 3 hari setelah finished_at, atau 3 hari setelah created_at hingga tugas selesai. Untuk akun Enterprise, yang menyimpan hasil API tanpa batas waktu, nilainya sekitar 100 tahun kemudian. Lihat Retensi aset.

Posisi tugas dalam antrean selama berstatus PENDING. 1 berarti tugas ini akan dimulai berikutnya. 0 setelah tugas keluar dari antrean, dan selalu 0 pada hasil daftar.

Alasan tugas gagal. null kecuali status adalah FAILED. Lihat Kesalahan.

Jumlah kredit yang dikenakan untuk tugas tersebut, setelah dikurangi pengembalian dana. Permintaan yang mengembalikan kesalahan tidak akan dikenakan biaya. Tugas yang gagal bernilai 0, karena Meshy mengembalikan dananya. Membatalkan tugas hanya mengembalikan dana selama tugas masih berstatus PENDING. Jika Meshy tidak dapat membaca biaya yang dikenakan, respons get atau stream akan meniadakan field ini, dan permintaan daftar akan mengembalikan 500. Dalam kasus ini, coba ulangi permintaan tersebut.

URL unduhan untuk file siap cetak. Key mana yang muncul bergantung pada output.format dan options.light_source_preset.