Bir kaynak fotoğrafı iki aşamada büyük kafalı bir vinil koleksiyonluk 3D figüre dönüştürün: prototip giriş fotoğrafınızdan stilize bir konsept resmi oluşturur, ardından yapı bu konsept resmini dokulu bir 3D model haline getirir. İki aşama input_task_id üzerinden bağlantılıdır.
POST /openapi/creative-lab/vinyl-figure/v1/prototype
Kaynak fotoğraftan tek bir vinyl-figür tarzı konsept görseli oluşturun. Döndürülen görev kimliği, bunu input_task_id olarak oluşturma uç noktasına geçirmeniz gereken kimliktir. Yanıt yapısı için Vinyl Figür Prototip Görevi Nesnesi sayfasına bakın.
Parametreler
Name
image_url
Type
string
Zorunlu
Description
Meshy'nin büyük başlı bir vinyl figür olarak stilize etmesi için kaynak fotoğraf. Şu anda .jpg, .jpeg, .png ve .webp formatlarını destekliyoruz.
Görseli sağlamak için iki yol vardır:
Genel olarak erişilebilir URL: İnternet üzerinden erişilebilen bir URL.
Data URI: Görselin base64 ile kodlanmış bir veri URI'si. Bir veri URI örneği: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
Görüntüleme amacıyla isteğe bağlı görev adı. Maksimum 100 karakter.
Dönüşler
Yanıtın result özelliği, yeni oluşturulan vinyl figür prototip görevinin id kimliğini içerir. Görev SUCCEEDED olana kadar Bir Görev Al uç noktasını takip edin veya akışa abone olun, ardından bu kimliği input_task_id olarak yapılandırma uç noktasına geçirin.
Başarısızlık Modları
Name
400 - Bad Request
Description
İstek kabul edilemezdi. Yaygın sebepler:
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ı sınır dışında: Görsel ç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: Girdideki görsel 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.
İstek
POST
/openapi/creative-lab/vinyl-figure/v1/prototype
# Aşama 1: vinyl-figür tarzı bir konsept görseli oluşturuncurl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/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>" }'
Yanıt
{"result":"019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de"}
Prototype example
Start with a source portrait, then generate the prototype image used by the build stage.
Başarılı bir prototip görevden son dokulu 3D vinil figürü oluşturun. Yapı, Görselden 3D'ye ile aynı görüntüden 3D'ye dönüşüm hattını çalıştırır, bu nedenle yanıt nesne formatı ve çıktı URL'leri listesi tam olarak aynıdır. Yanıt şekli için Vinil Figür Yapı Görev Nesnesi bölümüne başvurun.
Parametreler
Name
input_task_id
Type
string
Zorunlu
Description
Aynı OpenAPI uç noktası aracılığıyla oluşturulan bir prototip görevin görevi numarası. Prototip, aynı API anahtarıyla oluşturulmuş olmalı, SUCCEEDED durumuna ulaşmış ve tam olarak bir aday görüntü üretmiş olmalıdır.
Web uygulaması aracılığıyla 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 kaynakları 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önenler
Yanıtın result özelliği, yeni oluşturulan vinil figür yapı görevinin 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 altyapınızın OBJ tercih etmeleri durumunda model_urls.obj ve model_urls.mtl çifti).
Hata Modları
Name
400 - Bad Request
Description
İstek kabul edilemezdi. Genel 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 alınan prototip görev, henüz SUCCEEDED durumuna ulaşmamıştır.
Aday yok: Prototip görev başarılı oldu ancak aday bir görüntü ü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 alınan 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 bu yapıya bağlanır).
Name
429 - Too Many Requests
Description
Hız sınırınızı aştınız.
İstek
POST
/openapi/creative-lab/vinyl-figure/v1/build
# Aşama 2: başarılı bir prototip görevden zincir yapıcurl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build \ -X POST \ -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 verilmiş prototip veya inşa görevi alın. URL yolu
görevin aşamasıyla uyumlu olmalıdır — bir inşa görevi /prototype/:id
ile getirildiğinde 404 döner ve tersi de geçerlidir.
Bir vinyl figür görevini iptal eder. Görev hâlâ PENDING durumdaysa, oluşturulma sırasında tüketilen krediler iade edilir. Zaten IN_PROGRESS olan görevler, iade yapılmadan iptal edilir (çalışan kaynakları zaten tükeniyor olabilir). Zaten terminal durumuna (SUCCEEDED, FAILED, CANCELED) ulaşmış görevler iptal edilemez.
URL yolu, görevin aşaması ile eşleşmelidir — /prototype/:buildId üzerindeki DELETE404 döndürür.
Vinil figür görevi için gerçek zamanlı güncellemeleri Server-Sent Events
(SSE) aracılığıyla yayınla. URL yolu görevin aşamasıyla eşleşmelidir —
/prototype/:buildId/stream bir event: error yükü ve
status_code: 404 emisyonuyla akışı kapatır.
Vinil Figür Prototipi
veya Vinil Figür Oluşturma görev
nesnelerini Server-Sent Events olarak döner. PENDING veya IN_PROGRESS
görevler için yanıt akışı sadece gerekli progress ve status alanlarını
içerecektir.
Belirli bir aşama için pagine edilmiş vinyl figür görevlerinizi alın.
URL yolu aşamayı seçer — /prototype prototip görevlerini döndürür;
/build yapı görevlerini döndürür. Diğer aşamanın görevleri her iki
yanıtın da içinde yer almaz.
Yol Parametreleri
Name
stage
Type
path
Zorunlu
Description
prototype veya build. Koleksiyon sadece URL ile
eşleşen aşamanın görevlerini döndürür — /prototype
çağırmak yapı görevlerini asla döndürmez ve 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 50 birimdir.
Name
sort_by
Type
string
varsayılan -created_at
Description
Sıralama için alan. Mevcut değerler:
+created_at: Oluşturulma zamanına göre artan sırada sıralayın.
-created_at: Oluşturulma zamanına göre azalan sırada sıralayın.
Vinyl Figür Prototip Görev nesnesi, Meshy'nin bir kaynak fotoğraftan vinil figür tarzında bir konsept görüntüsü oluşturmak için izlediğ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örevin benzersiz tanımlayıcısı. Görev kimlikleri için k-sıralı UUID kullanıyoruz ancak kimliğin formatı hakkında
varsayımlarda bulunmamalısınız.
Name
type
Type
string
Description
Görevin türü. Değer creative-lab-vinyl-figure-prototype şeklindedir.
Name
name
Type
string
Description
Görev oluşturulduğunda sağlanan görev adı. Ad verilmediyse boş bir dize olacaktır.
Name
status
Type
string
Description
Görevin durumu. Olası değerler arasında PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED bulunur.
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 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; Cuma, Eylül 1, 2023 12:00:00 PM GMT, 1693569600000 şeklinde 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 0 olacaktır.
Name
finished_at
Type
timestamp
Description
Görevin bittiği zaman damgası, milisaniye cinsinden. Görev henüz bitmediyse, bu özellik 0 olacaktır.
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ı.
Bu alanın değeri sadece görev durumu PENDING ise anlam taşı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 kısmına bakın.
Name
consumed_credits
Type
integer
Description
Bu görevin tükettiği 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ıkta krediler iade edilir).
Name
image_urls
Type
array of strings
Description
Bu prototip görevi 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 kalır, böylece gelecekteki revizyonlar birden fazla adayı kırılma yapmadan sunabilir.
Vinil Figür İnşa Görev nesnesi, bir prototip görevinin başarıyla tamamlanmasından sonra bir doku entegre edilmiş 3D vinil figür oluşturmak için Meshy'nin takip ettiği bir iş birimidir.
Bu görev, Görselden 3D'ye tarafından kullanılan aynı görselden 3D'ye dönüşüm hattını çalıştırır, bu nedenle çıktı alanları bu uç noktanın görev nesnesi ile paralellik gösterir.
Özellikler
Name
id
Type
string
Description
Görev için benzersiz kimlik.
Name
type
Type
string
Description
Görevin türü. Değer creative-lab-vinyl-figure-build olacaktır.
Name
name
Type
string
Description
Göreve atanmış isim, görev oluşturulduğunda sağlanır. Eğer isim verilmediyse boş string olur.
Name
status
Type
string
Description
Görevin durumu. Olası değerler PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED olabilir.
Name
progress
Type
integer
Description
Görevin ilerleme durumu. Görev henüz başlamamışsa, bu özellik 0 olur. 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ş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 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 nesnesi referansı için Errors adresine bakın.
Name
consumed_credits
Type
integer
Description
Bu görev tarafından tüketilen kredilerin sayısı. FAILED görevler için 0 döndürür (hata durumunda krediler iade edilir).
Name
prompt
Type
string
Description
Vinil figür oluşturma için her zaman boştur. Görselden 3D'ye tarafından kullanılan paylaşılan V2ImageTo3DTaskResponse yapısı ile farklı uç nokta uyumluluğu için mevcuttur.
Name
negative_prompt
Type
string
Description
Vinil figür oluşturma için her zaman boştur. Farklı uç nokta uyumluluğu için mevcuttur.
Name
texture_prompt
Type
string
Description
Vinil figür oluşturma için her zaman boştur. Farklı uç nokta uyumluluğu için mevcuttur.
Name
texture_image_url
Type
string
Description
Vinil figür oluşturma için her zaman boştur. Farklı uç nokta uyumluluğu için mevcuttur.
Name
model_urls
Type
object
Description
Oluşturulan 3D model için indirilebilir URL'ler. Vinil figür oluşturma, Wavefront OBJ'yi tercih eden hatlar için doku eklenmiş GLB ve OBJ + MTL çifti üretir. Alan yapısı Görselden 3D'ye model_urls nesnesi ile eşleşir, böylece gelecekte format eklemeleri kopma olmadan uyarlanır.