Bir kaynak fotoğrafı iki aşamada chibi tarzında toplanabilir bir 3D figüre dönüştürün:
prototip aşaması, girdi fotoğrafınızdan stilize edilmiş bir konsept görüntü oluşturur, ardından
yapı aşaması bu konsept görüntüyü dokulu bir 3D modele dönüştürür. Bu iki aşama
input_task_id aracılığıyla birbirine bağlanır.
Kaynak fotoğraftan chibi tarzında tek bir konsept görsel oluşturur.
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
Figür Prototip Görevi Nesnesi
bölümüne bakın.
Parametreler
Name
image_url
Type
string
Zorunlu
Description
Meshy'nin bir chibi figü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ı. En fazla 100 karakter.
Name
remove_background
Type
boolean
varsayılan false
Description
true olarak ayarlandığında, prototip görseli arka planı kaldırılmış saydam bir RGBA PNG olarak döndürülür; böylece konuyu herhangi bir arka planla birleştirebilirsiniz.
Dönüş Değerleri
Yanıtın result özelliği, yeni oluşturulan figür prototip görevinin id değerini içerir. Görev SUCCEEDED durumuna ulaşana kadar Bir Görev Alma uç noktasını sorgulayın veya stream aboneliği yapın, ardından bu kimliği build uç noktasınainput_task_id olarak iletin.
Başarısızlık Durumları
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 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/figure/v1/prototype
# Stage 1: generate a chibi-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/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":"018a210d-8ba4-705c-b111-1f1776f7f578"}
Prototip örneği
Bir kaynak portreyle başlayın, ardından build aşaması tarafından kullanılan prototip görseli oluşturun.
Başarıya ulaşmış bir prototip görevden nihai dokulu 3D figürü oluşturun.
Build işlemi, Görselden 3D'ye ile aynı görselden-3D'ye
pipeline'ını çalıştırır, bu nedenle yanıt nesnesi biçimi ve çıktı URL'lerinin
listesi birebir eşleşir. Yanıt şekli için
Figür Build 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ı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 — build uç noktası yalnızca POST /openapi/creative-lab/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 figür build görevinin id değerini içerir. Görev SUCCEEDED durumuna ulaşana kadar Bir Görevi Al uç noktasını yoklayın veya stream'e abone olun, ardından dokulu GLB dosyasını model_urls.glb üzerinden (veya alt akış pipeline'ınız 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ıya ulaşmamış: 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 modundaki prototip görevleri build'e zincirlenebilir).
Name
429 - Too Many Requests
Description
Hız sınırınızı aştınız.
Request
POST
/openapi/creative-lab/figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578" }'
Response
{"result":"019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"}
Build örneği
Build görevi, seçilen prototip görselini indirilebilir dokulu bir 3D modele dönüştürür.
Geçerli bir görev id'si verildiğinde bir prototip veya build görevini alın. URL yolu
görevin aşamasıyla eşleşmelidir — /prototype/:id üzerinden alınan bir build görevi
404 döndürür ve bunun tersi de geçerlidir.
Bir figür görevini iptal edin. Görev hâlâ PENDING durumundaysa, oluşturma
sırasında harcanan kredi iade edilir. IN_PROGRESS durumundaki görevler
iade yapılmadan iptal edilir (işçi zaten kaynak tüketiyor olabilir). Zaten
bir sonlanmış duruma (SUCCEEDED, FAILED, CANCELED) ulaşmış görevler
iptal edilemez.
Bir figür görevi için gerçek zamanlı güncellemeleri Server-Sent Events (SSE)
aracılığıyla yayınlar (stream). URL yolu, görevin aşamasıyla eşleşmelidir —
/prototype/:buildId/stream adresinde bir stream açmak, status_code: 404
değerine sahip tek bir event: error yükü yayımlar ve stream'i kapatır.
Parametreler
Name
id
Type
path
Description
Yayınlanacak figür görevi için benzersiz tanımlayıcı.
Dönüş Değerleri
Server-Sent Events olarak Figür Prototipi
veya Figür Yapısı görev nesnelerinden oluşan
bir stream döndürür. Her karede ilgili aşamaya ait tam görev nesnesi bulunur —
Get uç noktasının döndürdüğü ile aynı şekilde — bu nedenle görev PENDING ya
da IN_PROGRESS durumundayken çıktı alanları henüz doldurulmamıştır
(null, [] veya {}) ve finished_at değeri null olur.
Tek bir aşamaya ait 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 yapım (build) görevlerini döndürür. Diğer aşamaya ait görevler her iki
yanıta da dahil edilmez.
Yol 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 çağrısı
asla yapım 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 limiti. İzin verilen maksimum değer 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.
Figure Prototype Task nesnesi, bir kaynak fotoğraftan chibi tarzı 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örevin benzersiz tanımlayıcısı. Uygulama detayı olarak görev id'leri için k-sıralanabilir bir UUID kullansak da, id'nin formatı hakkında hiçbir varsayımda bulunmamalısınız.
Name
type
Type
string
Description
Görevin türü. Değer creative-lab-figure-prototype şeklindedir.
Name
name
Type
string
Description
Görev oluşturulduğunda verilen görev adı. Ad verilmemişse boş dizedir.
Görevin progress değeri. Görev henüz başlamadıysa bu özellik 0 olacaktır. Görev başarıyla tamamlandığında bu değer 100 olacaktır.
Name
created_at
Type
timestamp
Description
Görevin oluşturulduğu andaki 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ü GMT saatiyle 12:00:00, 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ığı andaki 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 andaki 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 dolacağı andaki 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 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ö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; bu alan, gelecekteki revizyonların kırıcı bir değişiklik yapmadan birden fazla aday sunabilmesi için bir dizi olarak tanımlanmıştır.
Figür Oluşturma Görevi nesnesi, başarılı bir prototip görevinden dokulu bir 3D figür oluşturmak için Meshy'nin takip ettiği bir iş birimidir. Görselden 3D'ye tarafından kullanılan aynı görselden-3D'ye pipeline'ını çalıştırır, bu nedenle çıktı alanları o 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-figure-build şeklindedir.
Name
name
Type
string
Description
Görev oluşturulduğunda sağlanan görev adı. Herhangi bir ad sağlanmadıysa 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 olacaktır.
Name
created_at
Type
timestamp
Description
Görevin oluşturulduğu zamanın milisaniye cinsinden zaman damgası.
Name
started_at
Type
timestamp
Description
Görevin başladığı zamanın milisaniye cinsinden zaman damgası.
Name
finished_at
Type
timestamp
Description
Görevin tamamlandığı zamanın milisaniye cinsinden zaman damgası.
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ı. 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
prompt
Type
string
Description
Figür oluşturma için her zaman boştur. Görselden 3D'ye tarafından kullanılan ortak V2ImageTo3DTaskResponse şekliyle uç noktalar arası uyumluluk için mevcuttur.
Name
negative_prompt
Type
string
Description
Figür oluşturma için her zaman boştur. Uç noktalar arası uyumluluk için mevcuttur.
Name
texture_prompt
Type
string
Description
Figür oluşturma için her zaman boştur. Uç noktalar arası uyumluluk için mevcuttur.
Name
texture_image_url
Type
string
Description
Figür oluşturma 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. Figür oluşturma, dokulu bir GLB ile birlikte Wavefront OBJ'yi tercih eden pipeline'lar için OBJ + MTL çiftini üretir. Alan şekli, Görselden 3D'ye model_urls nesnesiyle eşleşir, böylece gelecekteki format eklemeleri kırıcı bir değişiklik olmadan yerine oturur.