프린팅 가능성 분석 API

3D 모델의 FDM 프린팅 가능성을 분석합니다 — 워터타이트성, 볼륨, 홀, 비매니폴드 에지, 퇴화 면.

POST/openapi/v1/print/analyze

프린팅 가능성 분석 작업 삭제

이 엔드포인트는 프린팅 가능성 분석 작업과 캐시된 결과를 영구적으로 삭제합니다. 이 작업은 되돌릴 수 없습니다.

경로 매개변수

Name
id
Type
path
Description
삭제할 프린팅 가능성 분석 작업의 ID입니다.

작업 상태

아직 PENDING 상태인 작업은 삭제되며, 생성 시 소비된 크레딧은 환불됩니다.

이미 IN_PROGRESS 상태인 작업은 삭제할 수 없습니다. 요청은 409 Conflict로 거부되며 작업은 계속 실행됩니다. 워커가 이미 시작한 작업에 대한 크레딧은 환불되지 않으므로, 실행 도중에 삭제하면 크레딧과 결과를 모두 잃게 됩니다. SUCCEEDED, FAILED 또는 CANCELED 상태에 도달할 때까지 기다린 후 삭제하세요.

최종 상태(SUCCEEDED, FAILED 또는 CANCELED)의 작업은 환불 없이 삭제됩니다.

반환값

성공 시 200 OK를 반환하며, 작업이 IN_PROGRESS 상태일 때는 409 Conflict를 반환합니다.

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

// 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/analyze

List Analyze Printability Tasks

이 엔드포인트를 사용하면 프린팅 가능성 분석 작업 목록을 조회할 수 있습니다.

매개변수

선택 속성

Name
page_num
Type
integer
Description
페이지네이션을 위한 페이지 번호입니다. 1부터 시작하며 기본값은 1입니다.
Name
page_size
Type
integer
Description
페이지 크기 제한입니다. 기본값은 10개 항목이며, 최대 허용값은 100개 항목입니다.
Name
sort_by
Type
string
Description
정렬 기준 필드입니다. 사용 가능한 값:
- +created_at: 생성 시간 오름차순으로 정렬합니다.
- -created_at: 생성 시간 내림차순으로 정렬합니다.

반환값

Analyze Printability Task 객체의 페이지네이션 목록을 반환합니다.

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

프린팅 가능성 분석 작업 스트리밍

이 엔드포인트는 Server-Sent Events(SSE)를 사용하여 프린팅 가능성 분석 작업에 대한 실시간 업데이트를 스트리밍합니다.

매개변수

Name
id
Type
path
Description
스트리밍할 프린팅 가능성 분석 작업의 고유 식별자입니다.

반환값

프린팅 가능성 분석 작업 객체의 스트림을 Server-Sent Events 형태로 반환합니다.

모든 프레임은 해당 단계의 전체 작업 객체를 담고 있습니다 — Get 엔드포인트가 반환하는 것과 동일한 형태입니다 — 따라서 작업이 PENDING 또는 IN_PROGRESS 상태인 동안에는 출력 필드가 아직 채워지지 않은 상태(null, [] 또는 {})이며, finished_at은 null입니다. printability 블록은 작업이 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.
// 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-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
}

Analyze Printability 작업 객체

Name
id
Type
string
Description
작업의 고유 식별자입니다. 구현 세부 사항으로 작업 id에 k-정렬 가능한 UUID를 사용하지만, id의 형식에 대해 어떠한 가정도 하지 않아야 합니다.
Name
type
Type
string
Description
프린팅 가능성 분석 작업의 유형입니다. 값은 print-analyze입니다.
Name
status
Type
string
Description
작업의 상태입니다. 가능한 값은 PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED 중 하나입니다.
Name
progress
Type
integer
Description
작업의 progress입니다. 작업이 아직 시작되지 않은 경우 이 속성은 0입니다. 작업이 성공하면 100이 됩니다.
Name
preceding_tasks
Type
integer
Description
선행 작업의 개수입니다.
이 필드의 값은 작업 상태가 PENDING일 때만 의미가 있습니다.
Name
created_at
Type
timestamp
Description
작업이 생성된 시점의 타임스탬프로, 밀리초 단위입니다.
Name
started_at
Type
timestamp
Description
작업이 시작된 시점의 타임스탬프로, 밀리초 단위입니다. 작업이 아직 시작되지 않은 경우 이 속성은 0입니다.
Name
finished_at
Type
timestamp
Description
작업이 완료된 시점의 타임스탬프로, 밀리초 단위입니다. 작업이 아직 완료되지 않은 경우 이 속성은 0입니다.
Name
expires_at
Type
timestamp
Description
작업 결과가 시스템에서 만료되는 시점의 타임스탬프로, 밀리초 단위입니다. 작업이 아직 완료되지 않은 경우 0입니다.
Name
task_error
Type
object
Description
작업이 실패한 경우의 오류 정보입니다. 작업이 실패하지 않은 경우 이 속성은 null입니다. 자세한 내용은 오류를 참고하세요.
- Name
  message
  Type
  string
  Description
  무엇이 잘못되었는지 설명하는 오류 메시지입니다.
Name
printability
Type
object
Description
프린팅 가능성 평가 결과입니다. 작업이 SUCCEEDED에 도달하기 전까지는 null입니다.
- Name
  _version
  Type
  string
  Description
  프린팅 가능성 결과의 스키마 버전입니다. 현재는 v1입니다.
- Name
  status
  Type
  string
  Description
  전체 상태입니다. 다음 중 하나입니다:
  
  healthy: 오류와 경고가 없음.
  
  warning: 오류는 없지만 경고가 하나 이상 있음.
  
  error: 오류가 하나 이상 있음.
  
  unknown: 모델을 분석할 수 없음.
- Name
  issue_count
  Type
  integer
  Description
  error_count + warning_count와 같은 전체 이슈 개수입니다.
- Name
  error_count
  Type
  integer
  Description
  오류 수준 이슈의 개수입니다. 모델이 수밀(watertight)하지 않거나, 부피가 0 이하이거나, 비매니폴드 에지가 있는 경우 오류가 발생합니다.
- Name
  warning_count
  Type
  integer
  Description
  경고 수준 이슈의 개수입니다. 모델에 퇴화 면 또는 구멍이 있는 경우 경고가 발생합니다.
- Name
  metrics
  Type
  object
  Description
  평가기가 반환한 원시 지오메트리 지표입니다.
  Name
  is_watertight
  Type
  boolean
  Description
  메시에 경계 에지가 없는(즉, 닫혀 있는) 경우 true입니다.
  Name
  volume
  Type
  number
  Description
  모델의 부피로, 세제곱미터 단위입니다.
  Name
  non_manifold_edges
  Type
  integer
  Description
  비매니폴드 에지의 개수입니다.
  Name
  degenerate_faces
  Type
  integer
  Description
  퇴화 면(면적이 0이거나 유효하지 않은 면)의 개수입니다.
  Name
  holes
  Type
  integer
  Description
  메시에 있는 구멍(경계 루프)의 개수입니다.
- Name
  evaluated_at
  Type
  timestamp
  Description
  분석이 계산된 시점의 타임스탬프로, 에포크 이후 밀리초 단위입니다.
Name
consumed_credits
Type
integer
Description
항상 0입니다. 이 엔드포인트는 무료입니다.

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
}

프린팅 가능성 분석 API

프린팅 가능성 분석 태스크 생성

파라미터

반환값

실패 모드

Request

Response

Analyze Printability 작업 조회

매개변수

반환값

Request

Response

프린팅 가능성 분석 작업 삭제

경로 매개변수

작업 상태

반환값

Request

Response

List Analyze Printability Tasks

매개변수

선택 속성

반환값

Request

Response

프린팅 가능성 분석 작업 스트리밍

매개변수

반환값

Request

Response Stream

Analyze Printability 작업 객체

The Analyze Printability Task Object