Remesh API
Remesh API pozwala na remesh i eksport istniejących modeli 3D generowanych przez inne API Meshy (takie jak Obraz na 3D lub Tekst na 3D) do różnych formatów. Ta sekcja zawiera szczegóły dotyczące korzystania z Remesh API.
Utwórz zadanie Remesh
Ten punkt końcowy tworzy nowe zadanie remesh.
Do konwersji formatu i zmiany rozmiaru użyj dedykowanego API konwersji i API zmiany rozmiaru. Poniższe przestarzałe parametry będą nadal działać, ale zalecamy nowe punkty końcowe do nowych integracji.
Parametry
Tylko jeden z input_task_id lub model_url jest wymagany. Jeśli oba są podane, input_task_id ma priorytet.
- Name
- input_task_id
- Type
- string
- Wymagane
- Description
ID zakończonego zadania Obraz na 3D lub Tekst na 3D, które chcesz przetworzyć na remesh. To zadanie musi być jednym z następujących zadań: Podgląd Tekst na 3D, Udoskonalenie Tekst na 3D, Obraz na 3D lub Reteksturowanie. Dodatkowo, musi mieć status
SUCCEEDED.
- Name
- model_url
- Type
- string
- Wymagane
- Description
Proszę podać model 3D dla Meshy do przetworzenia na remesh za pośrednictwem publicznie dostępnego URL lub Data URI. Obsługiwane formaty:
.glb,.gltf,.obj,.fbx,.stl.Dla Data URI użyj MIME type:
application/octet-stream.
- Name
- target_formats
- Type
- string[]
- domyślne ["glb"]
- Description
Lista docelowych formatów dla przetworzonego modelu. Jeśli pominięte, generowany jest tylko GLB.
Dostępne wartości:
glb,fbx,obj,usdz,blend,stl,3mf.
- Name
- topology
- Type
- string
- domyślne triangle
- Description
Określ topology generowanego modelu.
Dostępne wartości:
quad: Generuj siatkę z dominującymi czworokątami.triangle: Generuj zredukowaną siatkę trójkątów.
- Name
- target_polycount
- Type
- integer
- domyślne 30,000
- Description
Określ docelową liczbę wielokątów w generowanym modelu. Rzeczywista liczba wielokątów może odbiegać od celu w zależności od złożoności geometria.
Prawidłowy zakres wartości zależy od poziomu użytkownika:
- 100 do 300,000 (włącznie)
- Name
- decimation_mode
- Type
- integer
- Description
Włącz adaptacyjną redukcję przez ustawienie poziomu liczby wielokątów. Gdy ustawione,
target_polycountjest ignorowane.Dostępne wartości:
1: Adaptacyjny — ultra liczba wielokątów.2: Adaptacyjny — wysoka liczba wielokątów.3: Adaptacyjny — średnia liczba wielokątów.4: Adaptacyjny — niska liczba wielokątów.
- Name
- resize_height
- Type
- number
- ⚠ przestarzałe
- domyślne 0
- Description
Zmień rozmiar modelu do określonej wysokości mierzonej w metrach. Zalecamy użycie dedykowanego API zmiany rozmiaru.
auto_size,resize_heightiresize_longest_sidesą wzajemnie wykluczające się.
- Name
- resize_longest_side
- Type
- number
- ⚠ przestarzałe
- domyślne 0
- Description
Zmień rozmiar modelu, aby najdłuższy wymiar obwiedni był równy określonej wartości w metrach. Zalecamy użycie dedykowanego API zmiany rozmiaru.
auto_size,resize_heightiresize_longest_sidesą wzajemnie wykluczające się.
- Name
- auto_size
- Type
- boolean
- ⚠ przestarzałe
- domyślne false
- Description
Gdy ustawione na
true, usługa używa wizji AI do automatycznego oszacowania rzeczywistej wysokości obiektu i odpowiedniego zmiany rozmiaru modelu. Zalecamy użycie dedykowanego API zmiany rozmiaru.auto_size,resize_heightiresize_longest_sidesą wzajemnie wykluczające się.
auto_size = true- Name
- origin_at
- Type
- string
- ⚠ przestarzałe
- domyślne bottom
- Description
Pozycja punktu początkowego. Zalecamy użycie dedykowanego API zmiany rozmiaru.
Dostępne wartości:
bottom,center.
- Name
- convert_format_only
- Type
- boolean
- ⚠ przestarzałe
- Description
Jeśli
true, usługa zmieni tylko format pliku wejściowego modelu, ignorując inne wejścia jaktopology,resize_heightitarget_polycount. Zalecamy użycie dedykowanego API konwersji.target_formatsmusi być podane, jeśliconvert_format_onlyjest ustawione natrue.
- 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ą jakoalpha_thumbnail_urlw odpowiedzi GET. Istniejące polethumbnail_urlpozostaje niezmienione.
Zwraca
Właściwość result odpowiedzi zawiera id nowo utworzonego zadania remesh.
Tryby awarii
- Name
400 - Bad Request- Description
Żądanie było nieakceptowalne. Typowe przyczyny:
- Brakujący parametr: Musi być podany
model_urllubinput_task_id. - Nieprawidłowe zadanie wejściowe:
input_task_idmusi odnosić się do pomyślnego zadania z obsługiwanego modelu. - Nieprawidłowy format modelu:
model_urlwskazuje na plik z nieobsługiwanym rozszerzeniem. - Nieosiągalny URL:
model_urlnie mógł zostać pobrany. - Nieprawidłowa topology: Parametr
topologyjest nieprawidłowy. - Wzajemnie wykluczające się parametry:
auto_sizeiresize_heightnie mogą być ustawione jednocześnie.
- Brakujący parametr: Musi być podany
- Name
401 - Unauthorized- Description
Uwierzytelnianie nie powiodło się. Proszę sprawdzić swój klucz API.
- Name
402 - Payment Required- Description
Niewystarczające kredyty do wykonania tego zadania.
- Name
429 - Too Many Requests- Description
Przekroczyłeś swój limit szybkości.
Żądanie
# 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
}'
Odpowiedź
{
"result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}
Pobierz zadanie Remesh
Ten punkt końcowy pobiera zadanie remesh według jego ID.
Parametry
- Name
- id
- Type
- path
- Description
ID zadania remesh do pobrania.
Zwraca
Obiekt zadania Remesh.
Żądanie
curl https://api.meshy.ai/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Odpowiedź
{
"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,
}
Usuń zadanie Remesh
Ten punkt końcowy trwale usuwa zadanie remesh, w tym wszystkie powiązane modele i dane. Ta akcja jest nieodwracalna.
Parametry ścieżki
- Name
- id
- Type
- path
- Description
ID zadania remesh do usunięcia.
Zwraca
Zwraca 200 OK w przypadku sukcesu.
Request
curl --request DELETE \
--url https://api.meshy.ai/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
// Returns 200 Ok on success.
Lista zadań Remesh
Ten punkt końcowy pozwala na pobranie listy zadań Remesh.
Parametry
- Name
- page_num
- Type
- integer
- domyślne 1
- Description
Numer strony dla stronicowania.
- Name
- page_size
- Type
- integer
- domyślne 10
- Description
Limit rozmiaru strony. Maksymalnie dozwolone to
50elementów.
- Name
- sort_by
- Type
- string
- Description
Pole do sortowania.
Dostępne wartości:
+created_at: Sortuj według czasu utworzenia w porządku rosnącym.-created_at: Sortuj według czasu utworzenia w porządku malejącym.
Zwraca
Zwraca stronicowaną listę Obiektów Zadań Remesh.
Żądanie
curl https://api.meshy.ai/openapi/v1/remesh?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Odpowiedź
[
{
"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
}
]
Strumieniowanie zadania Remesh
Ten punkt końcowy strumieniuje aktualizacje w czasie rzeczywistym dla zadania Remesh przy użyciu Server-Sent Events (SSE).
Parametry
- Name
- id
- Type
- path
- Description
Unikalny identyfikator dla zadania Remesh do strumieniowania.
Zwraca
Zwraca strumień Obiektów Zadania Remesh jako Server-Sent Events.
Dla zadań PENDING lub IN_PROGRESS, strumień odpowiedzi będzie zawierał tylko niezbędne pola progress i status.
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,
}
Obiekt Zadania Remesh
Obiekt Zadania Remesh reprezentuje jednostkę pracy, którą Meshy używa do remeshu i eksportu istniejącego modelu 3D do różnych formatów. Obiekt ma następujące właściwości:
Właściwości
- Name
- id
- Type
- string
- Description
Unikalny identyfikator zadania. Chociaż używamy UUID sortowalnego k dla identyfikatorów zadań jako szczegółu implementacji, nie powinieneś zakładać żadnych założeń dotyczących formatu id.
- Name
- type
- Type
- string
- Description
Typ zadania Remesh. Wartość to
remesh.
- Name
- model_urls
- Type
- object
- Description
Pobieralny URL do pliku modelu 3D z teksturą wygenerowanego przez Meshy. Właściwość dla formatu zostanie pominięta, jeśli format nie zostanie wygenerowany, zamiast zwracać pusty ciąg.
- Name
glb- Type
- string
- Description
Pobieralny URL do pliku GLB.
- Name
fbx- Type
- string
- Description
Pobieralny URL do pliku FBX.
- Name
obj- Type
- string
- Description
Pobieralny URL do pliku OBJ.
- Name
usdz- Type
- string
- Description
Pobieralny URL do pliku USDZ.
- Name
blend- Type
- string
- Description
Pobieralny URL do pliku Blender.
- Name
stl- Type
- string
- Description
Pobieralny URL do pliku STL.
- Name
3mf- Type
- string
- Description
Pobieralny URL do pliku 3MF. Obecny tylko wtedy, gdy
3mfzostał zażądany przeztarget_formats.
- Name
- thumbnail_url
- Type
- string
- Description
Pobieralny URL do obrazu podglądu renderowanego z modelu po remeshu.
- Name
- alpha_thumbnail_url
- Type
- string
- Description
Pobieralny URL do wersji
thumbnail_urlz przezroczystym tłem (RGBA). Obecny tylko wtedy, gdy zadanie zostało utworzone zalpha_thumbnail: truei przezroczysty podgląd został pomyślnie wyrenderowany; w przeciwnym razie to pole jest pomijane.
- Name
- progress
- Type
- integer
- Description
Progress zadania. Jeśli zadanie jeszcze się nie rozpoczęło, ta właściwość będzie miała wartość
0. Gdy zadanie zakończy się sukcesem, stanie się100.
- Name
- status
- Type
- string
- Description
Status zadania. Możliwe wartości to
PENDING,IN_PROGRESS,SUCCEEDED,FAILED.
- Name
- preceding_tasks
- Type
- integer
- Description
Liczba poprzedzających zadań.
Wartość tego pola ma znaczenie tylko wtedy, gdy status zadania to
PENDING.
- Name
- created_at
- Type
- timestamp
- Description
Znacznik czasu utworzenia zadania, w milisekundach.
- 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.
- 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
- task_error
- Type
- object
- Description
Szczegóły błędu dla nieudanych zadań. Zobacz Błędy dla pełnej referencji obiektu
task_error.
- Name
- consumed_credits
- Type
- integer
- Description
Liczba kredytów zużytych przez to zadanie. Obecne, gdy status zadania to
PENDING,IN_PROGRESSlubSUCCEEDED. Zwraca0dla zadańFAILED(kredyty są zwracane w przypadku niepowodzenia).
Przykład Obiektu Zadania Remesh
{
"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
}