Fotoğraflarınızı özel buzdolabı mıknatıslarına dönüştürün — buzdolabı için
boyutlandırılmış, düz manyetik arkalığa sahip, yuvarlatılmış dikdörtgen
biçimli renklendirilmiş bir derinlik rölyefi — iki aşamada: prototip
girdi fotoğrafınızdan renklendirilmiş bir konsept görüntü oluşturur,
ardından oluşturma bu konsept görüntüyü rölyef bir 3D modele dönüştürür.
İki aşama input_task_id aracılığıyla bağlanır.
POST /openapi/creative-lab/fridge-magnet/v1/prototype
Kaynak fotoğraftan tek bir renklendirilmiş konsept görseli oluşturun. Döndürülen
görev ID'si, build uç noktasına input_task_id olarak ileteceğiniz değerdir.
Yanıt yapısı için
Buzdolabı Mıknatısı Prototip Görevi Nesnesi
bölümüne bakın.
Parametreler
Name
image_url
Type
string
Zorunlu
Description
Meshy'nin buzdolabı mıknatısına hazır bir konsept görsele renklendirmesi için kaynak fotoğraf. Şu anda .jpg, .jpeg, .png ve .webp formatlarını destekliyoruz.
Görseli sağlamanın iki yolu vardır:
Herkese açık erişilebilir URL: Herkese açık internetten erişilebilen bir URL.
Data URI: Görselin base64 ile kodlanmış Data URI'si. Bir Data URI örneği: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
Görüntüleme amaçları için isteğe bağlı görev adı. Maksimum 100 karakter.
Döndürür
Yanıtın result özelliği, yeni oluşturulan buzdolabı mıknatısı prototip görevinin görev id değerini içerir. Görev SUCCEEDED durumuna ulaşana kadar Bir Görev Al uç noktasını yoklayın veya stream öğesine abone olun, ardından bu ID'yi input_task_id olarak build uç noktasına iletin.
Hata Modları
Name
400 - Bad Request
Description
İstek kabul edilemez durumdaydı. Yaygın nedenler:
Eksik parametre: image_url gereklidir.
Geçersiz görsel formatı: Sağlanan image_url desteklenen bir format değil (.jpg, .jpeg, .png, .webp).
Görsel boyutları aralık dışında: Görsel çok küçük, maksimum dosya boyutunu aşıyor veya maksimum piksel sayısını aşıyor.
Erişilemeyen URL: image_url indirilemedi (404 veya timeout).
Geçersiz Data URI: Base64 dizesi hatalı biçimlendirilmiş.
İşaretlenen içerik: Girdi görseli NSFW veya fikri mülkiyet moderation tarafından işaretlendi.
Name
401 - Unauthorized
Description
Kimlik doğrulama başarısız oldu. Lütfen API anahtarınızı kontrol edin.
Name
402 - Payment Required
Description
Bu görevi gerçekleştirmek için yetersiz kredi.
Name
429 - Too Many Requests
Description
Hız sınırınızı aştınız.
Request
POST
/openapi/creative-lab/fridge-magnet/v1/prototype
# Stage 1: generate a colorized fridge magnet concept imagecurl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/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>" }'
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.
Başarılı olmuş bir prototip görevinden, 3D baskıya hazır nihai
buzdolabı mıknatısını oluşturun. Derleme, prototipin renklendirilmiş
konsept görüntüsü üzerinde bir derinlik haritası rölyef işlem hattı çalıştırır
ve istediğiniz formatta tek bir ağ yapıtı gönderir. Yanıt yapısı için
Buzdolabı Mıknatısı Derleme Görevi Nesnesi bölümüne bakın.
Parametreler
Name
input_task_id
Type
string
Zorunlu
Description
Bu aynı OpenAPI uç noktası üzerinden oluşturulmuş bir prototip görevinin görev ID'si. Prototip aynı API anahtarı ile oluşturulmuş olmalı, SUCCEEDED durumuna ulaşmış olmalı ve tam olarak bir aday görüntü üretmiş olmalıdır.
Web uygulaması üzerinden oluşturulan prototip görevleri kabul edilmez — derleme uç noktası yalnızca POST /openapi/creative-lab/fridge-magnet/v1/prototype tarafından üretilen prototip görevlerini kabul eder ve diğer tüm kaynakları 404 ile reddeder.
Name
name
Type
string
Description
Görüntüleme amacıyla isteğe bağlı görev adı. En fazla 100 karakter.
options
Rölyef geometrisi için isteğe bağlı ayarlama parametreleri. Her alanın makul bir varsayılanı vardır — yalnızca geçersiz kılmak istediklerinizi gönderin.
Name
badge_shape
Type
string
varsayılan rounded-rect
Description
Buzdolabı mıknatısının dış hat silüeti. Kullanılabilir değerler:
Tabanın üzerindeki maksimum rölyef yüksekliği, milimetre cinsinden. Aralık: [0, 20].
Name
relief_offset_mm
Type
number
varsayılan 0
Description
Ekstrüzyondan önce rölyefe uygulanan dikey ofset, milimetre cinsinden. Aralık: [0, 20].
Name
base_thickness_mm
Type
number
varsayılan 2.0
Description
Rölyefin arkasındaki düz taban plakasının kalınlığı, milimetre cinsinden. Buzdolabı mıknatısı varsayılanı daha kalın bir 2 mm tabandır — rölyefin kırılgan hissettirmemesi için mıknatısa buzdolabına tutunmaya yetecek kadar gövde sağlar. Aralık: [0, 20].
Name
has_closed_back
Type
boolean
varsayılan true
Description
Buzdolabı mıknatısının arkasının kapalı bir yüzey olarak mühürlenip mühürlenmeyeceği (mıknatısı yapıştırdığınız taraf). Açık bir kabuk için false olarak ayarlayın.
Koyu bölgelerin daha yüksek rölyef haline gelmesi için derinlik haritası yorumunu tersine çevirin.
Name
smoothing
Type
number
varsayılan 0.24
Description
Rölyef çıkarımından önce derinlik haritasına uygulanan yumuşatma gücü. Aralık: [0, 10].
Name
relief_scale
Type
number
varsayılan 1.0
Description
relief_height_mm üzerine uygulanan dikey ölçek çarpanı. Aralık: (0, 10].
Name
depth_threshold
Type
number
varsayılan 0.1
Description
Derinlik haritası değerleri için düşük geçiren eşik; bunun altındaki her şey sıfıra sabitlenir. Aralık: [0, 1].
Name
remove_background
Type
boolean
varsayılan true
Description
Rölyefleştirmeden önce prototipin konsept görüntüsünün arka planını otomatik olarak kaldırın.
Name
export_resolution
Type
integer
varsayılan 512
Description
Dışa aktarma için kullanılan ağ çözünürlüğü. Aralık: [64, 2048].
output
İsteğe bağlı kablo formatı seçici. Varsayılan değer glb'dir.
Name
format
Type
string
varsayılan glb
Description
Derleme tarafından döndürülen yapıt paketi. Kullanılabilir değerler:
glb (varsayılan) — model_urls.glb altında tek bir model.glb döndürür.
obj — model.obj + model.mtl + texture.png dosyalarını zipler ve paketi model_urls.obj altında döndürür.
zip — oluşturucunun yaydığı her yapıtı zipler ve paketi model_urls.bundle_zip altında döndürür.
Döndürür
Yanıtın result özelliği, yeni oluşturulan buzdolabı mıknatısı derleme görevinin görev id değerini içerir. Görev SUCCEEDED durumuna ulaşana kadar Bir Görev Al uç noktasını yoklayın veya akışa abone olun, ardından yapıtı model_urls içindeki tek girdiden indirin.
Hata Modları
Name
400 - Bad Request
Description
İstek kabul edilemezdi. Yaygın nedenler:
Eksik parametre: input_task_id gereklidir.
Geçersiz UUID: input_task_id geçerli bir UUID değil.
Üst görev başarılı değil: Başvurulan prototip görev henüz SUCCEEDED durumuna ulaşmadı.
Aday yok: Prototip görev başarılı oldu ancak aday görüntü üretmedi.
Seçenekler aralık dışında: options alanlarından biri izin verilen aralığının veya enum kümesinin dışına çıktı.
Name
401 - Unauthorized
Description
Kimlik doğrulama başarısız oldu. Lütfen API anahtarınızı kontrol edin.
Name
402 - Payment Required
Description
Bu görevi gerçekleştirmek için yetersiz kredi.
Name
404 - Not Found
Description
Başvurulan prototip görev mevcut değil, farklı bir kullanıcıya ait veya web uygulaması üzerinden oluşturulmuş (yalnızca API mode prototip görevleri derlemeye zincirlenir).
Geçerli bir görev id değeri verildiğinde bir prototip veya oluşturma görevini alın. URL yolu
görevin aşamasıyla eşleşmelidir — /prototype/:id üzerinden getirilen bir oluşturma görevi
404 döndürür; bunun tersi de geçerlidir.
Bir buzdolabı mıknatısı görevini iptal edin. Görev hâlâ PENDING durumundaysa, oluşturma sırasında
tüketilen kredi iade edilir. Zaten
IN_PROGRESS durumunda olan görevler iade olmadan iptal edilir (işleyici zaten
kaynakları tüketiyor olabilir). Zaten son bir duruma ulaşmış görevler
(SUCCEEDED, FAILED, CANCELED) iptal edilemez.
Bir buzdolabı mıknatısı görevi için gerçek zamanlı güncellemeleri Server-Sent Events (SSE) aracılığıyla akış olarak alın.
URL yolu görevin aşamasıyla eşleşmelidir — /prototype/:buildId/stream üzerinde
bir akış açmak, status_code: 404 içeren tek bir event: error yükü yayınlar
ve akışı kapatır.
Parametreler
Name
id
Type
path
Description
Akış olarak alınacak buzdolabı mıknatısı görevi için benzersiz tanımlayıcı.
Döndürür
Buzdolabı Mıknatısı Prototipi
veya Buzdolabı Mıknatısı Build görev nesnelerinden oluşan bir akışı
Server-Sent Events olarak döndürür. PENDING veya IN_PROGRESS görevleri için yanıt
akışı yalnızca gerekli progress ve status alanlarını içerir.
// Error event example (wrong stage or task not found)event: errordata: {"status_code": 404,"message": "Task not found"}// Message event examples illustrate task progress.// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.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=***" }}
Tek bir aşama için buzdolabı mıknatısı görevlerinizin sayfalanmış listesini alın. URL
yolu aşamayı seçer — /prototype prototip görevlerini döndürür; /build
build görevlerini döndürür. Diğer aşamadaki görevler hiçbir
yanıta dahil edilmez.
Yol Parametreleri
Name
stage
Type
path
Zorunlu
Description
prototype veya build. Koleksiyon yalnızca aşaması
URL ile eşleşen görevleri döndürür — /prototype çekmek hiçbir zaman
build görevlerini döndürmez ve tersi de geçerlidir.
Sorgu Parametreleri
Name
page_num
Type
integer
varsayılan 1
Description
Sayfalama için sayfa numarası.
Name
page_size
Type
integer
varsayılan 10
Description
Sayfa boyutu sınırı. İzin verilen en fazla öğe sayısı 50.
Name
sort_by
Type
string
varsayılan -created_at
Description
Sıralama yapılacak alan. Kullanılabilir değerler:
+created_at: Oluşturma zamanına göre artan düzende sırala.
-created_at: Oluşturma zamanına göre azalan düzende sırala.
Buzdolabı mıknatısı prototip görev nesnesi, Meshy'nin bir kaynak fotoğraftan
renklendirilmiş bir konsept görseli oluşturmak için takip ettiği bir iş birimidir. Bu aşamanın çıktısı,
input_task_id aracılığıyla oluşturma aşamasına
zincirlenir.
Özellikler
Name
id
Type
string
Description
Görev için benzersiz tanımlayıcı. Uygulama ayrıntısı olarak görev kimlikleri için k-sıralanabilir bir UUID kullansak da, id formatı hakkında hiçbir varsayımda bulunmamalısınız.
Name
type
Type
string
Description
Görevin türü. Değer creative-lab-fridge-magnet-prototype şeklindedir.
Name
name
Type
string
Description
Görev oluşturulurken sağlanan görev adı. Ad sağlanmadıysa boş dizedir.
Görevin progress değeri. Görev henüz başlatılmadıysa bu özellik 0 olur. Görev başarıyla tamamlandığında bu değer 100 olur.
Name
created_at
Type
timestamp
Description
Görevin oluşturulduğu zamanın milisaniye cinsinden zaman damgası.
Bir zaman damgası, 1 Ocak 1970 UTC tarihinden bu yana geçen milisaniye sayısını temsil eder ve
RFC 3339 standardını izler.
Örneğin, 1 Eylül 2023 Cuma 12:00:00 PM GMT, 1693569600000 olarak temsil edilir. Bu, Meshy API içindeki
tüm zaman damgaları için geçerlidir.
Name
started_at
Type
timestamp
Description
Görevin başlatıldığı zamanın milisaniye cinsinden zaman damgası. Görev henüz başlatılmadıysa bu özellik 0 olur.
Name
finished_at
Type
timestamp
Description
Görevin tamamlandığı zamanın milisaniye cinsinden zaman damgası. Görev henüz tamamlanmadıysa bu özellik 0 olur.
Name
expires_at
Type
timestamp
Description
Görev sonucunun süresinin dolacağı zamanın milisaniye cinsinden zaman damgası.
Name
preceding_tasks
Type
integer
Description
Önceki görevlerin sayısı.
Bu alanın değeri yalnızca görev durumu PENDING ise anlamlıdır.
Name
task_error
Type
object
Description
Başarısız görevler için hata ayrıntıları. Tam task_error nesne referansı için Hatalar bölümüne bakın.
Name
consumed_credits
Type
integer
Description
Bu görev tarafından tüketilen kredi sayısı. Görev durumu PENDING, IN_PROGRESS veya SUCCEEDED olduğunda bulunur. FAILED görevler için 0 döndürür (kredi başarısızlık durumunda iade edilir).
Name
image_urls
Type
array of strings
Description
Bu prototip görev tarafından oluşturulan konsept görüntü adayları için indirilebilir URL'ler. API şu anda her zaman tam olarak bir aday döndürür; alan bir dizidir, böylece gelecekteki revizyonlar uyumluluğu bozan bir değişiklik olmadan birden fazla adayı sunabilir.
Buzdolabı Mıknatısı Oluşturma Görevi nesnesi, Meshy’nin başarılı bir prototip görevinden
nihai 3D buzdolabı mıknatısı ağını oluşturmak için takip ettiği bir iş birimidir.
Oluşturma işlemi, prototipin konsept görüntüsü üzerinde bir derinlik haritası rölyef işlem hattı çalıştırır ve
çağıranın istediği formatta tek bir ağ çıktısı yayımlar.
Özellikler
Name
id
Type
string
Description
Görev için benzersiz tanımlayıcı.
Name
type
Type
string
Description
Görevin türü. Değer creative-lab-fridge-magnet-build olur.
Name
name
Type
string
Description
Görev oluşturulduğunda sağlanan görev adı. Ad sağlanmadıysa boş dizedir.
Görevin progress değeri. Görev henüz başlatılmadıysa bu özellik 0 olur. Görev başarıyla tamamlandığında bu değer 100 olur.
Name
created_at
Type
timestamp
Description
Görevin oluşturulduğu zamanın zaman damgası, milisaniye cinsinden.
Name
started_at
Type
timestamp
Description
Görevin başlatıldığı zamanın zaman damgası, milisaniye cinsinden.
Name
finished_at
Type
timestamp
Description
Görevin tamamlandığı zamanın zaman damgası, milisaniye cinsinden.
Name
expires_at
Type
timestamp
Description
Görev sonucunun süresinin dolacağı zamanın zaman damgası, milisaniye cinsinden.
Name
preceding_tasks
Type
integer
Description
Önceki görevlerin sayısı. Yalnızca durum PENDING olduğunda anlamlıdır.
Name
task_error
Type
object
Description
Başarısız görevler için hata ayrıntıları. Tam task_error nesne referansı için Hatalar bölümüne bakın.
Name
consumed_credits
Type
integer
Description
Bu görev tarafından tüketilen kredi sayısı. FAILED görevler için 0 döndürür (başarısızlık durumunda kredi iade edilir).
Name
model_urls
Type
object
Description
Oluşturulan yapı için indirilebilir URL'ler, yapı adına göre anahtarlanmıştır. Her zaman tam olarak bir giriş içerir — oluşturma isteğinin output.format değeri aracılığıyla istenen format. Anahtar, istenen formatla eşleşir: