Bir kaynak fotoğrafı iki aşamada tuğla tarzı koleksiyonluk 3D minifigüre dönüştürün:
prototip giriş fotoğrafınızdan stilize bir konsept görüntü oluşturur, ardından
yapı bu konsept görüntüyü 3D model haline getirir. İki aşama input_task_id aracılığıyla bağlantılıdır.
POST /openapi/creative-lab/brick-figure/v1/prototype
Kaynak fotoğraftan tek bir tuğla tarzı konsept görüntüsü oluşturun. Döndürülen görev kimliği, oluşturma uç noktasına input_task_id olarak ilettiğiniz kimliktir. Yanıt yapısı için Tuğla Figür Prototip Görev Nesnesi bölümüne bakın.
Parametreler
Name
image_url
Type
string
Zorunlu
Description
Meshy'nin tuğla minifigür olarak stilize etmesi için kaynak fotoğraf. Şu anda .jpg, .jpeg, .png ve .webp formatlarını destekliyoruz.
Görüntüyü sağlamak için iki yol vardır:
Herkese açık erişilebilir URL: Genel internetten erişilebilen bir URL.
Data URI: Görüntünün base64 ile kodlanmış bir data URI'si. Bir data URI örneği: data:image/jpeg;base64,<base64 ile kodlanmış görüntü veriniz>.
Name
name
Type
string
Description
Görüntüleme amacıyla isteğe bağlı görev adı. Maksimum 100 karakter.
Name
remove_background
Type
boolean
varsayılan false
Description
true olarak ayarlandığında, prototip görüntü arka planı kaldırılmış olarak şeffaf RGBA PNG formatında döndürülür, böylece konuyu herhangi bir arka plana yerleştirebilirsiniz.
Dönen Değerler
Yanıtın result özelliği, yeni oluşturulan tuğla figür prototip görevinin görev id değerini içerir. Görev SUCCEEDED durumuna ulaşana kadar Bir Görev Al uç noktasını sorgulayın veya akışa abone olun, ardından bu kimliği input_task_id olarak oluşturma uç noktasına iletin.
Başarısızlık Modları
Name
400 - Bad Request
Description
İstek kabul edilemezdi. Yaygın nedenler:
Eksik parametre: image_url gereklidir.
Geçersiz görüntü formatı: Sağlanan image_url desteklenen bir format değil (.jpg, .jpeg, .png, .webp).
Görüntü boyutları aralık dışında: Görüntü çok küçük, maksimum dosya boyutunu aşıyor veya maksimum piksel sayısını aşıyor.
Erişilemez URL: image_url indirilemedi (404 veya timeout).
Geçersiz Data URI: Base64 dizesi hatalı.
İçerik işaretlendi: Girdi görüntüsü NSFW 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
403 - Forbidden
Description
Girdi görüntüsü fikri mülkiyet ihlali nedeniyle işaretlendi.
Name
429 - Too Many Requests
Description
Hız sınırınızı aştınız.
İstek
POST
/openapi/creative-lab/brick-figure/v1/prototype
# Stage 1: generate a brick-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/brick-figure/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>" }'
Başarılı bir prototip görevinden nihai dokulu 3D tuğla figürü oluşturun. Bu yapı, Görselden 3D'ye ile aynı görselden 3D'ye dönüşüm hattını çalıştırır, bu nedenle yanıt nesnesi formatı ve çıktı URL'lerinin listesi tam olarak eşleşir. Yanıt yapısı için Tuğla Figür Oluşturma Görevi Nesnesi bölümüne bakın.
Parametreler
Name
input_task_id
Type
string
Zorunlu
Description
Bu aynı OpenAPI uç noktası aracılığıyla oluşturulmuş bir prototip görevinin görev kimliği. Prototip aynı API anahtarı ile oluşturulmuş olmalı, SUCCEEDED durumuna ulaşmış olmalı ve tam olarak bir aday görsel üretmiş olmalıdır.
Web uygulaması aracılığıyla oluşturulan prototip görevler kabul edilmez — yapı uç noktası yalnızca POST /openapi/creative-lab/brick-figure/v1/prototype tarafından üretilen prototip görevleri kabul eder ve başka herhangi bir kaynağı 404 ile reddeder.
Name
name
Type
string
Description
Görüntüleme amaçlı isteğe bağlı görev adı. Maksimum 100 karakter.
Dönen Değerler
Yanıtın result özelliği, yeni oluşturulan tuğla figür oluşturma görevinin görev id değerini içerir. Görev SUCCEEDED durumuna ulaşana kadar Bir Görev Al uç noktasını sorgulayın veya akışa abone olun, ardından dokulu GLB'yi model_urls.glb'den indirin (veya alt akış hattınız OBJ tercih ediyorsa model_urls.obj ve model_urls.mtl'den OBJ + MTL çiftini indirin).
Başarısızlık 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.
Ebeveyn başarılı değil: Referans verilen prototip görev henüz SUCCEEDED durumuna ulaşmadı.
Aday yok: Prototip görev başarılı oldu ancak aday görsel üretmedi.
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
Referans verilen prototip görev mevcut değil, farklı bir kullanıcıya ait veya web uygulaması aracılığıyla oluşturulmuş (yalnızca API modundaki prototip görevler yapıya zincirlenir).
Name
429 - Too Many Requests
Description
Hız sınırınızı aştınız.
İstek
POST
/openapi/creative-lab/brick-figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578" }'
Geçerli bir görev idsi verilen bir prototip veya inşa görevini getirir. URL yolu
görevin aşamasıyla eşleşmelidir — /prototype/:id üzerinden getirilen bir inşa görevi
404 döndürür ve tersi de geçerlidir.
Bir tuğla figür görevini iptal edin. Görev hala PENDING durumundaysa, oluşturma sırasında tüketilen krediler iade edilir. Zaten IN_PROGRESS olan görevler, geri ödeme yapılmadan iptal edilir (çalışan kaynakları tüketiyor olabilir). Zaten bir son duruma ulaşmış görevler (SUCCEEDED, FAILED, CANCELED) iptal edilemez.
URL yolu, görevin aşamasıyla eşleşmelidir — /prototype/:buildId üzerinde DELETE404 döndürür.
Yol Parametreleri
Name
id
Type
path
Description
İptal edilecek tuğla figür görevi için benzersiz tanımlayıcı.
Dönüşler
Başarı durumunda boş bir gövde ile 204 No Content döner.
Başarısızlık Modları
Name
400 - Bad Request
Description
Görev zaten bir son durumda ve iptal edilemez.
Name
404 - Not Found
Description
Görev mevcut değil, farklı bir kullanıcıya ait veya aşaması URL yoluyla eşleşmiyor.
Bir tuğla figür görevi için Gerçek Zamanlı Güncellemeleri Sunucu Tarafından Gönderilen Olaylar (SSE) aracılığıyla yayınlayın.
URL yolu, görevin aşamasıyla eşleşmelidir — /prototype/:buildId/stream adresinde bir akış açmak,
status_code: 404 ile tek bir event: error yükü yayar ve akışı kapatır.
Parametreler
Name
id
Type
path
Description
Yayınlanacak tuğla figür görevi için benzersiz tanımlayıcı.
Dönüşler
Tuğla Figür Prototipi veya Tuğla Figür Yapımı görev nesnelerinin bir akışını Sunucu Tarafından Gönderilen Olaylar olarak döndürür. PENDING veya IN_PROGRESS görevler için yanıt akışı yalnızca gerekli progress ve status alanlarını içerecektir.
Tek bir aşama için tuğla figür görevlerinizin sayfalı listesini alın. URL yolu aşamayı seçer — /prototype prototip görevlerini döndürür; /build inşa görevlerini döndürür. Diğer aşamadan görevler hiçbir yanıtın içinde yer almaz.
Yol Parametreleri
Name
stage
Type
path
Zorunlu
Description
Ya prototype ya da build. Koleksiyon yalnızca aşaması URL ile eşleşen görevleri döndürür — /prototype alındığında asla inşa görevlerini döndürmez ve tam tersi.
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 maksimum değer 100 öğedir.
Name
sort_by
Type
string
varsayılan -created_at
Description
Sıralama yapılacak alan. Mevcut değerler:
+created_at: Oluşturulma zamanına göre artan sırada sıralama.
-created_at: Oluşturulma zamanına göre azalan sırada sıralama.
Tuğla Figür Prototip Görev nesnesi, Meshy'nin bir kaynak fotoğraftan tuğla tarzı bir konsept görüntü oluşturmak için takip ettiği bir iş birimidir. Bu aşamanın çıktısı, input_task_id aracılığıyla inşa aşamasına zincirlenir.
Özellikler
Name
id
Type
string
Description
Görev için benzersiz tanımlayıcı. Görev kimlikleri için k-sıralı UUID kullanıyoruz, ancak kimlik formatı hakkında herhangi bir varsayımda bulunmamalısınız.
Name
type
Type
string
Description
Görevin türü. Değer creative-lab-brick-figure-prototype'dır.
Name
name
Type
string
Description
Görev oluşturulurken sağlanan görev adı. Eğer bir ad sağlanmadıysa boş bir dize olur.
Name
status
Type
string
Description
Görevin durumu. Olası değerler PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED'dan biridir.
Name
progress
Type
integer
Description
Görevin ilerlemesi. Görev henüz başlamadıysa, bu özellik 0 olacaktır. Görev başarıyla tamamlandığında, bu 100 olur.
Name
created_at
Type
timestamp
Description
Görevin oluşturulduğu zamanın zaman damgası, milisaniye cinsinden.
Bir zaman damgası, 1 Ocak 1970 UTC'den itibaren geçen milisaniye sayısını temsil eder ve RFC 3339 standardını takip eder. Örneğin, 1 Eylül 2023 Cuma 12:00:00 PM GMT, 1693569600000 olarak temsil edilir. Bu, Meshy API'deki tüm zaman damgaları için geçerlidir.
Name
started_at
Type
timestamp
Description
Görevin başladığı zamanın zaman damgası, milisaniye cinsinden. Görev henüz başlamadıysa, bu özellik null olacaktır.
Name
finished_at
Type
timestamp
Description
Görevin tamamlandığı zamanın zaman damgası, milisaniye cinsinden. Görev henüz tamamlanmadıysa, bu özellik null olacaktır.
Name
expires_at
Type
timestamp
Description
Görev sonucunun sona erdiği zamanın zaman damgası, milisaniye cinsinden.
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 detayları. 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 mevcuttur. FAILED görevler için 0 döner (başarısızlık durumunda krediler iade edilir).
Name
image_urls
Type
array of strings
Description
Bu prototip görev tarafından üretilen konsept görüntü adaylarının indirilebilir URL'leri. Şu anda API her zaman tam olarak bir aday döndürür; alan bir dizi olarak gelecekteki revizyonların birden fazla adayı yüzeye çıkarmasına olanak tanır, böylece bir kırılma değişikliği olmadan.
Tuğla Figür Yapım Görev nesnesi, Meshy'nin başarılı bir prototip görevinden dokulu bir 3D tuğla figür oluşturmak için takip ettiği bir iş birimidir. Görselden 3D'ye tarafından kullanılan aynı görselden-3D'ye hattını çalıştırır, bu nedenle çıktı alanları bu uç noktanın görev nesnesi ile aynıdır.
Özellikler
Name
id
Type
string
Description
Görevin benzersiz tanımlayıcısı.
Name
type
Type
string
Description
Görevin türü. Değer creative-lab-brick-figure-build'dir.
Name
name
Type
string
Description
Görev oluşturulurken sağlanan görev adı. Ad sağlanmadıysa boş dize.
Name
status
Type
string
Description
Görevin durumu. Olası değerler PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED'den biridir.
Name
progress
Type
integer
Description
Görevin ilerlemesi. Görev henüz başlamadıysa, bu özellik 0 olacaktır. Görev başarıyla tamamlandığında, bu 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şladığı 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 dolduğu 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 detayları. 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öner (başarısızlık durumunda krediler iade edilir).
Name
prompt
Type
string
Description
Tuğla figür yapımı için her zaman boş. Görselden 3D'ye tarafından kullanılan paylaşılan V2ImageTo3DTaskResponse şekli ile uç nokta uyumluluğu için mevcuttur.
Name
negative_prompt
Type
string
Description
Tuğla figür yapımı için her zaman boş. Uç nokta uyumluluğu için mevcuttur.
Name
texture_prompt
Type
string
Description
Tuğla figür yapımı için her zaman boş. Uç nokta uyumluluğu için mevcuttur.
Name
texture_image_url
Type
string
Description
Tuğla figür yapımı için her zaman boş. Uç nokta uyumluluğu için mevcuttur.
Name
model_urls
Type
object
Description
Oluşturulan 3D model için indirilebilir URL'ler. Tuğla figür yapımı, dokulu bir GLB ve Wavefront OBJ'yi tercih eden hatlar için OBJ + MTL çiftini yayar. Alan şekli, gelecekteki format eklemelerinin kırılmadan eklenebilmesi için Görselden 3D'ye model_urls nesnesi ile eşleşir.