Auto Split API
3D 모델을 별도로 출력 가능한 파트로 분할합니다 — 자동으로, 사용자가 지정한 부위별로, 또는 색상 영역별로 분할할 수 있으며 커넥터를 선택적으로 추가할 수 있습니다. 절단으로 인해 얇아진 부위는 항상 보강되어 모든 파트가 견고하게 출력됩니다.
Auto Split은 현재 텍스처가 없는 모델만 지원합니다. 이미지로 3D 및 멀티 이미지로 3D의 경우, should_texture를 false로 설정하여 입력을 생성하세요. 텍스처가 적용된 입력은 400으로 거부됩니다.
Auto Split 작업 생성
이 엔드포인트는 새로운 Auto Split 작업을 생성합니다. 이 작업은 이전 작업의 모델을 별도로 출력 가능한 부품들로 절단하고, 각 부품을 파일 내에서 개별 객체로 담아 분할된 모델을 반환합니다.
매개변수
- Name
- mode
- Type
- string
- 기본값 auto
- Description
모델을 부품으로 분할하는 방식입니다.
사용 가능한 값:
auto: Meshy가 절단 위치를 결정합니다.prompt는 무시됩니다.by_parts:prompt에 지정한 머리, 팔, 몸통 등 구조적 부품을 기준으로 절단합니다.by_color:prompt에 지정한 색상 영역을 기준으로 절단합니다. 업로드된 이미지로 생성된 입력(이미지로 3D 또는 멀티 이미지로 3D)이 필요하며, 그 외 입력은400으로 거부됩니다.
mode = by_parts or by_color- Name
- prompt
- Type
- string
- 필수
- Description
분할할 부품을 어떤 언어로든 설명합니다. Meshy는 여기서 1개에서 10개의 부품 이름을 읽어들이므로, 모델을 설명하기보다는 각 조각의 이름을 지정해야 합니다 — 예:
split into the figure and the base또는head, torso, left arm, right arm, legs. 최대 600자까지 입력할 수 있습니다. 두 가지 실패 사례가 있습니다: 분할처럼 보이지만 지정된 부품이 두 개 미만인 설명(예:split into individual parts)은400으로 거부되며 아무 비용도 청구되지 않습니다. Meshy가 전혀 해석할 수 없는 설명은auto로 대체되어 작업은 그대로 실행되고 비용이 청구되며, 응답에는prompt_ignored: true가 포함됩니다.
- Name
- target_formats
- Type
- array
- 기본값 ["glb"]
- Description
분할된 모델을 내보낼 포맷입니다. 각 형식에서 각 부품은 별도의 객체로 생성됩니다.
glb는 항상 생성되어model_urls에 반환되며, 추가로 원하는 다른 포맷을 목록에 지정하면 됩니다.사용 가능한 값:
glb,obj,fbx,usdz,blend,3mf.
- Name
- layout
- Type
- string
- 기본값 assembled
- Description
각 출력 포맷 및 썸네일에서 부품이 배치되는 방식입니다.
사용 가능한 값:
assembled: 부품이 원본 모델에 있던 위치를 그대로 유지합니다.on_plate: 부품들이 빌드 플레이트 위에 평평하게 펼쳐져 배치되어 바로 슬라이싱할 수 있는 상태가 됩니다 — 웹 앱의 On Plate 보기와 동일한 배치입니다.
두 레이아웃 모두 내보낸 파일에는 부품당 하나의 객체만 포함되며 그 외에는 아무것도 없습니다. 절단으로 인해 남은, 찌그러진 얇은 조각이나 점 형태의 파편은 내보내기 전에 제거되므로, 파일에서 발견되는 모든 객체는 출력 가능합니다.
- Name
- connectors
- Type
- boolean
- 기본값 false
- Description
각 절단면에 사개 맞춤(mortise-and-tenon) 커넥터를 추가하여 출력된 부품들이 서로 맞물리도록 합니다.
connectors = true- Name
- connector_type
- Type
- string
- 기본값 cube
- Description
각 절단면에 적용되는 커넥터의 형태입니다.
사용 가능한 값:
cube,cylinder.
- Name
- connector_size
- Type
- number
- 기본값 0.5
- Description
절단면 대비 커넥터의 크기입니다.
유효 범위:
0.1~0.8.
- Name
- connector_height
- Type
- number
- 기본값 0.1
- Description
절단면을 기준으로 커넥터가 얼마나 돌출되는지를 나타냅니다.
유효 범위:
0.1~0.8.
반환 값
응답의 result 속성에는 새로 생성된 Auto Split 작업의 id가 포함됩니다.
실패 모드
- Name
400 - Bad Request- Description
요청이 허용되지 않았습니다. 일반적인 원인은 다음과 같습니다:
- prompt 누락:
mode가by_parts또는by_color인 경우prompt는 필수입니다. - prompt에 지정된 부품이 두 개 미만인 경우:
by_parts/by_color에는 최소 두 개의 이름 있는 조각이 필요합니다(예:head, torso, base).split into individual parts처럼 일반적인 지시는 거부됩니다. 이 경우 비용은 청구되지 않습니다. - 지원되지 않는 입력 작업:
input_task_id는 지원되는 유형의 성공한 작업을 가리켜야 하며, Meshy 6 또는 Meshy 7로 생성되어야 합니다. - 텍스처가 있는 입력: 입력 모델에 텍스처가 있습니다. 현재는 텍스처가 없는 모델만 지원됩니다.
- 참조 이미지 없음:
by_color에는 업로드된 이미지로 생성된 입력이 필요합니다. - 지원되지 않는 포맷:
target_formats에stl이 포함되어 있습니다. - 범위를 벗어난 커넥터 값:
connector_size또는connector_height가0.1에서0.8범위를 벗어났습니다.
- prompt 누락:
- Name
401 - Unauthorized- Description
인증에 실패했습니다. API 키를 확인해 주세요.
- Name
402 - Payment Required- Description
이 작업을 수행하기에 크레딧이 부족합니다.
- Name
404 - Not Found- Description
input_task_id가 존재하지 않거나 사용자의 계정에 속해 있지 않습니다.
- Name
429 - Too Many Requests- Description
속도 제한을 초과했습니다.
by_parts및by_color요청은 계정당 분당 12건이라는 prompt 해석 제한도 함께 공유합니다.
- Name
503 - Service Unavailable- Description
prompt 기반 분할(
by_parts및by_color)이 일시적으로 사용할 수 없습니다. 나중에 다시 시도하거나, 영향을 받지 않는mode: "auto"를 사용하세요. 이 경우 비용은 청구되지 않습니다.
Request
# Simple request: let Meshy choose the cuts
curl https://api.meshy.cn/openapi/v1/print/split \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578"
}'
# Advanced request: name the parts, add connectors, export glb and obj
curl https://api.meshy.cn/openapi/v1/print/split \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"mode": "by_parts",
"prompt": "split into the figure and the base",
"target_formats": ["glb", "obj"],
"layout": "on_plate",
"connectors": true,
"connector_type": "cylinder",
"connector_size": 0.4
}'
Response
{
"result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}
Auto Split 작업 조회
이 엔드포인트는 ID를 통해 Auto Split 작업을 조회합니다.
매개변수
- Name
- id
- Type
- path
- Description
조회할 Auto Split 작업의 ID입니다.
반환값
Auto Split Task 객체입니다.
Request
curl https://api.meshy.cn/openapi/v1/print/split/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
{
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "print-split",
"model_urls": {
"glb": "https://assets.meshy.cn/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
"obj": "https://assets.meshy.cn/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***"
},
"thumbnail_url": "https://assets.meshy.cn/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
"part_count": 4,
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000082000,
"task_error": null,
"consumed_credits": 10
}
Auto Split 작업 삭제하기
이 엔드포인트는 Auto Split 작업과 관련된 모든 모델 및 데이터를 영구적으로 삭제합니다. 이 작업은 되돌릴 수 없습니다.
경로 매개변수
- Name
- id
- Type
- path
- Description
삭제할 Auto Split 작업의 ID입니다.
반환값
성공 시 200 OK를 반환합니다.
Request
curl --request DELETE \
--url https://api.meshy.cn/openapi/v1/print/split/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
// Returns 200 Ok on success.
Auto Split 작업 목록 조회
이 엔드포인트를 사용하면 Auto Split 작업 목록을 조회할 수 있습니다.
매개변수
선택적 속성
- Name
- page_num
- Type
- integer
- Description
페이지네이션을 위한 페이지 번호입니다.
1부터 시작하며 기본값은1입니다.
- Name
- page_size
- Type
- integer
- Description
페이지 크기 제한입니다. 기본값은
10개입니다. 최대 허용값은100개이며, 그보다 큰 값은100으로 제한됩니다.
- Name
- sort_by
- Type
- string
- Description
정렬 기준 필드입니다. 사용 가능한 값:
+created_at: 생성 시간을 기준으로 오름차순 정렬합니다.-created_at: 생성 시간을 기준으로 내림차순 정렬합니다.
반환 값
Auto Split 작업 객체의 페이지네이션된 목록을 반환합니다.
Request
curl https://api.meshy.cn/openapi/v1/print/split?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
[
{
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "print-split",
"model_urls": {
"glb": "https://assets.meshy.cn/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***"
},
"thumbnail_url": "https://assets.meshy.cn/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
"part_count": 4,
"progress": 100,
"status": "SUCCEEDED",
"preceding_tasks": 0,
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000082000,
"task_error": null,
"consumed_credits": 10
}
]
Auto Split 작업 스트리밍
이 엔드포인트는 Server-Sent Events(SSE)를 사용하여 Auto Split 작업의 실시간 업데이트를 스트리밍합니다.
매개변수
- Name
- id
- Type
- path
- Description
스트리밍할 Auto Split 작업의 고유 식별자입니다.
반환값
Auto Split 작업 객체의 스트림을 Server-Sent Events로 반환합니다.
모든 message 이벤트는 Auto Split 작업 조회에서 반환되는 것과 동일한 전체 작업 객체를 담고 있으며, 여기에는 consumed_credits, 타임스탬프, prompt_ignored가 포함됩니다. 작업이 PENDING 또는 IN_PROGRESS 상태인 동안 프레임마다 변경되는 필드는 progress, status, started_at, preceding_tasks이며, SUCCEEDED 상태에 도달하면 model_urls, thumbnail_url, part_count, parts가 나타납니다. error 이벤트는 status_code와 message만을 담고 있으므로, status를 읽기 전에 이벤트 이름으로 분기 처리해야 합니다.
Request
curl -N https://api.meshy.cn/openapi/v1/print/split/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 (other task fields omitted here for brevity;
// each frame is the full task object).
event: message
data: {
"id": "a43b5c6d-7e8f-901a-234b-567c890d1e2f",
"progress": 0,
"status": "PENDING"
}
event: message
data: {
"id": "a43b5c6d-7e8f-901a-234b-567c890d1e2f",
"type": "print-split",
"model_urls": {
"glb": "https://assets.meshy.cn/***/tasks/a43b5c6d-7e8f-901a-234b-567c890d1e2f/output/model.glb?Expires=***"
},
"thumbnail_url": "https://assets.meshy.cn/***/tasks/a43b5c6d-7e8f-901a-234b-567c890d1e2f/output/preview.png?Expires=***",
"part_count": 4,
"progress": 100,
"status": "SUCCEEDED",
"preceding_tasks": 0,
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000082000,
"task_error": null,
"consumed_credits": 10
}
Auto Split 작업 객체
Auto Split 작업은 아래 속성만 포함합니다. 다른 작업 객체에 포함되는 생성 프롬프트 필드(name, object_prompt, texture_prompt 등), 단일 model_url, 그리고 texture_urls는 분할 작업에서는 절대 채워지지 않으며 반환되지도 않습니다. 작업이 진행되는 동안 채워지는 속성(thumbnail_url, model_urls, 타임스탬프)은 값이 채워질 때까지 비어 있는 상태로 항상 존재하므로, PENDING과 SUCCEEDED 사이에서 키의 집합이 변하지 않습니다.
- Name
- id
- Type
- string
- Description
작업의 고유 식별자입니다. 구현상 세부 사항으로 작업 id에는 k-정렬 가능한(k-sortable) UUID를 사용하지만, id의 형식에 대해 어떠한 가정도 하지 말아야 합니다.
- Name
- type
- Type
- string
- Description
작업의 유형입니다. 값은
print-split입니다.
- Name
- model_urls
- Type
- object
- Description
분할된 모델을 다운로드할 수 있는 URL로, 요청한 형식마다 하나씩 제공됩니다. 각 파트는 파일 내에서 별도의 객체로 존재합니다. 요청하지 않은 형식에 대한 속성은 생략됩니다.
- Name
glb- Type
- string
- Description
GLB 형식의 분할된 모델을 다운로드할 수 있는 URL입니다.
- Name
obj- Type
- string
- Description
OBJ 형식의 분할된 모델을 다운로드할 수 있는 URL입니다.
- Name
fbx- Type
- string
- Description
FBX 형식의 분할된 모델을 다운로드할 수 있는 URL입니다.
- Name
usdz- Type
- string
- Description
USDZ 형식의 분할된 모델을 다운로드할 수 있는 URL입니다.
- Name
blend- Type
- string
- Description
Blender 형식의 분할된 모델을 다운로드할 수 있는 URL입니다.
- Name
3mf- Type
- string
- Description
3MF 형식의 분할된 모델을 다운로드할 수 있는 URL입니다.
- Name
- thumbnail_url
- Type
- string
- Description
요청한
layout에 따라 각 파트가 서로 다른 색상으로 표시된, 분할된 모델의 렌더링 미리보기를 다운로드할 수 있는 URL입니다.
- Name
- prompt_ignored
- Type
- boolean
- Description
by_parts또는by_color요청의prompt에 파트 이름이 지정되지 않아 Meshy가 대신 모델을 자동으로 분할한 경우true가 됩니다 — 이 경우 결과에 표시되는 파트 이름은 사용자가 지정한 것이 아니라 Meshy가 지정한 이름입니다.PENDING상태부터 존재합니다.auto작업의 경우와 프롬프트가 그대로 따라진 경우에는 생략됩니다.
- Name
- part_count
- Type
- integer
- Description
분할된 모델에서 인쇄 가능한 파트의 수로, 내보낸 파일 내의 객체마다 하나씩입니다. 세그멘테이션 과정에서 인쇄 가능한 조각으로 만들 수 없었던 붕괴된 조각들은 내보내기 전에 파일에서 제거되며 개수에 포함되지 않습니다.
- Name
- progress
- Type
- integer
- Description
작업의 progress입니다. 작업이 아직 시작되지 않았다면 이 속성은
0입니다. 작업이 성공하면100이 됩니다.
- Name
- status
- Type
- string
- Description
작업의 상태입니다. 가능한 값은
PENDING,IN_PROGRESS,SUCCEEDED,FAILED,CANCELED중 하나입니다.
- 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
- task_error
- Type
- object
- Description
실패한 작업에 대한 오류 세부 정보입니다.
task_error객체의 전체 참조는 오류를 확인하세요.
- Name
- consumed_credits
- Type
- integer
- Description
이 작업으로 소비된 크레딧 수입니다. 항상 존재하며, 작업이 접수되면
10이고,FAILED작업의 경우 실패 시 요금이 환불되므로0입니다. 작업이 여전히PENDING상태일 때 삭제해도 환불됩니다.
The Auto Split Task Object
{
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "print-split",
"model_urls": {
"glb": "https://assets.meshy.cn/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
"obj": "https://assets.meshy.cn/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***"
},
"thumbnail_url": "https://assets.meshy.cn/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
"part_count": 4,
"progress": 100,
"status": "SUCCEEDED",
"preceding_tasks": 0,
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000082000,
"task_error": null,
"consumed_credits": 10
}