Creative Lab — Fidget Pixel API

Foto sumber yang akan dipiksel oleh Meshy. Kami saat ini mendukung format .jpg, .jpeg, .png, dan .webp.

Format terdeteksi dengan mendekode data gambar, bukan dari ekstensi file pada URL — URL tanpa ekstensi, atau yang melakukan redirect, tetap berfungsi selama byte-nya terdekode ke format yang didukung. HTTP redirect akan diikuti.

Ada dua cara untuk menyediakan gambar:

• URL yang dapat diakses publik: URL yang dapat diakses dari internet publik.
• Data URI: Data URI gambar yang di-encode base64. Contoh data URI: data:image/jpeg;base64,<data gambar Anda yang di-encode base64>.

Apa yang ditampilkan foto tersebut. Menentukan gaya pixelization, jadi pilihlah dengan cermat — kedua opsi menghasilkan hasil yang terlihat berbeda secara nyata. Nilai yang tersedia:

• person — subjeknya adalah seseorang (potret atau seluruh tubuh). Menghasilkan sprite piksel bergaya chibi dari subjek tersebut.
• other — apa pun selain itu: hewan peliharaan, objek, maskot, logo, pemandangan. Menghasilkan ikon piksel bergaya bead-art dari subjek tersebut.

Nama task opsional untuk tujuan tampilan. Maksimum 100 karakter.

Permintaan tidak dapat diterima. Penyebab umum:

• Parameter hilang: image_url dan type keduanya wajib diisi.
• Type tidak valid: type harus berupa person atau other.
• Format gambar tidak valid: image_url yang diberikan bukan format yang didukung (.jpg, .jpeg, .png, .webp).
• Dimensi gambar di luar rentang: Gambar terlalu kecil, melebihi ukuran file maksimum, atau melebihi jumlah piksel maksimum.
• URL tidak dapat dijangkau: image_url tidak dapat diunduh (404 atau timeout).
• Data URI tidak valid: String base64 tidak berformat dengan benar.
• Konten ditandai: Gambar input ditandai oleh moderation NSFW.

Autentikasi gagal. Silakan periksa kunci API Anda.

Kredit tidak mencukupi untuk melakukan task ini, atau kunci API tersebut dimiliki oleh akun paket gratis.

Gambar input ditandai oleh moderation kekayaan intelektual (Content flagged for intellectual property violation). Hanya akun Enterprise dengan penyaringan kekayaan intelektual yang diaktifkan yang diblokir; tidak ada tagihan yang dikenakan.

Anda telah melampaui batas laju Anda.

Pemeriksaan kekayaan intelektual itu sendiri tidak dapat diselesaikan (Unable to perform intellectual property check, please try again). Akun Enterprise dengan penyaringan kekayaan intelektual yang diaktifkan akan gagal secara tertutup pada pemeriksaan ini; tidak ada tagihan yang dikenakan — coba ulangi permintaan tersebut.

ID task dari prototype task yang dibuat melalui endpoint OpenAPI yang sama ini. Prototype tersebut harus dibuat oleh akun Meshy yang sama dan harus telah mencapai SUCCEEDED.

Prototype task yang dibuat melalui webapp tidak diterima — endpoint build hanya menerima prototype task yang dihasilkan oleh POST /openapi/creative-lab/fidget-pixel/v1/prototype dan menolak sumber lainnya dengan 404.

Nama task opsional untuk keperluan tampilan. Maksimal 100 karakter.

Bentuk jejak setiap bagian. Nilai yang tersedia:

• square (default) — bagian persegi pada grid persegi.
• hex — bagian heksagonal pada grid heksagonal. Bagian hex tersedia hanya dalam ukuran 6 dan 8 mm.

Jumlah bagian di sepanjang setiap sisi papan. Nilai yang tersedia: 16 atau 32. Grid 32 mempertahankan lebih banyak detail; grid 16 berarti bagian yang lebih sedikit dan lebih besar untuk subjek yang sama.

Panjang sisi setiap bagian, dalam milimeter. Nilai yang tersedia: 6, 8, atau 10. Bersama dengan grid_size, ini menentukan ukuran papan yang dicetak — misalnya 32 × 8 mm ≈ 26 cm per sisi. 10 tidak tersedia untuk shape: "hex" (permukaan hex yang miring menyebabkan overhang pada sebagian besar printer FDM konsumen).

Jumlah maksimum warna dalam palet tempat gambar dikuantisasi. Rentang: [1, 8]. Setiap warna menjadi satu filamen di slicer Anda.

Tinggi setiap bagian, dalam milimeter. Rentang: [10, 80].

Artefak yang dikembalikan oleh proses build. Nilai yang tersedia:

• 3mf (default) — mengembalikan satu model.3mf di bawah model_urls.3mf, dengan satu objek per bagian dan warna bagian yang dilekatkan pada setiap objek.

Permintaan tidak dapat diterima. Penyebab umum:

• Parameter hilang: input_task_id wajib diisi.
• UUID tidak valid: input_task_id bukan UUID yang valid.
• Parent belum berhasil: Prototype task yang dirujuk belum mencapai SUCCEEDED.
• Tidak ada kandidat: Prototype task berhasil tetapi tidak menghasilkan gambar pixel-art; buat prototype baru.
• Options di luar rentang: Salah satu field options berada di luar kumpulan atau rentang yang diizinkan — misalnya options.grid_size must be 16 or 32, atau options.piece_size_mm=10 is not supported for shape=hex; hex pieces are available in 6 and 8 mm.
• Format tidak didukung: output.format harus 3mf.

Autentikasi gagal. Silakan periksa kunci API Anda.

Kredit tidak mencukupi untuk melakukan task ini, atau kunci API tersebut milik akun paket gratis.

Gambar prototype yang dirujuk ditandai oleh moderation kekayaan intelektual. Hanya akun Enterprise dengan filtering kekayaan intelektual yang diaktifkan yang diblokir; tidak ada biaya yang dikenakan.

Prototype task yang dirujuk tidak ada, milik pengguna lain, atau dibuat melalui webapp (hanya prototype task mode API yang dapat dirangkai ke build).

Anda telah melampaui batas laju Anda.

Vonis kekayaan intelektual dari prototype yang dirujuk tidak dapat ditetapkan (Unable to perform intellectual property check, please try again). Akun Enterprise dengan filtering kekayaan intelektual yang diaktifkan akan gagal secara tertutup pada pemeriksaan ini; tidak ada biaya yang dikenakan — coba lagi permintaan tersebut.

Pengenal unik untuk task fidget pixel yang ingin diambil.

id bukan UUID yang valid (Invalid ID).

Gambar task ditandai oleh moderasi kekayaan intelektual. Hanya akun Enterprise dengan filter kekayaan intelektual yang diaktifkan yang akan diblokir.

Task tersebut tidak ada, milik pengguna lain, atau tahapnya tidak sesuai dengan path URL.

Pemeriksaan kekayaan intelektual tidak dapat diselesaikan (Unable to perform intellectual property check, please try again); akun Enterprise dengan filter kekayaan intelektual yang diaktifkan akan gagal secara tertutup (fail closed). Coba lagi permintaan tersebut.

Pengenal unik untuk task fidget pixel yang akan dibatalkan.

Permintaan tidak dapat diterima. Penyebab umum:

• ID tidak valid: id bukan UUID yang valid.
• Status akhir: Task sudah berstatus SUCCEEDED, FAILED, atau CANCELED dan tidak dapat dibatalkan.

Task tidak ditemukan, milik pengguna lain, atau tahapnya tidak sesuai dengan path URL.

Pengenal unik untuk task fidget pixel yang akan di-stream.

Salah satu dari prototype atau build. Koleksi tersebut hanya mengembalikan tugas yang tahapnya cocok dengan URL — mengambil /prototype tidak akan pernah mengembalikan tugas build dan sebaliknya.

Nomor halaman untuk paginasi.

Batas ukuran halaman. Maksimum yang diizinkan adalah 100 item.

Kolom untuk pengurutan. Nilai yang tersedia:

• +created_at: Urutkan berdasarkan waktu pembuatan secara ascending.
• -created_at: Urutkan berdasarkan waktu pembuatan secara descending.

Pengidentifikasi unik untuk task. Meskipun kami menggunakan UUID yang dapat diurutkan-k (k-sortable) untuk id task sebagai detail implementasi, Anda tidak boleh membuat asumsi apa pun tentang format id tersebut.

Tipe task. Nilainya adalah creative-lab-fidget-pixel-prototype.

Nama task yang diberikan saat task dibuat. String kosong jika tidak ada nama yang diberikan.

Status task. Nilai yang mungkin adalah salah satu dari PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Progress dari task. Jika task belum dimulai, properti ini akan bernilai 0. Setelah task berhasil, nilainya akan menjadi 100.

Stempel waktu saat task dibuat, dalam milidetik.

Stempel waktu saat task dimulai, dalam milidetik. Jika task belum dimulai, properti ini akan bernilai null.

Stempel waktu saat task selesai, dalam milidetik. Jika task belum selesai, properti ini akan bernilai null.

Stempel waktu saat hasil task kedaluwarsa, dalam milidetik — 3 hari setelah task selesai. Akun Enterprise menyimpan hasil API tanpa batas waktu (lihat Asset Retention); untuk mereka, stempel waktu ini diatur sekitar 100 tahun ke depan.

Jumlah task yang mendahului.

Detail kesalahan untuk task yang gagal. Lihat Kesalahan untuk referensi lengkap objek task_error.

Jumlah kredit yang dikonsumsi oleh task ini. Task yang mencapai SUCCEEDED akan dikenakan biaya penuh untuk tahapnya. Task yang tidak pernah dibuat (4xx pada saat request, termasuk penolakan moderation) tidak dikenakan biaya sama sekali. Task yang mencapai FAILED mengembalikan 0 — biaya akan dikembalikan. Membatalkan melalui DELETE hanya mengembalikan biaya selama task masih PENDING; task yang sudah IN_PROGRESS tetap dikenakan biaya, karena pekerjaan sudah dilakukan.

URL yang dapat diunduh untuk gambar pixel-art yang dihasilkan oleh task prototype ini. Saat ini API selalu mengembalikan tepat satu gambar; field ini berupa array agar revisi mendatang dapat menampilkan beberapa kandidat tanpa perubahan yang tidak kompatibel. Kosong hingga task mencapai SUCCEEDED.

Ini adalah URL yang ditandatangani (signed): ambil tanpa header Authorization. URL ini tetap valid hingga expires_at, yaitu 3 hari setelah finished_at, dan membaca ulang task dalam rentang waktu tersebut akan mengembalikan URL yang identik, bukan yang baru ditandatangani. Unduh dan simpan file tersebut sendiri sebelum waktu itu — tidak ada cara untuk memperbarui tautan yang sudah kedaluwarsa.

Pengenal unik untuk task ini.

Jenis task. Nilainya adalah creative-lab-fidget-pixel-build.

Nama task yang diberikan saat task dibuat. String kosong jika tidak ada nama yang diberikan.

Status task. Nilai yang mungkin adalah salah satu dari PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Progress dari task. Jika task belum dimulai, properti ini akan bernilai 0. Setelah task berhasil, nilainya akan menjadi 100.

Stempel waktu saat task dibuat, dalam milidetik.

Stempel waktu saat task dimulai, dalam milidetik. null sampai task dimulai.

Stempel waktu saat task selesai, dalam milidetik. null sampai task selesai.

Stempel waktu saat hasil task kedaluwarsa, dalam milidetik — 3 hari setelah task selesai. Akun Enterprise menyimpan hasil API tanpa batas waktu (lihat Asset Retention); untuk mereka, stempel waktu ini disetel sekitar 100 tahun ke depan.

Jumlah task yang mendahului. Hanya bermakna ketika status adalah PENDING.

Detail kesalahan untuk task yang gagal. Lihat Kesalahan untuk referensi lengkap objek task_error.

Jumlah kredit yang dikonsumsi oleh task ini. Task yang mencapai SUCCEEDED dikenakan biaya penuh untuk tahapannya. Task yang tidak pernah dibuat (sebuah 4xx pada saat permintaan, termasuk penolakan moderation) tidak dikenakan biaya sama sekali. Task yang mencapai FAILED mengembalikan 0 — biaya dikembalikan. Membatalkan melalui DELETE hanya mengembalikan biaya selama task masih PENDING; task yang sudah IN_PROGRESS tetap dikenakan biaya, karena pekerjaannya sudah dilakukan.

URL yang dapat diunduh untuk artefak yang dihasilkan, dengan kunci berdasarkan format. Berisi tepat satu entri — format yang diminta melalui output.format pada permintaan build. Kosong sampai task mencapai SUCCEEDED.

Ini adalah URL bertanda tangan: ambil tanpa header Authorization. URL ini tetap berlaku hingga expires_at, yaitu 3 hari setelah finished_at, dan membaca ulang task di dalam jangka waktu tersebut akan mengembalikan URL yang identik, bukan yang baru ditandatangani. Unduh dan simpan file tersebut sendiri sebelum itu — tidak ada cara untuk memperbarui tautan yang sudah kedaluwarsa.