Tukarkan foto anda kepada magnet peti sejuk tersuai — satu relief kedalaman
berwarna berbentuk segi empat tepi bertepi bulat dengan bahagian belakang
magnetik yang rata, bersaiz untuk peti sejuk — dalam dua peringkat:
prototaip menjana imej konsep berwarna daripada foto input anda,
kemudian binaan menukarkan imej konsep tersebut menjadi model 3D relief.
Kedua-dua peringkat ini dihubungkan melalui input_task_id.
POST /openapi/creative-lab/fridge-magnet/v1/prototype
Jana satu imej konsep berwarna daripada foto sumber. ID tugas yang dikembalikan ialah nilai yang anda hantar sebagai input_task_id kepada endpoint build. Rujuk
The Fridge Magnet Prototype Task Object
untuk bentuk respons.
Parameter
Name
image_url
Type
string
Diperlukan
Description
Foto sumber untuk Meshy warnakan menjadi imej konsep sedia magnet peti sejuk. Kami buat masa ini 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 umum.
Data URI: Data URI yang dikodkan base64 bagi imej tersebut. Contoh data URI: data:image/jpeg;base64,<your base64-encoded image data>.
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.
Ini hanya mengawal imej yang dikembalikan oleh endpoint ini. Ia berasingan daripada pilihan build dengan nama yang sama (lalai true), yang mengawal penyingkiran latar belakang sebelum proses relief.
Kembalian
Sifat result bagi respons mengandungi id tugas bagi tugas prototaip magnet peti sejuk yang baharu 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 bilangan 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 ditandai: Imej input ditandai oleh moderation NSFW atau harta intelek.
Name
401 - Unauthorized
Description
Pengesahan gagal. Sila semak kunci API anda.
Name
402 - Payment Required
Description
Kredit tidak mencukupi untuk melaksanakan tugas ini.
Name
429 - Too Many Requests
Description
Anda telah melebihi had kadar anda.
Request
POST
/openapi/creative-lab/fridge-magnet/v1/prototype
# Stage 1: generate a colorized fridge magnet concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/fridge-magnet/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>" }'
Response
{"result":"01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9"}
Prototype example
Start with a source photo, then generate the prototype image used by the fridge magnet build stage.
Menjana magnet peti sejuk boleh cetak 3D akhir daripada tugas prototaip
yang berjaya. Pembinaan ini menjalankan saluran paip relief peta kedalaman
pada imej konsep berwarna prototaip dan menghasilkan satu artifak jejaring
dalam format yang anda minta. Rujuk
Objek Tugas Pembinaan Magnet Peti Sejuk 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 mesti telah 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 build hanya menerima tugas prototaip yang dihasilkan oleh POST /openapi/creative-lab/fridge-magnet/v1/prototype dan menolak mana-mana sumber lain dengan 404.
Name
name
Type
string
Description
Nama tugas pilihan untuk tujuan paparan. Maksimum 100 aksara.
options
Parameter penalaan pilihan untuk geometri relief. Setiap medan mempunyai lalai yang munasabah — hantar hanya yang anda mahu ganti.
Name
badge_shape
Type
string
lalai rounded-rect
Description
Bentuk garis luar magnet peti sejuk. Nilai yang tersedia:
circle
rounded-rect (lalai)
hexagon
shield
star
Name
size_mm
Type
number
lalai 60
Description
Panjang tepi segi empat sama sempadan magnet peti sejuk, dalam milimeter. Julat: (0, 400].
Name
relief_height_mm
Type
number
lalai 3.3
Description
Ketinggian relief maksimum di atas asas, dalam milimeter. Julat: [0, 20].
Name
relief_offset_mm
Type
number
lalai 0
Description
Ofset menegak yang dikenakan pada relief sebelum penyemperitan, dalam milimeter. Julat: [0, 20].
Name
base_thickness_mm
Type
number
lalai 2.0
Description
Ketebalan plat asas rata di belakang relief, dalam milimeter. Lalai magnet peti sejuk ialah asas 2 mm yang lebih tebal — memberikan magnet cukup badan untuk mencengkam peti sejuk tanpa relief terasa rapuh. Julat: [0, 20].
Name
has_closed_back
Type
boolean
lalai true
Description
Sama ada bahagian belakang magnet peti sejuk dimeterai sebagai permukaan tertutup (bahagian yang anda gam magnet padanya). Tetapkan kepada false untuk cengkerang terbuka.
Name
relief_curve
Type
string
lalai linear
Description
Lengkung pemindahan yang memetakan nilai peta kedalaman kepada ketinggian relief. Nilai yang tersedia:
linear (lalai)
gamma
s-curve
Name
curve_param
Type
number
lalai 1.0
Description
Parameter bentuk untuk lengkung pemindahan (hanya bermakna apabila relief_curve ialah gamma). Julat: (0, 10].
Name
invert_depth
Type
boolean
lalai false
Description
Songsangkan tafsiran peta kedalaman supaya kawasan yang lebih gelap menjadi relief yang lebih tinggi.
Name
smoothing
Type
number
lalai 0.24
Description
Kekuatan pelicinan yang dikenakan pada peta kedalaman sebelum pengekstrakan relief. Julat: [0, 10].
Name
relief_scale
Type
number
lalai 1.0
Description
Pengganda skala menegak yang dikenakan di atas relief_height_mm. Julat: (0, 10].
Name
depth_threshold
Type
number
lalai 0.1
Description
Ambang lulus rendah untuk nilai peta kedalaman; apa-apa di bawah ini akan dipincangkan kepada sifar. Julat: [0, 1].
Name
remove_background
Type
boolean
lalai true
Description
Buang latar belakang imej konsep prototaip secara automatik sebelum melakukan relief.
Berasingan daripada parameter prototaip yang bernama sama (lalai false), yang mengawal sama ada imej prototaip itu sendiri dikembalikan dengan ketelusan.
Name
export_resolution
Type
integer
lalai 512
Description
Resolusi jejaring yang digunakan untuk eksport. Julat: [64, 2048].
output
Pemilih format wayar pilihan. Lalai kepada glb.
Name
format
Type
string
lalai glb
Description
Bungkusan artifak yang dikembalikan oleh pembinaan. Nilai yang tersedia:
glb (lalai) — mengembalikan satu model.glb di bawah model_urls.glb.
obj — mengzip model.obj + model.mtl + texture.png dan mengembalikan bungkusan di bawah model_urls.obj.
zip — mengzip setiap artifak yang dihasilkan oleh penjana dan mengembalikan bungkusan di bawah model_urls.bundle_zip.
Pemulangan
Ciri result bagi respons mengandungi id tugas bagi tugas pembinaan magnet peti sejuk yang baru dicipta. Poll endpoint Dapatkan Tugas atau langgan strim sehingga tugas mencapai SUCCEEDED, kemudian muat turun artifak daripada entri tunggal dalam model_urls.
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 mencapai SUCCEEDED lagi.
Tiada calon: Tugas prototaip berjaya tetapi tidak menghasilkan imej calon.
Options di luar julat: Salah satu medan options berada di luar julat yang dibenarkan atau set enum.
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, kepunyaan pengguna lain, atau dicipta melalui webapp (hanya tugas prototaip mod API dapat dirangkaikan ke build).
Dapatkan semula tugas prototaip atau binaan berdasarkan id tugas yang sah. Laluan URL
mesti sepadan dengan peringkat tugas — tugas binaan yang diambil melalui
/prototype/:id akan memulangkan 404, dan sebaliknya.
Batalkan tugas magnet peti sejuk. Jika tugas masih PENDING, kredit
yang digunakan pada masa penciptaan akan dikembalikan. Tugas yang sudah
IN_PROGRESS dibatalkan tanpa bayaran balik (worker mungkin sudah
menggunakan sumber). Tugas yang telah mencapai status muktamad
(SUCCEEDED, FAILED, CANCELED) tidak boleh dibatalkan.
Laluan URL mesti sepadan dengan peringkat tugas — DELETE pada
/prototype/:buildId mengembalikan 404.
Parameter Laluan
Name
id
Type
path
Description
Pengecam unik untuk tugas magnet peti sejuk yang hendak dibatalkan.
Pulangan
Mengembalikan 204 No Content apabila berjaya dengan badan kosong.
Mod Kegagalan
Name
400 - Bad Request
Description
Tugas sudah berada dalam status muktamad dan tidak boleh dibatalkan.
Name
404 - Not Found
Description
Tugas tidak wujud, dimiliki oleh pengguna lain, atau peringkatnya tidak sepadan dengan laluan URL.
Alirkan kemas kini masa nyata untuk tugas magnet peti sejuk melalui Server-Sent Events (SSE).
Laluan URL mestilah sepadan dengan peringkat tugas — membuka aliran di
/prototype/:buildId/stream akan menghasilkan satu event: error payload dengan
status_code: 404 dan menutup aliran tersebut.
Parameter
Name
id
Type
path
Description
Pengenal unik untuk tugas magnet peti sejuk yang hendak dialirkan.
Nilai Pulangan
Mengembalikan aliran objek tugas Fridge Magnet Prototype
atau Fridge Magnet Build sebagai
Server-Sent Events. Setiap bingkai 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 bernilai null.
// Error event example (wrong stage or task not found)event: errordata: {"status_code": 404,"message": "Task not found"}// Message event examples illustrate task progress.// Every frame is the full task object; fields not yet populated are null / empty.// The PENDING frame below is abbreviated to the fields that change.event: messagedata: {"id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0","progress": 0,"status": "PENDING"}event: messagedata: {"id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0","type": "creative-lab-fridge-magnet-build","status": "SUCCEEDED","progress": 100,"created_at": 1729543250000,"started_at": 1729543258000,"finished_at": 1729543285000,"expires_at": 1729802485000,"task_error": null,"consumed_credits": 20,"model_urls": {"glb":"https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***" }}
Dapatkan senarai bertomborkan halaman bagi tugasan magnet peti sejuk anda untuk satu peringkat sahaja. Laluan URL
memilih peringkat tersebut — /prototype mengembalikan tugasan prototaip; /build
mengembalikan tugasan pembinaan. Tugasan daripada peringkat yang lain tidak disertakan dalam mana-mana
respons.
Parameter Laluan
Name
stage
Type
path
Diperlukan
Description
Sama ada prototype atau build. Koleksi hanya mengembalikan tugasan
yang peringkatnya sepadan dengan URL — mengambil /prototype tidak akan pernah mengembalikan
tugasan pembinaan, 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 ialah 100 item.
Name
sort_by
Type
string
lalai -created_at
Description
Medan untuk diisih mengikut. Nilai yang tersedia:
+created_at: Isih mengikut masa penciptaan secara menaik.
-created_at: Isih mengikut masa penciptaan secara menurun.
Objek Tugas Prototaip magnet peti sejuk adalah unit kerja yang dijejaki oleh Meshy untuk
menjana imej konsep berwarna daripada foto sumber. Output daripada
peringkat ini dirangkaikan ke peringkat pembinaan
melalui input_task_id.
Ciri-ciri
Name
id
Type
string
Description
Pengenal unik untuk tugas tersebut. Walaupun kami menggunakan UUID yang boleh disusun secara k-sortable untuk id tugas sebagai butiran pelaksanaan, anda tidak sepatutnya membuat sebarang andaian tentang format id tersebut.
Name
type
Type
string
Description
Jenis tugas. Nilainya adalah creative-lab-fridge-magnet-prototype.
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 adalah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress tugas. Jika tugas belum dimulakan lagi, ciri ini akan menjadi 0. Sebaik sahaja tugas berjaya, ini akan menjadi 100.
Name
created_at
Type
timestamp
Description
Cap masa bila tugas dicipta, dalam milisaat.
Cap masa mewakili jumlah milisaat yang berlalu sejak 1 Januari 1970 UTC, mengikut
standard RFC 3339.
Sebagai contoh, Jumaat, 1 September 2023 12:00:00 PM GMT diwakili sebagai 1693569600000. Ini berlaku
untuk semua cap masa dalam Meshy API.
Name
started_at
Type
timestamp
Description
Cap masa bila tugas dimulakan, dalam milisaat. Jika tugas belum dimulakan lagi, ciri ini akan menjadi 0.
Name
finished_at
Type
timestamp
Description
Cap masa bila tugas selesai, dalam milisaat. Jika tugas belum selesai lagi, ciri ini akan menjadi 0.
Name
expires_at
Type
timestamp
Description
Cap masa bila hasil tugas akan tamat tempoh, dalam milisaat.
Name
preceding_tasks
Type
integer
Description
Bilangan tugas yang mendahului.
Nilai medan ini hanya bermakna jika status tugas adalah 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. Hadir apabila status tugas adalah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugas FAILED (kredit dikembalikan apabila gagal).
Name
image_urls
Type
array of strings
Description
URL yang boleh dimuat turun untuk calon imej konsep yang dijana oleh tugas prototaip ini. Pada masa ini API sentiasa mengembalikan tepat satu calon; medan ini adalah tatasusunan supaya semakan masa hadapan boleh memaparkan beberapa calon tanpa perubahan yang memutuskan keserasian.
Objek Tugas Bina Magnet Peti Sejuk ialah unit kerja yang dijejaki oleh Meshy untuk
menjana jejaring 3D magnet peti sejuk akhir daripada tugas prototaip yang berjaya. Bina
ini menjalankan saluran paip relief peta kedalaman pada imej konsep prototaip dan
menerbitkan satu artifak jejaring dalam format yang diminta oleh pemanggil.
Ciri-ciri
Name
id
Type
string
Description
Pengenal unik untuk tugas.
Name
type
Type
string
Description
Jenis tugas. Nilainya ialah creative-lab-fridge-magnet-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 adalah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress tugas. Jika tugas belum bermula lagi, ciri ini akan menjadi 0. Setelah tugas berjaya, ini akan menjadi 100.
Name
created_at
Type
timestamp
Description
Cap masa bila tugas dicipta, dalam milisaat.
Name
started_at
Type
timestamp
Description
Cap masa bila tugas bermula, dalam milisaat.
Name
finished_at
Type
timestamp
Description
Cap masa bila tugas selesai, dalam milisaat.
Name
expires_at
Type
timestamp
Description
Cap masa bila hasil tugas akan tamat tempoh, dalam milisaat.
Name
preceding_tasks
Type
integer
Description
Bilangan tugas yang mendahului. Hanya bermakna apabila status adalah PENDING.
Name
task_error
Type
object
Description
Butiran ralat untuk tugas yang gagal. Lihat Ralat untuk rujukan lengkap 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
model_urls
Type
object
Description
URL yang boleh dimuat turun untuk artifak yang dijana, dikunci mengikut nama artifak. Sentiasa mengandungi tepat satu entri — format yang diminta melalui output.format permintaan bina. Kunci ini sepadan dengan format yang diminta:
Name
glb
Type
string
Description
URL yang boleh dimuat turun untuk fail GLB. Hadir apabila output.format ialah glb (lalai).
Name
obj
Type
string
Description
URL yang boleh dimuat turun untuk gugusan zip yang mengandungi model.obj, model.mtl, dan texture.png. Hadir apabila output.format ialah obj.
Name
bundle_zip
Type
string
Description
URL yang boleh dimuat turun untuk gugusan zip bagi setiap artifak yang dihasilkan oleh penjana. Hadir apabila output.format ialah zip.