Napraw drukowalność API

Napraw drukowalność modelu 3D w technologii FDM — usuń krawędzie non-manifold, zdegenerowane ściany, otwory i inne problemy dotyczące topology, aby siatka była gotowa do druku.

POST/openapi/v1/print/repair

Utwórz zadanie naprawy drukowalności

Ten punkt końcowy tworzy nowe zadanie naprawy drukowalności. Zadanie wykonuje naprawę topology na modelu 3D i zwraca szczelną (watertight), gotową do druku wersję.

Format wyjściowy odpowiada formatowi wejściowemu. Jeśli prześlesz plik .stl za pomocą model_url, w odpowiedzi pole model_urls.stl będzie zawierać naprawioną siatkę, a pozostałe pola formatów pozostaną puste. Ścieżka input_task_id zawsze odczytuje plik GLB zadania źródłowego, więc dane wyjściowe mają format .glb.

Parametry

Wymagany jest tylko jeden z parametrów input_task_id lub model_url. Jeśli podano oba, priorytet ma input_task_id.

Istniejące tekstury są usuwane podczas naprawy ze względu na zmiany w geometrii. Aby ponownie dodać tekstury, użyj Retexture API na naprawionym modelu.

  • Name
    model_url
    Type
    string
    Wymagane
    Description

    Adres URL modelu 3D do naprawy. Obsługiwane formaty: .glb, .gltf, .obj, .fbx, .stl. Maksymalny rozmiar pliku: 100 MB. Musi używać http, https lub adresu URL data: (adresy URL typu data pomijają kontrolę rozszerzeń).

  • 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 nowo utworzonego zadania naprawy drukowalności.

Tryby awarii

  • Name
    400 - Bad Request
    Description

    Żądanie było niepoprawne. Typowe przyczyny:

    • Brakujący parametr: nie podano ani input_task_id, ani model_url.
    • Nieprawidłowy UUID: input_task_id nie jest prawidłowym UUID.
    • Nieprawidłowy adres URL modelu: model_url ma niepoprawny format, używa nieobsługiwanego schematu lub ma nieobsługiwane rozszerzenie pliku.
    • Plik modelu zbyt duży: treść model_url przekroczyła 100 MB.
    • Zadanie niezakończone powodzeniem: wskazane zadanie jest wciąż oczekujące, w trakcie realizacji lub zakończone niepowodzeniem.
    • Brak GLB: wskazane zadanie nie posiada zasobu GLB do naprawy.
  • Name
    401 - Unauthorized
    Description

    Uwierzytelnianie nie powiodło się. Sprawdź swój klucz API.

  • Name
    402 - Payment Required
    Description

    Typowe przyczyny:

    • Plan darmowy: tworzenie zadań wymaga płatnego planu. Ulepsz na stronie subskrypcji.
    • Niewystarczające kredyty: osiągnięto limit kredytów obszaru roboczego.
  • Name
    404 - Not Found
    Description

    Wskazane zadanie nie istnieje lub jego właścicielem jest inny użytkownik.

  • Name
    429 - Too Many Requests
    Description

    Przekroczono limit oczekujących zadań lub limit szybkości.

Request

POST
/openapi/v1/print/repair
# Repair an existing task
curl https://api.meshy.ai/openapi/v1/print/repair \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578"
  }'

# Or repair a model URL directly
curl https://api.meshy.ai/openapi/v1/print/repair \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "model_url": "https://example.com/model.stl"
  }'

Response

{
  "result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}
GET/openapi/v1/print/repair/:id

Pobierz zadanie Napraw drukowalność

Ten punkt końcowy pobiera zadanie napraw drukowalność na podstawie jego ID.

Parametry

  • Name
    id
    Type
    path
    Description

    ID zadania napraw drukowalność do pobrania.

Zwraca

Obiekt zadania Napraw drukowalność. Blok model_urls jest pusty, dopóki zadanie nie osiągnie statusu SUCCEEDED. Wypełniane jest tylko pole model_urls odpowiadające formatowi wejściowemu.

Request

GET
/openapi/v1/print/repair/a43b5c6d-7e8f-901a-234b-567c890d1e2f
curl https://api.meshy.ai/openapi/v1/print/repair/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "print-repair",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000030000,
  "expires_at": 1715725401000,
  "task_error": null,
  "model_urls": {
    "glb": "",
    "gltf": "",
    "fbx": "",
    "obj": "",
    "stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***",
    "usdz": "",
    "3mf": "",
    "mtl": ""
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
  "texture_urls": [],
  "consumed_credits": 10
}
DELETE/openapi/v1/print/repair/:id

Usuń zadanie naprawy drukowalności

Ten punkt końcowy trwale usuwa zadanie naprawy drukowalności oraz jego naprawiony wynik. Ta operacja jest nieodwracalna.

Parametry ścieżki

  • Name
    id
    Type
    path
    Description

    ID zadania naprawy drukowalności do usunięcia.

Status zadania

Zadanie, które nadal ma status PENDING, zostaje usunięte, a kredyty zużyte w momencie jego utworzenia są zwracane.

Zadania o statusie IN_PROGRESS nie można usunąć: żądanie zostaje odrzucone z kodem 409 Conflict, a zadanie kontynuuje działanie. Kredyty za zadanie, które worker już rozpoczął przetwarzać, 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.

Request

DELETE
/openapi/v1/print/repair/a43b5c6d-7e8f-901a-234b-567c890d1e2f
curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/print/repair/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."
}
GET/openapi/v1/print/repair

Wyświetl listę zadań naprawy drukowalności

Ten punkt końcowy umożliwia pobranie listy zadań naprawy drukowalności.

Parametry

Opcjonalne atrybuty

  • Name
    page_num
    Type
    integer
    Description

    Numer strony do stronicowania. Zaczyna się od 1 i domyślnie ma wartość 1.

  • Name
    page_size
    Type
    integer
    Description

    Limit rozmiaru strony. Domyślnie 10 elementów. Maksymalna dopuszczalna wartość to 100 elementów.

  • Name
    sort_by
    Type
    string
    Description

    Pole, według którego ma być sortowana lista. 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 zadania naprawy drukowalności.

Request

GET
/openapi/v1/print/repair
curl https://api.meshy.ai/openapi/v1/print/repair?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
    "type": "print-repair",
    "status": "SUCCEEDED",
    "progress": 100,
    "preceding_tasks": 0,
    "created_at": 1699999999000,
    "started_at": 1700000000000,
    "finished_at": 1700000030000,
    "expires_at": 1715725401000,
    "task_error": null,
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
      "gltf": "",
      "fbx": "",
      "obj": "",
      "stl": "",
      "usdz": "",
      "3mf": "",
      "mtl": ""
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
    "texture_urls": [],
    "consumed_credits": 10
  }
]
GET/openapi/v1/print/repair/:id/stream

Strumieniowanie zadania naprawy drukowalności

Ten punkt końcowy strumieniuje aktualizacje w czasie rzeczywistym dla zadania naprawy drukowalności przy użyciu Server-Sent Events (SSE).

Parametry

  • Name
    id
    Type
    path
    Description

    Unikalny identyfikator zadania naprawy drukowalności do strumieniowania.

Zwraca

Zwraca strumień Obiektów zadania naprawy drukowalności jako Server-Sent Events.

Każda ramka zawiera pełny obiekt zadania dla danego etapu — dokładnie w takiej samej postaci, jaką zwraca punkt końcowy Get — więc gdy zadanie ma status PENDING lub IN_PROGRESS, pola wyjściowe po prostu nie są jeszcze wypełnione (null, [] lub {}), a finished_at ma wartość null. Blok model_urls jest wysyłany dopiero po osiągnięciu przez zadanie statusu SUCCEEDED.

Request

GET
/openapi/v1/print/repair/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream
curl -N https://api.meshy.ai/openapi/v1/print/repair/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.
// Every frame is the full task object; fields not yet populated are null / empty.
// The PENDING frame below is abbreviated to the fields that change.
event: message
data: {
  "id": "a43b5c6d-7e8f-901a-234b-567c890d1e2f",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "a43b5c6d-7e8f-901a-234b-567c890d1e2f",
  "type": "print-repair",
  "status": "SUCCEEDED",
  "progress": 100,
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000030000,
  "expires_at": 1715725401000,
  "task_error": null,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/a43b5c6d-7e8f-901a-234b-567c890d1e2f/output/model.glb?Expires=***",
    "gltf": "",
    "fbx": "",
    "obj": "",
    "stl": "",
    "usdz": "",
    "3mf": "",
    "mtl": ""
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/a43b5c6d-7e8f-901a-234b-567c890d1e2f/output/preview.png?Expires=***",
  "texture_urls": [],
  "consumed_credits": 10
}

Obiekt zadania Napraw drukowalność

  • Name
    id
    Type
    string
    Description

    Unikalny identyfikator zadania. Choć jako szczegół implementacyjny używamy identyfikatorów zadań w formacie k-sortable UUID, nie powinieneś przyjmować żadnych założeń co do formatu id.

  • Name
    type
    Type
    string
    Description

    Typ zadania napraw drukowalność. Wartość to print-repair.

  • Name
    status
    Type
    string
    Description

    Status zadania. Możliwe wartości to jedna z: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    progress
    Type
    integer
    Description

    Postęp zadania. Jeśli zadanie nie zostało jeszcze rozpoczęte, ta właściwość będzie miała wartość 0. Gdy zadanie zakończy się powodzeniem, przyjmie wartość 100.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Liczba zadań poprzedzających.

    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 nie zostało jeszcze rozpoczęte, 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 nie zostało jeszcze zakończone, ta właściwość będzie miała wartość 0.

  • Name
    expires_at
    Type
    timestamp
    Description

    Znacznik czasu, kiedy wynik zadania wygaśnie w systemie, w milisekundach. 0, jeśli zadanie nie zostało jeszcze zakończone.

  • Name
    task_error
    Type
    object
    Description

    Informacje o błędzie, jeśli zadanie zakończyło się niepowodzeniem. Ta właściwość ma wartość null, jeśli zadanie nie zakończyło się niepowodzeniem. Zobacz Błędy, aby uzyskać więcej informacji.

    • Name
      message
      Type
      string
      Description

      Komunikat błędu opisujący, co poszło nie tak.

  • Name
    model_urls
    Type
    object
    Description

    Adresy URL do pobrania naprawionego modelu 3D. Wypełniane jest tylko pole odpowiadające formatowi wejściowemu; pozostałe pola formatów są pustymi ciągami znaków.

    • Name
      glb
      Type
      string
      Description

      Adres URL do pobrania naprawionego pliku GLB. Wypełniany, gdy dane wejściowe były w formacie GLB lub gdy użyto input_task_id.

    • Name
      gltf
      Type
      string
      Description

      Adres URL do pobrania naprawionego pliku GLTF. Wypełniany, gdy dane wejściowe pochodziły z przesłanego pliku GLTF.

    • Name
      fbx
      Type
      string
      Description

      Adres URL do pobrania naprawionego pliku FBX. Wypełniany, gdy dane wejściowe pochodziły z przesłanego pliku FBX.

    • Name
      obj
      Type
      string
      Description

      Adres URL do pobrania naprawionego pliku OBJ. Wypełniany, gdy dane wejściowe pochodziły z przesłanego pliku OBJ.

    • Name
      stl
      Type
      string
      Description

      Adres URL do pobrania naprawionego pliku STL. Wypełniany, gdy dane wejściowe pochodziły z przesłanego pliku STL.

    • Name
      usdz
      Type
      string
      Description

      Zarezerwowane dla wyjścia USDZ. W przypadku zadań napraw drukowalność zawsze pusty ciąg znaków.

    • Name
      3mf
      Type
      string
      Description

      Zarezerwowane dla wyjścia 3MF. W przypadku zadań napraw drukowalność zawsze pusty ciąg znaków.

    • Name
      mtl
      Type
      string
      Description

      Zarezerwowane dla wyjścia MTL. W przypadku zadań napraw drukowalność zawsze pusty ciąg znaków.

  • Name
    thumbnail_url
    Type
    string
    Description

    Adres URL obrazu podglądowego wyrenderowanego na podstawie naprawionego modelu.

  • Name
    alpha_thumbnail_url
    Type
    string
    Description

    Adres URL do pobrania wersji thumbnail_url z przezroczystym tłem (RGBA). Obecne tylko wtedy, gdy zadanie zostało utworzone z alpha_thumbnail: true, a przezroczysty podgląd został pomyślnie wyrenderowany; w przeciwnym razie to pole jest pomijane.

  • Name
    texture_urls
    Type
    array
    Description

    Zawsze pusta tablica. Naprawa zachowuje wyłącznie geometrię wejściową i nie ponownie zapieka tekstur.

  • Name
    consumed_credits
    Type
    integer
    Description

    Liczba kredytów zużytych przez to zadanie. 10, gdy zadanie osiągnie status SUCCEEDED. Zwraca 0 dla zadań FAILED (kredyty są zwracane w przypadku niepowodzenia).

The Repair Printability Task Object

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "print-repair",
  "status": "SUCCEEDED",
  "progress": 100,
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000030000,
  "expires_at": 1715725401000,
  "task_error": null,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
    "gltf": "",
    "fbx": "",
    "obj": "",
    "stl": "",
    "usdz": "",
    "3mf": "",
    "mtl": ""
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
  "texture_urls": [],
  "consumed_credits": 10
}