변환 API
Meshy 작업 또는 모델 파일에서 3D 모델을 다른 파일 형식으로 변환합니다.
변환 작업 생성
변환 작업을 생성합니다. 작업은 백그라운드에서 실행됩니다. 작업이 일반적으로 얼마나 걸리는지는 처리 시간을 참고하세요.
Request
curl https://api.meshy.ai/openapi/v1/convert \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"target_formats": ["fbx", "stl"]
}'
Response
{
"result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}
파라미터
- Name
- input_task_id
- Type
- string
- 필수
- Description
model_url을 보내지 않는 경우 필수입니다. 3D 모델을 생성한 작업의 ID로, 예를 들어 텍스트로 3D, 이미지로 3D, 리메시, 크기 조정, 또는 리텍스처 작업이 해당됩니다. 해당 작업은 API를 통해 생성된 것이어야 하며 상태가SUCCEEDED여야 합니다.
- Name
- model_url
- Type
- string
- 필수
- Description
input_task_id를 보내지 않는 경우 필수입니다. 변환할 모델을 공개 URL 또는 data URI 형태로 지정합니다. 둘 다 보낸 경우 Meshy는input_task_id를 사용합니다.모델은
http또는httpsURL인 경우 최대 400MB, data URI인 경우 최대 100MB의 GLB, glTF, OBJ, FBX, 또는 STL 파일이어야 합니다. data URI의 경우 MIME type은application/octet-stream을 사용하세요.100MB를 초과하는 파일은 다음 규칙도 따라야 합니다:
- GLB, glTF, FBX, OBJ 파일은 최대 10,000,000개의 면(face)을 가질 수 있습니다. Meshy는 면을 삼각형 단위로 계산하므로, 사각형은 2개로 계산되며, 여러 번 그려진 메시는 복사본마다 한 번씩 계산됩니다.
- FBX 파일은 바이너리 FBX 7.1 이상이어야 합니다.
- GLB 또는 glTF 파일은 Draco 압축을 사용해서는 안 됩니다.
- Name
- target_formats
- Type
- string[]
- 필수
- Description
생성할 파일 형식입니다. 최소 하나 이상 나열하세요. 목록이 없거나 비어 있으면
400이 반환됩니다.사용 가능한 값:
glbfbxobjusdzblendstl3mf
반환 값
응답의 result 필드에는 새로 생성된 변환 작업의 ID가 담겨 있습니다.
실패 모드
- Name
400 - Bad Request- Description
요청을 실행할 수 없습니다. 오류 메시지에 발견된 문제가 표시됩니다. 예를 들면:
- 파라미터 누락:
model_url과input_task_id중 어느 것도 전송되지 않았습니다. target_formats누락:target_formats가 없거나 형식을 하나도 나열하지 않았습니다.- 유효하지 않은 입력 작업:
input_task_id가 모델 파일을 가진 성공한 API 작업이 아닙니다. - 유효하지 않은 모델 형식:
model_url파일의 확장자가 지원되지 않습니다. - 접근할 수 없는 URL: Meshy가
model_url파일을 다운로드할 수 없습니다. - 모델 파일이 너무 큼:
model_url파일이http또는httpsURL인 경우 400MB를 초과하거나, data URI인 경우 100MB를 초과합니다. - 면이 너무 많음:
model_url파일이 100MB를 초과하며 면(face)이 10,000,000개를 넘습니다. 면 수를 줄인 후 파일을 다시 전송하세요. - ASCII FBX가 100MB 초과:
model_url파일이 100MB를 초과하는 ASCII FBX입니다. 바이너리 FBX 또는 GLB로 전송하세요. - 읽을 수 없는 모델 파일:
model_url파일이 100MB를 초과하며 Meshy가 헤더를 읽을 수 없습니다. 예를 들어 Draco로 압축된 GLB나 glTF, 또는 7.1보다 오래된 바이너리 FBX인 경우입니다. - 모델 헤더가 너무 복잡함:
model_url파일이 100MB를 초과하며, 헤더에 확인해야 할 메시, 노드, 또는 레코드가 너무 많습니다. 파일 내 객체 수를 줄인 후 다시 전송하세요.
요청을 수정한 후 다시 전송하세요. 오류를 참고하세요.
- 파라미터 누락:
- Name
401 - Unauthorized- Description
API 키가 없거나 유효하지 않습니다.
Authorization헤더를 확인하세요.
- Name
402 - Payment Required- Description
예를 들면:
- 크레딧 부족: 계정에 이 작업을 수행할 충분한 크레딧이 없거나, 계정이 크레딧 한도에 도달했습니다. 크레딧 잔액을 확인한 후 다시 시도하세요.
- 무료 플랜: 작업을 생성하려면 유료 플랜이 필요합니다. 구독 설정에서 플랜을 업그레이드한 후 다시 시도하세요.
- Name
403 - Forbidden- Description
input_task_id가 부조(bas-relief) 모델이며, 이 엔드포인트는 이를 변환할 수 없습니다. 메시지는This model type does not support this operation입니다. 다른 모델을 보내세요.
- Name
404 - Not Found- Description
input_task_id가 사용자의 어떤 작업과도 일치하지 않습니다. 작업 ID를 확인한 후 요청을 다시 보내세요.
- Name
429 - Too Many Requests- Description
속도 제한을 초과했습니다. 잠시 기다린 후 다시 시도하세요. 속도 제한을 참고하세요.
Convert 작업 가져오기
ID로 Convert 작업을 조회합니다.
Request
curl https://api.meshy.ai/openapi/v1/convert/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
{
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "convert",
"model_urls": {
"fbx": "https://assets.meshy.ai/.../model.fbx?Expires=...",
"stl": "https://assets.meshy.ai/.../model.stl?Expires=..."
},
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000001000,
"task_error": null,
"consumed_credits": 1
}
Convert 작업 삭제
Convert 작업을 모델 및 데이터를 포함하여 영구적으로 삭제합니다. 삭제는 취소할 수 없습니다.
Request
curl --request DELETE \
--url https://api.meshy.ai/openapi/v1/convert/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 keeps 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."
}
경로 매개변수
- Name
- id
- Type
- path
- Description
삭제할 작업의 ID입니다.
작업 상태
PENDING 상태의 작업을 삭제하면 작업을 생성할 때 사용된 크레딧이 환불됩니다.
IN_PROGRESS 상태의 작업은 삭제할 수 없습니다. 요청은 409 Conflict를 반환하며,
작업은 계속 실행됩니다. Meshy는 이미 시작된 작업에 대해서는 환불하지 않으므로,
이를 삭제하면 크레딧과 결과물을 모두 잃게 됩니다. 작업이 SUCCEEDED, FAILED,
또는 CANCELED 상태에 도달할 때까지 기다린 후 삭제하세요.
최종 상태(SUCCEEDED, FAILED, 또는 CANCELED)인 작업을 삭제해도
크레딧은 환불되지 않습니다.
반환값
작업이 삭제되면 200 OK를, 작업이 IN_PROGRESS 상태이면 409 Conflict를
반환합니다.
Convert 작업 목록 조회
사용자의 Convert 작업 목록을 반환합니다.
Request
curl https://api.meshy.ai/openapi/v1/convert?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
[
{
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "convert",
"model_urls": {
"fbx": "https://assets.meshy.ai/.../model.fbx?Expires=...",
"stl": "https://assets.meshy.ai/.../model.stl?Expires=..."
},
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000001000,
"task_error": null,
"consumed_credits": 1
}
]
매개변수
- Name
- page_num
- Type
- integer
- 기본값 1
- Description
반환할 페이지 번호로, 최대
255까지 가능합니다. 더 큰 값을 사용하면400을 반환합니다.
- Name
- page_size
- Type
- integer
- 기본값 10
- Description
페이지당 작업 수로, 최대
100까지 가능합니다.
- Name
- sort_by
- Type
- string
- Description
정렬 순서입니다.
사용 가능한 값:
+created_at: 오래된 순서대로-created_at: 최신 순서대로
반환값
Convert 작업 객체의 페이지네이션된 목록입니다.
Convert 작업 스트리밍
Convert 작업의 업데이트를 서버 전송 이벤트(SSE)로 스트리밍합니다.
Request
curl -N https://api.meshy.ai/openapi/v1/convert/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response Stream
// Message event examples illustrate task progress.
event: message
data: {
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"progress": 0,
"status": "PENDING"
}
event: message
data: {
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "convert",
"model_urls": {
"fbx": "https://assets.meshy.ai/.../model.fbx?Expires=...",
"stl": "https://assets.meshy.ai/.../model.stl?Expires=..."
},
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000001000,
"task_error": null,
"consumed_credits": 1
}
Parameters
- Name
- id
- Type
- path
- Description
생성 응답에서 받은 작업 ID입니다.
Returns
Convert 작업 객체의 스트림을 서버 전송 이벤트로 반환합니다.
각 이벤트는 Get 엔드포인트가 반환하는 것과 동일한 형태로 전체 작업 객체를 담고 있습니다. 작업이 PENDING 또는 IN_PROGRESS 상태인 동안에는 결과 필드에 아직 값이 없습니다.
변환 작업 객체
변환 작업 객체는 3D 모델의 형식 변환 작업 하나를 나타냅니다. 작업이 성공하면 상태, progress, 그리고 모델 파일을 담고 있습니다.
속성
- Name
- id
- Type
- string
- Description
작업 ID입니다. 형식에 의존하지 말고 불투명한 문자열로 취급하세요.
- Name
- type
- Type
- string
- Description
작업 유형으로, 항상
convert입니다.
- Name
- model_urls
- Type
- object
- Description
변환된 모델의 다운로드 URL이며, 파일 형식마다 하나씩 있습니다.
target_formats에 포함된 형식만 URL을 가집니다. 요청하지 않은 형식은 빈 문자열이 아니라 키 자체가 없습니다.
- Name
- progress
- Type
- integer
- Description
작업이 얼마나 진행되었는지를 백분율로 나타냅니다. 작업이 시작되기 전에는
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
- expires_at
- Type
- timestamp
- Description
작업의 다운로드 URL이 만료되는 시각이며, 유닉스 밀리초 단위입니다. 작업이 종료되기 전에는
0입니다.
- Name
- texture_urls
- Type
- array
- Description
작업이 성공했을 때, 모델의 텍스처 맵에 대한 다운로드 URL입니다. 텍스처 세트마다 하나씩, 객체들의 배열로 제공됩니다. 각 객체는
base_colorURL을 가지며, 추가로metallic,roughness,normal,emission,metallic_roughnessURL을 가질 수 있습니다. 작업이 성공하기 전에는null이며, 모델에 텍스처 맵이 없는 경우에는 빈 배열입니다.
- Name
- task_error
- Type
- object
- Description
작업이 실패했을 때의 오류 세부 정보입니다. 오류를 참고하세요.
- Name
- consumed_credits
- Type
- integer
- Description
작업에 사용된 크레딧 수이며, 변환 작업의 경우
1입니다.FAILED작업의 경우0입니다.