Metinden 3D'ye API, Meshy'nin Metinden 3D'ye özelliklerini 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.
Metinden 3D'ye iki adımlı bir iş akışı kullanır. Önce, şekli değerlendirebilmeniz için doku olmadan bir 3D ağ oluşturmak üzere bir önizleme görevi (mode: "preview") oluşturun. Ardından, ağa doku uygulamak için tamamlanan önizlemenin görev kimliğini bir iyileştirme görevine (mode: "refine") iletin. Her iki adım da aynı uç noktayı paylaşır.
Bu uç nokta, bir metin prompt'undan kaplamasız bir 3D ağ (yalnızca geometri) oluşturan bir Metinden 3D'ye önizleme görevi oluşturur. Bu, iki adımlı iş akışının ilk adımıdır. Önizleme başarılı olduktan sonra, kaplama eklemek için döndürülen görev ID'sini kullanarak bir iyileştirme görevi oluşturun. Tam yanıt şeması için
Metinden 3D'ye Görev Nesnesi bölümüne bakın.
Parametreler
Name
mode
Type
string
Zorunlu
Description
Bu alan, bir önizleme görevi oluşturulurken "preview" olarak ayarlanmalıdır.
Name
prompt
Type
string
Zorunlu
Description
3D modelin ne tür bir nesne olduğunu açıklayın. Maksimum 600 karakter.
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 yok sayılır.
Yeniden ağ aşamasının etkinleştirilip etkinleştirilmeyeceğini kontrol eder. false olarak ayarlandığında API, doğrudan en yüksek hassasiyetli üçgen 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: Sadeleştirilmiş bir üç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 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
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ında simetri davranışını kontrol eder.
Geçerli değerler şunlardır:
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 pose_mode değerini 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
art_style
Type
string
⚠ kullanımdan kaldırıldı
varsayılan realistic
Description
Meshy-6 tarafından desteklenmez. Meshy-6 kullanan istekler art_style değerini yok sayar ve bazı kombinasyonlar hatalara neden olabilir. Kullanılabilir değerler: realistic, sculpture.
Sculpture stili kullanılırken enable_pbrfalse olarak ayarlanmalıdır, çünkü Sculpture stili kendi PBR haritaları kümesini oluşturur.
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şturmaya devam etmez.
prompt içindeki metin 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, görev tamamlama 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
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şmeden kalır.
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.
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ür
Yanıtın result özelliği, yeni oluşturulan Metinden 3D'ye görevinin görev id değerini içerir.
Başarısızlık Modları
Name
400 - Bad Request
Description
İstek kabul edilemezdi. Yaygın nedenler:
Eksik parametre: Gerekli bir parametre (örn. prompt, mode) eksik.
Geçersiz parametre: art_style izin verilen değerlerden biri değil.
Prompt çok uzun: prompt karakter sınırını aşıyor.
Name
401 - Unauthorized
Description
Kimlik doğrulama başarısız oldu. Lütfen API anahtarınızı kontrol edin.
Bu uç nokta, tamamlanmış bir önizleme ağına doku uygulayan bir Metinden 3D'ye refine görevi oluşturur. Başarılı bir önizleme görevinden alınan preview_task_id değerini sağlamanız gerekir. Bu, iki adımlı iş akışının ikinci adımıdır.
Parametreler
Name
mode
Type
string
Zorunlu
Description
Bir refine görevi oluştururken bu alan "refine" olarak ayarlanmalıdır.
Name
preview_task_id
Type
string
Zorunlu
Description
İlgili önizleme görevi kimliği.
Verilen önizleme görevinin durumu SUCCEEDED olmalıdır.
Name
enable_pbr
Type
boolean
varsayılan false
Description
Temel renge ek olarak PBR haritaları (metallic, roughness, normal) oluşturur. 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şturur.
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 ek 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örüntü sağlayın. Şu anda .jpg, .jpeg ve .png formatlarını destekliyoruz.
Görüntüyü sağlamanın iki yolu vardır:
Herkese açık erişilebilir URL: Genel internetten erişilebilen bir URL
Data URI: Görüntünün base64 ile kodlanmış Data URI'si. Bir Data URI örneği: data:image/jpeg;base64,<your base64-encoded image data>
Orijinal asset ile yüklenen görüntü arasında önemli geometri farkları varsa görüntüyle 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. Her iki parametre de sağlanırsa model varsayılan olarak texture_prompt kullanılarak dokulandırılır.
Name
ai_model
Type
string
varsayılan latest
Description
Refine işlemi için kullanılacak modelin kimliği. Kullanılabilir değerler: meshy-5, meshy-6, latest (Meshy 6).
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 devam etmez.
Hem texture_prompt içindeki metin hem de texture_image_url içindeki görüntü taranır.
Name
remove_lighting
Type
boolean
varsayılan true
Description
Temel renk dokusundan parlak noktaları ve gölgeleri kaldırarak özel aydınlatma kurulumları altında daha iyi çalışan daha temiz bir sonuç üretir.
Yalnızca ai_modelmeshy-6 veya latest olduğunda desteklenir.
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örevin tamamlanma süresini azaltabilir. Atlandığında tüm desteklenen formatlar dahil edilir.
Atlandığında 3mf dışındaki tüm formatlar oluşturulur. 3mf yalnızca açıkça belirtildiğinde dahil edilir.
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ü render eder ve GET yanıtında alpha_thumbnail_url olarak döndürür. Mevcut thumbnail_url alanı değişmez.
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 ve modeli buna göre yeniden boyutlandırmak için AI vision kullanır. origin_at açıkça ayarlanmadıkça orijin varsayılan olarak bottom olur.
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ür
Yanıtın result özelliği, yeni oluşturulan Metinden 3D'ye görevinin görev id değerini içerir.
Hata Modları
Name
400 - Bad Request
Description
İstek kabul edilemez durumdaydı. Yaygın nedenler:
Geçersiz görev kimliği: preview_task_id geçersiz veya mevcut değil.
Görev hazır değil: Önizleme görevi henüz başarılı olmadı.
Model uyuşmazlığı: Önizleme görevinin AI modeli, istenen refine modeliyle uyumlu değil.
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
preview_task_id ile belirtilen önizleme görevi bulunamadı.
Bu uç nokta, geçerli bir görev id verildiğinde bir Metinden 3D'ye görevini almanızı sağlar.
Metinden 3D'ye görev nesnesine hangi özelliklerin dahil edildiğini görmek için
Metinden 3D'ye Görev Nesnesi bölümüne bakın.
Bu uç nokta hem önizleme hem de iyileştirme görevleri için çalışır.
Parametreler
Name
id
Type
path
Description
Alınacak Metinden 3D'ye görevi için benzersiz tanımlayıcı.
Metinden 3D'ye Görev nesnesi, Meshy'nin bir metin girdisinden 3D model oluşturmak için takip ettiği bir iş birimidir. Metinden 3D'ye API'sinin iki aşaması vardır: preview ve refine. Önizleme aşaması, yalnızca ağ içeren bir 3D model oluşturmak içindir; iyileştirme aşaması ise önizleme aşamasının sonucuna dayalı kaplamalı bir 3D model oluşturmak içindir.
Nesne aşağıdaki özelliklere sahiptir:
Özellikler
Name
id
Type
string
Description
Görev için benzersiz tanımlayıcı. Uygulama ayrıntısı olarak görev kimlikleri için k-sıralanabilir bir UUID kullanıyor olsak da,
kimliğin biçimi hakkında herhangi bir varsayımda bulunmamalısınız.
Name
type
Type
string
Description
Metinden 3D'ye görevinin türü. Olası değerler, önizleme aşaması görevleri için text-to-3d-preview ve iyileştirme aşaması görevleri için text-to-3d-refine değerleridir.
Name
model_urls
Type
object
Description
Meshy tarafından oluşturulan dokulu 3D model dosyasına ait indirilebilir URL. Bir format oluşturulmadığında, boş bir dize döndürmek yerine o formata ait özellik atlanır.
Name
glb
Type
string
Description
GLB dosyasına ait indirilebilir URL.
Name
fbx
Type
string
Description
FBX dosyasına ait indirilebilir URL.
Name
usdz
Type
string
Description
USDZ dosyasına ait indirilebilir URL.
Name
obj
Type
string
Description
OBJ dosyasına ait indirilebilir URL.
Name
mtl
Type
string
Description
MTL dosyasına ait indirilebilir URL.
Name
stl
Type
string
Description
STL dosyasına ait indirilebilir URL.
Name
3mf
Type
string
Description
3MF dosyasına ait indirilebilir URL. Yalnızca target_formats aracılığıyla 3mf istendiğinde bulunur.
Name
prompt
Type
string
Description
Bu, görevi oluşturmak için kullanılan değiştirilmemiş prompt değeridir.
Name
negative_prompt
Type
string
⚠ kullanımdan kaldırıldı
Description
Geriye dönük uyumluluk için korunur. Bu alanın oluşturulan modeller üzerinde işlevsel bir etkisi yoktur.
Name
art_style
Type
string
⚠ kullanımdan kaldırıldı
Description
Önizleme görevini oluşturmak için kullanılan değiştirilmemiş art_style değeridir. Meshy-6 tarafından desteklenmez.
Name
texture_richness
Type
string
⚠ kullanımdan kaldırıldı
Description
Geriye dönük uyumluluk için korunur. Bu alanın oluşturulan modeller üzerinde işlevsel bir etkisi yoktur.
Name
texture_prompt
Type
string
Description
İyileştirme aşamasında doku oluşturma sürecine rehberlik etmek için sağlanan ek metin prompt'u.
Name
texture_image_url
Type
string
Description
Doku oluşturma sürecine rehberlik etmek için kullanılan doku görüntüsüne ait indirilebilir URL.
Name
thumbnail_url
Type
string
Description
Model dosyasının küçük resim görüntüsüne ait indirilebilir URL.
Name
alpha_thumbnail_url
Type
string
Description
thumbnail_url değerinin şeffaf arka planlı (RGBA) sürümüne ait indirilebilir URL. Yalnızca görev alpha_thumbnail: true ile oluşturulduğunda ve şeffaf önizleme başarıyla render edildiğinde bulunur; aksi takdirde bu alan atlanır.
Name
video_url
Type
string
⚠ kullanımdan kaldırıldı
Description
Önizleme videosuna ait indirilebilir URL. Gelecekteki bir sürümde kaldırılacaktır.
Name
progress
Type
integer
Description
Görevin progress değeri. Görev henüz başlatılmadıysa, bu özellik 0 olur. Görev başarılı olduğunda bu değer 100 olur.
Name
started_at
Type
timestamp
Description
Görevin ne zaman başlatıldığının milisaniye cinsinden zaman damgası. Görev henüz başlatılmadı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 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 ne zaman oluşturulduğunun milisaniye cinsinden zaman damgası.
Name
finished_at
Type
timestamp
Description
Görevin ne zaman tamamlandığının milisaniye cinsinden zaman damgası. Görev henüz tamamlanmadıysa, bu özellik 0 olur.
Görevden oluşturulan doku URL nesnelerinden oluşan bir dizi. 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
Temel renk haritası görüntüsüne ait indirilebilir URL.
Name
metallic
Type
string
Description
Metalik harita görüntüsüne ait indirilebilir URL.
Görev enable_pbr: false ile oluşturulursa, bu özellik atlanır.
Name
normal
Type
string
Description
Normal harita görüntüsüne ait indirilebilir URL.
Görev enable_pbr: false ile oluşturulursa, bu özellik atlanır.
Name
roughness
Type
string
Description
Pürüzlülük haritası görüntüsüne ait indirilebilir URL.
Görev enable_pbr: false ile oluşturulursa, bu özellik atlanır.
Name
emission
Type
string
Description
Emisyon haritası görüntüsüne ait indirilebilir URL.
Görev enable_pbr: false ile oluşturulursa 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 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 (kredi başarısızlık durumunda iade edilir).
Example Text to 3D Task Object
{"id":"018a210d-8ba4-705c-b111-1f1776f7f578","type":"text-to-3d-preview","model_urls": {"glb":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***","fbx":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***","usdz":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***","obj":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***","mtl":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***","stl":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***" },"prompt":"a monster mask","texture_prompt":"green slimy skin with scales and warts","texture_image_url":"","thumbnail_url":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***","progress":100,"seed":1234,"started_at":1692771667037,"created_at":1692771650657,"finished_at":1692771669037,"status":"SUCCEEDED","texture_urls": [ {"base_color":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***","metallic":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX","normal":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX","roughness":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX","emission":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX" } ],"preceding_tasks":0,"task_error": {"message":"" },"consumed_credits":20}