API Analizuj drukowalność

Analizuj model 3D pod kątem drukowalności FDM — szczelności, objętości, otworów, krawędzi non-manifold i zdegenerowanych ścian.

POST/openapi/v1/print/analyze

Utwórz zadanie Analizuj drukowalność

Ten punkt końcowy tworzy nowe zadanie Analizuj drukowalność. Zadanie ocenia model 3D i raportuje jego metryki drukowalności.

Jeśli zadanie wejściowe ma już zapisaną w pamięci podręcznej drukowalność, zwrócone zadanie jest natychmiast gotowe, a pierwsze GET na nim zwróci wynik analizy bez przechodzenia przez worker.

Parametry

Wymagane jest tylko jedno z input_task_id lub model_url. Jeśli podano oba, input_task_id ma priorytet.

Name
input_task_id
Type
string
Wymagane
Description
ID zakończonego powodzeniem zadania, którego jesteś właścicielem. Obsługiwane typy zadań: Obraz na 3D, Wiele obrazów na 3D, Tekst na 3D, Remesh i Reteksturowanie. Zadanie musi używać Meshy 6 (lub dowolnego modelu Preview) i musi mieć status SUCCEEDED.

Name
model_url
Type
string
Wymagane
Description
URL modelu 3D do analizy. Obsługiwane formaty: .glb, .gltf, .obj, .fbx, .stl. Maksymalny rozmiar pliku: 100 MB. Musi używać adresu URL http, https lub data: (adresy URL data pomijają sprawdzanie rozszerzeń).

Zwraca

Właściwość result odpowiedzi zawiera id nowo utworzonego zadania Analizuj drukowalność.

Tryby niepowodzenia

Name
400 - Bad Request
Description
Żądanie było nieakceptowalne. 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 URL modelu: model_url jest źle sformułowany, używa nieobsługiwanego schematu lub ma nieobsługiwane rozszerzenie pliku.
- Plik modelu jest zbyt duży: treść model_url przekroczyła 100 MB.
- Zadanie nie zakończyło się powodzeniem: wskazane zadanie nadal oczekuje, jest w toku lub zakończyło się niepowodzeniem.
Name
401 - Unauthorized
Description
Uwierzytelnianie nie powiodło się. Sprawdź swój klucz API.
Name
403 - Forbidden
Description
Zadanie istnieje, ale należy do innego użytkownika.
Name
404 - Not Found
Description
Typowe przyczyny:
- Zadanie nie istnieje lub zostało usunięte.
- Zadanie używa modelu starszego niż Meshy 6 albo jego mode nie tworzy assetu 3D.
- Bazowy plik modelu nie jest już dostępny w pamięci masowej.
Name
429 - Too Many Requests
Description
Przekroczono limit oczekujących zadań lub limit szybkości.

Request

POST

/openapi/v1/print/analyze

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

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

Response

{
  "result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}

GET/openapi/v1/print/analyze/:id

Pobierz zadanie Analizuj drukowalność

Ten punkt końcowy pobiera zadanie analizy drukowalności według jego ID.

Parametry

Name
id
Type
path
Description
ID zadania analizy drukowalności do pobrania.

Zwraca

Obiekt zadania Analizuj drukowalność. Pole printability ma wartość null, dopóki zadanie nie osiągnie stanu SUCCEEDED.

Request

GET

/openapi/v1/print/analyze/a43b5c6d-7e8f-901a-234b-567c890d1e2f

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

Response

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "print-analyze",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "expires_at": 1715725401000,
  "task_error": null,
  "printability": {
    "_version": "v1",
    "status": "warning",
    "issue_count": 1,
    "error_count": 0,
    "warning_count": 1,
    "metrics": {
      "is_watertight": true,
      "volume": 1.316167354292668,
      "non_manifold_edges": 0,
      "degenerate_faces": 43242,
      "holes": 0
    },
    "evaluated_at": 1700000001000
  },
  "consumed_credits": 0
}

DELETE/openapi/v1/print/analyze/:id

Usuń zadanie Analizuj drukowalność

Ten punkt końcowy trwale usuwa zadanie Analizuj drukowalność oraz jego wynik z pamięci podręcznej. Tej akcji nie można cofnąć.

Parametry ścieżki

Name
id
Type
path
Description
ID zadania Analizuj drukowalność do usunięcia.

Zwraca

Zwraca 200 OK po powodzeniu.

Request

DELETE

/openapi/v1/print/analyze/a43b5c6d-7e8f-901a-234b-567c890d1e2f

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

Response

// Returns 200 Ok on success.

GET/openapi/v1/print/analyze

Lista zadań Analizuj drukowalność

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

Parametry

Atrybuty opcjonalne

Name
page_num
Type
integer
Description
Numer strony dla stronicowania. Zaczyna się od 1 i domyślnie wynosi 1.
Name
page_size
Type
integer
Description
Limit rozmiaru strony. Domyślnie 10 elementów. Maksymalna dozwolona wartość to 50 elementów.
Name
sort_by
Type
string
Description
Pole, według którego sortować. Dostępne wartości:
- +created_at: Sortuj według czasu utworzenia w kolejności rosnącej.
- -created_at: Sortuj według czasu utworzenia w kolejności malejącej.

Zwraca

Zwraca stronicowaną listę obiektów zadań Analizuj drukowalność.

Request

GET

/openapi/v1/print/analyze

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

Response

[
  {
    "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
    "type": "print-analyze",
    "status": "SUCCEEDED",
    "progress": 100,
    "preceding_tasks": 0,
    "created_at": 1699999999000,
    "started_at": 1700000000000,
    "finished_at": 1700000001000,
    "expires_at": 1715725401000,
    "task_error": null,
    "printability": {
      "_version": "v1",
      "status": "warning",
      "issue_count": 1,
      "error_count": 0,
      "warning_count": 1,
      "metrics": {
        "is_watertight": true,
        "volume": 1.316167354292668,
        "non_manifold_edges": 0,
        "degenerate_faces": 43242,
        "holes": 0
      },
      "evaluated_at": 1700000001000
    },
    "consumed_credits": 0
  }
]

GET/openapi/v1/print/analyze/:id/stream

Strumieniuj zadanie Analizuj drukowalność

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

Parametry

Name
id
Type
path
Description
Unikalny identyfikator zadania Analizuj drukowalność do strumieniowania.

Zwraca

Zwraca strumień obiektów zadań Analizuj drukowalność jako Server-Sent Events.

W przypadku zadań PENDING lub IN_PROGRESS strumień odpowiedzi będzie zawierać tylko niezbędne pola progress i status. Blok printability jest wysyłany dopiero po osiągnięciu przez zadanie stanu SUCCEEDED.

Request

GET

/openapi/v1/print/analyze/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream

curl -N https://api.meshy.ai/openapi/v1/print/analyze/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": "a43b5c6d-7e8f-901a-234b-567c890d1e2f",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "a43b5c6d-7e8f-901a-234b-567c890d1e2f",
  "type": "print-analyze",
  "status": "SUCCEEDED",
  "progress": 100,
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "expires_at": 1715725401000,
  "task_error": null,
  "printability": {
    "_version": "v1",
    "status": "warning",
    "issue_count": 1,
    "error_count": 0,
    "warning_count": 1,
    "metrics": {
      "is_watertight": true,
      "volume": 1.316167354292668,
      "non_manifold_edges": 0,
      "degenerate_faces": 43242,
      "holes": 0
    },
    "evaluated_at": 1700000001000
  },
  "consumed_credits": 0
}

Obiekt zadania Analizuj drukowalność

Name
id
Type
string
Description
Unikalny identyfikator zadania. Chociaż używamy k-sortowalnego UUID dla identyfikatorów zadań jako szczegółu implementacyjnego, nie należy przyjmować żadnych założeń dotyczących formatu identyfikatora.
Name
type
Type
string
Description
Typ zadania analizy drukowalności. Wartość to print-analyze.
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
Progress zadania. Jeśli zadanie nie zostało jeszcze rozpoczęte, ta właściwość będzie mieć wartość 0. Gdy zadanie zakończy się powodzeniem, wartość ta stanie się 100.
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 nie zostało jeszcze rozpoczęte, ta właściwość będzie mieć 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 mieć 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. Więcej szczegółów znajdziesz w Błędy.
- Name
  message
  Type
  string
  Description
  Komunikat błędu opisujący, co poszło nie tak.
Name
printability
Type
object
Description
Wynik oceny drukowalności. null do momentu, aż zadanie osiągnie SUCCEEDED.
- Name
  _version
  Type
  string
  Description
  Wersja schematu wyniku drukowalności. Obecnie v1.
- Name
  status
  Type
  string
  Description
  Ogólny status. Jedna z:
  
  healthy: brak błędów i brak ostrzeżeń.
  
  warning: co najmniej jedno ostrzeżenie, brak błędów.
  
  error: co najmniej jeden błąd.
  
  unknown: model nie mógł zostać przeanalizowany.
- Name
  issue_count
  Type
  integer
  Description
  Łączna liczba problemów, równa error_count + warning_count.
- Name
  error_count
  Type
  integer
  Description
  Liczba problemów na poziomie błędu. Błędy są zgłaszane, gdy model nie jest wodoszczelny, ma nie-dodatnią objętość lub ma krawędzie non-manifold.
- Name
  warning_count
  Type
  integer
  Description
  Liczba problemów na poziomie ostrzeżenia. Ostrzeżenia są zgłaszane, gdy model zawiera zdegenerowane ściany lub otwory.
- Name
  metrics
  Type
  object
  Description
  Surowe metryki geometrii zwrócone przez ewaluator.
  Name
  is_watertight
  Type
  boolean
  Description
  true, gdy siatka nie ma krawędzi brzegowych (tj. jest zamknięta).
  Name
  volume
  Type
  number
  Description
  Objętość modelu w metrach sześciennych.
  Name
  non_manifold_edges
  Type
  integer
  Description
  Liczba krawędzi non-manifold.
  Name
  degenerate_faces
  Type
  integer
  Description
  Liczba zdegenerowanych ścian (ścian o zerowym polu lub nieprawidłowych).
  Name
  holes
  Type
  integer
  Description
  Liczba otworów (pętli brzegowych) w siatce.
- Name
  evaluated_at
  Type
  timestamp
  Description
  Znacznik czasu obliczenia analizy, w milisekundach od epoki.
Name
consumed_credits
Type
integer
Description
Zawsze 0. Ten punkt końcowy jest bezpłatny.

The Analyze Printability Task Object

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "print-analyze",
  "status": "SUCCEEDED",
  "progress": 100,
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "expires_at": 1715725401000,
  "task_error": null,
  "printability": {
    "_version": "v1",
    "status": "warning",
    "issue_count": 1,
    "error_count": 0,
    "warning_count": 1,
    "metrics": {
      "is_watertight": true,
      "volume": 1.316167354292668,
      "non_manifold_edges": 0,
      "degenerate_faces": 43242,
      "holes": 0
    },
    "evaluated_at": 1700000001000
  },
  "consumed_credits": 0
}