Creative Lab — Keycap API

Foto sumber untuk Meshy menukar kepada imej reka bentuk keycap. Kami kini menyokong format .jpg, .jpeg, .png, dan .webp.

Format dikesan dengan menyahkod data imej, bukan dari sambungan fail URL — URL tanpa sambungan, atau yang mengalihkan, berfungsi selagi bait menyahkod kepada format yang disokong. Pengalihan HTTP diikuti. Orientasi EXIF dinormalisasi, jadi foto telefon yang diputar digunakan seperti yang kelihatan.

Had: sekurang-kurangnya 32 piksel pada setiap sisi, paling banyak 178,956,970 piksel secara keseluruhan, dan paling banyak 20,000,000 bait setelah dimuat turun. Untuk Data URI had ini terpakai kepada bait yang dinyahkod, jadi fail sumber itu sendiri boleh mencapai saiz tersebut — ia adalah teks base64 yang kira-kira satu pertiga lebih besar, yang penting untuk badan permintaan anda, bukan untuk had ini. Data URI mesti mengisytiharkan jenis kandungan image/* dan ;base64.

Terdapat dua cara untuk menyediakan imej:

• URL yang boleh diakses secara awam: URL yang boleh diakses dari internet awam.
• Data URI: Data URI yang dikodkan base64 bagi imej. Contoh Data URI: data:image/jpeg;base64,<your base64-encoded image data>.

Nama tugas pilihan untuk tujuan paparan. Maksimum 100 aksara.

Apabila ditetapkan kepada true, render paparan yang dikembalikan dalam image_urls adalah PNG RGBA telus dengan latar belakang dibuang, jadi anda boleh menggabungkannya pada mana-mana latar belakang.

Ini terpakai kepada render paparan sahaja. Calon yang digunakan oleh endpoint bina tidak terjejas, jadi hasil 3D adalah sama sama ada cara.

Permintaan tidak dapat diterima. Punca biasa:

• 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 julat: 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.
• Kandungan ditandakan: Imej input ditandakan oleh moderation NSFW.

Pengesahan gagal. Sila semak kunci API anda.

Akaun berada pada pelan percuma (pelan berbayar diperlukan untuk mencipta tugas) atau tidak mempunyai kredit yang mencukupi.

Imej input ditandakan oleh moderation harta intelek.

Anda telah melebihi had kadar anda.

Ralat pelayan yang tidak dijangka berlaku — contohnya perkhidmatan moderation kandungan tidak tersedia, pementasan imej input gagal, atau tugas tidak dapat dicipta. Tiada tugas yang dicipta dalam kes ini, jadi mencuba semula adalah selamat.

ID tugas bagi tugas prototaip yang dicipta melalui endpoint OpenAPI yang sama ini. Prototaip mesti telah dicipta oleh akaun Meshy yang sama, mesti telah mencapai SUCCEEDED, dan mesti telah menghasilkan sekurang-kurangnya satu calon.

Tugas prototaip yang dicipta melalui aplikasi web tidak diterima — endpoint pembinaan hanya menerima tugas prototaip yang dihasilkan oleh POST /openapi/creative-lab/keycap/v1/prototype dan menolak mana-mana sumber lain dengan 404.

Calon untuk dibina, diambil dari array candidate_ids dari tugas prototaip yang berjaya. Mesti milik tugas itu; sebarang nilai lain ditolak dengan 400.

Nama tugas pilihan untuk tujuan paparan. Maksimum 100 aksara.

Asas keycap untuk dibina. Pada masa ini, satu-satunya nilai yang tersedia adalah cherry-mx-1x1-r1 — profil standard Cherry MX 1u keycap. 3–5 saiz standard arus perdana tambahan dirancang; saiz tersuai tidak disokong.

Saiz sasaran kepala yang diukir, dalam milimeter: dimensi terpanjangnya diskalakan kepada nilai ini. Julat: [10, 40]. Nilai di atas kira-kira 32.9 mungkin dikurangkan supaya kepala masih muat dalam had jejak pelindung asas, jadi dimensi terpanjang yang dihantar boleh lebih kecil daripada yang diminta. Nilai yang diterapkan tidak dipaparkan semula pada objek tugas hari ini — jika anda perlu mengesahkan saiz yang sebenarnya diterima, ukur kotak pembatas jejaring keycap-head dalam model yang dimuat turun.

Ofset menegak yang diterapkan kepada kepala sebelum ia dipasang pada asas, dalam milimeter. Julat: [-5, 5].

Permintaan tidak dapat diterima. Punca biasa:

• Parameter hilang: input_task_id dan candidate_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 calon.
• Calon tidak diketahui: candidate_id bukan salah satu calon tugas input.
• Pilihan di luar julat: Salah satu medan options jatuh di luar julat atau set enum yang dibenarkan.

Pengesahan gagal. Sila semak kunci API anda.

Akaun berada pada pelan percuma (pelan berbayar diperlukan untuk mencipta tugas) atau tidak mempunyai kredit yang mencukupi.

Tugas prototaip yang dirujuk tidak wujud, milik pengguna lain, atau dicipta melalui aplikasi web (hanya tugas prototaip mod API yang berantai ke dalam pembinaan).

Anda telah melebihi had kadar anda.

Ralat pelayan yang tidak dijangka berlaku — contohnya perkhidmatan moderation kandungan tidak tersedia, pementasan imej input gagal, atau tugas tidak dapat dicipta. Tiada tugas yang dicipta dalam kes ini, jadi mencuba semula adalah selamat.

Pengenal pasti unik untuk tugas keycap yang ingin diambil.

Pengenal pasti unik untuk tugas keycap yang hendak dibatalkan.

Tugas sudah berada dalam keadaan terminal dan tidak boleh dibatalkan.

Tugas tidak wujud, milik pengguna lain, atau tahapnya tidak sepadan dengan laluan URL.

Ralat tidak dijangka di sisi pelayan berlaku semasa pembatalan. Tugas mungkin atau mungkin tidak telah dibatalkan — baca semula untuk mengesahkan sebelum mencuba semula.

Pengenal pasti unik untuk tugas keycap yang ingin distrim.

Sama ada prototype atau build. Koleksi hanya mengembalikan tugas yang peringkatnya sepadan dengan URL — mendapatkan /prototype tidak akan mengembalikan tugas binaan dan sebaliknya.

Nombor halaman untuk penomboran halaman.

Had saiz halaman. Maksimum yang dibenarkan ialah 100 item.

Medan untuk disusun. Nilai yang tersedia:

• +created_at: Susun mengikut masa penciptaan dalam susunan menaik.
• -created_at: Susun mengikut masa penciptaan dalam susunan menurun.

Pengenal pasti unik untuk tugas. Walaupun kami menggunakan UUID yang boleh diurutkan k untuk id tugas sebagai perincian pelaksanaan, anda tidak seharusnya membuat sebarang andaian tentang format id.

Jenis tugas. Nilainya adalah creative-lab-keycap-prototype.

Nama tugas yang diberikan semasa tugas dicipta. Rentetan kosong jika tiada nama diberikan.

Status tugas. Nilai yang mungkin adalah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Kemajuan tugas. Jika tugas belum dimulakan, sifat ini akan menjadi 0. Setelah tugas berjaya, ini akan menjadi 100.

Cap masa apabila tugas dicipta, dalam milisaat.

Cap masa apabila tugas dimulakan, dalam milisaat. Jika tugas belum dimulakan, sifat ini akan menjadi 0.

Cap masa apabila tugas selesai, dalam milisaat. Jika tugas belum selesai, sifat ini akan menjadi 0.

Cap masa apabila hasil tugas tamat tempoh, dalam milisaat.

Bilangan tugas terdahulu.

Butiran ralat untuk tugas yang gagal. Lihat Ralat untuk rujukan penuh objek task_error.

Bilangan kredit yang digunakan oleh tugas ini. Tugas yang mencapai SUCCEEDED dikenakan caj penuh untuk peringkatnya. Tugas yang tidak pernah dicipta (kesalahan 4xx semasa masa permintaan, termasuk penolakan moderation) tidak dikenakan caj sama sekali. Tugas yang mencapai FAILED mengembalikan 0 — caj dikembalikan, termasuk blok moderation tidak segerak. Pembatalan melalui DELETE hanya mengembalikan wang semasa tugas masih PENDING; tugas yang sudah IN_PROGRESS tetap dikenakan caj, kerana kerja telah dilakukan.

URL yang boleh dimuat turun bagi render reka bentuk kekunci siap — bagaimana calon kelihatan sebagai kekunci siap. Mengandungi satu entri; image_urls[i] sepadan dengan candidate_ids[i]. Kosong sehingga tugas mencapai SUCCEEDED. URL adalah untuk paparan sahaja; endpoint binaan menggunakan candidate_ids, bukan URL ini. Kitaran hayat URL sama seperti model_urls: ditandatangani, tiada header Authorization, sah sehingga expires_at, dan stabil apabila tugas dibaca semula.

Pengenal pasti calon yang tidak telus, selari dengan image_urls. Serahkan entri yang sepadan dengan reka bentuk pilihan anda sebagai candidate_id permintaan binaan. Jangan buat sebarang andaian tentang format id ini.

Pengenal pasti unik untuk tugas ini.

Jenis tugas. Nilainya adalah creative-lab-keycap-build.

Nama tugas yang diberikan semasa tugas dicipta. Rentetan kosong jika tiada nama diberikan.

Status tugas. Nilai yang mungkin adalah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Kemajuan tugas. Jika tugas belum dimulakan, sifat ini akan menjadi 0. Setelah tugas berjaya, ini akan menjadi 100.

Cap masa apabila tugas dicipta, dalam milisaat.

Cap masa apabila tugas dimulakan, dalam milisaat.

Cap masa apabila tugas selesai, dalam milisaat.

Cap masa apabila hasil tugas tamat tempoh, dalam milisaat.

Bilangan tugas terdahulu. Bermakna hanya apabila status adalah PENDING.

Butiran ralat untuk tugas yang gagal. Lihat Ralat untuk rujukan objek task_error penuh.

Bilangan kredit yang digunakan oleh tugas ini. Tugas yang mencapai SUCCEEDED dikenakan caj penuh untuk tahapnya. Tugas yang tidak pernah dicipta (kesalahan 4xx pada masa permintaan, termasuk penolakan moderation) tidak dikenakan caj sama sekali. Tugas yang mencapai FAILED mengembalikan 0 — caj dikembalikan, termasuk blok moderation asinkron. Pembatalan melalui DELETE hanya mengembalikan wang semasa tugas masih PENDING; tugas yang sudah IN_PROGRESS tetap dikenakan caj, kerana kerja telah dilakukan.

URL yang boleh dimuat turun untuk artifak model yang dihasilkan. Kedua-dua GLB dan bundel OBJ dieksport pada skala milimeter dunia sebenar, Y-up, dengan bahagian depan keycap menghadap +Z. Jejaring dinamakan keycap-head dan keycap-base; apabila asas kembali kepada pengisian corak, jejaring ketiga keycap-base-interior juga hadir untuk rongga batang. Jangan anggap tepat dua jejaring.

Ini adalah URL yang ditandatangani: ambil mereka tanpa tajuk Authorization. Mereka kekal sah sehingga expires_at, iaitu 3 hari selepas finished_at, dan membaca semula tugas dalam tempoh itu mengembalikan URL yang sama dan bukannya yang baru ditandatangani. Muat turun dan simpan fail sendiri sebelum itu — tiada cara untuk menyegarkan pautan yang telah tamat tempoh.

URL yang boleh dimuat turun untuk imej proses perantaraan, dikunci mengikut jenis. Kitaran hayat URL yang sama seperti model_urls: ditandatangani, tiada tajuk Authorization, sah sehingga expires_at, dan stabil apabila tugas dibaca semula. Jenis yang dikeluarkan pada masa ini:

• head_design — imej reka bentuk calon yang dipilih yang digunakan dalam pembinaan (sentiasa hadir).
• composite — render paparan keycap siap calon yang dipilih (hadir apabila tersedia).
• base_canvas — kanvas asas keycap yang dicat (hadir apabila tersedia).

Anggap set kunci sebagai terbuka; jenis baru boleh ditambah tanpa perubahan yang memecahkan.