Bir kaynak fotoğrafı iki aşamada chibi tarzı, koleksiyonluk bir 3D figüre dönüştürün:
prototip, giriş fotoğrafınızdan stilize bir konsept görseli oluşturur, ardından
build bu konsept görselini kaplamalı bir 3D modele dönüştürür. İki aşama
input_task_id aracılığıyla bağlanır.
Kaynak fotoğraftan tek bir chibi tarzı konsept görsel oluşturun. Döndürülen
görev ID'si, derleme uç noktasına input_task_id olarak ilettiğiniz değerdir.
Yanıt yapısı için
Figür Prototip Görevi Nesnesi
bölümüne bakın.
Parametreler
Name
image_url
Type
string
Zorunlu
Description
Meshy'nin chibi figür olarak stilize etmesi için 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: Herkese açık internetten erişilebilen bir URL.
Data URI: Görselin base64 ile kodlanmış Data URI'si. Bir Data 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öndürür
Yanıtın result özelliği, yeni oluşturulan 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ı yoklayın veya stream aboneliği yapın, ardından bu ID'yi derleme uç noktasınainput_task_id olarak iletin.
Hata Modları
Name
400 - Bad Request
Description
İstek kabul edilemezdi. Yaygın nedenler:
Eksik parametre: image_url zorunludur.
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.
Ulaşılamayan 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 imagecurl https://api.meshy.ai/openapi/creative-lab/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>" }'
Response
{"result":"018a210d-8ba4-705c-b111-1f1776f7f578"}
Prototype example
Start with a source portrait, then generate the prototype image used by the build stage.
Başarılı bir prototip görevinden nihai kaplamalı 3D figürü oluşturun.
Build, Görselden 3D'ye ile aynı görselden 3D'ye işlem hattını çalıştırır; bu nedenle yanıt nesnesi biçimi ve
çıktı URL'leri listesi bire bir aynıdır. Yanıt biçimi için
Figür Build Görev 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 ID'si. 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 — build uç noktası yalnızca POST /openapi/creative-lab/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çları için isteğe bağlı görev adı. En fazla 100 karakter.
Döndürür
Yanıtın result özelliği, yeni oluşturulan figür build görevinin görev id değerini içerir. Görev SUCCEEDED durumuna ulaşana kadar Bir Görev Al uç noktasını yoklayın veya stream aboneliği kurun; ardından kaplamalı GLB dosyasını model_urls.glb üzerinden indirin (veya sonraki işlem hattı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 edilemezdi. 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: Başvurulan 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
Başvurulan prototip görev mevcut değil, farklı bir kullanıcıya ait veya webapp üzerinden oluşturulmuş (yalnızca API mode prototip görevleri build aşamasına zincirlenir).
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 taskcurl https://api.meshy.ai/openapi/creative-lab/figure/v1/build \ -X POST \ -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 example
The build task turns the selected prototype image into a downloadable textured 3D model.
Geçerli bir görev id değeriyle bir prototip veya derleme görevini alın. URL yolu
görevin aşamasıyla eşleşmelidir — /prototype/:id üzerinden getirilen
bir derleme görevi 404 döndürür ve tersi de geçerlidir.
Bir figür görevini iptal edin. Görev hâlâ PENDING durumundaysa, oluşturma anında
tüketilen kredi iade edilir. Zaten
IN_PROGRESS durumunda olan görevler iadesiz olarak iptal edilir (çalışan zaten
kaynakları tüketiyor olabilir). Zaten bir terminal duruma
(SUCCEEDED, FAILED, CANCELED) ulaşmış görevler iptal edilemez.
Server-Sent Events (SSE) aracılığıyla bir figür görevi için gerçek zamanlı güncellemeleri akışla aktarı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ışla aktarılacak figür görevi için benzersiz tanımlayıcı.
Döndürür
Server-Sent Events olarak Figür Prototipi
veya Figür Oluşturma görev nesnelerinden oluşan bir akış döndürür.
PENDING veya IN_PROGRESS görevleri için yanıt akışı yalnızca gerekli
progress ve status alanlarını içerir.
Tek bir aşama için figür görevlerinizin sayfalanmış listesini alın. URL
yolu aşamayı seçer — /prototype prototip görevlerini döndürür; /build
build görevlerini döndürür. Diğer aşamadaki görevler her iki
yanıta da dahil edilmez.
Yol Parametreleri
Name
stage
Type
path
Zorunlu
Description
prototype veya build. Koleksiyon yalnızca aşaması URL ile eşleşen
görevleri döndürür — /prototype çekmek hiçbir zaman
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 50 öğ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ırala.
-created_at: Oluşturulma zamanına göre azalan sırada sırala.
Figür Prototip Görevi nesnesi, Meshy'nin bir kaynak fotoğraftan chibi tarzı bir konsept görseli oluşturmak için
takip ettiğ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örev için benzersiz tanımlayıcı. Uygulama ayrıntısı olarak görev id'leri için k-sıralanabilir bir UUID kullansak da, id'nin biçimi hakkında herhangi 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şturulurken sağlanan görev adı. Ad sağlanmadıysa boş dizedir.
Görevin progress değeri. Görev henüz başlatılmadıysa bu özellik 0 olur. Görev başarıyla tamamlandığında bu değer 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 bu yana geçen milisaniye sayısını temsil eder ve
RFC 3339 standardını izler.
Örneğin, 1 Eylül 2023 Cuma 12:00:00 GMT, 1693569600000 olarak temsil edilir. Bu,
Meshy API içindeki tüm zaman damgaları için geçerlidir.
Name
started_at
Type
timestamp
Description
Görevin başlatıldığı zaman damgası, milisaniye cinsinden. Görev henüz başlatılmadıysa bu özellik 0 olur.
Name
finished_at
Type
timestamp
Description
Görevin tamamlandığı zaman damgası, milisaniye cinsinden. Görev henüz tamamlanmadıysa bu özellik 0 olur.
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 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 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 bulunur. FAILED görevler için 0 döndürür (başarısızlık durumunda kredi iade edilir).
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 dizidir, böylece gelecekteki revizyonlar kırıcı değişiklik olmadan birden fazla adayı gösterebilir.
Figür Oluşturma Görev nesnesi, Meshy'nin başarılı bir prototip görevinden
kaplamalı bir 3D figür oluşturmak için izlediğ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ı ilgili uç noktanın görev nesnesi ile aynıdı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 olur.
Name
name
Type
string
Description
Görev oluşturulurken sağlanan görev adı. Ad sağlanmadıysa boş dize.
Görevin progress değeri. Görev henüz başlatılmadıysa bu özellik 0 olur. Görev başarıyla tamamlandığında bu değer 100 olur.
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şlatıldığı 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 dolduğu 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 nesnesi başvurusu 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 (krediler başarısızlık durumunda 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 paylaşılan V2ImageTo3DTaskResponse yapısıyla 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, Wavefront OBJ tercih eden işlem hatları için dokulu bir GLB ile OBJ + MTL çiftini üretir. Alan yapısı, gelecekteki biçim eklemelerinin uyumluluğu bozan bir değişiklik olmadan yerleşebilmesi 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ı için indirilebilir URL (geometri + UV).
Name
mtl
Type
string
Description
OBJ eşlikçisi MTL malzeme dosyası için indirilebilir URL. obj ve texture_urls[0].base_color içindeki girişle eşleştirin.
Name
thumbnail_url
Type
string
Description
Model dosyasının küçük resim görseli 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ını içeren tek bir nesne içerir.
Name
base_color
Type
string
Description
Temel renk haritası görseli için indirilebilir URL.