Bir kaynak fotoğrafı, iki aşamada büyük kafalı vinil koleksiyon 3D figürüne
dönüştürün: prototip aşaması, girdi fotoğrafınızdan stilize edilmiş bir
konsept görüntüsü oluşturur, ardından yapım aşaması bu konsept görüntüsünü
dokulu bir 3D modele dönüştürür. İki aşama input_task_id aracılığıyla
birbirine bağlanır.
POST /openapi/creative-lab/vinyl-figure/v1/prototype
Kaynak fotoğraftan tek bir vinyl-figür tarzında konsept görüntü üretir. Döndürülen görev kimliği, build uç noktasına input_task_id olarak ilettiğiniz değerdir. Yanıt şekli için
Vinyl Figür Prototip Görevi Nesnesi
bölümüne bakın.
Parametreler
Name
image_url
Type
string
Zorunlu
Description
Meshy'nin büyük kafalı bir vinyl figüre dönüştürerek stilize edeceği kaynak fotoğraf. Şu anda .jpg, .jpeg, .png ve .webp formatlarını destekliyoruz.
Görüntüyü sağlamanın iki yolu vardır:
Herkese açık erişilebilir URL: Genel internet üzerinden erişilebilen bir URL.
Data URI: Görüntünün base64 ile kodlanmış data URI'si. Data URI örneği: data:image/jpeg;base64,<base64 ile kodlanmış görüntü 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örüntüsü arka planı kaldırılmış, şeffaf RGBA PNG olarak döndürülür; böylece öznesini herhangi bir arka planla birleştirebilirsiniz.
Dönüş Değerleri
Yanıtın result özelliği, yeni oluşturulan vinyl figür prototip görevinin id değerini içerir. Görev SUCCEEDED durumuna ulaşana kadar Bir Görev Alma uç noktasını yoklayın veya stream'e abone olun, ardından bu kimliği 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 zorunludur.
Geçersiz görüntü formatı: Sağlanan image_url desteklenen bir formatta 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şilemeyen URL: image_url indirilemedi (404 veya timeout).
Geçersiz Data URI: Base64 dizesi hatalı biçimlendirilmiş.
İçerik işaretlendi: Girdi görüntüsü 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/vinyl-figure/v1/prototype
# Stage 1: generate a vinyl-figure-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/vinyl-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>" }'
Response
{"result":"019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de"}
Prototype example
Start with a source photo, then generate the prototype image used by the build stage.
Başarılı bir prototip görevinden nihai dokulu 3D vinyl figürü oluşturur. Yapı 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 Vinyl Figure Yapı 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şturulan bir prototip görevinin görev kimliği. Prototip aynı API anahtarıyla 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ı uç noktası yalnızca POST /openapi/creative-lab/vinyl-figure/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 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 vinyl figure yapı 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 dosyasını model_urls.glb üzerinden (veya alt akış işleminiz OBJ 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 zorunludur.
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 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 mode prototip görevleri yapı görevine zincirlenebilir).
Name
429 - Too Many Requests
Description
Hız sınırınızı aştınız.
Request
POST
/openapi/creative-lab/vinyl-figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de" }'
Geçerli bir görev id'si verildiğinde bir prototip veya derleme (build) görevini getirir. 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 vinil figür görevini iptal eder. Görev hâlâ 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ı
zaten tüketiyor olabilir). Zaten bir son duruma ulaşmış görevler
(SUCCEEDED, FAILED, CANCELED) iptal edilemez.
Bir vinil figür görevine ait gerçek zamanlı güncellemeleri Server-Sent Events
(SSE) aracılığıyla akışla alın. URL yolu, görevin aşamasıyla eşleşmelidir —
/prototype/:buildId/stream adresinde 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ışı alınacak vinil figür görevi için benzersiz tanımlayıcı.
Dönüş Değerleri
Server-Sent Events olarak Vinil Figür Prototipi
veya Vinil Figür Yapısı görev nesnelerinin
bir akışını döndürür. Her karede o aşamaya ait tam görev nesnesi bulunur — Get
uç noktasının döndürdüğüyle aynı şekilde — bu nedenle görev PENDING veya
IN_PROGRESS durumundayken çıktı alanları henüz doldurulmamıştır
(null, [] veya {}) ve finished_at değeri null'dır.
Tek bir aşamaya ait vinil figür görevlerinizin sayfalanmış bir listesini alın.
URL yolu aşamayı seçer — /prototype prototip görevlerini döndürür;
/build ise derleme 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
URL ile eşleşen aşamaya ait görevleri döndürür — /prototype
adresini almak asla derleme 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 100 öğedir.
Name
sort_by
Type
string
varsayılan -created_at
Description
Sıralama yapılacak alan. Kullanılabilir değerler:
+created_at: Oluşturulma zamanına göre artan sırada sıralar.
-created_at: Oluşturulma zamanına göre azalan sırada sıralar.
Vinyl Figür Prototip Görevi nesnesi, bir kaynak fotoğraftan vinyl-figür tarzında bir konsept görüntü 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 id'leri için k-sıralanabilir bir UUID kullanıyor olsak da, id'nin biçimi hakkında hiçbir varsayımda bulunmamalısınız.
Name
type
Type
string
Description
Görevin türü. Değer creative-lab-vinyl-figure-prototype'tır.
Name
name
Type
string
Description
Görev oluşturulduğunda sağlanan görev adı. Eğer bir ad sağlanmadıysa boş dizedir.
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 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 olacaktır.
Name
created_at
Type
timestamp
Description
Görevin oluşturulduğu zamanın milisaniye cinsinden zaman damgası.
Bir zaman damgası, RFC 3339 standardını takip ederek 1 Ocak 1970 UTC'den itibaren geçen milisaniye sayısını temsil eder.
Örneğin, 1 Eylül 2023 Cuma, 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şlatıldığı zamanın milisaniye cinsinden zaman damgası. Görev henüz başlamadıysa, bu özellik 0 olacaktır.
Name
finished_at
Type
timestamp
Description
Görevin tamamlandığı zamanın milisaniye cinsinden zaman damgası. Görev henüz tamamlanmadıysa, bu özellik 0 olacaktır.
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 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ı. 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 geri ödenir).
Name
image_urls
Type
array of strings
Description
Bu prototip görevi tarafından oluşturulan konsept görüntü 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ılma değişikliği yapmadan birden fazla adayı sunabilir.
Vinyl Figür Yapım Görevi nesnesi, Meshy'nin başarılı bir prototip görevinden dokulu bir 3D vinyl figür oluşturmak için takip ettiği bir iş birimidir.
Görselden 3D'ye tarafından kullanılan aynı görselden-3D-boyuta işlem hattını çalıştırır,
bu nedenle çıktı alanları bu uç noktanın görev 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-vinyl-figure-build'dir.
Name
name
Type
string
Description
Görev oluşturulduğunda sağlanan görev adı. Ad sağlanmadıysa boş dizedir.
Görevin ilerlemesi. Görev henüz başlamadıysa bu özellik 0 olacaktır. Görev başarılı olduğunda ise 100 olacaktır.
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 sayfasına 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
Vinyl figür yapımı 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
Vinyl figür yapımı için her zaman boştur. Uç noktalar arası uyumluluk için mevcuttur.
Name
texture_prompt
Type
string
Description
Vinyl figür yapımı için her zaman boştur. Uç noktalar arası uyumluluk için mevcuttur.
Name
texture_image_url
Type
string
Description
Vinyl figür yapımı 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. Vinyl figür yapımı, dokulu bir GLB ile birlikte Wavefront OBJ tercih eden işlem hatları için OBJ + MTL çiftini üretir. Alan şekli, gelecekteki format eklemelerinin kesintiye yol açmadan uyum sağlaması için Görselden 3D'ye model_urls nesnesiyle eşleşir.
Name
glb
Type
string
Description
Dokulu GLB dosyası için indirilebilir URL.
Name
obj
Type
string
Description
Wavefront OBJ dosyası (geometri + UV) için indirilebilir URL.
Name
mtl
Type
string
Description
OBJ eşlik eden MTL malzeme dosyası için indirilebilir URL. obj ile ve texture_urls[0].base_color girdisiyle birlikte kullanın.
Name
thumbnail_url
Type
string
Description
Model dosyasının küçük resmi için indirilebilir URL.
Name
texture_urls
Type
array
Description
Bu görev tarafından oluşturulan doku URL nesnelerinden oluşan bir dizi. Şu anda temel renk haritasına sahip tek bir nesne içerir.
Name
base_color
Type
string
Description
Temel renk haritası görseli için indirilebilir URL.