이미지로 3D API

이미지로 3D API는 Meshy의 이미지로 3D 기능을 여러분의 애플리케이션에 통합할 수 있도록 지원하는 기능입니다. 이 섹션에서는 이 API를 시작하는 데 필요한 모든 정보를 확인할 수 있습니다.

POST/openapi/v1/image-to-3d

이미지로 3D 작업 생성하기

이 엔드포인트를 사용하면 새로운 이미지로 3D 작업을 생성할 수 있습니다. 이미지로 3D 작업 객체에 포함된 속성을 확인하려면 이미지로 3D 작업 객체를 참조하세요.

파라미터

input_task_id 또는 image_url 중 하나만 필수입니다. 둘 다 제공된 경우, input_task_id가 우선합니다.

Name
input_task_id
Type
string
필수
Description
출력을 입력 이미지로 사용할, 완료된 이미지 생성 작업의 ID입니다. 이 작업은 다음 작업 중 하나여야 합니다: 텍스트로 이미지 또는 이미지로 이미지. 또한 API를 통해 실행되었어야 하며, 상태가 SUCCEEDED여야 하고, 정확히 하나의 이미지를 생성해야 합니다.

Name
image_url
Type
string
필수
Description
Meshy가 모델 생성에 사용할 이미지를 제공하세요. 현재 .jpg, .jpeg, .png 형식을 지원합니다.
이미지를 제공하는 방법은 두 가지가 있습니다:
- 공개적으로 접근 가능한 URL: 공용 인터넷에서 접근할 수 있는 URL입니다.
- Data URI: 이미지의 base64로 인코딩된 data URI입니다. data URI 예시: data:image/jpeg;base64,<your base64-encoded image data>.

Name
model_type
Type
string
기본값 standard
Description
생성할 3D 메시의 유형을 지정합니다.
사용 가능한 값:
- standard: 일반적인 고해상도 3D 메시 생성입니다.
- smart-topology: ai_model(meshy-t2)로 Smart Topology 모델을 선택합니다.
- lowpoly(지원 중단): 더 깔끔한 폴리곤에 최적화된 로우폴리 메시를 생성합니다. 대신 smart-topology를 사용하는 것을 권장합니다.
smart-topology가 선택되면 topology, should_remesh, save_pre_remeshed_model은 무시됩니다.
lowpoly가 선택되면 ai_model, topology, target_polycount, should_remesh, save_pre_remeshed_model은 무시됩니다.
Name
ai_model
Type
string
기본값 latest
Description
사용할 모델의 ID입니다. 사용 가능한 값은 model_type에 따라 달라집니다.
표준 생성(model_type: standard):
- meshy-6-lite, meshy-6, meshy-7.1, latest(Meshy 7.1)
- meshy-7(지원 중단): 대신 meshy-7.1을 사용하세요.
Smart Topology 생성(model_type: smart-topology):
- meshy-t2(기본값): Smart Topology 모델 — 더 깔끔한 topology, 네이티브로 분리된 부품, 삼각형 출력, target_polycount로 설정할 수 있는 면 수를 제공합니다.
Name
geometry_resolution
Type
string
기본값 standard
Description
지오메트리 생성 패스입니다. 2k는 2048³에서 Ultra 패스를 실행하며, 4k는 가장 정교한 표면 디테일을 위해 4096³에서 실행합니다.
사용 가능한 값: standard, 2k, 4k
meshy-7.1 또는 latest가 필요합니다.
Name
ultra_mode
Type
boolean
⚠ 사용 중단
기본값 false
Description
대신 geometry_resolution을 사용하세요. ultra_mode: true는 geometry_resolution: "2k"와 동일합니다.
Name
should_texture
Type
boolean
기본값 true
Description
텍스처를 생성할지 여부를 결정합니다. false로 설정하면 텍스처 단계를 건너뛰어 텍스처가 없는 메시를 제공합니다.

다음 경우에만 적용 should_texture = true

Name
enable_pbr
Type
boolean
기본값 false
Description
기본 색상 외에 PBR 맵(metallic, roughness, normal)을 생성합니다. ai_model이 meshy-6인 경우 emission 맵도 포함되지만, texture_resolution: 8k에서는 제외됩니다. meshy-6-lite, meshy-7.1, latest는 emission 맵을 생성하지 않습니다.
Name
texture_resolution
Type
string
기본값 2k
Description
기본 색상 텍스처 해상도입니다. 2k(2048×2048), 4k(4096×4096), 8k(8192×8192) 중 하나입니다. 해상도가 높을수록 더 많은 표면 디테일을 포착합니다.
4k와 8k는 ai_model이 meshy-6-lite인 경우 사용할 수 없습니다. 8k에서는 emission 맵이 생성되지 않습니다.
Name
hd_texture
Type
boolean
⚠ 사용 중단
기본값 false
Description
대신 texture_resolution을 사용하세요 — texture_resolution: "4k"와 동일합니다. 둘 다 설정된 경우 texture_resolution이 우선합니다.
Name
texture_prompt
Type
string
Description
텍스처링 과정을 안내할 텍스트 prompt를 제공하세요. 최대 800자입니다.
Name
texture_image_url
Type
string
Description
텍스처링 과정을 안내할 2D 이미지를 제공하세요. 현재 .jpg, .jpeg, .png 형식을 지원합니다.
이미지를 제공하는 방법은 두 가지가 있습니다:
- 공개적으로 접근 가능한 URL: 공용 인터넷에서 접근할 수 있는 URL입니다
- Data URI: 이미지의 base64로 인코딩된 data URI입니다. data URI 예시: data:image/jpeg;base64,<your base64-encoded image data>
원본 asset과 업로드된 이미지 간에 지오메트리 차이가 큰 경우, 이미지 텍스처링이 최적으로 동작하지 않을 수 있습니다. 텍스처링 과정을 안내하는 데 texture_image_url 또는 texture_prompt 중 하나만 사용할 수 있습니다. 두 파라미터가 모두 제공된 경우, 기본적으로 texture_prompt가 모델 텍스처링에 사용됩니다. 텍스트 또는 이미지를 통한 텍스처링은 작업당 10크레딧이 소요됩니다.

Name
should_remesh
Type
boolean
기본값 false (Meshy 6 and Meshy 7 models), true (others)
Description
리메시 단계를 활성화할지 여부를 제어합니다. 최고 품질의 모델을 위해서는 should_remesh를 false로 설정하는 것을 권장합니다.

다음 경우에만 적용 should_remesh = true

Name
topology
Type
string
기본값 triangle
Description
생성된 모델의 topology를 지정합니다.
사용 가능한 값:
- quad: 쿼드가 주를 이루는 메시를 생성합니다.
- triangle: 감소 처리된 삼각형 메시를 생성합니다.
Name
decimation_mode
Type
integer
Description
폴리곤 수 레벨을 설정하여 적응형 감소(adaptive decimation)를 활성화합니다. 설정 시 target_polycount는 무시됩니다.
사용 가능한 값:
- 1: 적응형 — 초고 폴리곤 수.
- 2: 적응형 — 고 폴리곤 수.
- 3: 적응형 — 중간 폴리곤 수.
- 4: 적응형 — 저 폴리곤 수.
Name
save_pre_remeshed_model
Type
boolean
기본값 false
Description
true로 설정하면, Meshy는 리메시 단계가 완료되기 전 상태의 추가 GLB 파일도 저장합니다.

Name
target_polycount
Type
integer
Description
출력물의 목표 폴리곤(면) 수입니다. 지오메트리에 따라 실제 수치는 목표값과 다를 수 있습니다.
target_polycount는 두 가지 독립적인 경우에 적용됩니다:
- 리메시 — standard 모델에서 should_remesh: true인 경우. 메시는 대략 이 수치로 리메시(감소)됩니다. 범위는 100~300,000이며 기본값은 30,000입니다. decimation_mode가 설정된 경우 이것이 우선하며 target_polycount는 무시됩니다.
- Smart Topology — model_type: smart-topology 및 ai_model: meshy-t2인 경우. 모델은 이 면 수로 직접 생성되며, 리메시가 실행되지 않고 should_remesh가 필요하지 않습니다. 범위는 100~15,000이며 기본값은 4,000입니다.

Name
symmetry_mode
Type
string
⚠ 사용 중단
기본값 auto
Description
지원 중단됨. 이 파라미터는 더 이상 출력에 영향을 미치지 않습니다.
symmetry_mode 필드는 모델 생성 과정에서의 대칭 동작을 제어합니다.
유효한 값은 다음과 같습니다:
- off: 대칭을 비활성화합니다.
- auto: 입력 지오메트리를 기반으로 대칭을 자동으로 판단하여 적용합니다.
- on: 생성 시 대칭을 강제 적용합니다.
Name
pose_mode
Type
string
기본값 ""
Description
생성된 모델의 포즈 mode를 지정합니다.
사용 가능한 값:
- a-pose: 모델을 A 포즈로 생성합니다.
- t-pose: 모델을 T 포즈로 생성합니다.
- ""(빈 문자열): 특정 포즈를 적용하지 않습니다.
Name
is_a_t_pose
Type
boolean
⚠ 사용 중단
기본값 false
Description
대신 pose_mode를 사용하세요. 모델을 A/T 포즈로 생성할지 여부입니다.
Name
image_enhancement
Type
boolean
기본값 true
Description
더 나은 결과를 위해 입력 이미지를 최적화합니다. 스타일 처리 없이 입력 이미지의 정확한 모습을 유지하려면 false로 설정하세요.
ai_model이 meshy-6, meshy-7.1, 또는 latest인 경우에만 지원됩니다.
Name
remove_lighting
Type
boolean
기본값 true
Description
기본 색상 텍스처에서 하이라이트와 그림자를 제거하여, 커스텀 조명 설정에서 더 잘 작동하는 더 깔끔한 결과를 만들어냅니다.
ai_model이 meshy-6인 경우에만 지원됩니다.
Name
moderation
Type
boolean
기본값 false
Description
true로 설정하면 입력 콘텐츠가 유해할 가능성이 있는지 자동으로 검사됩니다. 유해한 콘텐츠가 감지되면 작업이 생성 단계로 진행되지 않습니다.
image_url, texture_image_url, texture_prompt 입력값에서 나온 콘텐츠가 검사 대상입니다.
Name
target_formats
Type
string[]
Description
출력에 포함할 3D 파일 형식을 지정합니다. 요청된 형식만 생성되어 반환되므로 작업 완료 시간을 줄일 수 있습니다. 생략하면 지원되는 모든 형식이 포함됩니다.
사용 가능한 값: glb, obj, fbx, stl, usdz, 3mf
생략하면 3mf를 제외한 모든 형식이 생성됩니다. 3mf는 명시적으로 지정된 경우에만 포함됩니다.
Name
auto_size
Type
boolean
기본값 false
Description
true로 설정하면 서비스는 AI 비전을 사용하여 객체의 실제 높이를 자동으로 추정하고 그에 맞게 모델의 크기를 조정합니다. origin_at이 명시적으로 설정되지 않는 한 원점은 기본적으로 bottom이 됩니다.
Name
alpha_thumbnail
Type
boolean
기본값 false
Description
true로 설정하면, 작업은 미리보기의 투명 배경(RGBA) 버전도 추가로 렌더링하여 GET 응답에서 alpha_thumbnail_url로 반환합니다. 기존 thumbnail_url 필드는 변경되지 않습니다.
Name
multi_view_thumbnails
Type
boolean
기본값 false
Description
true로 설정하면, 작업은 네 가지 기본 방향(전면, 우측, 후면, 좌측)의 썸네일을 추가로 렌더링하여 GET 응답의 thumbnail_urls에 반환합니다. 기존 thumbnail_url 필드는 변경되지 않으며 계속 전면 뷰를 가리키므로, 기존 클라이언트에는 영향이 없습니다.
작업 지연 시간이 약 3초 증가합니다.

다음 경우에만 적용 auto_size = true

Name
origin_at
Type
string
기본값 bottom
Description
auto_size가 활성화된 경우의 원점 위치입니다.
사용 가능한 값: bottom, center.

반환값

응답의 result 속성에는 새로 생성된 이미지로 3D 작업의 id가 포함됩니다.

실패 모드

Name
400 - Bad Request
Description
요청을 처리할 수 없습니다. 일반적인 원인:
- 파라미터 누락: image_url 또는 input_task_id 중 하나는 반드시 제공되어야 합니다.
- 유효하지 않은 입력 작업: input_task_id는 정확히 하나의 이미지를 생성하는, SUCCEEDED 상태의 텍스트로 이미지 또는 이미지로 이미지 작업을 참조해야 합니다.
- 유효하지 않은 이미지 형식: 제공된 image_url이 지원되는 형식(.jpg, .jpeg, .png)이 아닙니다.
- 접근할 수 없는 URL: image_url을 다운로드할 수 없습니다(404 또는 timeout).
- 유효하지 않은 Data URI: base64 문자열의 형식이 올바르지 않습니다.
- 유효하지 않은 파라미터 조합: enable_pbr은 should_texture가 true인 경우에만 지원됩니다.
- 로우폴리에서 지원되지 않는 모델: ai_model: "meshy-6-lite"는 model_type: "lowpoly"를 지원하지 않습니다.
- Ultra에서 지원되지 않는 모델: geometry_resolution은 meshy-7.1 또는 latest가 필요합니다.
Name
401 - Unauthorized
Description
인증에 실패했습니다. API 키를 확인해 주세요.
Name
402 - Payment Required
Description
이 작업을 수행하기 위한 크레딧이 부족합니다.
Name
429 - Too Many Requests
Description
속도 제한을 초과했습니다.

Request

POST

/openapi/v1/image-to-3d

# Simple request with required params
curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>"
  }'

# With Ultra 4K geometry, remesh, PBR, and A-pose
curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>",
    "ai_model": "meshy-7.1",
    "geometry_resolution": "4k",
    "enable_pbr": true,
    "should_remesh": true,
    "target_polycount": 100000,
    "should_texture": true,
    "pose_mode": "a-pose",
    "target_formats": ["glb"]
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

GET/openapi/v1/image-to-3d/:id

이미지로 3D 작업 조회

이 엔드포인트를 사용하면 유효한 작업 id를 통해 이미지로 3D 작업을 조회할 수 있습니다. 이미지로 3D 작업 객체에 포함된 속성을 확인하려면 The Image to 3D Task Object를 참고하세요.

매개변수

Name
id
Type
path
Description
조회할 이미지로 3D 작업의 고유 식별자입니다.

반환값

응답에는 이미지로 3D 작업 객체가 포함됩니다. 자세한 내용은 The Image to 3D Task Object 섹션을 확인하세요.

Request

GET

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {
    "message": ""
  },
  "consumed_credits": 30
}

DELETE/openapi/v1/image-to-3d/:id

이미지로 3D 작업 삭제

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

경로 매개변수

Name
id
Type
path
Description
삭제할 이미지로 3D 작업의 ID입니다.

작업 상태

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

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

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

반환값

성공 시 200 OK를 반환하며, 작업이 IN_PROGRESS인 경우 409 Conflict를 반환합니다.

Request

DELETE

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -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/image-to-3d

이미지로 3D 작업 목록 조회

이 엔드포인트를 사용하면 이미지로 3D 작업 목록을 조회할 수 있습니다.

매개변수

선택 속성

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: 생성 시간 내림차순 정렬.

반환값

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

Request

GET

/openapi/v1/image-to-3d

curl https://api.meshy.ai/openapi/v1/image-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "image-to-3d",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
      "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "thumbnail_urls": {
      "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
      "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
      "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
      "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
    },
    "texture_prompt": "",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "expires_at": 1692771679037,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
        "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
        "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
        "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
        "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {
      "message": ""
    },
    "consumed_credits": 30
  }
]

GET/openapi/v1/image-to-3d/:id/stream

이미지로 3D 작업 스트리밍

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

매개변수

Name
id
Type
path
Description
스트리밍할 이미지로 3D 작업의 고유 식별자입니다.

반환값

Server-Sent Events 형태로 이미지로 3D 작업 객체의 스트림을 반환합니다.

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

Request

GET

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/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": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "model_urls": {
  "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
  "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
  "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
  "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
  "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
  "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {
    "message": ""
  },
  "consumed_credits": 30
}

The Image to 3D Task Object

이미지로 3D Task 객체는 이미지 입력으로부터 3D 모델을 생성하기 위해 Meshy가 추적하는 작업 단위입니다. 이 객체는 다음과 같은 속성을 가집니다:

Properties

Name
id
Type
string
Description
작업의 고유 식별자입니다. 구현 세부사항으로 작업 id에 k-sortable UUID를 사용하지만, id의 형식에 대해서는 어떠한 가정도 하지 말아야 합니다.
Name
type
Type
string
Description
이미지로 3D 작업의 유형입니다. 값은 image-to-3d입니다.
Name
model_urls
Type
object
Description
Meshy가 생성한 텍스처가 적용된 3D 모델 파일을 다운로드할 수 있는 URL입니다. 해당 형식이 생성되지 않은 경우 빈 문자열을 반환하는 대신 해당 형식의 속성이 생략됩니다.
- Name
  glb
  Type
  string
  Description
  GLB 파일을 다운로드할 수 있는 URL입니다.
- Name
  fbx
  Type
  string
  Description
  FBX 파일을 다운로드할 수 있는 URL입니다.
- Name
  obj
  Type
  string
  Description
  OBJ 파일을 다운로드할 수 있는 URL입니다.
- Name
  usdz
  Type
  string
  Description
  USDZ 파일을 다운로드할 수 있는 URL입니다.
- Name
  mtl
  Type
  string
  Description
  텍스처가 존재할 때 OBJ 내보내기와 함께 반환되는 MTL 파일을 다운로드할 수 있는 URL입니다.
- Name
  stl
  Type
  string
  Description
  STL 파일을 다운로드할 수 있는 URL입니다.
- Name
  3mf
  Type
  string
  Description
  3MF 파일을 다운로드할 수 있는 URL입니다. target_formats를 통해 3mf가 요청된 경우에만 존재합니다.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  리메시 이전의 원본 GLB 출력을 다운로드할 수 있는 URL입니다.
  should_remesh: true와 save_pre_remeshed_model: true가 모두 설정된 상태로 작업이 생성된 경우에만 사용할 수 있습니다.
Name
thumbnail_url
Type
string
Description
모델 파일의 썸네일 이미지를 다운로드할 수 있는 URL입니다. 존재하는 경우 thumbnail_urls.front와 동일하며, 이전 버전과의 호환성을 위해 유지됩니다.
Name
alpha_thumbnail_url
Type
string
Description
thumbnail_url의 투명 배경(RGBA) 버전을 다운로드할 수 있는 URL입니다. 작업이 alpha_thumbnail: true로 생성되고 투명 프리뷰가 성공적으로 렌더링된 경우에만 존재하며, 그렇지 않으면 이 필드는 생략됩니다.
Name
thumbnail_urls
Type
object
Description
생성된 3D 모델의 네 방향(전, 후, 좌, 우) 썸네일을 다운로드할 수 있는 URL입니다. 각 값은 thumbnail_url과 동일한 재질과 조명으로 렌더링된 512×512 PNG의 서명된 URL입니다. GLB를 다운로드하지 않고도 배치 파이프라인에서 여러 각도로 모델을 미리 볼 때 유용합니다.
작업이 multi_view_thumbnails: true로 생성되고 SUCCEEDED 상태에 도달한 경우에만 존재합니다. 이전 작업이나 옵트인 없이 생성된 작업에는 이 필드가 포함되지 않습니다.
- Name
  front
  Type
  string
  Description
  정면 뷰, 수직축을 기준으로 0° 회전 (thumbnail_url과 일치).
- Name
  right
  Type
  string
  Description
  우측 뷰, 90° 회전.
- Name
  back
  Type
  string
  Description
  후면 뷰, 180° 회전.
- Name
  left
  Type
  string
  Description
  좌측 뷰, 270° 회전.
Name
texture_prompt
Type
string
Description
텍스처링 과정을 안내하는 데 사용된 텍스트 prompt입니다.
Name
texture_image_url
Type
string
Description
텍스처링 과정을 안내하는 데 사용된 텍스처 이미지를 다운로드할 수 있는 URL입니다.
Name
ultra_mode
Type
boolean
⚠ 사용 중단
Description
지원 중단됨; 대신 geometry_resolution을 참조하세요.
Name
geometry_resolution
Type
string
Description
작업이 실행된 Ultra 등급(2k 또는 4k)입니다. standard인 경우에는 생략됩니다.
Name
progress
Type
integer
Description
작업의 progress입니다. 작업이 아직 시작되지 않았다면 이 속성은 0입니다. 작업이 성공하면 100이 됩니다.
Name
started_at
Type
timestamp
Description
작업이 시작된 시점의 타임스탬프(밀리초)입니다. 작업이 아직 시작되지 않았다면 이 속성은 0입니다.
타임스탬프는 RFC 3339 표준에 따라 1970년 1월 1일 UTC 이후 경과한 밀리초 수를 나타냅니다. 예를 들어, 2023년 9월 1일 금요일 12:00:00 PM GMT는 1693569600000으로 표현됩니다. 이는 Meshy API의 모든 타임스탬프에 적용됩니다.
Name
created_at
Type
timestamp
Description
작업이 생성된 시점의 타임스탬프(밀리초)입니다.
Name
expires_at
Type
timestamp
Description
작업 결과가 만료되는 시점의 타임스탬프(밀리초)입니다.
Name
finished_at
Type
timestamp
Description
작업이 완료된 시점의 타임스탬프(밀리초)입니다. 작업이 아직 완료되지 않았다면 이 속성은 0입니다.
Name
status
Type
string
Description
작업의 상태입니다. 가능한 값은 PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED 중 하나입니다.
Name
texture_urls
Type
array
Description
작업에서 생성된 텍스처 URL 객체의 배열입니다. 일반적으로 하나의 텍스처 URL 객체만 포함됩니다. 각 텍스처 URL은 다음과 같은 속성을 가집니다:
- Name
  base_color
  Type
  string
  Description
  기본 색상 맵 이미지를 다운로드할 수 있는 URL입니다.
- Name
  metallic
  Type
  string
  Description
  메탈릭 맵 이미지를 다운로드할 수 있는 URL입니다.
  작업이 enable_pbr: false로 생성된 경우, 이 속성은 생략됩니다.
- Name
  normal
  Type
  string
  Description
  노멀 맵 이미지를 다운로드할 수 있는 URL입니다.
  작업이 enable_pbr: false로 생성된 경우, 이 속성은 생략됩니다.
- Name
  roughness
  Type
  string
  Description
  러프니스 맵 이미지를 다운로드할 수 있는 URL입니다.
  작업이 enable_pbr: false로 생성된 경우, 이 속성은 생략됩니다.
- Name
  emission
  Type
  string
  Description
  발광 맵 이미지를 다운로드할 수 있는 URL입니다.
  작업이 enable_pbr: false로 생성되었거나 ai_model이 meshy-6-lite, meshy-7.1, 또는 latest인 경우, 이 속성은 생략됩니다.
Name
preceding_tasks
Type
integer
Description
선행 작업의 수입니다.
이 필드의 값은 작업 상태가 PENDING일 때만 의미가 있습니다.
Name
task_error
Type
object
Description
실패한 작업에 대한 오류 세부 정보입니다. task_error 객체의 전체 참조는 오류를 참조하세요.
Name
consumed_credits
Type
integer
Description
이 작업에서 소비된 크레딧 수입니다. 작업 상태가 PENDING, IN_PROGRESS, 또는 SUCCEEDED일 때 존재합니다. FAILED 작업의 경우 0을 반환합니다(실패 시 크레딧은 환불됩니다).

Example Image to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "texture_image_url": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {
    "message": ""
  },
  "consumed_credits": 30
}