Görselden 3D'ye API, Meshy'nin Görselden 3D'ye özelliklerini kendi uygulamanıza entegre etmenizi sağlayan bir özelliktir. Bu bölümde, bu API ile başlamanız için ihtiyaç duyduğunuz tüm bilgileri
bulacaksınız.
Bu uç nokta yeni bir Görselden 3D'ye görevi oluşturmanıza olanak tanır. Görselden 3D'ye görev nesnesinde hangi
özelliklerin bulunduğunu görmek için
Görselden 3D'ye Görev Nesnesi bölümüne bakın.
Parametreler
input_task_id veya image_url değerlerinden yalnızca biri gereklidir. İkisi de sağlanırsa input_task_id öncelik alır.
Name
input_task_id
Type
string
Zorunlu
Description
Çıktısı giriş görseli olarak kullanılacak, tamamlanmış bir görsel oluşturma görevinin ID'si. Bu görev aşağıdaki görevlerden biri olmalıdır: Metinden görsele veya Görselden görsele. Ayrıca API üzerinden çalıştırılmış olmalı, durumu SUCCEEDED olmalı ve tam olarak bir görsel üretmelidir.
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ış data URI'si. Bir data URI örneği: data:image/jpeg;base64,<your base64-encoded image data>.
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 ayrıntılı 3D ağ oluşturma.
lowpoly: Daha temiz poligonlar için optimize edilmiş low-poly ağ oluşturur.
lowpoly seçildiğinde ai_model, topology, target_polycount, should_remesh, save_pre_remeshed_model yok sayılır.
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ı (metallic, roughness, normal) oluşturun. ai_modelmeshy-6 veya latest olduğunda bir emission haritası da dahil edilir.
Name
hd_texture
Type
boolean
varsayılan false
Description
Daha yüksek ayrıntı için temel renk dokusunu 4K (4096×4096) çözünürlükte oluşturun.
Yalnızca ai_modelmeshy-6 veya latest olduğunda desteklenir. PBR haritaları her zaman 2K olarak oluşturulur.
Name
texture_prompt
Type
string
Description
Dokulandırma sürecini yönlendirmek için bir metin prompt sağlayın. En fazla 600 karakter.
Name
texture_image_url
Type
string
Description
Dokulandırma sürecini yönlendirmek için 2D 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ış data URI'si. Bir data URI örneği: data:image/jpeg;base64,<your base64-encoded image data>
Orijinal varlık ile yüklenen görsel arasında önemli geometri farkları varsa görsel ile dokulandırma en iyi şekilde çalışmayabilir. Dokulandırma sürecini yönlendirmek için texture_image_url veya texture_prompt değerlerinden yalnızca biri kullanılabilir. İki parametre de sağlanırsa varsayılan olarak modeli dokulandırmak için texture_prompt kullanılır. Metin veya görsel aracılığıyla dokulandırma, görev başına 10 krediye mal olur.
Name
should_remesh
Type
boolean
varsayılan false (meshy-6), true (others)
Description
Yeniden ağ aşamasının etkinleştirilip etkinleştirilmeyeceğini kontrol eder. false olarak ayarlandığında API en yüksek hassasiyetli üçgensel ağı döndürür.
Yalnızca şu durumlarda geçerli should_remesh = true
Name
topology
Type
string
varsayılan triangle
Description
Oluşturulan modelin topology değerini belirtin.
Kullanılabilir değerler:
quad: Dörtgen ağırlıklı bir ağ oluşturur.
triangle: Azaltılmış üçgen ağ oluşturur.
Name
target_polycount
Type
integer
varsayılan 30,000
Description
Oluşturulan modeldeki hedef poligon sayısını belirtin. Gerçek poligon sayısı, geometrinin karmaşıklığına bağlı olarak hedeften sapabilir.
Geçerli değer aralığı kullanıcı katmanına göre değişir:
100 ile 300.000 arası (dahil)
Name
decimation_mode
Type
integer
Description
Bir poligon sayısı seviyesi ayarlayarak uyarlanabilir azaltmayı 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 depolar.
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ürecinde 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 değerini belirtin.
Kullanılabilir değerler:
a-pose: Modeli A pozunda oluşturur.
t-pose: Modeli T pozunda oluşturur.
"" (boş string): 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 tam görünümünü herhangi bir stil işlemesi olmadan korumak için false olarak ayarlayın.
Yalnızca ai_modelmeshy-6 veya latest olduğunda desteklenir.
Name
remove_lighting
Type
boolean
varsayılan true
Description
Temel renk dokusundan parlaklıkları ve gölgeleri kaldırarak özel ışıklandırma kurulumlarında daha iyi çalışan daha temiz bir sonuç üretir.
Yalnızca ai_modelmeshy-6 veya latest 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 algılanırsa görev oluşturmaya devam etmez.
image_url, texture_image_url ve texture_prompt girişlerinden gelen içerik taranı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 servis, nesnenin gerçek dünyadaki yüksekliğini otomatik olarak tahmin etmek ve modeli buna göre yeniden boyutlandırmak için AI vision kullanır. origin_at açıkça ayarlanmadığı sürece 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ü işler ve GET yanıtında bunu 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önden küçük resim (ön, sağ, arka, sol) işler 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üme işaret etmeye devam eder, bu nedenle mevcut istemciler etkilenmez.
Görev gecikmesine 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öndürülenler
Yanıtın result özelliği, yeni oluşturulan Görselden 3D'ye görevinin görev id değerini içerir.
Hata Durumları
Name
400 - Bad Request
Description
İstek kabul edilemezdi. Yaygın nedenler:
Eksik parametre: image_url veya input_task_id 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 başvurmalıdır.
Geçersiz görsel formatı: Sağlanan image_url desteklenen bir formatta değil (.jpg, .jpeg, .png).
Erişilemeyen URL: image_url indirilemedi (404 veya timeout).
Geçersiz Data URI: Base64 string 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 paramscurl https://api.meshy.ai/openapi/v1/image-to-3d \ -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>" }'# With remesh, PBR, and A-posecurl https://api.meshy.ai/openapi/v1/image-to-3d \ -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>", "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 id değeri verilerek bir Görselden 3D'ye görevini almanıza olanak tanır.
Görselden 3D'ye görev nesnesinde hangi özelliklerin yer aldığını görmek için
Görselden 3D'ye Görev Nesnesi bölümüne bakın.
Parametreler
Name
id
Type
path
Description
Alınacak Görselden 3D'ye görevi için benzersiz tanımlayıcı.
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 uygulama ayrıntısı olarak
k-sıralanabilir bir UUID kullansak da, id biçimi 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 şeklindedir.
Name
model_urls
Type
object
Description
Meshy tarafından oluşturulan dokulu 3D model dosyasına indirilebilir URL. Bir format oluşturulmadıysa, boş bir dize döndürmek yerine o formata ait özellik atlanır.
Name
glb
Type
string
Description
GLB dosyasına indirilebilir URL.
Name
fbx
Type
string
Description
FBX dosyasına indirilebilir URL.
Name
obj
Type
string
Description
OBJ dosyasına indirilebilir URL.
Name
usdz
Type
string
Description
USDZ dosyasına indirilebilir URL.
Name
mtl
Type
string
Description
MTL dosyasına indirilebilir URL; dokular mevcut olduğunda OBJ dışa aktarımlarıyla birlikte döndürülür.
Name
stl
Type
string
Description
STL dosyasına indirilebilir URL.
Name
3mf
Type
string
Description
3MF dosyasına indirilebilir URL. Yalnızca target_formats aracılığıyla 3mf istendiğinde bulunur.
Name
pre_remeshed_glb
Type
string
Description
Yeniden topolojilendirmeden önceki orijinal GLB çıktısına indirilebilir URL.
Yalnızca görev hem should_remesh: true hem de save_pre_remeshed_model: true ile oluşturulduğunda kullanılabilir.
Name
thumbnail_url
Type
string
Description
Model dosyasının küçük resim görüntüsüne indirilebilir URL. Mevcut olduğunda thumbnail_urls.front ile eşdeğerdir; geriye dönük uyumluluk için korunur.
Name
alpha_thumbnail_url
Type
string
Description
thumbnail_url değerinin şeffaf arka planlı (RGBA) sürümüne indirilebilir URL. Yalnızca görev alpha_thumbnail: true ile oluşturulduğunda ve şeffaf önizleme başarıyla renderlandığında bulunur; aksi takdirde bu alan atlanır.
Name
thumbnail_urls
Type
object
Description
Oluşturulan 3D modelin dört ana yönden küçük resimleri için indirilebilir URL'ler. Her değer, thumbnail_url ile aynı materyaller ve aydınlatma kullanılarak renderlanmış 512×512 PNG'ye ait imzalı bir URL'dir. GLB'yi indirmeden toplu iş hatlarında modeli birden çok açıdan önizlemek için kullanışlıdır.
Yalnızca görev multi_view_thumbnails: true ile oluşturulduğunda ve SUCCEEDED durumuna ulaştığında bulunur. Daha eski görevler ve katılım seçeneği olmadan oluşturulan görevler bu alanı içermez.
Name
front
Type
string
Description
Ön görünüm, dikey eksen etrafında 0° döndürme (thumbnail_url ile eşleşir).
Name
right
Type
string
Description
Sağ görünüm, 90° döndürme.
Name
back
Type
string
Description
Arka görünüm, 180° döndürme.
Name
left
Type
string
Description
Sol görünüm, 270° döndürme.
Name
texture_prompt
Type
string
Description
Dokulandırma sürecini yönlendirmek için kullanılan metin prompt'u.
Name
texture_image_url
Type
string
Description
Dokulandırma sürecini yönlendirmek için kullanılan doku görüntüsüne indirilebilir URL.
Name
progress
Type
integer
Description
Görevin progress değeri. Görev henüz başlamadıysa, bu özellik 0 olur. Görev başarıyla tamamlandığında bu değer 100 olur.
Name
started_at
Type
timestamp
Description
Görevin başlatıldığı zaman damgası, milisaniye cinsinden. Görev henüz başlamadıysa, bu özellik 0 olur.
Bir zaman damgası, RFC 3339 standardını izleyerek
1 Ocak 1970 UTC'den bu yana geçen milisaniye sayısını temsil eder.
Örneğin, 1 Eylül 2023 Cuma 12:00:00 PM GMT, 1693569600000 olarak temsil edilir. Bu,
Meshy API içindeki tüm zaman damgaları için geçerlidir.
Name
created_at
Type
timestamp
Description
Görevin oluşturulduğu zaman damgası, milisaniye cinsinden.
Name
expires_at
Type
timestamp
Description
Görev sonucunun süresinin dolacağı zaman damgası, milisaniye cinsinden.
Name
finished_at
Type
timestamp
Description
Görevin tamamlandığı zaman damgası, milisaniye cinsinden. Görev henüz tamamlanmadıysa, bu özellik 0 olur.
Görevden oluşturulan doku URL nesnelerinin dizisi. Normalde bu yalnızca bir doku URL nesnesi içerir. Her doku URL'si aşağıdaki özelliklere sahiptir:
Name
base_color
Type
string
Description
Base color haritası görüntüsüne indirilebilir URL.
Name
metallic
Type
string
Description
Metallic harita görüntüsüne indirilebilir URL.
Görev enable_pbr: false ile oluşturulduysa, bu özellik atlanır.
Name
normal
Type
string
Description
Normal harita görüntüsüne indirilebilir URL.
Görev enable_pbr: false ile oluşturulduysa, bu özellik atlanır.
Name
roughness
Type
string
Description
Roughness haritası görüntüsüne indirilebilir URL.
Görev enable_pbr: false ile oluşturulduysa, bu özellik atlanır.
Name
emission
Type
string
Description
Emission haritası görüntüsüne indirilebilir URL.
Görev enable_pbr: false ile oluşturulduysa veya ai_modelmeshy-5 ise, bu özellik atlanır.
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 nesnesi referansı için bkz. Hatalar.
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 (krediler başarısızlık durumunda iade edilir).