Yeniden Ağ API'si
Yeniden Ağ API'si, diğer Meshy API'leri (Görselden 3D'ye veya Metinden 3D'ye gibi) tarafından oluşturulan mevcut 3D modelleri yeniden ağ yapısına dönüştürmenize ve çeşitli formatlara aktarmanıza olanak tanır. Bu bölüm, Yeniden Ağ API'sinin nasıl kullanılacağına dair ayrıntılar sunar.
Bir Yeniden Ağ Görevi Oluştur
Bu uç nokta yeni bir yeniden ağ görevi oluşturur.
Format dönüştürme ve yeniden boyutlandırma için özel Convert API ve Resize API'yi kullanın. Aşağıdaki kullanımdan kaldırılan parametreler çalışmaya devam edecek, ancak yeni entegrasyonlar için yeni uç noktaları öneriyoruz.
Parametreler
input_task_id veya model_url'den yalnızca biri gereklidir. Her ikisi de sağlanırsa, input_task_id önceliklidir.
- Name
- input_task_id
- Type
- string
- Zorunlu
- Description
Yeniden ağlamak istediğiniz tamamlanmış Görselden 3D'ye veya Metinden 3D'ye görevinin ID'si. Bu görev şu görevlerden biri olmalıdır: Metinden 3D'ye Önizleme, Metinden 3D'ye Refine, Görselden 3D'ye veya Yeniden dokulama. Ayrıca,
SUCCEEDEDdurumuna sahip olmalıdır.
- Name
- model_url
- Type
- string
- Zorunlu
- Description
Lütfen Meshy'nin yeniden ağlaması için herkese açık erişilebilir bir URL veya data URI aracılığıyla bir 3D model sağlayın. Desteklenen formatlar:
.glb,.gltf,.obj,.fbx,.stl.Data URI'ler için MIME type'ı kullanın:
application/octet-stream.
- Name
- target_formats
- Type
- string[]
- varsayılan ["glb"]
- Description
Yeniden ağlanan model için hedef formatların bir listesi. Belirtilmediğinde, yalnızca GLB oluşturulur.
Kullanılabilir değerler:
glb,fbx,obj,usdz,blend,stl,3mf.
- 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: Azaltılmış 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 belirleyerek uyarlanabilir azaltmayı etkinleştirin. Ayarlandığında,
target_polycountyok 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
- resize_height
- Type
- number
- ⚠ kullanımdan kaldırıldı
- varsayılan 0
- Description
Modeli metre cinsinden belirli bir yüksekliğe yeniden boyutlandırır. Bunun yerine özel Resize API'yi kullanmanızı öneririz.
auto_size,resize_heightveresize_longest_sidebirbirini dışlar.
- Name
- resize_longest_side
- Type
- number
- ⚠ kullanımdan kaldırıldı
- varsayılan 0
- Description
Modeli, sınırlayıcı kutunun en uzun boyutu metre cinsinden belirtilen değere eşit olacak şekilde yeniden boyutlandırır. Bunun yerine özel Resize API'yi kullanmanızı öneririz.
auto_size,resize_heightveresize_longest_sidebirbirini dışlar.
- Name
- auto_size
- Type
- boolean
- ⚠ kullanımdan kaldırıldı
- varsayılan false
- Description
trueolarak ayarlandığında, servis nesnenin gerçek dünyadaki yüksekliğini otomatik olarak tahmin etmek için AI görüşünü kullanır ve modeli buna göre yeniden boyutlandırır. Bunun yerine özel Resize API'yi kullanmanızı öneririz.auto_size,resize_heightveresize_longest_sidebirbirini dışlar.
auto_size = true- Name
- origin_at
- Type
- string
- ⚠ kullanımdan kaldırıldı
- varsayılan bottom
- Description
Orijinin konumu. Bunun yerine özel Resize API'yi kullanmanızı öneririz.
Kullanılabilir değerler:
bottom,center.
- Name
- convert_format_only
- Type
- boolean
- ⚠ kullanımdan kaldırıldı
- Description
trueise, servis yalnızca girdi model dosyasının formatını değiştirir;topology,resize_heightvetarget_polycountgibi diğer girdileri yok sayar. Bunun yerine özel Convert API'yi kullanmanızı öneririz.convert_format_onlytrueolarak ayarlanırsatarget_formatssağlanmalıdır.
- Name
- alpha_thumbnail
- Type
- boolean
- varsayılan false
- Description
trueolarak ayarlandığında, görev ek olarak önizlemenin şeffaf arka planlı (RGBA) bir sürümünü işler ve bunu GET yanıtındaalpha_thumbnail_urlolarak döndürür. Mevcutthumbnail_urlalanı değişmez.
Dönüş Değerleri
Yanıtın result özelliği, yeni oluşturulan yeniden ağ görevinin id'sini içerir.
Hata Modları
- Name
400 - Bad Request- Description
İstek kabul edilemedi. Yaygın nedenler:
- Eksik parametre:
model_urlveyainput_task_id'den biri sağlanmalıdır. - Geçersiz girdi görevi:
input_task_id, desteklenen bir modelden başarılı bir göreve atıfta bulunmalıdır. - Geçersiz model formatı:
model_url, desteklenmeyen bir uzantıya sahip bir dosyayı işaret ediyor. - Erişilemeyen URL:
model_urlindirilemedi. - Geçersiz topology:
topologyparametresi geçersiz. - Birbirini dışlayan parametreler:
auto_sizeveresize_heightaynı anda ayarlanamaz.
- Eksik parametre:
- 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
# Basic remesh with custom formats and resize
curl https://api.meshy.ai/openapi/v1/remesh \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"target_formats": ["glb", "fbx"],
"topology": "quad",
"target_polycount": 50000,
"resize_height": 1.0,
"origin_at": "bottom"
}'
# Quad remesh with auto-size
curl https://api.meshy.ai/openapi/v1/remesh \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"target_formats": ["glb", "fbx"],
"topology": "quad",
"target_polycount": 50000,
"auto_size": true
}'
Response
{
"result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}
Bir Yeniden Ağ Görevini Getir
Bu uç nokta, kimliğine göre bir yeniden ağ görevini getirir.
Parametreler
- Name
- id
- Type
- path
- Description
Getirilecek yeniden ağ görevinin kimliği.
Dönüş Değerleri
Yeniden Ağ Görevi nesnesi.
Request
curl https://api.meshy.ai/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
{
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "remesh",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
"fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
"usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
"blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
"stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
},
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000001000,
"task_error": null,
}
Bir Yeniden Ağ Görevini Sil
Bu uç nokta, bir yeniden ağ görevini ilişkili tüm modeller ve verilerle birlikte kalıcı olarak siler. Bu işlem geri alınamaz.
Yol Parametreleri
- Name
- id
- Type
- path
- Description
Silinecek yeniden ağ görevinin ID'si.
Görev Durumu
Hâlâ PENDING durumunda olan bir görev silinir ve oluşturma sırasında
harcanan kredi iade edilir.
Zaten IN_PROGRESS durumunda olan bir görev silinemez: istek
409 Conflict ile reddedilir ve görev çalışmaya devam eder. Worker'ın zaten
başlatmış olduğu bir görev için krediler iade edilemez, bu yüzden çalışma
sırasında silmek hem kredilerinize hem de sonuca mal olur. Görevin
SUCCEEDED, FAILED veya CANCELED durumuna ulaşmasını bekleyin, ardından silin.
Sonlanmış bir durumdaki (SUCCEEDED, FAILED veya CANCELED) bir görev
iade yapılmadan silinir.
Dönüş Değerleri
Başarılı olduğunda 200 OK, görev IN_PROGRESS durumundayken
409 Conflict döner.
Request
curl --request DELETE \
--url https://api.meshy.ai/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS — the task is left running:
{
"message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}
Yeniden Ağ Görevlerini Listele
Bu uç nokta, Yeniden ağ görevlerinin bir listesini almanızı sağlar.
Parametreler
- 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
100öğedir.
- Name
- sort_by
- Type
- string
- Description
Sıralama yapılacak alan.
Kullanılabilir değerler:
+created_at: Oluşturulma zamanına göre artan sırayla sırala.-created_at: Oluşturulma zamanına göre azalan sırayla sırala.
Döndürülenler
Yeniden Ağ Görevi Nesneleri'nin sayfalanmış bir listesini döndürür.
Request
curl https://api.meshy.ai/openapi/v1/remesh?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
[
{
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "remesh",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
"fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
"usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
"blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
"stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
},
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000001000,
"task_error": null
}
]
Bir Yeniden Ağ Görevini Akışla Aktar
Bu uç nokta, Server-Sent Events (SSE) kullanarak bir Yeniden Ağ görevi için gerçek zamanlı güncellemeleri akışla aktarır.
Parametreler
- Name
- id
- Type
- path
- Description
Akışla aktarılacak Yeniden Ağ görevi için benzersiz tanımlayıcı.
Dönüş Değerleri
Yeniden Ağ Görevi Nesnelerinin Server-Sent Events olarak bir akışını döndürür.
PENDING veya IN_PROGRESS durumundaki görevler için yanıt akışı yalnızca gerekli progress ve status alanlarını içerecektir.
Request
curl -N https://api.meshy.ai/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response Stream
// Error event example
event: error
data: {
"status_code": 404,
"message": "Task not found"
}
// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
event: message
data: {
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"progress": 0,
"status": "PENDING"
}
event: message
data: {
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "remesh",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
"fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
"usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
"blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
"stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
},
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000001000,
"task_error": null,
}
Remesh Görevi Nesnesi
Remesh Görevi nesnesi, Meshy'nin mevcut bir 3D modeli yeniden ağlamak (remesh) ve çeşitli formatlara dışa aktarmak için kullandığı bir iş birimini temsil eder. Nesne aşağıdaki özelliklere sahiptir:
Özellikler
- Name
- id
- Type
- string
- Description
Görev için benzersiz tanımlayıcı. Uygulama detayı olarak görev id'leri için k-sıralanabilir bir UUID kullansak da, id'nin formatı hakkında herhangi bir varsayımda bulunmamalısınız.
- Name
- type
- Type
- string
- Description
Remesh görevinin türü. Değer
remeshşeklindedir.
- Name
- model_urls
- Type
- object
- Description
Meshy tarafından oluşturulan dokulu 3D model dosyasına indirilebilir URL. Bir format oluşturulmamışsa, boş bir string 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
blend- Type
- string
- Description
Blender dosyasına indirilebilir URL.
- Name
stl- Type
- string
- Description
STL dosyasına indirilebilir URL.
- Name
3mf- Type
- string
- Description
3MF dosyasına indirilebilir URL. Yalnızca
target_formatsüzerinden3mftalep edildiğinde bulunur.
- Name
- thumbnail_url
- Type
- string
- Description
Yeniden ağlanmış (remesh) modelden render edilen bir önizleme görüntüsüne indirilebilir URL.
- Name
- alpha_thumbnail_url
- Type
- string
- Description
thumbnail_urldeğerinin şeffaf arka planlı (RGBA) sürümüne indirilebilir URL. Yalnızca görevalpha_thumbnail: trueile oluşturulduğunda ve şeffaf önizleme başarıyla render edildiğinde bulunur; aksi takdirde bu alan atlanır.
- Name
- progress
- Type
- integer
- Description
Görevin ilerlemesi (progress). Görev henüz başlamadıysa, bu özellik
0olur. Görev başarıyla tamamlandığında bu değer100olur.
- Name
- status
- Type
- string
- Description
Görevin durumu. Olası değerler
PENDING,IN_PROGRESS,SUCCEEDED,FAILEDdeğerlerinden biridir.
- Name
- preceding_tasks
- Type
- integer
- Description
Öncesindeki görevlerin sayısı.
Bu alanın değeri yalnızca görev durumu
PENDINGolduğunda anlamlıdır.
- Name
- created_at
- Type
- timestamp
- Description
Görevin oluşturulduğu zaman damgası, milisaniye cinsinden.
- Name
- started_at
- Type
- timestamp
- Description
Görevin başladığı zaman damgası, milisaniye cinsinden. Görev henüz başlamadıysa, bu özellik
0olur.
- Name
- finished_at
- Type
- timestamp
- Description
Görevin tamamlandığı zaman damgası, milisaniye cinsinden. Görev henüz tamamlanmadıysa, bu özellik
0olur.
- Name
- task_error
- Type
- object
- Description
Başarısız görevler için hata detayları. Tam
task_errornesne 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_PROGRESSveyaSUCCEEDEDolduğunda bulunur.FAILEDgörevler için0döner (başarısızlık durumunda krediler iade edilir).
Example Remesh Task Object
{
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "remesh",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
"fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
"usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
"blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
"stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
},
"progress": 100,
"status": "SUCCEEDED",
"preceding_tasks": 0,
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000001000,
"task_error": {
"message": ""
},
"consumed_credits": 5
}