API Analizuj Drukowalność

Analizuj model 3D pod kątem drukowalności FDM — szczelność, objętość, otwory, krawędzie non-manifold i zdegenerowane ściany.

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ż zbuforowaną drukowalność, zwrócone zadanie jest natychmiast gotowe, a pierwsze GET na nim zwróci wynik analizy bez przechodzenia przez pracownika.

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 sukcesem zadania, które posiadasz. 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 nowszego (w tym Meshy 7) 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ć http, https lub data: URL (URL danych omijają sprawdzanie rozszerzeń).

Zwraca

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

Tryby awarii

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 niepoprawny, używa nieobsługiwanego schematu lub ma nieobsługiwane rozszerzenie pliku.
- Plik modelu za duży: ciało model_url przekroczyło 100 MB.
- Zadanie nie zakończone sukcesem: odwołane zadanie jest nadal oczekujące, w toku lub nie powiodło się.
Name
401 - Unauthorized
Description
Uwierzytelnianie nie powiodło się. Proszę sprawdzić swój klucz API.
Name
403 - Forbidden
Description
Zadanie istnieje, ale jest własnością 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 lub jego tryb nie produkuje zasobu 3D.
- Podstawowy plik modelu nie jest już dostępny w magazynie.
Name
429 - Too Many Requests
Description
Przekroczyłeś swoją kwotę zadań oczekujących 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 analizuj-drukowalność według jego ID.

Parametry

Name
id
Type
path
Description
ID zadania analizuj-drukowalność do pobrania.

Zwraca

Obiekt zadania Analizuj drukowalność. Pole drukowalność jest null dopóki zadanie nie osiągnie 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ść i jego zapisany w pamięci podręcznej wynik. Ta akcja jest nieodwracalna.

Parametry ścieżki

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

Zwraca

Zwraca 200 OK w przypadku powodzenia.

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 pozwala na pobranie listy zadań analizuj-drukowalność.

Parametry

Opcjonalne atrybuty

Name
page_num
Type
integer
Description
Numer strony dla stronicowania. Zaczyna się i domyślnie wynosi 1.
Name
page_size
Type
integer
Description
Limit rozmiaru strony. Domyślnie 10 pozycji. Maksymalnie dozwolone to 50 pozycji.
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ń Analizuj Drukowalność.

Żądanie

GET

/openapi/v1/print/analyze

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

Odpowiedź

[
  {
    "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

Streamuj zadanie Analizuj drukowalność

Ten punkt końcowy przesyła strumieniowo aktualizacje w czasie rzeczywistym dla zadania analizuj drukowalność przy użyciu Server-Sent Events (SSE).

Parametry

Name
id
Type
path
Description
Unikalny identyfikator dla zadania analizuj drukowalność do przesyłania strumieniowego.

Zwraca

Zwraca strumień Obiektów zadania Analizuj drukowalność jako Server-Sent Events.

Dla zadań PENDING lub IN_PROGRESS, strumień odpowiedzi będzie zawierał tylko niezbędne pola progress i status. Blok drukowalność jest wysyłany tylko wtedy, gdy zadanie osiągnie 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 UUID sortowalnego k- jako szczegółu implementacji dla identyfikatorów zadań, nie powinieneś zakładać żadnego formatu identyfikatora.
Name
type
Type
string
Description
Typ zadania analizującego drukowalność. Wartość to print-analyze.
Name
status
Type
string
Description
Status zadania. Możliwe wartości to PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
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ę sukcesem, wartość ta wyniesie 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 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
expires_at
Type
timestamp
Description
Znacznik czasu, kiedy wynik zadania wygaśnie w systemie, w milisekundach. 0, jeśli zadanie jeszcze się nie zakończyło.
Name
task_error
Type
object
Description
Informacje o błędzie, jeśli zadanie nie powiodło się. Ta właściwość ma wartość null, jeśli zadanie nie zakończyło się niepowodzeniem. Zobacz Błędy po więcej szczegółów.
- Name
  message
  Type
  string
  Description
  Komunikat o błędzie opisujący, co poszło nie tak.
Name
printability
Type
object
Description
Wynik oceny drukowalności. null dopóki zadanie nie osiągnie SUCCEEDED.
- Name
  _version
  Type
  string
  Description
  Wersja schematu wyniku drukowalności. Obecnie v1.
- Name
  status
  Type
  string
  Description
  Ogólny status. Jeden z:
  
  healthy: brak błędów i 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
  Całkowita 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 szczelny, ma niepozytywną 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 dziury.
- 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 (ściany o zerowej powierzchni lub nieprawidłowe).
  Name
  holes
  Type
  integer
  Description
  Liczba dziur (pętli brzegowych) w siatce.
- Name
  evaluated_at
  Type
  timestamp
  Description
  Znacznik czasu, kiedy analiza została wykonana, w milisekundach od epoki.
Name
consumed_credits
Type
integer
Description
Zawsze 0. Ten punkt końcowy jest darmowy.

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
}