API Analyzovat tisknutelnost

Analyzujte 3D model z hlediska tisknutelnosti pro FDM — vodotěsnosti, objemu, otvorů, non-manifold hran a degenerovaných ploch.

POST/openapi/v1/print/analyze

Vytvoření úlohy Analyzovat tisknutelnost

Tento koncový bod vytváří novou úlohu Analyzovat tisknutelnost. Úloha vyhodnotí 3D model a nahlásí jeho metriky tisknutelnosti.

Pokud už má vstupní úloha tisknutelnost uloženou v mezipaměti, vrácená úloha je okamžitě připravena a první GET na ni vrátí výsledek analýzy bez průchodu přes worker.

Parametry

Vyžadován je pouze jeden z parametrů input_task_id nebo model_url. Pokud jsou uvedeny oba, input_task_id má prioritu.

Name
input_task_id
Type
string
Povinné
Description
ID úspěšně dokončené úlohy, kterou vlastníte. Podporované typy úloh: Obrázek na 3D, Více obrázků na 3D, Text na 3D, Remesh a Retexturování. Úloha musí používat Meshy 6 (nebo jakýkoli model Preview) a musí mít stav SUCCEEDED.

Name
model_url
Type
string
Povinné
Description
URL 3D modelu k analýze. Podporované formáty: .glb, .gltf, .obj, .fbx, .stl. Maximální velikost souboru: 100 MB. Musí používat URL http, https nebo data: (datové URL obcházejí kontroly přípony).

Vrací

Vlastnost result v odpovědi obsahuje id nově vytvořené úlohy Analyzovat tisknutelnost.

Režimy selhání

Name
400 - Bad Request
Description
Požadavek nebyl přijatelný. Běžné příčiny:
- Chybějící parametr: nebyl uveden ani input_task_id, ani model_url.
- Neplatné UUID: input_task_id není platné UUID.
- Neplatná URL modelu: model_url má chybný formát, používá nepodporované schéma nebo má nepodporovanou příponu souboru.
- Soubor modelu je příliš velký: tělo model_url překročilo 100 MB.
- Úloha nebyla úspěšně dokončena: odkazovaná úloha stále čeká, probíhá nebo selhala.
Name
401 - Unauthorized
Description
Autentizace selhala. Zkontrolujte prosím svůj API klíč.
Name
403 - Forbidden
Description
Úloha existuje, ale vlastní ji jiný uživatel.
Name
404 - Not Found
Description
Běžné příčiny:
- Úloha neexistuje nebo byla odstraněna.
- Úloha používá model starší než Meshy 6 nebo její mode nevytváří 3D asset.
- Podkladový soubor modelu už není v úložišti dostupný.
Name
429 - Too Many Requests
Description
Překročili jste kvótu čekajících úloh nebo limit rychlosti.

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

Načíst úlohu Analyzovat tisknutelnost

Tento koncový bod načte úlohu Analyzovat tisknutelnost podle jejího ID.

Parametry

Name
id
Type
path
Description
ID úlohy Analyzovat tisknutelnost, kterou chcete načíst.

Vrací

Objekt úlohy Analyzovat tisknutelnost. Pole printability je null, dokud úloha nedosáhne stavu 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

Odstranit úlohu Analyzovat tisknutelnost

Tento koncový bod trvale odstraní úlohu analýzy tisknutelnosti a její výsledek uložený v mezipaměti. Tato akce je nevratná.

Parametry cesty

Name
id
Type
path
Description
ID úlohy analýzy tisknutelnosti, kterou chcete odstranit.

Návratová hodnota

Při úspěchu vrací 200 OK.

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

Vypsat úlohy Analyzovat tisknutelnost

Tento koncový bod umožňuje načíst seznam úloh Analyzovat tisknutelnost.

Parametry

Volitelné atributy

Name
page_num
Type
integer
Description
Číslo stránky pro stránkování. Začíná a výchozí hodnotu má 1.
Name
page_size
Type
integer
Description
Limit velikosti stránky. Výchozí hodnota je 10 položek. Maximální povolená hodnota je 50 položek.
Name
sort_by
Type
string
Description
Pole, podle kterého se má řadit. Dostupné hodnoty:
- +created_at: Řadit podle času vytvoření vzestupně.
- -created_at: Řadit podle času vytvoření sestupně.

Vrací

Vrací stránkovaný seznam objektů úlohy Analyzovat tisknutelnost.

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

Streamovat úlohu Analyzovat tisknutelnost

Tento koncový bod streamuje aktualizace v reálném čase pro úlohu Analyzovat tisknutelnost pomocí Server-Sent Events (SSE).

Parametry

Name
id
Type
path
Description
Jedinečný identifikátor úlohy Analyzovat tisknutelnost, která se má streamovat.

Vrací

Vrací stream objektů úlohy Analyzovat tisknutelnost jako Server-Sent Events.

U úloh PENDING nebo IN_PROGRESS bude stream odpovědi obsahovat pouze nezbytná pole progress a status. Blok printability se odešle až poté, co úloha dosáhne stavu 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
}

Objekt úlohy Analyzovat tisknutelnost

Name
id
Type
string
Description
Jedinečný identifikátor úlohy. Přestože jako implementační detail používáme pro ID úloh k-sortovatelný UUID, neměli byste o formátu ID dělat žádné předpoklady.
Name
type
Type
string
Description
Typ úlohy analyze-printability. Hodnota je print-analyze.
Name
status
Type
string
Description
Stav úlohy. Možné hodnoty jsou jedna z PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress úlohy. Pokud úloha ještě nebyla spuštěna, tato vlastnost bude 0. Jakmile úloha úspěšně skončí, bude mít hodnotu 100.
Name
preceding_tasks
Type
integer
Description
Počet předcházejících úloh.
Hodnota tohoto pole má význam pouze tehdy, když je stav úlohy PENDING.
Name
created_at
Type
timestamp
Description
Časové razítko okamžiku, kdy byla úloha vytvořena, v milisekundách.
Name
started_at
Type
timestamp
Description
Časové razítko okamžiku, kdy byla úloha spuštěna, v milisekundách. Pokud úloha ještě nebyla spuštěna, tato vlastnost bude 0.
Name
finished_at
Type
timestamp
Description
Časové razítko okamžiku, kdy byla úloha dokončena, v milisekundách. Pokud úloha ještě nebyla dokončena, tato vlastnost bude 0.
Name
expires_at
Type
timestamp
Description
Časové razítko okamžiku, kdy výsledek úlohy vyprší v systému, v milisekundách. 0, pokud úloha ještě nebyla dokončena.
Name
task_error
Type
object
Description
Informace o chybě, pokud úloha selhala. Tato vlastnost je null, pokud úloha neselhala. Další podrobnosti najdete v části Chyby.
- Name
  message
  Type
  string
  Description
  Chybová zpráva popisující, co se pokazilo.
Name
printability
Type
object
Description
Výsledek vyhodnocení tisknutelnosti. null, dokud úloha nedosáhne stavu SUCCEEDED.
- Name
  _version
  Type
  string
  Description
  Verze schématu výsledku tisknutelnosti. Aktuálně v1.
- Name
  status
  Type
  string
  Description
  Celkový stav. Jedna z hodnot:
  
  healthy: žádné chyby a žádná varování.
  
  warning: alespoň jedno varování, žádné chyby.
  
  error: alespoň jedna chyba.
  
  unknown: model nebylo možné analyzovat.
- Name
  issue_count
  Type
  integer
  Description
  Celkový počet problémů, rovný error_count + warning_count.
- Name
  error_count
  Type
  integer
  Description
  Počet problémů na úrovni chyby. Chyby jsou hlášeny, když model není vodotěsný, má nekladný objem nebo má non-manifold hrany.
- Name
  warning_count
  Type
  integer
  Description
  Počet problémů na úrovni varování. Varování jsou hlášena, když model obsahuje degenerované plochy nebo otvory.
- Name
  metrics
  Type
  object
  Description
  Nezpracované metriky geometrie vrácené vyhodnocovačem.
  Name
  is_watertight
  Type
  boolean
  Description
  true, když síť nemá žádné okrajové hrany (tj. je uzavřená).
  Name
  volume
  Type
  number
  Description
  Objem modelu v metrech krychlových.
  Name
  non_manifold_edges
  Type
  integer
  Description
  Počet non-manifold hran.
  Name
  degenerate_faces
  Type
  integer
  Description
  Počet degenerovaných ploch (plochy s nulovou plochou nebo neplatné plochy).
  Name
  holes
  Type
  integer
  Description
  Počet otvorů (okrajových smyček) v síti.
- Name
  evaluated_at
  Type
  timestamp
  Description
  Časové razítko okamžiku, kdy byla analýza vypočítána, v milisekundách od epochy.
Name
consumed_credits
Type
integer
Description
Vždy 0. Tento koncový bod je zdarma.

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
}