API pro Analyzovat tisknutelnost

Analyzujte 3D model pro FDM tisknutelnost — vodotěsnost, objem, díry, non-manifold hrany a degenerované plochy.

POST/openapi/v1/print/analyze

Vytvoření úlohy Analyzovat tisknutelnost

Tento koncový bod vytváří novou úlohu pro analyzování tisknutelnosti. Úloha vyhodnocuje 3D model a hlásí jeho metriky tisknutelnosti.

Pokud vstupní úloha již má uloženou tisknutelnost, vrácená úloha je okamžitě připravena a první GET na ni vrátí výsledek analýzy bez nutnosti zpracování pracovníkem.

Parametry

Pouze jeden z input_task_id nebo model_url je požadován. Pokud jsou oba poskytnuty, input_task_id má prioritu.

Name
input_task_id
Type
string
Povinné
Description
ID úspěšné ú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 novější (včetně Meshy 7) a musí mít status 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 http, https nebo data: URL (data URL obchází kontrolu přípon).

Návratové hodnoty

Vlastnost result odpovědi obsahuje id nově vytvořené úlohy pro analyzování tisknutelnosti.

Režimy selhání

Name
400 - Bad Request
Description
Požadavek byl nepřijatelný. Běžné příčiny:
- Chybějící parametr: nebyl poskytnut ani input_task_id, ani model_url.
- Neplatný UUID: input_task_id není platný UUID.
- Neplatná URL modelu: model_url je špatně formátována, 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á: odkazovaná úloha je stále čekající, v procesu nebo selhala.
Name
401 - Unauthorized
Description
Autentizace selhala. Zkontrolujte prosím svůj API klíč.
Name
403 - Forbidden
Description
Úloha existuje, ale je vlastněna jiným uživatelem.
Name
404 - Not Found
Description
Běžné příčiny:
- Úloha neexistuje nebo byla smazána.
- Úloha používá model starší než Meshy 6, nebo její mode nevytváří 3D asset.
- Podkladový soubor modelu již není dostupný ve skladu.
Name
429 - Too Many Requests
Description
Překročili jste svou kvótu čekajících úloh nebo limit rychlosti.

Požadavek

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"
  }'

Odpověď

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

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

Načíst úkol Analyzovat tisknutelnost

Tento koncový bod načte úkol analyzovat tisknutelnost podle jeho ID.

Parametry

Name
id
Type
path
Description
ID úkolu analyzovat tisknutelnost, který chcete načíst.

Vrátí

Objekt úkolu Analyzovat tisknutelnost. Pole tisknutelnost je null, dokud úkol nedosáhne stavu SUCCEEDED.

Požadavek

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}"

Odpověď

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

Smazat úlohu Analyzovat tisknutelnost

Tento endpoint trvale smaže úlohu analyzovat tisknutelnost a její uložený výsledek. Tato akce je nevratná.

Parametry cesty

Name
id
Type
path
Description
ID úlohy analyzovat tisknutelnost ke smazání.

Vrátí

Vrátí 200 OK při úspěchu.

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

Seznam úloh Analyzovat tisknutelnost

Tento koncový bod vám umožňuje získat 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í hodnota je 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 pro řazení. Dostupné hodnoty:
- +created_at: Řadit podle času vytvoření vzestupně.
- -created_at: Řadit podle času vytvoření sestupně.

Vrací

Vrací stránkovaný seznam Objektů úloh 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

Streamování úkolu Analyzovat tisknutelnost

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

Parametry

Name
id
Type
path
Description
Unikátní identifikátor pro úkol analyzovat tisknutelnost ke streamování.

Návratové hodnoty

Vrací stream Objektů úkolu Analyzovat tisknutelnost jako Server-Sent Events.

Pro úkoly ve stavu PENDING nebo IN_PROGRESS bude stream odpovědi obsahovat pouze nezbytná pole progress a status. Blok printability je odeslán pouze tehdy, když úkol 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
Unikátní identifikátor pro úlohu. I když používáme k-tříditelné UUID pro id úloh jako implementační detail, neměli byste dělat žádné předpoklady o formátu id.
Name
type
Type
string
Description
Typ úlohy analyzovat tisknutelnost. 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
Postup úlohy. Pokud úloha ještě nezačala, tato vlastnost bude 0. Jakmile úloha uspěje, stane se 100.
Name
preceding_tasks
Type
integer
Description
Počet předcházejících úloh.
Hodnota tohoto pole má smysl pouze pokud je stav úlohy PENDING.
Name
created_at
Type
timestamp
Description
Časové razítko, kdy byla úloha vytvořena, v milisekundách.
Name
started_at
Type
timestamp
Description
Časové razítko, kdy byla úloha zahájena, v milisekundách. Pokud úloha ještě nezačala, tato vlastnost bude 0.
Name
finished_at
Type
timestamp
Description
Časové razítko, kdy byla úloha dokončena, v milisekundách. Pokud úloha ještě není dokončena, tato vlastnost bude 0.
Name
expires_at
Type
timestamp
Description
Časové razítko, kdy výsledek úlohy vyprší ze systému, v milisekundách. 0, pokud úloha ještě není dokončena.
Name
task_error
Type
object
Description
Informace o chybě, pokud úloha selhala. Tato vlastnost je null, pokud úloha neselhala. Podrobnosti naleznete v Chyby.
- Name
  message
  Type
  string
  Description
  Chybová zpráva popisující, co se pokazilo.
Name
printability
Type
object
Description
Výsledek hodnocení tisknutelnosti. null, dokud úloha nedosáhne SUCCEEDED.
- Name
  _version
  Type
  string
  Description
  Verze schématu výsledku tisknutelnosti. Aktuálně v1.
- Name
  status
  Type
  string
  Description
  Celkový stav. Jeden z:
  
  healthy: žádné chyby a žádná varování.
  
  warning: alespoň jedno varování, žádné chyby.
  
  error: alespoň jedna chyba.
  
  unknown: model nemohl být analyzován.
- 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 vyvolány, 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 vyvolána, když model obsahuje degenerované plochy nebo díry.
- Name
  metrics
  Type
  object
  Description
  Surové metriky geometrie vrácené hodnotitelem.
  Name
  is_watertight
  Type
  boolean
  Description
  true, když síť nemá žádné hraniční hrany (tj. je uzavřená).
  Name
  volume
  Type
  number
  Description
  Objem modelu v kubických metrech.
  Name
  non_manifold_edges
  Type
  integer
  Description
  Počet non-manifold hran.
  Name
  degenerate_faces
  Type
  integer
  Description
  Počet degenerovaných ploch (plošky s nulovou plochou nebo neplatné plošky).
  Name
  holes
  Type
  integer
  Description
  Počet děr (hraniční smyčky) v síti.
- Name
  evaluated_at
  Type
  timestamp
  Description
  Časové razítko, 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
}