Wiele obrazów na 3D API to funkcja, która pozwala na integrację możliwości Meshy w zakresie Wiele obrazów na 3D z Twoją 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 Wiele obrazów na 3D. Zobacz
Obiekt zadania Wiele obrazów na 3D, aby dowiedzieć się, jakie
właściwości zawiera obiekt zadania Wiele obrazów na 3D.
Parametry
Wymagany jest tylko jeden z parametrów input_task_id lub image_urls. Jeśli podane zostaną oba, priorytet ma input_task_id.
Name
input_task_id
Type
string
Wymagane
Description
ID ukończonego zadania generowania obrazu, którego wynik (1-4 obrazy) powinien zostać użyty jako dane wejściowe. To zadanie musi być jednym z następujących: Tekst na obraz, Obraz na obraz, Tekst na obraz Wiele widoków lub Obraz na obraz Wiele widoków. Ponadto musi zostać uruchomione za pośrednictwem API i mieć status SUCCEEDED.
Name
image_urls
Type
array
Wymagane
Description
Podaj od 1 do 4 obrazów, które Meshy ma wykorzystać przy tworzeniu modelu. Obecnie obsługujemy formaty .jpg, .jpeg i .png. Aby uzyskać najlepsze rezultaty, wszystkie obrazy powinny przedstawiać ten sam obiekt z różnych kątów.
Istnieją dwa sposoby dostarczenia każdego obrazu:
Publicznie dostępny URL: adres URL dostępny z publicznego internetu.
Data URI: zakodowany w base64 identyfikator URI danych obrazu. Przykład Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
W przypadku meshy-7 (lub latest) pierwszy obraz jest używany jako główny (przedni) widok. Kolejność pozostałych obrazów nie ma znaczenia.
Name
ai_model
Type
string
domyślne latest
Description
ID modelu do użycia. Dostępne wartości: meshy-5, meshy-6, meshy-7, latest (Meshy 7).
Name
ultra_mode
Type
boolean
domyślne false
Description
Włącza generowanie Ultra dla geometrii o wyższej wierności i bardziej szczegółowej powierzchni.
Obsługiwane tylko wtedy, gdy ai_model to meshy-7 (lub latest).
Name
should_texture
Type
boolean
domyślne true
Description
Określa, czy generowane są tekstury. Ustawienie wartości false pomija etap teksturowania, dostarczając siatkę bez tekstur.
Dotyczy tylko gdy should_texture = true
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-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 uchwycą więcej szczegółów powierzchni.
4k i 8k wymagają ai_modelmeshy-6, meshy-7 lub latest. Przy 8k nie jest generowana mapa emisji.
Name
hd_texture
Type
boolean
⚠ przestarzałe
domyślne false
Description
Użyj zamiast tego texture_resolution — odpowiednik texture_resolution: "4k". Gdy oba są ustawione, pierwszeństwo ma texture_resolution.
Name
texture_prompt
Type
string
Description
Podaj prompt tekstowy, aby ukierunkować proces teksturowania. Maksymalnie 800 znaków.
Name
texture_image_url
Type
string
Description
Podaj obraz 2D, aby ukierunkować proces teksturowania. Obecnie obsługujemy formaty .jpg, .jpeg i .png.
Istnieją dwa sposoby dostarczenia obrazu:
Publicznie dostępny URL: adres URL dostępny z publicznego internetu
Data URI: zakodowany w base64 identyfikator URI danych obrazu. Przykład Data URI: data:image/jpeg;base64,<your base64-encoded image data>
Teksturowanie obrazu może nie działać optymalnie, jeśli istnieją istotne różnice geometrii między oryginalnym zasobem a przesłanym obrazem. Tylko jeden z parametrów texture_image_url lub texture_prompt może być użyty do ukierunkowania procesu teksturowania. Jeśli podane zostaną oba parametry, domyślnie do teksturowania modelu zostanie użyty texture_prompt.
Name
texture_image_urls
Type
string[]
Description
Podaj od 1 do 4 obrazów przedstawiających ten sam obiekt z różnych widoków, aby ukierunkować teksturowanie. Pierwszy obraz jest głównym (przednim) widokiem; kolejność pozostałych widoków (lewy, tylny, prawy) nie ma znaczenia.
Każdy element akceptuje te same formaty co texture_image_url (publicznie dostępny URL lub zakodowany w base64 Data URI, .jpg/.jpeg/.png).
Te obrazy kierują wyłącznie teksturowaniem i są niezależne od image_urls — obie listy mogą zawierać różne obrazy i różną liczbę obrazów.
Wymaga ai_modelmeshy-7 lub latest. Nie można łączyć z texture_image_url ani texture_prompt.
Name
should_remesh
Type
boolean
domyślne false (meshy-6), true (others)
Description
Kontroluje, czy włączyć etap Remesh. Aby uzyskać model najwyższej jakości, zalecamy ustawienie should_remesh na false.
Dotyczy tylko gdy should_remesh = true
Name
topology
Type
string
domyślne triangle
Description
Określ topology generowanego modelu.
Dostępne wartości:
quad: Generuje siatkę zdominowaną przez czworokąty.
Określ docelową liczbę wielokątów w generowanym modelu. Rzeczywista liczba wielokątów może odbiegać od wartości docelowej w zależności od złożoności geometrii.
Prawidłowy zakres wartości zależy od poziomu użytkownika:
od 100 do 300 000 (włącznie)
Name
decimation_mode
Type
integer
Description
Włącz adaptacyjną decymację, ustawiając poziom liczby wielokątów. Gdy ta wartość jest ustawiona, target_polycount jest ignorowany.
Dostępne wartości:
1: Adaptacyjna — ultra liczba wielokątów.
2: Adaptacyjna — wysoka liczba wielokątów.
3: Adaptacyjna — średnia liczba wielokątów.
4: Adaptacyjna — niska liczba wielokątów.
Name
save_pre_remeshed_model
Type
boolean
domyślne false
Description
Gdy ustawione na true, Meshy dodatkowo zapisuje dodatkowy plik GLB przed zakończeniem etapu remesh.
Name
symmetry_mode
Type
string
⚠ przestarzałe
domyślne auto
Description
Przestarzałe. Ten parametr nie wpływa już na wynik.
Pole symmetry_mode kontroluje zachowanie symetrii podczas procesu generowania modelu.
Prawidłowe wartości to:
off: Wyłącza symetrię.
auto: Automatycznie określa i stosuje symetrię na podstawie geometrii wejściowej.
on: Wymusza symetrię podczas generowania.
Name
pose_mode
Type
string
domyślne ""
Description
Określ pose_mode dla generowanego modelu.
Dostępne wartości:
a-pose: Generuje model w pozycji A.
t-pose: Generuje model w pozycji T.
"" (pusty ciąg znaków): Nie zastosowano żadnej konkretnej pozy.
Name
is_a_t_pose
Type
boolean
⚠ przestarzałe
domyślne false
Description
Użyj zamiast tego pose_mode. Określa, czy wygenerować model w pozycji A/T.
Name
image_enhancement
Type
boolean
domyślne true
Description
Optymalizuje obrazy wejściowe dla lepszych rezultatów. Ustaw na false, aby zachować dokładny wygląd obrazów wejściowych bez żadnego przetwarzania stylistycznego.
Obsługiwane tylko wtedy, gdy ai_model to meshy-6, meshy-7 lub latest.
Name
remove_lighting
Type
boolean
domyślne true
Description
Usuwa podświetlenia i cienie z tekstury koloru bazowego, dając czystszy rezultat, który sprawdza się lepiej przy niestandardowych ustawieniach oświetlenia.
Obsługiwane tylko wtedy, gdy ai_model to meshy-6, meshy-7 lub latest.
Name
moderation
Type
boolean
domyślne false
Description
Gdy ustawione na true, treść wejściowa zostanie automatycznie sprawdzona pod kątem potencjalnie szkodliwych treści. Jeśli szkodliwa treść zostanie wykryta, zadanie nie przejdzie do etapu generowania.
Każdy obraz z image_urls oraz tekst z texture_prompt zostaną sprawdzone.
Name
target_formats
Type
string[]
Description
Określa, które formaty plików 3D mają zostać uwzględnione w wyniku. Tylko żądane formaty zostaną wygenerowane i zwrócone, co może skrócić czas ukończenia zadania.
Dostępne wartości: glb, obj, fbx, stl, usdz, 3mf
Gdy pominięte, generowane są wszystkie formaty z wyjątkiem 3mf. 3mf jest dołączany tylko wtedy, gdy zostanie jawnie określony.
Name
auto_size
Type
boolean
domyślne false
Description
Gdy ustawione na true, usługa wykorzystuje wizję AI do automatycznego oszacowania rzeczywistej wysokości obiektu i odpowiedniego zmiania rozmiaru modelu. Punkt początkowy domyślnie przyjmie wartość bottom, chyba że origin_at zostanie jawnie ustawione.
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 niezmienione.
Name
multi_view_thumbnails
Type
boolean
domyślne false
Description
Gdy ustawione na true, zadanie dodatkowo renderuje cztery główne widoki miniatur (przód, prawo, tył, lewo) i zwraca je pod thumbnail_urls w odpowiedzi GET. Istniejące pole thumbnail_url pozostaje niezmienione i nadal wskazuje na widok przedni, więc istniejący klienci nie są tym dotknięci.
Dodaje około 3 sekundy do czasu wykonania zadania.
Dotyczy tylko gdy auto_size = true
Name
origin_at
Type
string
domyślne bottom
Description
Pozycja punktu początkowego, gdy auto_size jest włączone. Dostępne wartości: bottom, center.
Zwraca
Właściwość result odpowiedzi zawiera id zadania nowo utworzonego zadania Wiele obrazów na 3D.
Tryby awarii
Name
400 - Bad Request
Description
Żądanie było niedopuszczalne. Typowe przyczyny:
Brak parametru: Musi zostać podany image_urls lub input_task_id.
Nieprawidłowe zadanie wejściowe: input_task_id musi odnosić się do zadania Tekst na obraz, Obraz na obraz lub jego wariantu wielowidokowego o statusie SUCCEEDED.
Nieprawidłowa liczba obrazów: image_urls musi zawierać od 1 do 4 obrazów, a texture_image_urls od 1 do 4.
Nieprawidłowy format obrazu: Jeden lub więcej obrazów w image_urls ma nieobsługiwany format.
Sprzeczne dane wejściowe tekstury: texture_image_urls nie można łączyć z texture_image_url ani texture_prompt, a ponadto wymaga should_texture: true.
Nieobsługiwany model dla tekstury wielowidokowej: texture_image_urls wymaga ai_modelmeshy-7 lub latest.
Niedostępny URL: Nie udało się pobrać jednego lub więcej elementów image_urls lub texture_image_urls.
Name
401 - Unauthorized
Description
Uwierzytelnianie nie powiodło się. Sprawdź swój klucz API.
Name
402 - Payment Required
Description
Niewystarczające kredyty do wykonania tego zadania.
Name
429 - Too Many Requests
Description
Przekroczono limit szybkości.
Request
POST
/openapi/v1/multi-image-to-3d
# Simple requestcurlhttps://api.meshy.ai/openapi/v1/multi-image-to-3d \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_urls": [ "<your publicly accessible image url or base64-encoded data URI>", "<your second publicly accessible image url or base64-encoded data URI>" ] }'# With PBR texturing and GLB formatcurlhttps://api.meshy.ai/openapi/v1/multi-image-to-3d \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_urls": [ "<your publicly accessible image url or base64-encoded data URI>", "<your second publicly accessible image url or base64-encoded data URI>" ], "should_texture": true, "enable_pbr": true, "target_formats": ["glb"] }'
Ten punkt końcowy pozwala na pobranie zadania Wiele obrazów na 3D, podając prawidłowy id zadania.
Odwołaj się do Obiekt zadania Wiele obrazów na 3D, aby zobaczyć, które
właściwości są zawarte w obiekcie zadania Wiele obrazów na 3D.
Parametry
Name
id
Type
path
Description
Unikalny identyfikator dla zadania Wiele obrazów na 3D do pobrania.
Obiekt zadania Wiele obrazów na 3D jest jednostką pracy, którą Meshy śledzi w celu wygenerowania modelu 3D na podstawie wielu obrazów (od 1 do 4 włącznie). Obrazy powinny przedstawiać ten sam obiekt, najlepiej z różnych widoków lub kątów.
Obiekt 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 dla identyfikatorów zadań UUID z możliwością sortowania k-sortable, nie należy przyjmować żadnych założeń dotyczących formatu tego identyfikatora.
Name
type
Type
string
Description
Typ zadania Wiele obrazów na 3D. Wartość to multi-image-to-3d.
Name
model_urls
Type
object
Description
Adres URL do pobrania pliku tekstorowanego modelu 3D wygenerowanego przez Meshy. Właściwość dla danego formatu zostanie pominięta, jeśli format nie został wygenerowany, zamiast zwracać pusty ciąg.
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 wraz 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. Występuje tylko wtedy, gdy 3mf zostało zażądane za pomocą target_formats.
Name
pre_remeshed_glb
Type
string
Description
Adres URL do pobrania oryginalnego wyniku GLB przed przeprowadzeniem remeshingu.
Dostępne tylko wtedy, gdy zadanie zostało utworzone jednocześnie z should_remesh: true i save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Adres URL do pobrania obrazu miniatury pliku modelu. Odpowiada wartości thumbnail_urls.front, gdy jest ona obecna; zachowane dla zapewnienia zgodności wstecznej.
Name
alpha_thumbnail_url
Type
string
Description
Adres URL do pobrania wersji thumbnail_url z przezroczystym tłem (RGBA). Występuje tylko wtedy, gdy zadanie zostało utworzone z alpha_thumbnail: true, a podgląd z przezroczystością został poprawnie wyrenderowany; w innym przypadku pole to jest pominięte.
Name
thumbnail_urls
Type
object
Description
Adresy URL do pobrania czterech miniatur modelu 3D przedstawiających cztery główne widoki. Każda wartość to podpisany adres URL do obrazu PNG 512×512, wyrenderowanego z tymi samymi materiałami i oświetleniem co thumbnail_url. Przydatne do podglądu modelu z wielu kątów w potokach przetwarzania wsadowego bez konieczności pobierania pliku GLB.
Występuje tylko wtedy, gdy zadanie zostało utworzone z multi_view_thumbnails: true i osiągnęło status SUCCEEDED. Starsze zadania oraz zadania utworzone bez tej opcji nie będą zawierać tego pola.
Name
front
Type
string
Description
Widok z przodu, obrót 0° wokół osi wertykalnej (odpowiada thumbnail_url).
Name
right
Type
string
Description
Widok z prawej strony, obrót 90°.
Name
back
Type
string
Description
Widok z tyłu, obrót 180°.
Name
left
Type
string
Description
Widok z lewej strony, obrót 270°.
Name
texture_prompt
Type
string
Description
Prompt tekstowy, który został użyty do sterowania procesem teksturowania.
Name
texture_image_urls
Type
string[]
Description
Adresy URL do pobrania obrazów referencyjnych tekstury, które zostały użyte do utworzenia zadania, w kolejności ich podania. Występuje tylko wtedy, gdy zadanie zostało utworzone z texture_image_urls.
Name
ultra_mode
Type
boolean
Description
Odzwierciedla wartość ultra_mode, z jaką zadanie zostało utworzone. Występuje tylko dla zadań meshy-7 (lub latest), które w wyraźny sposób ustawiły ultra_mode; w innym przypadku pominięte.
Name
progress
Type
integer
Description
Postęp zadania (progress). Jeśli zadanie nie zostało jeszcze rozpoczęte, ta właściwość będzie miała wartość 0. Po zakończeniu zadania powodzeniem, wartość ta zmieni się na 100.
Name
started_at
Type
timestamp
Description
Znacznik czasu rozpoczęcia zadania, w milisekundach. Jeśli zadanie nie zostało jeszcze rozpoczęte, ta właściwość będzie miała wartość 0.
Znacznik czasu przedstawia 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 12:00:00 PM GMT jest przedstawiany 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 nie zostało jeszcze zakończone, 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 przez zadanie. Zwykle zawiera ona jeden obiekt adresu URL tekstury. Każdy adres URL tekstury posiada 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 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 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 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 enable_pbr: false, lub ai_model ma wartość meshy-5, ta właściwość zostanie pominięta.
Name
preceding_tasks
Type
integer
Description
Liczba poprzedzających zadań.
Wartość tego pola ma znaczenie tylko wtedy, gdy status zadania to PENDING.
Name
task_error
Type
object
Description
Szczegóły błędu dla nieudanych zadań. Zobacz Błędy, aby uzyskać pełny opis obiektu task_error.
Name
consumed_credits
Type
integer
Description
Liczba kredytów zużytych przez to zadanie. Obecne, gdy status zadania to PENDING, IN_PROGRESS lub SUCCEEDED. Zwraca 0 dla zadań ze statusem FAILED (kredyty są zwracane w przypadku niepowodzenia).