API Reteksturowania to funkcja, która umożliwia integrację możliwości reteksturowania AI Meshy z własną aplikacją. W tej sekcji znajdziesz wszystkie informacje
potrzebne do rozpoczęcia pracy z tym API.
Ten punkt końcowy umożliwia utworzenie nowego zadania reteksturowania. Zobacz
Obiekt zadania reteksturowania, aby dowiedzieć się, jakie
właściwości zawiera obiekt zadania reteksturowania.
Parametry
Wymagane jest podanie tylko jednego z parametrów input_task_id lub model_url. Jeśli podano oba, priorytet ma input_task_id.
Name
input_task_id
Type
string
Wymagane
Description
ID ukończonego zadania Obraz na 3D lub Tekst na 3D, które chcesz poddać reteksturowaniu.
To zadanie musi być jednym z następujących: Text to 3D Preview, Text to 3D Refine, Image to 3D lub Remesh. Dodatkowo musi mieć status SUCCEEDED.
Name
model_url
Type
string
Wymagane
Description
Podaj model 3D, który Meshy ma poddać teksturowaniu. Obsługiwane formaty: .glb, .gltf, .obj, .fbx, .stl.
Model można podać na dwa sposoby:
Publicznie dostępny URL: adres URL dostępny z publicznego internetu.
Data URI: zakodowany w base64 identyfikator URI danych modelu. Użyj typu MIME application/octet-stream. Przykład: data:application/octet-stream;base64,<your base64-encoded model data>.
Wymagane jest podanie dokładnie jednego wejścia stylu: text_style_prompt, image_style_url lub multiview_image_urls. multiview_image_urls nie może być łączone z żadnym z pozostałych dwóch; jeśli podano zarówno text_style_prompt, jak i image_style_url, priorytet ma image_style_url.
Name
text_style_prompt
Type
string
Wymagane
Description
Opisz za pomocą tekstu pożądany styl tekstury obiektu. Maksymalnie 800 znaków.
Name
image_style_url
Type
string
Wymagane
Description
Podaj obraz 2D, który posłuży jako wskazówka dla procesu teksturowania. Obecnie obsługujemy formaty .jpg, .jpeg i .png.
Obraz można podać na dwa sposoby:
Publicznie dostępny URL: adres URL dostępny z publicznego internetu
Data URI: zakodowany w base64 identyfikator URI danych obrazu. Przykład identyfikatora URI danych: data:image/jpeg;base64,<your base64-encoded image data>
Teksturowanie na podstawie obrazu może nie działać optymalnie, jeśli między oryginalnym zasobem a przesłanym obrazem występują znaczące różnice geometrii.
Name
multiview_image_urls
Type
string[]
Wymagane
Description
Podaj od 1 do 4 obrazów przedstawiających ten sam obiekt z różnych widoków, aby ukierunkować teksturowanie. Pierwszy obraz to widok główny (przedni); kolejność pozostałych widoków (lewy, tylny, prawy) nie ma znaczenia.
Każdy element akceptuje te same formaty co image_style_url (publicznie dostępny URL lub zakodowany w base64 identyfikator URI danych, .jpg/.jpeg/.png).
Wymaga jawnego ustawienia ai_model: "meshy-7".
Name
ai_model
Type
string
domyślne latest
Description
ID modelu AI używanego do reteksturowania. Dostępne wartości: meshy-6-lite, meshy-6, meshy-7, latest (Meshy 7).
Name
enable_original_uv
Type
boolean
domyślne false
Description
Zachowuje istniejący układ UV modelu zamiast generowania nowego.
Jeśli reteksturujesz model wygenerowany przez Meshy (za pomocą input_task_id lub model_url wskazującego na wynik działania Meshy), ustaw tę wartość na true, aby ponownie wykorzystać jego zoptymalizowany układ UV.
Jeśli reteksturujesz przesłany przez siebie model firmy trzeciej, ustaw true, gdy ma on już dobre UV, które chcesz zachować, lub pozostaw false, aby Meshy wygenerowało nowe rozwinięcie UV (najlepsze rozwiązanie dla modeli bez odpowiedniego mapowania UV).
Name
enable_pbr
Type
boolean
domyślne false
Description
Generuje mapy PBR (metaliczność, chropowatość, mapa normalnych) oprócz koloru bazowego. Mapa emisji jest również dołączana, gdy ai_model to meshy-6, z wyjątkiem texture_resolution: 8k. meshy-6-lite, meshy-7 i latest nie generują mapy emisji.
Name
texture_resolution
Type
string
domyślne 2k
Description
Rozdzielczość tekstury koloru bazowego. Jedna z wartości: 2k (2048×2048), 4k (4096×4096) lub 8k (8192×8192). Wyższe rozdzielczości pozwalają uchwycić więcej szczegółów powierzchni.
4k i 8k wymagają ai_modelmeshy-6, meshy-7 lub latest. Przy 8k mapa emisji nie jest generowana.
Name
hd_texture
Type
boolean
⚠ przestarzałe
domyślne false
Description
Zamiast tego użyj texture_resolution — jest to równoważne texture_resolution: "4k". Gdy oba parametry są ustawione, priorytet ma texture_resolution.
Name
remove_lighting
Type
boolean
domyślne true
Description
Usuwa podświetlenia i cienie z tekstury koloru bazowego, dając czystszy wynik, który lepiej sprawdza się przy niestandardowych ustawieniach oświetlenia.
Obsługiwane tylko wtedy, gdy ai_model to meshy-6.
Name
target_formats
Type
string[]
Description
Określa, które formaty plików 3D mają zostać uwzględnione w wyniku. Generowane i zwracane będą tylko żądane formaty, co może skrócić czas ukończenia zadania. Jeśli parametr zostanie pominięty, uwzględnione zostaną wszystkie obsługiwane formaty.
Dostępne wartości: glb, obj, fbx, stl, usdz, 3mf
Jeśli parametr zostanie pominięty, generowane są wszystkie formaty oprócz 3mf. 3mf jest dołączany tylko wtedy, gdy zostanie jawnie podany.
Name
alpha_thumbnail
Type
boolean
domyślne false
Description
Gdy ustawione na true, zadanie dodatkowo renderuje wersję podglądu z przezroczystym tłem (RGBA) i zwraca ją jako alpha_thumbnail_url w odpowiedzi GET. Istniejące pole thumbnail_url pozostaje bez zmian.
Zwracane wartości
Właściwość result odpowiedzi zawiera id zadania nowo utworzonego zadania reteksturowania.
Tryby awarii
Name
400 - Bad Request
Description
Żądanie było niedopuszczalne. Typowe przyczyny:
Brakujący parametr: Musi zostać podany model_url lub input_task_id.
Brakujący styl: Musi zostać podany jeden z parametrów text_style_prompt, image_style_url lub multiview_image_urls.
Sprzeczne dane wejściowe stylu: multiview_image_urls nie może być łączone z text_style_prompt ani image_style_url.
Nieobsługiwany model dla wielu widoków: multiview_image_urls wymaga jawnego ustawienia ai_model: "meshy-7".
Model niedostępny: ai_model: "meshy-7" i ai_model: "meshy-6-lite" są wdrażane stopniowo i mogą nie być jeszcze włączone dla Twojego konta.
Nieprawidłowe zadanie wejściowe: input_task_id musi odnosić się do zakończonego powodzeniem zadania z obsługiwanego modelu.
Nieprawidłowy format modelu: model_url wskazuje na plik o nieobsługiwanym rozszerzeniu.
Niedostępny URL: Nie udało się pobrać model_url, image_style_url lub jednego z elementów multiview_image_urls.
Name
401 - Unauthorized
Description
Uwierzytelnianie nie powiodło się. Sprawdź swój klucz API.
Name
402 - Payment Required
Description
Niewystarczająca liczba kredytów do wykonania tego zadania.
Name
429 - Too Many Requests
Description
Przekroczono limit szybkości.
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 }'
Ten punkt końcowy umożliwia pobranie zadania Reteksturowania na podstawie prawidłowego identyfikatora id zadania.
Zapoznaj się z sekcją Obiekt zadania Reteksturowania, aby zobaczyć,
jakie właściwości są zawarte w obiekcie zadania Reteksturowania.
Parametry
Name
id
Type
path
Description
Unikalny identyfikator zadania Reteksturowania, które ma zostać pobrane.
{"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}
Ten punkt końcowy trwale usuwa zadanie Reteksturowania, w tym wszystkie powiązane modele i dane. Ta czynność jest nieodwracalna.
Parametry ścieżki
Name
id
Type
path
Description
ID zadania Reteksturowania do usunięcia.
Status zadania
Zadanie, które nadal ma status PENDING, zostaje usunięte, a kredyty zużyte
w momencie utworzenia są zwracane.
Zadanie, które ma już status IN_PROGRESS, nie może zostać usunięte: żądanie
zostaje odrzucone z kodem 409 Conflict, a zadanie nadal działa. Kredyty za zadanie,
które worker już rozpoczął, nie podlegają zwrotowi, więc usunięcie go w trakcie
działania kosztowałoby zarówno kredyty, jak i wynik. Poczekaj, aż osiągnie status
SUCCEEDED, FAILED lub CANCELED, a następnie je usuń.
Zadanie w stanie końcowym (SUCCEEDED, FAILED lub CANCELED) zostaje usunięte
bez zwrotu kredytów.
Zwraca
Zwraca 200 OK w przypadku powodzenia lub 409 Conflict, gdy zadanie ma status
IN_PROGRESS.
// 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."}
[ {"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 }]
Obiekt zadania Reteksturowania to jednostka pracy, której Meshy używa do generowania tekstury 3D na podstawie danych wejściowych w postaci tekstu lub obrazu.
Model ma następujące właściwości:
Właściwości
Name
id
Type
string
Description
Unikalny identyfikator zadania. Chociaż jako szczegół implementacyjny używamy identyfikatorów zadań w formacie k-sortowalnego UUID, nie należy przyjmować żadnych założeń co do formatu tego identyfikatora.
Name
type
Type
string
Description
Typ zadania Reteksturowania. Wartość to retexture.
Name
model_urls
Type
object
Description
Adres URL do pobrania wytłumaczonego (z teksturami) pliku modelu 3D wygenerowanego przez Meshy.
Name
glb
Type
string
Description
Adres URL do pobrania pliku GLB.
Name
fbx
Type
string
Description
Adres URL do pobrania pliku FBX.
Name
obj
Type
string
Description
Adres URL do pobrania pliku OBJ.
Name
usdz
Type
string
Description
Adres URL do pobrania pliku USDZ.
Name
mtl
Type
string
Description
Adres URL do pobrania pliku MTL, zwracany razem z eksportem OBJ, gdy obecne są tekstury.
Name
stl
Type
string
Description
Adres URL do pobrania pliku STL.
Name
3mf
Type
string
Description
Adres URL do pobrania pliku 3MF. Obecny tylko wtedy, gdy format 3mf został zażądany za pomocą target_formats.
Name
text_style_prompt
Type
string
Description
Jest to prompt tekstowy, który został użyty do utworzenia zadania teksturowania.
Name
image_style_url
Type
string
Description
Jest to obraz wejściowy, który został użyty do utworzenia zadania teksturowania.
Name
multiview_image_urls
Type
string[]
Description
Adresy URL do pobrania obrazów referencyjnych z wielu widoków, które zostały użyte do utworzenia zadania teksturowania. Obecne tylko wtedy, gdy zadanie zostało utworzone z użyciem multiview_image_urls.
Name
thumbnail_url
Type
string
Description
Adres URL do pobrania miniatury pliku modelu.
Name
alpha_thumbnail_url
Type
string
Description
Adres URL do pobrania wersji thumbnail_url z przezroczystym tłem (RGBA). Obecny tylko wtedy, gdy zadanie zostało utworzone z parametrem alpha_thumbnail: true, a przezroczysty podgląd został pomyślnie wyrenderowany; w przeciwnym razie to pole jest pomijane.
Name
progress
Type
integer
Description
Postęp zadania. Jeśli zadanie jeszcze się nie rozpoczęło, ta właściwość będzie miała wartość 0. Gdy zadanie zakończy się powodzeniem, wartość ta zmieni się na 100.
Name
started_at
Type
timestamp
Description
Znacznik czasu rozpoczęcia zadania, w milisekundach. Jeśli zadanie jeszcze się nie rozpoczęło, ta właściwość będzie miała wartość 0.
Znacznik czasu reprezentuje liczbę milisekund, które upłynęły od 1 stycznia 1970 UTC, zgodnie ze
standardem RFC 3339.
Na przykład piątek, 1 września 2023, godzina 12:00:00 GMT jest reprezentowany jako 1693569600000. Dotyczy to
wszystkich znaczników czasu w Meshy API.
Name
created_at
Type
timestamp
Description
Znacznik czasu utworzenia zadania, w milisekundach.
Name
expires_at
Type
timestamp
Description
Znacznik czasu wygaśnięcia wyniku zadania, w milisekundach.
Name
finished_at
Type
timestamp
Description
Znacznik czasu zakończenia zadania, w milisekundach. Jeśli zadanie jeszcze się nie zakończyło, ta właściwość będzie miała wartość 0.
Name
status
Type
string
Description
Status zadania. Możliwe wartości to jedna z: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Tablica obiektów adresów URL tekstur wygenerowanych w ramach zadania. Zwykle zawiera ona tylko jeden obiekt adresu URL tekstury. Każdy adres URL tekstury ma następujące właściwości:
Name
base_color
Type
string
Description
Adres URL do pobrania obrazu mapy koloru bazowego.
Name
metallic
Type
string
Description
Adres URL do pobrania obrazu mapy metaliczności.
Jeśli zadanie zostało utworzone z parametrem enable_pbr: false, ta właściwość zostanie pominięta.
Name
normal
Type
string
Description
Adres URL do pobrania obrazu mapy normalnych.
Jeśli zadanie zostało utworzone z parametrem enable_pbr: false, ta właściwość zostanie pominięta.
Name
roughness
Type
string
Description
Adres URL do pobrania obrazu mapy chropowatości.
Jeśli zadanie zostało utworzone z parametrem enable_pbr: false, ta właściwość zostanie pominięta.
Name
emission
Type
string
Description
Adres URL do pobrania obrazu mapy emisji.
Jeśli zadanie zostało utworzone z parametrem enable_pbr: false, lub gdy ai_model ma wartość meshy-6-lite, ta właściwość zostanie pominięta.
Name
preceding_tasks
Type
integer
Description
Liczba poprzedzających zadań.
Ta właściwość jest obecna tylko wtedy, gdy status zadania to PENDING.
Name
task_error
Type
object
Description
Szczegóły błędu dla nieudanych zadań. Pełną dokumentację obiektu task_error znajdziesz w sekcji Błędy.
Name
consumed_credits
Type
integer
Description
Liczba kredytów zużytych przez to zadanie. Obecna, gdy status zadania to PENDING, IN_PROGRESS lub SUCCEEDED. Zwraca 0 dla zadań FAILED (kredyty są zwracane w przypadku niepowodzenia).
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}