Bir kaynak fotoğrafı iki aşamada tuğla stilinde koleksiyonluk bir 3D minik figüre dönüştürün:
prototype aşaması, girdi fotoğrafınızdan stilize edilmiş bir konsept görüntüsü oluşturur, ardından
build aşaması bu konsept görüntüyü dokulu bir 3D modele dönüştürür. Bu iki aşama
input_task_id üzerinden birbirine bağlanır.
POST /openapi/creative-lab/brick-figure/v1/prototype
Kaynak fotoğraftan tek bir brick tarzı konsept görsel oluşturur. Döndürülen görev ID'si, build uç noktasına input_task_id olarak ilettiğiniz değerdir. Yanıt şekli için
Brick Figür Prototip Görevi Nesnesi
bölümüne bakın.
Parametreler
Name
image_url
Type
string
Zorunlu
Description
Meshy'nin brick minifigür olarak stilize edeceği 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: Genel internetten erişilebilen bir URL.
Data URI: Görselin base64 ile kodlanmış bir data URI'si. Data URI örneği: data:image/jpeg;base64,<base64 ile kodlanmış görsel verileriniz>.
Name
name
Type
string
Description
Görüntüleme amaçlı 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örseli arka planı kaldırılmış, şeffaf bir RGBA PNG olarak döndürülür; böylece öznenizi istediğiniz herhangi bir arka planla birleştirebilirsiniz.
Dönüş Değerleri
Yanıtın result özelliği, yeni oluşturulan brick figür prototip görevinin id değerini içerir. Görev SUCCEEDED durumuna ulaşana kadar Bir Görevi Getir uç noktasını yoklayın veya stream'e abone olun, ardından bu ID'yi build uç noktasınainput_task_id olarak iletin.
Hata Modları
Name
400 - Bad Request
Description
İstek kabul edilemedi. Yaygın nedenler:
Eksik parametre: image_url gereklidir.
Geçersiz görsel formatı: Sağlanan image_url desteklenen bir formatta 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ş.
İçerik işaretlendi: Girdi görseli 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örseli fikri mülkiyet ihlali nedeniyle işaretlendi.
Name
429 - Too Many Requests
Description
Hız sınırınızı aştınız.
Request
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 dokulu son 3D tuğla figürü oluşturun. Yapım işlemi, Görselden 3D'ye ile aynı görselden-3D'ye ardışık düzenini çalıştırır, bu nedenle yanıt nesnesi biçimi ve çıktı URL'lerinin listesi tam olarak eşleşir. Yanıt şekli için Tuğla Figür Yapım 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 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.
Webapp üzerinden oluşturulan prototip görevleri kabul edilmez — yapım uç noktası yalnızca POST /openapi/creative-lab/brick-figure/v1/prototype tarafından üretilen prototip görevlerini 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ı. En fazla 100 karakter.
Dönüş Değerleri
Yanıtın result özelliği, yeni oluşturulan tuğla figür yapım görevinin id değerini içerir. Görev SUCCEEDED durumuna ulaşana kadar Bir Görevi Al uç noktasını yoklayın veya akışa abone olun, ardından dokulu GLB'yi model_urls.glb üzerinden (veya alt işlem hattınız OBJ'yi tercih ediyorsa model_urls.obj ve model_urls.mtl üzerinden OBJ + MTL çiftini) indirin.
Hata Modları
Name
400 - Bad Request
Description
İstek kabul edilemedi. 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: Referans verilen prototip görevi henüz SUCCEEDED durumuna ulaşmadı.
Aday yok: Prototip görevi başarılı oldu ancak hiçbir 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örevi mevcut değil, farklı bir kullanıcıya ait veya webapp üzerinden oluşturulmuş (yalnızca API modundaki prototip görevleri yapım ile zincirlenebilir).
Name
429 - Too Many Requests
Description
Hız sınırınızı aştınız.
Request
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 id değeri verilerek bir prototip veya build görevini getirin. URL yolu,
görevin aşamasıyla eşleşmelidir — /prototype/:id üzerinden getirilen bir build görevi
404 döndürür, ve bunun tersi de geçerlidir.
Bir brick figure görevini iptal eder. Görev henüz PENDING durumundaysa,
oluşturma sırasında harcanan kredi iade edilir. Zaten IN_PROGRESS
durumunda olan görevler iade yapılmadan iptal edilir (worker kaynakları
tüketmeye çoktan başlamış 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
DELETE işlemi 404 döndürür.
Bir tuğla figür 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
adresinde bir akış açmak, status_code: 404 değerine sahip tek bir
event: error yükü yayınlar ve akışı kapatır.
Parametreler
Name
id
Type
path
Description
Akışı alınacak tuğla figür görevi için benzersiz tanımlayıcı.
Dönüş Değerleri
Server-Sent Events olarak Tuğla Figür Prototip
veya Tuğla Figür Build görev nesnelerinden oluşan
bir akış döndürür. Her kare, ilgili aşama için tam görev nesnesini taşır — Get
uç noktasının döndürdüğü ile aynı şekli — bu nedenle görev PENDING veya IN_PROGRESS
durumundayken çıktı alanları henüz doldurulmamıştır (null, [] veya {}) ve
finished_at alanı null olur.
Tek bir aşama için brick figür görevlerinizin sayfalanmış bir listesini alın. URL
yolu aşamayı belirler — /prototype prototip görevlerini döndürür; /build
build görevlerini döndürür. Diğer aşamaya ait görevler her iki yanıta da
dahil edilmez.
Path Parametreleri
Name
stage
Type
path
Zorunlu
Description
prototype veya build değerlerinden biri. Koleksiyon yalnızca
aşaması URL ile eşleşen görevleri döndürür — /prototype üzerinden
alınan veriler asla build görevlerini döndürmez ve bunun 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 maksimum değer 100 öğedir.
Name
sort_by
Type
string
varsayılan -created_at
Description
Sıralanacak alan. Kullanılabilir değerler:
+created_at: Oluşturulma zamanına göre artan sırayla sırala.
-created_at: Oluşturulma zamanına göre azalan sırayla sırala.
Brick Figure Prototype Task nesnesi, kaynak bir fotoğraftan tuğla stilinde bir konsept görsel oluşturmak için Meshy'nin takip ettiği bir iş birimidir. Bu aşamanın çıktısı, input_task_id aracılığıyla derleme aşamasına zincirlenir.
Özellikler
Name
id
Type
string
Description
Görev için benzersiz tanımlayıcı. Uygulama detayı olarak görev kimlikleri için k-sıralanabilir bir UUID kullansak da, kimliğin biçimiyle ilgili herhangi bir varsayımda bulunmamalısınız.
Name
type
Type
string
Description
Görevin türü. Değer creative-lab-brick-figure-prototype şeklindedir.
Name
name
Type
string
Description
Görev oluşturulurken belirtilen görev adı. Herhangi bir ad belirtilmediyse boş dizedir.
Görevin progress'i. Görev henüz başlamadıysa bu özellik 0 olacaktır. Görev başarılı olduğunda bu değer 100 olur.
Name
created_at
Type
timestamp
Description
Görevin oluşturulduğu zaman damgası, milisaniye cinsinden.
Bir zaman damgası, RFC 3339 standardını takip ederek 1 Ocak 1970 UTC'den bu yana geçen milisaniye sayısını temsil eder.
Örneğin, 1 Eylül 2023 Cuma günü 12:00:00 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 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 damgası, milisaniye cinsinden. Görev henüz tamamlanmadıysa bu özellik null olacaktır.
Name
expires_at
Type
timestamp
Description
Görev sonucunun sona ereceği 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 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 sayfasına 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örevi tarafından oluşturulan konsept görsel adayları için indirilebilir URL'ler. Şu anda API her zaman tam olarak bir aday döndürür; alan bir dizi olarak tanımlanmıştır, böylece gelecekteki revizyonlar kırıcı bir değişiklik yapmadan birden fazla aday sunabilir.
Brick Figure Build Task nesnesi, Meshy'nin başarılı bir prototip görevinden dokulu bir 3D brick figure (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 işlem hattını çalıştırır, bu nedenle çıktı alanları bu uç noktanın task nesnesini yansıtır.
Ö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-brick-figure-build şeklindedir.
Name
name
Type
string
Description
Görev oluşturulduğunda sağlanan görev adı. Ad sağlanmadıysa boş dize.
Görevin progress değeri. Görev henüz başlamadıysa bu özellik 0 olacaktır. Görev başarılı olduğunda bu değer 100 olur.
Name
created_at
Type
timestamp
Description
Görevin oluşturulduğu zaman damgası, milisaniye cinsinden.
Name
started_at
Type
timestamp
Description
Görevin başladığı zaman damgası, milisaniye cinsinden.
Name
finished_at
Type
timestamp
Description
Görevin tamamlandığı zaman damgası, milisaniye cinsinden.
Name
expires_at
Type
timestamp
Description
Görev sonucunun süresinin dolduğu 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öner (başarısızlık durumunda krediler iade edilir).
Name
prompt
Type
string
Description
Brick figure build için her zaman boştur. Görselden 3D'ye tarafından kullanılan paylaşılan V2ImageTo3DTaskResponse şekliyle uç noktalar arası uyumluluk için mevcuttur.
Name
negative_prompt
Type
string
Description
Brick figure build için her zaman boştur. Uç noktalar arası uyumluluk için mevcuttur.
Name
texture_prompt
Type
string
Description
Brick figure build için her zaman boştur. Uç noktalar arası uyumluluk için mevcuttur.
Name
texture_image_url
Type
string
Description
Brick figure build için her zaman boştur. Uç noktalar arası uyumluluk için mevcuttur.
Name
model_urls
Type
object
Description
Oluşturulan 3D model için indirilebilir URL'ler. Brick figure build, dokulu bir GLB ile birlikte Wavefront OBJ'yi tercih eden işlem hatları için OBJ + MTL çiftini yayınlar. Alan şekli, gelecekteki format eklemelerinin kırılma yaratmadan uyum sağlaması için Görselden 3D'ye model_urls nesnesiyle eşleşir.