Görselden 3D'ye API, Meshy'nin Görselden 3D'ye yeteneklerini kendi uygulamanıza entegre etmenizi sağlayan bir özelliktir. Bu bölümde, bu API ile başlamanız için gereken tüm bilgileri bulacaksınız.
Bu uç nokta, yeni bir Görselden 3D'ye görevi oluşturmanızı sağlar. Görselden 3D'ye görev nesnesiyle birlikte hangi özelliklerin yer aldığını görmek için
Görselden 3D'ye Görev Nesnesi bölümüne bakın.
Parametreler
input_task_id veya image_url parametrelerinden yalnızca biri zorunludur. İkisi de sağlanırsa, input_task_id önceliklidir.
Name
input_task_id
Type
string
Zorunlu
Description
Çıktısı giriş görseli olarak kullanılacak, tamamlanmış bir görsel oluşturma görevinin kimliği. Bu görev şu görev türlerinden biri olmalıdır: Metinden görsele veya Görselden görsele. Ayrıca, API üzerinden çalıştırılmış olmalı, SUCCEEDED durumunda olmalı ve tam olarak bir görsel üretmiş olmalıdır.
Name
image_url
Type
string
Zorunlu
Description
Meshy'nin model oluşturmada kullanması için bir görsel sağlayın. Şu anda .jpg, .jpeg ve .png 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
model_type
Type
string
varsayılan standard
Description
3D ağ oluşturma türünü belirtin.
Kullanılabilir değerler:
standard: Normal yüksek detaylı 3D ağ oluşturma.
smart-topology: ai_model (meshy-t2) ile bir Smart Topology modeli seçin.
lowpoly (kullanımdan kaldırıldı): Daha temiz poligonlar için optimize edilmiş low-poly ağ üretir. Bunun yerine smart-topology kullanmanızı öneririz.
smart-topology seçildiğinde, topology, should_remesh ve save_pre_remeshed_model yok sayılır.
lowpoly seçildiğinde, ai_model, topology, target_polycount, should_remesh ve save_pre_remeshed_model yok sayılır.
Name
ai_model
Type
string
varsayılan latest
Description
Kullanılacak modelin kimliği. Kullanılabilir değerler model_type parametresine bağlıdır.
meshy-t2 (varsayılan): Smart Topology modeli — daha temiz topology, doğal olarak ayrılmış parçalar, üçgen çıktısı ve target_polycount ile ayarlayabileceğiniz bir yüzey sayısı.
Name
ultra_mode
Type
boolean
varsayılan false
Description
Daha ince yüzey detayına sahip, daha yüksek doğrulukta geometri için Ultra oluşturmayı etkinleştirir.
Yalnızca ai_model değeri meshy-7 (veya latest) olduğunda desteklenir.
Name
should_texture
Type
boolean
varsayılan true
Description
Dokuların oluşturulup oluşturulmayacağını belirler. false olarak ayarlamak doku aşamasını atlayarak dokusuz bir ağ sağlar.
Yalnızca şu durumlarda geçerli should_texture = true
Name
enable_pbr
Type
boolean
varsayılan false
Description
Temel renge ek olarak PBR haritaları (metalik, pürüzlülük, normal) oluşturun. ai_model değeri meshy-6 olduğunda, texture_resolution: 8k hariç olmak üzere bir emisyon haritası da dahil edilir. meshy-7 ve latest emisyon haritası üretmez.
Name
texture_resolution
Type
string
varsayılan 2k
Description
Temel renk dokusu çözünürlüğü. 2k (2048×2048), 4k (4096×4096) veya 8k (8192×8192) değerlerinden biri. Daha yüksek çözünürlükler daha fazla yüzey detayı yakalar.
4k ve 8k, ai_model: meshy-5 ile kullanılamaz. 8k değerinde emisyon haritası üretilmez.
Name
hd_texture
Type
boolean
⚠ kullanımdan kaldırıldı
varsayılan false
Description
Bunun yerine texture_resolution kullanın — texture_resolution: "4k" ile eşdeğerdir. İkisi de ayarlanırsa, texture_resolution önceliklidir.
Name
texture_prompt
Type
string
Description
Doku oluşturma sürecine rehberlik etmesi için bir metin prompt'u sağlayın. En fazla 800 karakter.
Name
texture_image_url
Type
string
Description
Doku oluşturma sürecine rehberlik etmesi için bir 2D görsel sağlayın. Şu anda .jpg, .jpeg ve .png 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>
Orijinal asset ile yüklenen görsel arasında önemli geometri farklılıkları varsa görsel dokulandırma en iyi şekilde çalışmayabilir. Doku oluşturma sürecine rehberlik etmek için texture_image_url veya texture_prompt parametrelerinden yalnızca biri kullanılabilir. Her iki parametre de sağlanırsa, model varsayılan olarak texture_prompt kullanılarak dokulandırılır. Metin veya görsel yoluyla dokulandırma, görev başına 10 kredi maliyetine sahiptir.
Yeniden ağ aşamasının etkinleştirilip etkinleştirilmeyeceğini kontrol eder. En yüksek kaliteli model için should_remesh değerini false olarak ayarlamanızı öneririz.
Yalnızca şu durumlarda geçerli should_remesh = true
Name
topology
Type
string
varsayılan triangle
Description
Oluşturulan modelin topology'sini belirtin.
Kullanılabilir değerler:
quad: Dörtgen ağırlıklı bir ağ oluşturur.
triangle: Sadeleştirilmiş bir üçgen ağ oluşturur.
Name
decimation_mode
Type
integer
Description
Bir poligon sayısı düzeyi ayarlayarak uyarlanabilir sadeleştirmeyi etkinleştirin. Ayarlandığında, target_polycount yok sayılır.
Kullanılabilir değerler:
1: Uyarlanabilir — ultra poligon sayısı.
2: Uyarlanabilir — yüksek poligon sayısı.
3: Uyarlanabilir — orta poligon sayısı.
4: Uyarlanabilir — düşük poligon sayısı.
Name
save_pre_remeshed_model
Type
boolean
varsayılan false
Description
true olarak ayarlandığında, Meshy yeniden ağ aşaması tamamlanmadan önce ek bir GLB dosyası da saklar.
Name
target_polycount
Type
integer
Description
Çıktıdaki hedef poligon (yüzey) sayısı. Gerçek sayı, geometriye bağlı olarak hedeften sapabilir.
target_polycount iki bağımsız durumda etkili olur:
Yeniden ağ — bir standard model üzerinde should_remesh: true ile. Ağ, yaklaşık olarak bu sayıya yeniden ağlanır (sadeleştirilir). Aralık 100 ile 300.000 arasında, varsayılan 30.000. decimation_mode ayarlanmışsa, o öncelikli olur ve target_polycount yok sayılır.
Smart Topology — model_type: smart-topology ve ai_model: meshy-t2 ile. Model doğrudan bu yüzey sayısında oluşturulur; yeniden ağ çalışmaz ve should_remesh gerekmez. Aralık 100 ile 15.000 arasında, varsayılan 4.000.
Name
symmetry_mode
Type
string
⚠ kullanımdan kaldırıldı
varsayılan auto
Description
Kullanımdan kaldırıldı. Bu parametre artık çıktıyı etkilemez.
symmetry_mode alanı, model oluşturma süreci sırasındaki simetri davranışını kontrol eder.
Geçerli değerler:
off: Simetriyi devre dışı bırakır.
auto: Giriş geometrisine göre simetriyi otomatik olarak belirler ve uygular.
on: Oluşturma sırasında simetriyi zorunlu kılar.
Name
pose_mode
Type
string
varsayılan ""
Description
Oluşturulan model için poz mode'unu belirtin.
Kullanılabilir değerler:
a-pose: Modeli A pozunda oluşturur.
t-pose: Modeli T pozunda oluşturur.
"" (boş dize): Belirli bir poz uygulanmaz.
Name
is_a_t_pose
Type
boolean
⚠ kullanımdan kaldırıldı
varsayılan false
Description
Bunun yerine pose_mode kullanın. Modelin A/T pozunda oluşturulup oluşturulmayacağı.
Name
image_enhancement
Type
boolean
varsayılan true
Description
Daha iyi sonuçlar için giriş görselini optimize eder. Giriş görselinin herhangi bir stil işlemesi yapılmadan tam olarak orijinal görünümünü korumak için false olarak ayarlayın.
Yalnızca ai_model değeri meshy-6, meshy-7 veya latest olduğunda desteklenir.
Name
remove_lighting
Type
boolean
varsayılan true
Description
Temel renk dokusundan vurguları ve gölgeleri kaldırarak, özel aydınlatma kurulumlarında daha iyi çalışan daha temiz bir sonuç üretir.
Yalnızca ai_model değeri meshy-6 olduğunda desteklenir.
Name
moderation
Type
boolean
varsayılan false
Description
true olarak ayarlandığında, giriş içeriği potansiyel olarak zararlı içerik açısından otomatik olarak taranır. Zararlı içerik tespit edilirse, görev oluşturma aşamasına geçmez.
image_url, texture_image_url ve texture_prompt girdilerindeki içerik taranacaktır.
Name
target_formats
Type
string[]
Description
Çıktıya hangi 3D dosya formatlarının dahil edileceğini belirtir. Yalnızca istenen formatlar oluşturulur ve döndürülür; bu da görev tamamlanma süresini azaltabilir. Atlandığında, desteklenen tüm formatlar dahil edilir.
Atlandığında, 3mf hariç tüm formatlar oluşturulur. 3mf yalnızca açıkça belirtildiğinde dahil edilir.
Name
auto_size
Type
boolean
varsayılan false
Description
true olarak ayarlandığında, hizmet nesnenin gerçek dünyadaki yüksekliğini otomatik olarak tahmin etmek için yapay zeka görüşünü kullanır ve modeli buna göre yeniden boyutlandırır. origin_at açıkça ayarlanmadıkça orijin varsayılan olarak bottom olur.
Name
alpha_thumbnail
Type
boolean
varsayılan false
Description
true olarak ayarlandığında, görev ayrıca önizlemenin şeffaf arka planlı (RGBA) bir sürümünü oluşturur ve bunu GET yanıtında alpha_thumbnail_url olarak döndürür. Mevcut thumbnail_url alanı değişmez.
Name
multi_view_thumbnails
Type
boolean
varsayılan false
Description
true olarak ayarlandığında, görev ayrıca dört ana yön görünümü küçük resmi (ön, sağ, arka, sol) oluşturur ve bunları GET yanıtında thumbnail_urls altında döndürür. Mevcut thumbnail_url alanı değişmez ve ön görünümü göstermeye devam eder, bu nedenle mevcut istemciler etkilenmez.
Görev gecikme süresine yaklaşık 3 saniye ekler.
Yalnızca şu durumlarda geçerli auto_size = true
Name
origin_at
Type
string
varsayılan bottom
Description
auto_size etkinleştirildiğinde orijinin konumu.
Kullanılabilir değerler: bottom, center.
Dönüş Değerleri
Yanıtın result özelliği, yeni oluşturulan Görselden 3D'ye görevinin id değerini içerir.
Hata Modları
Name
400 - Bad Request
Description
İstek kabul edilemedi. Yaygın nedenler:
Eksik parametre: image_url veya input_task_id parametrelerinden biri sağlanmalıdır.
Geçersiz giriş görevi: input_task_id, tam olarak bir görsel üreten SUCCEEDED durumundaki bir Metinden görsele veya Görselden görsele görevine işaret etmelidir.
Geçersiz görsel formatı: Sağlanan image_url desteklenen bir format değil (.jpg, .jpeg, .png).
Erişilemeyen URL: image_url indirilemedi (404 veya timeout).
Geçersiz Data URI: Base64 dizesi hatalı biçimlendirilmiş.
Geçersiz parametre kombinasyonu: enable_pbr yalnızca should_texture true olduğunda desteklenir.
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/v1/image-to-3d
# Simple request with required paramscurlhttps://api.meshy.ai/openapi/v1/image-to-3d \-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>" }'# With remesh, PBR, and A-posecurlhttps://api.meshy.ai/openapi/v1/image-to-3d \-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>", "enable_pbr": true, "should_remesh": true, "target_polycount": 100000, "should_texture": true, "pose_mode": "a-pose", "target_formats": ["glb"] }'
Bu uç nokta, geçerli bir görev idsi verildiğinde Görselden 3D'ye görevini getirmenizi sağlar.
Görselden 3D'ye görev nesnesiyle hangi özelliklerin dahil olduğunu görmek için Görselden 3D'ye Görev Nesnesi bölümüne bakın.
Görselden 3D'ye Görev nesnesi, Meshy'nin bir görsel girdisinden 3D model oluşturmak için takip ettiği bir iş birimidir.
Nesne aşağıdaki özelliklere sahiptir:
Özellikler
Name
id
Type
string
Description
Görev için benzersiz tanımlayıcı. Görev kimlikleri için k-sıralanabilir UUID kullanıyoruz, ancak kimlik formatı hakkında herhangi bir varsayımda bulunmamalısınız.
Name
type
Type
string
Description
Görselden 3D'ye görevinin türü. Değer image-to-3d'dir.
Name
model_urls
Type
object
Description
Meshy tarafından üretilen dokulu 3D model dosyasının indirilebilir URL'si. Bir format üretilmediğinde, boş bir dize döndürmek yerine o format için özellik atlanır.
Name
glb
Type
string
Description
GLB dosyasının indirilebilir URL'si.
Name
fbx
Type
string
Description
FBX dosyasının indirilebilir URL'si.
Name
obj
Type
string
Description
OBJ dosyasının indirilebilir URL'si.
Name
usdz
Type
string
Description
USDZ dosyasının indirilebilir URL'si.
Name
mtl
Type
string
Description
Doku mevcut olduğunda OBJ dışa aktarımlarıyla birlikte döndürülen MTL dosyasının indirilebilir URL'si.
Name
stl
Type
string
Description
STL dosyasının indirilebilir URL'si.
Name
3mf
Type
string
Description
3MF dosyasının indirilebilir URL'si. Sadece target_formats aracılığıyla 3mf talep edildiğinde mevcut.
Name
pre_remeshed_glb
Type
string
Description
Remesh öncesi orijinal GLB çıktısının indirilebilir URL'si.
Sadece görev hem should_remesh: true hem de save_pre_remeshed_model: true ile oluşturulduğunda mevcut.
Name
thumbnail_url
Type
string
Description
Model dosyasının küçük resim görüntüsünün indirilebilir URL'si. Mevcut olduğunda thumbnail_urls.front ile eşdeğer, geriye dönük uyumluluk için tutulur.
Name
alpha_thumbnail_url
Type
string
Description
thumbnail_url'ün şeffaf arka planlı (RGBA) versiyonunun indirilebilir URL'si. Sadece görev alpha_thumbnail: true ile oluşturulduğunda ve şeffaf önizleme başarıyla oluşturulduğunda mevcut; aksi takdirde bu alan atlanır.
Name
thumbnail_urls
Type
object
Description
Üretilen 3D modelin dört ana görünüm küçük resmi için indirilebilir URL'ler. Her değer, thumbnail_url ile aynı malzemeler ve aydınlatma ile render edilen 512×512 PNG için imzalı bir URL'dir. GLB'yi indirmeden modelin birden fazla açıdan önizlemesi için toplu iş hatlarında kullanışlıdır.
Sadece görev multi_view_thumbnails: true ile oluşturulduğunda ve SUCCEEDED durumuna ulaştığında mevcut. Daha eski görevler ve isteğe bağlı olarak oluşturulmamış görevler bu alanı içermez.
Name
front
Type
string
Description
Ön görünüm, dikey eksen etrafında 0° dönüş ( thumbnail_url ile eşleşir).
Name
right
Type
string
Description
Sağ görünüm, 90° dönüş.
Name
back
Type
string
Description
Arka görünüm, 180° dönüş.
Name
left
Type
string
Description
Sol görünüm, 270° dönüş.
Name
texture_prompt
Type
string
Description
Dokulama sürecini yönlendirmek için kullanılan metin prompt'u.
Name
texture_image_url
Type
string
Description
Dokulama sürecini yönlendirmek için kullanılan doku görüntüsünün indirilebilir URL'si.
Name
ultra_mode
Type
boolean
Description
Görev oluşturulurken kullanılan ultra_mode değerini yansıtır. Sadece meshy-7 (veya latest) görevleri için açıkça ultra_mode ayarlanmışsa mevcut; aksi takdirde atlanır.
Name
progress
Type
integer
Description
Görevin ilerleme durumu. Görev henüz başlamadıysa, bu özellik 0 olacaktır. Görev başarıyla tamamlandığında, bu 100 olur.
Name
started_at
Type
timestamp
Description
Görevin başlatıldığı zamanın zaman damgası, milisaniye cinsinden. Görev henüz başlamadıysa, bu özellik 0 olacaktır.
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, 1 Eylül 2023 12:00:00 PM GMT, 1693569600000 olarak temsil edilir. Bu, Meshy API'deki tüm zaman damgaları için geçerlidir.
Name
created_at
Type
timestamp
Description
Görevin oluşturulduğu zamanın zaman damgası, milisaniye cinsinden.
Name
expires_at
Type
timestamp
Description
Görev sonucunun sona erdiği zamanın zaman damgası, milisaniye cinsinden.
Name
finished_at
Type
timestamp
Description
Görevin tamamlandığı zamanın zaman damgası, milisaniye cinsinden. Görev henüz tamamlanmadıysa, bu özellik 0 olacaktır.
Name
status
Type
string
Description
Görevin durumu. Olası değerler PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED'dan biridir.
Name
texture_urls
Type
array
Description
Görevden üretilen doku URL nesnelerinin bir dizisi. Normalde bu sadece bir doku URL nesnesi içerir. Her doku URL'si aşağıdaki özelliklere sahiptir:
Name
base_color
Type
string
Description
Ana renk haritası görüntüsünün indirilebilir URL'si.
Name
metallic
Type
string
Description
Metalik harita görüntüsünün indirilebilir URL'si.
Görev enable_pbr: false ile oluşturulmuşsa, bu özellik atlanır.
Name
normal
Type
string
Description
Normal harita görüntüsünün indirilebilir URL'si.
Görev enable_pbr: false ile oluşturulmuşsa, bu özellik atlanır.
Görev enable_pbr: false ile oluşturulmuşsa veya ai_modelmeshy-5, meshy-7 veya latest ise, bu özellik atlanır.
Name
preceding_tasks
Type
integer
Description
Önceki görevlerin sayısı.
Bu alanın değeri sadece görev durumu PENDING ise anlamlıdı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 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 mevcut. FAILED görevler için 0 döner (başarısızlık durumunda krediler iade edilir).