Görselden 3D'ye API, Meshy's Görselden 3D'ye özelliklerini kendi uygulamanıza entegre etmenizi sağlar. Bu bölümde, bu API'ye başlamak için ihtiyacınız olan 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 nesnesine dahil olan özellikleri görmek için Görselden 3D'ye Görev Nesnesi başvurusuna bakın.
Parametreler
input_task_id veya image_urldan yalnızca biri gereklidir. Her ikisi de sağlanırsa, input_task_id öncelikli olacaktır.
Name
input_task_id
Type
string
Zorunlu
Description
Çıktısının, giriş görseli olarak kullanılacağı tamamlanmış bir görüntü oluşturma görevinin kimliği. 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ış, SUCCEEDED durumunu almış olmalı ve tam olarak bir görsel üretmiş olmalıdır.
Name
image_url
Type
string
Zorunlu
Description
Model oluşturma için Meshy'ye kullanılacak bir görsel sağlayın. Şu anda .jpg, .jpeg ve .png formatlarını destekliyoruz.
Görseli sağlamak için iki yol vardır:
Genel olarak erişilebilir URL: Herkese açık internetten erişilebilir bir URL.
Data URI: Görselin base64 ile kodlanmış bir veri URI'si. 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.
Uygun değerler:
standard: Düzenli yüksek detaylı 3D ağ oluşturma.
smart-topology: ai_model (meshy-t1 veya meshy-t2) ile bir Smart Topology modelini seçin.
lowpoly (kullanımdan kaldırıldı): Daha temiz poligonlar için optimize edilmiş low-poly ağ oluşturur. Bunun yerine smart-topology kullanmanızı öneririz.
smart-topology seçildiğinde, topology, should_remesh ve save_pre_remeshed_model göz ardı edilir.
lowpoly seçildiğinde, ai_model, topology, target_polycount, should_remesh ve save_pre_remeshed_model göz ardı edilir.
Name
ai_model
Type
string
varsayılan latest
Description
Kullanılacak modelin kimliği. Uygun değerler model_typea bağlıdır.
meshy-t2 (varsayılan, önerilen): Smart Topology model — daha temiz topology, yerel olarak ayrılmış parçalar, üçgen çıktı ve target_polycount ile ayarlanabilen yüz sayısı.
meshy-t1: eski low-poly model; target_polycount ile ayarlanabilen yüz sayısını desteklemez.
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_modelmeshy-7 (veya latest) olduğunda desteklenir.
Name
should_texture
Type
boolean
varsayılan true
Description
Dokuların üretilip üretilmediğini belirler. false olarak ayarlandığında doku evresi atlanır ve dokular olmadan ağ sağlanır.
Yalnızca şu durumlarda geçerli should_texture = true
Name
enable_pbr
Type
boolean
varsayılan false
Description
Baz renk haritasının yanı sıra, metaliklik, pürüz, normal içeren PBR haritaları üretin. ai_modelmeshy-6 olduğunda bir emisyon haritası da dahil edilir, texture_resolution: 8k hariç. meshy-7 ve latest emisyon haritası üretmez.
Name
texture_resolution
Type
string
varsayılan 2k
Description
Baz renk doku çö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. 8kde, 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 birlikte ayarlanırsa, texture_resolution önceliklidir.
Name
texture_prompt
Type
string
Description
Dokusu oluşturma sürecini yönlendirmek için bir metin prompt'u sağlayın. En fazla 600 karakter.
Name
texture_image_url
Type
string
Description
Dokusu oluşturma sürecini yönlendirmek için bir 2D görsel sağlayın. Şu anda .jpg, .jpeg ve .png formatlarını destekliyoruz.
Görseli sağlamak için iki yol vardır:
Genel olarak erişilebilir URL: Herkese açık internetten erişilebilir bir URL
Data URI: Görselin base64 ile kodlanmış bir veri URI'si. Data URI örneği: data:image/jpeg;base64,<your base64-encoded image data>
Orijinal varlık ile yüklenen görsel arasında belirgin bir geometri farkı varsa, görsel doku oluşturma optimal şekilde çalışmayabilir. Doku oluşturma sürecini yönlendirmek için texture_image_url veya texture_promptdan yalnızca biri kullanılmalıdır. Her iki parametre de sağlanırsa, texture_prompt varsayılan olarak modeli doku oluşturur. Metin veya görsel yoluyla doku oluşturma, görev başına 10 krediye mal olacaktır.
Yeniden ağ aşamasını etkinleştirip etkinleştirmeyeceğinizi kontrol eder. En yüksek kaliteli model için should_remeshi false olarak ayarlamanız önerilir.
Yalnızca şu durumlarda geçerli should_remesh = true
Name
topology
Type
string
varsayılan triangle
Description
Oluşturulan modelin topolojisini belirtin.
Uygun değerler:
quad: Dörtken dominant bir ağ oluşturun.
triangle: Küçültülmüş bir üçgen ağ oluşturun.
Name
decimation_mode
Type
integer
Description
Bir poligon sayısı seviyesini ayarlayarak adaptif küçültmeyi etkinleştirin. Ayarlandığında, target_polycount göz ardı edilir.
Uygun değerler:
1: Adaptif — ultra poligon sayısı.
2: Adaptif — yüksek poligon sayısı.
3: Adaptif — orta poligon sayısı.
4: Adaptif — düşük poligon sayısı.
Name
save_pre_remeshed_model
Type
boolean
varsayılan false
Description
true olarak ayarlandığında, Meshy ayrıca yeniden ağlama evresi tamamlanmadan önce ekstra bir GLB dosyası daha kaydeder.
Name
target_polycount
Type
integer
Description
Çıkıştaki poligonların (yüzlerin) hedef sayısı. Gerçek sayı, geometriye bağlı olarak hedeften sapabilir.
target_polycount iki bağımsız durumda etkili olur:
Yeniden Ağ — standard modelde should_remesh: true ile. Ağ yaklaşık olarak bu sayıya küçültülür. 100 ile 300,000 arasında, varsayılan 30,000. decimation_mode ayarlanırsa, öncelikli ol
ur ve target_polycount göz ardı edilir.
Smart Topology — model_type: smart-topology ve ai_model: meshy-t2 ile. Model doğrudan bu yüz sayısında oluşturulur; yeniden ağ çalıştırılmaz ve should_remesh gerekmez. 100 ile 15,000 arası, 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ı etkilemiyor.
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 bağlı olarak otomatik olarak simetri belirler ve uygular.
on: Oluşturma sırasında simetriyi zorlar.
Name
pose_mode
Type
string
varsayılan ""
Description
Oluşturulan model için poz modunu belirtin.
Uygun değerler:
a-pose: Modeli bir A pozunda oluşturun.
t-pose: Modeli bir T pozunda oluşturun.
"" (boş dize): Uygulanan özel poz yok.
Name
is_a_t_pose
Type
boolean
⚠ kullanımdan kaldırıldı
varsayılan false
Description
Bunun yerine pose_mode kullanın. Modeli bir A/T pozunda oluşturma olup olmadığını belirler.
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şlemese olmadan korumak için false olarak ayarlayın.
Yalnızca ai_modelmeshy-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 daha temiz bir sonuç üretir bu da özel aydınlatma kurulumlarında daha iyi çalışır.
Yalnızca ai_modelmeshy-6 olduğunda desteklenir.
Name
moderation
Type
boolean
varsayılan false
Description
true olarak ayarlandığında, giriş içeriği otomatik olarak potansiyel olarak zararlı içerik açısından taranacaktır. Tespit edilen zararlı içerik varsa, görev oluşturulmaya devam etmeyecektir.
image_url, texture_image_url ve texture_prompt girdileri taranacaktır.
Name
target_formats
Type
string[]
Description
Çıkışta hangi 3D dosya formatlarının dahil edileceğini belirtir. Yalnızca istenilen formatlar oluşturulacak ve döndürülecek, bu da görev tamamlanma süresini kısaltabilir. Yoksayıldığında, tüm desteklenen formatlar dahil edilir.
Mevcut değerler: glb, obj, fbx, stl, usdz, 3mf
Yoksayıldığında, 3mf hariç tüm formatlar üretilir. 3mf yalnızca açıkça belirtildiğinde dahil edilir.
Name
auto_size
Type
boolean
varsayılan false
Description
true olarak ayarlandığında, hizmet AI görüşünü kullanarak nesnenin gerçek dünyadaki yüksekliğini otomatik olarak tahmin eder ve modeli buna göre yeniden boyutlandırır. Orijin bottom olarak varsayılan olacak, origin_at açıkça ayarlanmadıkça.
Name
alpha_thumbnail
Type
boolean
varsayılan false
Description
true olarak ayarlandığında, görev ayrıca ön izlemenin şeffaf arka planlı (RGBA) bir versiyonunu render eder ve GET yanıtında alpha_thumbnail_url olarak döndürür. Mevcut thumbnail_url alanı değişmeden kalır.
Name
multi_view_thumbnails
Type
boolean
varsayılan false
Description
true olarak ayarlandığında, görev ayrıca dört ana görünüm küçük resimlerini (ön, sağ, arka, sol) render eder ve GET yanıtında thumbnail_urls altında döndürür. Mevcut thumbnail_url alanı değişmeden kalır ve ön görünüme işaret etmeye devam eder, böylece mevcut müşteriler 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 etkin olduğunda orijinin konumu.
Uygun değerler: bottom, center.
Dönenler
Yanıtın result özelliği, yeni oluşturulan Görselden 3D'ye görevin id değerini içerir.
Hata Modları
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 Metinden Görsele veya Görselden Görsele görevine atıfta bulunmalıdır.
Geçersiz görsel formatı: Sağlanan image_url desteklenen bir formatta değil (.jpg, .jpeg, .png).
Ulaşılamayan URL: image_url indirilemedi (404 ya da timeout).
Geçersiz Data URI: Base64 dizesi hatalı.
Geçersiz parametre kombinasyonu: enable_pbr yalnızca should_texture doğru 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.
İstek
POST
/openapi/v1/image-to-3d
# Gerekli parametrelerle basit istekcurlhttps://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>" }'# remesh, PBR ve A-pose ilecurlhttps://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 görev idsi olan bir Görselden 3D'ye görevi almanızı sağlar.
Görselden 3D'ye görev nesnesine dahil olan özellikleri görmek için Görselden 3D'ye Görev Nesnesi başvurusuna bakın.
Görselden 3D'ye Görev nesnesi, Meshy'nin bir görsel girişinden bir 3D model oluşturmak için izlediği bir çalışma birimidir.
Nesne aşağıdaki özelliklere sahiptir:
Özellikler
Name
id
Type
string
Description
Görevin benzersiz kimliği. Görev kimlikleri için bir uygulama detayı olarak k-sıralanabilir UUID kullanırken, kimliğin formatı hakkında hiçbir varsayımda bulunmamalısınız.
Name
type
Type
string
Description
Görselden 3D'ye görevin türü. Değer image-to-3d'dir.
Name
model_urls
Type
object
Description
Meshy tarafından oluşturulan dokulu 3D model dosyasının indirilebilir URL'si. Bir format için özellik, boş bir dize döndürmek yerine oluşturulmadığında çıkarılır.
3MF dosyasının indirilebilir URL'si. Yalnızca 3mfnin target_formats üzerinden talep edildiği durumlarda bulunur.
Name
pre_remeshed_glb
Type
string
Description
Yeniden ağlama öncesi orijinal GLB çıktısının indirilebilir URL'si.
Görev, should_remesh: true ve 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örseline indirilebilir URL. thumbnail_urls.front ile eşdeğerdir ve geriye dönük uyumluluk için korunur.
Name
alpha_thumbnail_url
Type
string
Description
thumbnail_urlun şeffaf arka planlı (RGBA) bir versiyonuna indirilebilir URL. Görev alpha_thumbnail: true ile oluşturulduğunda ve şeffaf ön izleme başarıyla render edildiğinde yalnızca bulunur; aksi takdirde bu alan çıkarılır.
Name
thumbnail_urls
Type
object
Description
Oluşturulan 3D modelin dört ana görünüm küçük resimlerinin indirilebilir URL'leri. Her değer, thumbnail_url ile aynı malzeme ve aydınlatma ile işlenmiş 512×512 PNG'ye ait imzalı bir URL'dir. GLB'yi indirmeden toplu işlemler için modeli birden fazla açıdan ön izlemek için kullanışlıdır.
Görev multi_view_thumbnails: true ile oluşturulduğunda ve SUCCEEDEDe ulaştığında yalnızca bulunur. Daha eski görevler ve isteğe bağlı olmayan görevler bu alanı içermeyecektir.
Name
front
Type
string
Description
Ön görünüm, dikey eksen etrafında 0° dönüş (matches thumbnail_url).
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
Doku oluşturma sürecini yönlendirmek için kullanılan metin prompt'u.
Name
texture_image_url
Type
string
Description
Doku oluşturma sürecini yönlendirmek için kullanılan doku imajının indirilebilir URL'si.
Name
ultra_mode
Type
boolean
Description
Görevin oluşturulduğu ultra_mode değerini yansıtır. Yalnızca ultra_mode'u açıkça ayarlayan meshy-7 (veya latest) görevleri için mevcuttur; aksi takdirde çıkarılır.
Name
progress
Type
integer
Description
Görevin ilerleyişi. Görev henüz başlamadıysa, bu özellik 0 olacaktır. Görev başarıyla sonuçlandığında, bu 100 olur.
Name
started_at
Type
timestamp
Description
Görevin başladığı zamanın zaman damgası, milisaniye olarak. Görev henüz başlamadıysa, bu özellik 0 olacaktır.
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, 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 olarak.
Name
expires_at
Type
timestamp
Description
Görev sonucunun sona erdiği zamanın zaman damgası, milisaniye olarak.
Name
finished_at
Type
timestamp
Description
Görevin bitirildiği zamanın zaman damgası, milisaniye olarak. Görev henüz bitmediyse, bu özellik 0 olacaktır.
Name
status
Type
string
Description
Görevin durumu. PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED değerlerinden biri olabilir.
Name
texture_urls
Type
array
Description
Görevden üretilen doku URL nesnelerinin bir 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
Baz renk harita imajına indirilebilir URL.
Name
metallic
Type
string
Description
Metalik harita imajına indirilebilir URL.
Görev enable_pbr: false ile oluşturulduğunda, bu özellik çıkarılır.
Name
normal
Type
string
Description
Normal harita imajına indirilebilir URL.
Görev enable_pbr: false ile oluşturulduğunda, bu özellik çıkarılır.
Name
roughness
Type
string
Description
Pürüzlülük harita imajına indirilebilir URL.
Görev enable_pbr: false ile oluşturulduğunda, bu özellik çıkarılır.
Name
emission
Type
string
Description
Emisyon harita imajına indirilebilir URL.
Görev enable_pbr: false ile oluşturulduğunda veya ai_modelmeshy-5, meshy-7 veya latest olduğunda, bu özellik çıkarılır.
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 sayfasına 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. Başarısız görevler için 0 döner (başarısızlık durumunda krediler iade edilir).