변환 API

변환 API를 사용하면 기존 3D 모델을 다른 파일 형식으로 변환할 수 있습니다.

POST/openapi/v1/convert

변환 작업 생성

이 엔드포인트는 새로운 포맷 변환 작업을 생성합니다.

파라미터

input_task_id 또는 model_url 중 하나만 필수입니다. 둘 다 제공된 경우, input_task_id가 우선순위를 갖습니다.

Name
input_task_id
Type
string
필수
Description
변환하려는 모델을 가진, 완료된 Meshy 작업의 ID입니다. 해당 작업은 SUCCEEDED 상태여야 합니다.

Name
model_url
Type
string
필수
Description
3D 모델 파일을 가리키는 공개적으로 접근 가능한 URL 또는 data URI입니다. 지원되는 포맷: .glb, .gltf, .obj, .fbx, .stl. Data URI의 경우, MIME type으로 application/octet-stream을 사용하세요.

Name
target_formats
Type
string[]
필수
Description
변환된 모델의 출력 포맷 목록입니다. 사용 가능한 값: glb, fbx, obj, usdz, blend, stl, 3mf.

반환값

응답의 result 속성에는 새로 생성된 변환 작업의 id가 포함됩니다.

실패 모드

400 - Bad Request

요청이 허용되지 않았습니다. 일반적인 원인:

파라미터 누락: model_url 또는 input_task_id 중 하나는 반드시 제공되어야 합니다.
target_formats 누락: 최소 하나의 대상 포맷을 지정해야 합니다.
잘못된 입력 작업: input_task_id는 성공한 작업을 참조해야 합니다.
잘못된 모델 포맷: model_url이 지원되지 않는 확장자를 가진 파일을 가리키고 있습니다.
접근할 수 없는 URL: model_url을 다운로드할 수 없습니다.

401 - Unauthorized

인증에 실패했습니다. API 키를 확인해 주세요.

402 - Payment Required

이 작업을 수행하기에 크레딧이 부족합니다.

429 - Too Many Requests

속도 제한을 초과했습니다.

Request

POST

/openapi/v1/convert

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

GET/openapi/v1/convert/:id

변환 작업 조회

이 엔드포인트는 ID로 변환 작업을 조회합니다.

Parameters

Name
id
Type
path
Description
조회할 변환 작업의 ID입니다.

Returns

변환 작업 객체입니다.

Request

GET

/openapi/v1/convert/:id

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": {
      "glb": "",
      "fbx": "https://assets.meshy.ai/.../model.fbx?Expires=...",
      "obj": "",
      "usdz": "",
      "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
}

DELETE/openapi/v1/convert/:id

변환 작업 삭제

이 엔드포인트는 변환 작업을 관련된 모든 모델 및 데이터와 함께 영구적으로 삭제합니다. 이 작업은 되돌릴 수 없습니다.

경로 매개변수

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/convert/:id

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

변환 작업 목록 조회

이 엔드포인트를 사용하면 변환 작업 목록을 조회할 수 있습니다.

매개변수

Name
page_num
Type
integer
기본값 1
Description
페이지네이션을 위한 페이지 번호입니다.

Name
page_size
Type
integer
기본값 10
Description
페이지 크기 제한입니다. 최대 허용값은 100개입니다.

Name
sort_by
Type
string
Description
정렬 기준 필드입니다. 사용 가능한 값:
- +created_at: 생성 시간 오름차순으로 정렬합니다.
- -created_at: 생성 시간 내림차순으로 정렬합니다.

반환 값

변환 작업 객체의 페이지네이션된 목록을 반환합니다.

Request

GET

/openapi/v1/convert

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

GET/openapi/v1/convert/:id/stream

변환 작업 스트리밍

이 엔드포인트는 Server-Sent Events(SSE)를 사용하여 변환 작업의 실시간 업데이트를 스트리밍합니다.

파라미터

Name
id
Type
path
Description
스트리밍할 변환 작업의 고유 식별자입니다.

반환값

변환 작업 객체의 스트림을 Server-Sent Events로 반환합니다.

PENDING 또는 IN_PROGRESS 상태의 작업의 경우, 응답 스트림에는 필요한 progress 및 status 필드만 포함됩니다.

Request

GET

/openapi/v1/convert/:id/stream

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
}

The Convert Task Object

변환 작업(Convert Task) 객체는 포맷 변환 작업을 나타냅니다.

Properties

id · string

작업의 고유 식별자입니다.

type · string

작업의 유형입니다. 값은 convert입니다.

model_urls · object

변환된 모델 파일의 다운로드 가능한 URL입니다. target_formats에 지정된 포맷에 대해서만 URL이 제공됩니다. 그 외 포맷 속성은 빈 문자열이 됩니다.

progress · integer

작업의 progress입니다 (0-100).

status · string

작업의 상태입니다. 가능한 값: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

preceding_tasks · integer

선행 작업의 수입니다. 상태가 PENDING일 때만 의미가 있습니다.

created_at · timestamp

작업이 생성된 시점의 타임스탬프이며, 밀리초 단위입니다.

started_at · timestamp

작업이 시작된 시점의 타임스탬프이며, 밀리초 단위입니다. 시작되지 않은 경우 0입니다.

finished_at · timestamp

작업이 완료된 시점의 타임스탬프이며, 밀리초 단위입니다. 완료되지 않은 경우 0입니다.

task_error · object

작업이 실패한 경우의 오류 객체입니다. 자세한 내용은 오류를 참고하세요.

consumed_credits · integer

이 작업에서 소모된 크레딧 수입니다 (변환 작업당 1 크레딧). FAILED 작업의 경우 0을 반환합니다.