Retexture API, Meshy'nin yapay zeka destekli yeniden dokulama yeteneklerini kendi uygulamanıza entegre etmenizi sağlayan bir özelliktir. 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 Yeniden dokulama görevi oluşturmanızı sağlar. Yeniden dokulama görev nesnesiyle hangi özelliklerin dahil edildiğini görmek için
Yeniden Dokulama Görev Nesnesi bölümüne bakın.
Parametreler
input_task_id veya model_url parametrelerinden yalnızca biri zorunludur. Her ikisi de sağlanırsa, input_task_id önceliklidir.
Name
input_task_id
Type
string
Zorunlu
Description
Yeniden dokulamak istediğiniz tamamlanmış Görselden 3D'ye veya Metinden 3D'ye görevinin kimliği.
Bu görev şunlardan biri olmalıdır: Metinden 3D'ye Ön İzleme, Metinden 3D'ye Refine, Görselden 3D'ye veya Yeniden ağ. Ayrıca, durumu SUCCEEDED olmalıdır.
Name
model_url
Type
string
Zorunlu
Description
Meshy'nin doku uygulayacağı bir 3D model sağlayın. Desteklenen formatlar: .glb, .gltf, .obj, .fbx, .stl.
Modeli sağlamanın iki yolu vardır:
Herkese açık erişilebilir URL: Genel internetten erişilebilen bir URL.
Data URI: Modelin base64 ile kodlanmış bir data URI'si. application/octet-stream MIME type'ını kullanın. Örnek: data:application/octet-stream;base64,<base64 ile kodlanmış model verileriniz>.
Tam olarak bir stil girdisi zorunludur: text_style_prompt, image_style_url veya multiview_image_urls. multiview_image_urls, diğer ikisinden hiçbiriyle birleştirilemez; hem text_style_prompt hem de image_style_url sağlanırsa, image_style_url önceliklidir.
Name
text_style_prompt
Type
string
Zorunlu
Description
Nesnenin istediğiniz doku stilini metin kullanarak açıklayın. En fazla 800 karakter.
Name
image_style_url
Type
string
Zorunlu
Description
Doku uygulama sürecine rehberlik edecek 2 boyutlu 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>
Orijinal asset ile yüklenen görsel arasında önemli geometri farklılıkları varsa görsel doku uygulama en iyi şekilde çalışmayabilir.
Name
multiview_image_urls
Type
string[]
Zorunlu
Description
Doku uygulamaya rehberlik etmesi için aynı nesnenin farklı görünümlerden 1 ila 4 görselini sağlayın. İlk görsel birincil (ön) görünümdür; kalan görünümlerin (sol, arka, sağ) sırası önemli değildir.
Her bir öğe, image_style_url ile aynı formatları kabul eder (herkese açık erişilebilir bir URL veya base64 data URI, .jpg/.jpeg/.png).
Açık bir şekilde ai_model: "meshy-7" gerektirir.
Name
ai_model
Type
string
varsayılan latest
Description
Yeniden dokulama için kullanılacak AI modelinin kimliği. Kullanılabilir değerler: meshy-5, meshy-6, meshy-7, latest (Meshy 7).
Name
enable_original_uv
Type
boolean
varsayılan false
Description
Yeni bir UV yerleşimi oluşturmak yerine modelin mevcut UV yerleşimini koruyun.
Meshy tarafından oluşturulmuş bir modeli yeniden dokuluyorsanız (input_task_id üzerinden veya bir Meshy çıktısına işaret eden bir model_url ile), optimize edilmiş UV yerleşimini yeniden kullanmak için bunu true olarak ayarlayın.
Yüklediğiniz üçüncü taraf bir modeli yeniden dokuluyorsanız, korumak istediğiniz iyi UV'lere zaten sahipse true olarak ayarlayın veya Meshy'nin yeni UV'ler açmasına izin vermek için false bırakın (uygun UV eşlemesi olmayan modeller için en iyisidir).
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_modelmeshy-6 olduğunda, texture_resolution: 8k dışında bir emisyon haritası da dahil edilir. meshy-7 ve latest bir emisyon haritası üretmez.
Name
texture_resolution
Type
string
varsayılan 2k
Description
Temel 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 için meshy-6, meshy-7 veya latest gerektirir. 8k seviyesinde 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. Her ikisi de ayarlandığında, texture_resolution önceliklidir.
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_modelmeshy-6 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şturulacak ve döndürülecektir, bu da görev tamamlanma süresini azaltabilir. Belirtilmediğinde, desteklenen tüm formatlar dahil edilir.
Belirtilmediğinde, 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 ön izlemenin şeffaf arka planlı (RGBA) bir sürümünü render eder ve bunu GET yanıtında alpha_thumbnail_url olarak döndürür. Mevcut thumbnail_url alanı değişmez.
Dönüş Değerleri
Yanıtın result özelliği, yeni oluşturulan Yeniden dokulama görevinin id değerini içerir.
Hata Modları
Name
400 - Bad Request
Description
İstek kabul edilemedi. Yaygın nedenler:
Eksik parametre: model_url veya input_task_id parametrelerinden biri sağlanmalıdır.
Eksik stil: text_style_prompt, image_style_url veya multiview_image_urls parametrelerinden biri sağlanmalıdır.
Çakışan stil girdileri: multiview_image_urls, text_style_prompt veya image_style_url ile birleştirilemez.
Çoklu görünüm için desteklenmeyen model: multiview_image_urls, açık bir şekilde ai_model: "meshy-7" gerektirir.
Model kullanılamıyor: ai_model: "meshy-7" aşamalı olarak kullanıma sunuluyor ve henüz hesabınız için etkinleştirilmemiş.
Geçersiz girdi görevi: input_task_id, desteklenen bir modelden başarılı bir göreve işaret etmelidir.
Geçersiz model formatı: model_url, desteklenmeyen bir uzantıya sahip bir dosyaya işaret ediyor.
Erişilemeyen URL: model_url, image_style_url veya bir multiview_image_urls öğesi indirilemedi.
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/retexture
# Retexture with text promptcurlhttps://api.meshy.ai/openapi/v1/retexture \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "model_url": "https://cdn.meshy.ai/model/example_model_2.glb", "text_style_prompt": "red fangs, Samurai outfit that fused with japanese batik style", "enable_original_uv": true, "enable_pbr": true }'# Retexture with image style and PBRcurlhttps://api.meshy.ai/openapi/v1/retexture \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "model_url": "https://cdn.meshy.ai/model/example_model_2.glb", "image_style_url": "https://cdn.meshy.ai/image/example_image.jpg", "ai_model": "latest", "enable_pbr": true, "enable_original_uv": true }'
Bu uç nokta, geçerli bir görev id'si verildiğinde bir Yeniden dokulama görevini almanızı sağlar.
Yeniden dokulama görev nesnesiyle birlikte hangi özelliklerin yer aldığını görmek için
Yeniden Dokulama Görevi Nesnesi bölümüne bakın.
Parametreler
Name
id
Type
path
Description
Alınacak Yeniden dokulama görevi için benzersiz tanımlayıcı.
{"id":"018a210d-8ba4-705c-b111-1f1776f7f578","type":"retexture","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=***","obj":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***","usdz":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?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=***" },"thumbnail_url":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***","text_style_prompt":"red fangs, Samurai outfit that fused with japanese batik style","texture_image_url":"","progress":100,"started_at":1692771667037,"created_at":1692771650657,"expires_at":1692771679037,"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" } ],"task_error": {"message":"" },"consumed_credits":10}
[ {"id":"018a210d-8ba4-705c-b111-1f1776f7f578","type":"retexture","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=***" },"thumbnail_url":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***","text_style_prompt":"red fangs, Samurai outfit that fused with japanese batik style","progress":100,"started_at":1692771667037,"created_at":1692771650657,"expires_at":1692771679037,"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":10 }]
Yeniden Dokulama Görevi nesnesi, Meshy'nin metin veya görsel girdilerinden bir 3D doku üretmek için kullandığı bir iş birimidir.
Model 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
Yeniden Dokulama görevinin türü. Değer retexture şeklindedir.
Name
model_urls
Type
object
Description
Meshy tarafından üretilen dokulu 3D model dosyasının indirilebilir URL'si.
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
Dokular 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. Yalnızca target_formats üzerinden 3mf talep edildiğinde bulunur.
Name
text_style_prompt
Type
string
Description
Bu, dokulama görevini oluşturmak için kullanılan metin prompt'udur.
Name
image_style_url
Type
string
Description
Bu, dokulama görevini oluşturmak için kullanılan görsel girdidir.
Name
multiview_image_urls
Type
string[]
Description
Dokulama görevini oluşturmak için kullanılan çoklu görünüm referans görsellerinin indirilebilir URL'leri. Yalnızca görev multiview_image_urls ile oluşturulduğunda bulunur.
Name
thumbnail_url
Type
string
Description
Model dosyasının küçük resminin indirilebilir URL'si.
Name
alpha_thumbnail_url
Type
string
Description
thumbnail_url'in şeffaf arka planlı (RGBA) versiyonunun indirilebilir URL'si. Yalnızca görev alpha_thumbnail: true ile oluşturulduğunda ve şeffaf önizleme başarıyla oluşturulduğunda bulunur; aksi takdirde bu alan atlanır.
Name
progress
Type
integer
Description
Görevin ilerlemesi. Görev henüz başlamadıysa, bu özellik 0 olacaktır. Görev başarılı olduğunda, bu değer 100 olur.
Name
started_at
Type
timestamp
Description
Görevin başlatıldığı zamanın milisaniye cinsinden zaman damgası. Görev henüz başlamadıysa, bu özellik 0 olacaktır.
Bir zaman damgası, RFC 3339 standardını
takip ederek 1 Ocak 1970 UTC'den bu yana geçen milisaniye sayısını temsil eder.
Örneğin, 1 Eylül 2023 Cuma, GMT saatiyle 12:00:00, 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 milisaniye cinsinden zaman damgası.
Name
expires_at
Type
timestamp
Description
Görev sonucunun süresinin dolacağı zamanın milisaniye cinsinden zaman damgası.
Name
finished_at
Type
timestamp
Description
Görevin tamamlandığı zamanın milisaniye cinsinden zaman damgası. Görev henüz tamamlanmadıysa, bu özellik 0 olacaktır.
Görev enable_pbr: false ile oluşturulduysa, bu özellik atlanır.
Name
emission
Type
string
Description
Emisyon haritası görselinin indirilebilir URL'si.
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 özellik yalnızca görev durumu PENDING olduğunda bulunur.
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. FAILED görevler için 0 döner (başarısızlık durumunda kredi iadesi yapılır).
Example Retexture Task Model
{"id":"018a210d-8ba4-705c-b111-1f1776f7f578","type":"retexture","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=***" },"text_style_prompt":"red fangs, Samurai outfit that fused with japanese batik style","image_style_url":"https://assets.meshy.ai/***/image/example_image.jpg?Expires=***","thumbnail_url":"https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***","progress":100,"started_at":1692771667037,"created_at":1692771650657,"expires_at":1692771679037,"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":10}