텍스트로 3D API
자체 애플리케이션에서 텍스트 프롬프트로 3D 모델을 생성하세요.
텍스트로 3D는 두 단계로 작동합니다. 먼저 preview 작업(mode: "preview")을 생성하여 텍스처가 없는 3D 메시를 생성함으로써 형태를 확인할 수 있습니다. 그런 다음 성공한 preview 작업의 작업 ID를 refine 작업(mode: "refine")에 전송하여 메시에 텍스처를 입힙니다. 두 단계 모두 동일한 엔드포인트를 사용합니다.
Text to 3D preview 태스크 생성
텍스트 prompt로부터 텍스처가 없는 3D 메시(지오메트리만)를 생성하는 Text to 3D preview 태스크를 생성합니다. 이는 2단계 워크플로의 첫 번째 단계입니다. preview가 성공하면 해당 태스크 ID를 refine 태스크로 전송하여 메시에 텍스처를 입힙니다. Text to 3D refine 태스크 생성을 참고하세요. 전체 응답 스키마는 Text to 3D 태스크 객체를 참고하세요.
태스크는 백그라운드에서 실행됩니다. 태스크가 일반적으로 소요되는 시간은 처리 시간을 참고하세요.
Request
# Simple preview with required params only
curl https://api.meshy.ai/openapi/v2/text-to-3d \
-H 'Authorization: Bearer ${YOUR_API_KEY}' \
-H 'Content-Type: application/json' \
-d '{
"mode": "preview",
"prompt": "a monster mask"
}'
# Preview with Ultra 4K geometry, remesh, and A-pose
curl https://api.meshy.ai/openapi/v2/text-to-3d \
-H 'Authorization: Bearer ${YOUR_API_KEY}' \
-H 'Content-Type: application/json' \
-d '{
"mode": "preview",
"prompt": "a futuristic robot warrior",
"ai_model": "meshy-7.1",
"geometry_resolution": "4k",
"should_remesh": true,
"target_polycount": 100000,
"pose_mode": "a-pose",
"target_formats": ["glb"]
}'
Response
{
"result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
파라미터
- Name
- mode
- Type
- string
- 필수
- Description
2단계 워크플로의 단계입니다. preview 태스크를 생성하려면
preview를 전송하세요.
- Name
- prompt
- Type
- string
- 필수
- Description
생성할 객체를 설명하는 텍스트로, 최대 800자입니다. 더 긴 텍스트를 보내면
400이 반환됩니다.
- Name
- model_type
- Type
- string
- 기본값 standard
- Description
생성할 3D 메시의 유형입니다.
사용 가능한 값:
standard: 고해상도 3D 메시smart-topology: Smart Topology 메시입니다.ai_model(meshy-t2또는meshy-t2.5)로 모델을 선택합니다.
smart-topology를 사용하면 Meshy는should_remesh와decimation_mode를 무시하며,topology: triangle만 허용합니다.
- Name
- ai_model
- Type
- string
- 기본값 latest
- Description
3D 모델을 생성하는 AI 모델입니다. 사용 가능한 값은
model_type에 따라 다릅니다.표준 모델 (
model_type: standard):meshy-6-litemeshy-6meshy-7.1latest: Meshy 7.1meshy-7(지원 중단): 대신meshy-7.1을 전송하세요
Smart Topology 모델 (
model_type: smart-topology):meshy-t2: 더 깔끔한 topology, 기본적으로 분리된 파츠, triangle 출력,target_polycount로 설정하는 면 개수meshy-t2.5(기본값): 게임 에셋에 적합한 더 선명한 디테일, triangle 출력,target_polycount로 설정하는 면 개수
- Name
- geometry_resolution
- Type
- string
- 기본값 standard
- Description
지오메트리 생성 패스입니다. preview 태스크에만 적용됩니다. refine에서 이 파라미터를 사용하면
400이 반환됩니다.사용 가능한 값:
standard2k: 2048³에서 Ultra 패스를 실행4k: 더 정교한 표면 디테일을 위해 4096³에서 Ultra 패스를 실행
2k는meshy-7.1,latest, 또는 지원 중단된meshy-7이 필요합니다.4k는meshy-7.1또는latest가 필요합니다. 다른 모델은400을 반환합니다.
- Name
- ultra_mode
- Type
- boolean
- ⚠ 사용 중단
- 기본값 false
- Description
대신
geometry_resolution을 전송하세요.ultra_mode: true는geometry_resolution: "2k"와 동일합니다.
- Name
- should_remesh
- Type
- boolean
- 기본값 true (meshy-6-lite), false (other models)
- Description
생성 후 모델을 리메시할지 여부입니다. 최고 품질의 3D 모델을 원하면
false를 전송하세요.
should_remesh = true- Name
- topology
- Type
- string
- 기본값 triangle
- Description
리메시된 모델의 면 유형입니다.
사용 가능한 값:
quad: quad 위주의 메시triangle: 감소된 triangle 메시
Smart Topology 출력은 triangle 전용입니다.
ai_model이meshy-t2또는meshy-t2.5일 때quad를 전송하면400이 반환됩니다.
- Name
- decimation_mode
- Type
- integer
- Description
레벨별 적응형 면 개수입니다. 이를 설정하면 Meshy는
target_polycount를 무시합니다.사용 가능한 값:
1: ultra2: high3: medium4: low
- Name
- target_polycount
- Type
- integer
- Description
목표로 할 면의 개수입니다. 지오메트리에 따라 결과가 목표값과 다를 수 있습니다. 이는 두 가지 개별적인 경우에 적용됩니다:
- 리메시:
standard모델에서should_remesh: true일 때입니다. Meshy는 메시를 이 개수에 가깝게 리메시(감소)합니다.decimation_mode를 설정하면 Meshy는 이를 사용하고target_polycount를 무시합니다. - Smart Topology:
model_type: smart-topology이고ai_model이meshy-t2또는meshy-t2.5일 때입니다. Meshy는 이 면 개수로 모델을 직접 생성합니다. 리메시는 실행되지 않으며,should_remesh는 필요하지 않습니다.
다음 표는 각 경우의 범위와 기본값을 보여줍니다:
경우 범위 기본값 리메시 100~30000030000meshy-t2100~150004000meshy-t2.5100~3000015000범위를 벗어난 값은
400을 반환합니다.- 리메시:
- Name
- symmetry_mode
- Type
- string
- ⚠ 사용 중단
- 기본값 auto
- Description
생략하세요. 이 파라미터는 출력에 영향을 주지 않습니다.
사용 가능한 값:
off: 대칭을 비활성화auto: 입력 지오메트리를 기반으로 대칭을 적용on: 생성 중 대칭을 강제 적용
- Name
- pose_mode
- Type
- string
- 기본값 ""
- Description
생성된 모델의 포즈입니다.
사용 가능한 값:
a-pose: A 포즈t-pose: T 포즈""(빈 문자열): 특정 포즈 없음
- Name
- is_a_t_pose
- Type
- boolean
- ⚠ 사용 중단
- 기본값 false
- Description
대신
pose_mode를 전송하세요. 모델을 A 포즈 또는 T 포즈로 생성할지 여부입니다.
- Name
- art_style
- Type
- string
- ⚠ 사용 중단
- 기본값 realistic
- Description
생략하세요. Meshy는 이를 무시합니다.
- Name
- moderation
- Type
- boolean
- 기본값 false
- Description
생성 전에
prompt에서 유해한 콘텐츠를 검사할지 여부입니다. Meshy가 유해한 콘텐츠를 감지하면 요청은400을 반환하고 Meshy는 태스크를 생성하지 않습니다.
- Name
- target_formats
- Type
- string[]
- Description
생성할 파일 형식입니다. Meshy는 이 형식들만 생성하고 반환하므로 태스크 시간이 단축될 수 있습니다. 생략하면 Meshy는
3mf를 제외한 모든 형식을 생성하며,3mf는 요청할 때만 생성합니다.사용 가능한 값:
glbobjfbxstlusdz3mf
- Name
- alpha_thumbnail
- Type
- boolean
- 기본값 false
- Description
투명 배경(RGBA)의 preview도 렌더링할지 여부이며, 태스크를 가져올 때
alpha_thumbnail_url로 반환됩니다.thumbnail_url은 변경되지 않습니다.
- Name
- auto_size
- Type
- boolean
- 기본값 false
- Description
AI 비전을 사용해 객체의 실제 높이를 추정하고 모델을 그 크기로 조정할지 여부입니다.
origin_at을 설정하지 않으면 Meshy는 원점을 바닥에 둡니다.
auto_size = true- Name
- origin_at
- Type
- string
- 기본값 bottom
- Description
모델의 원점을
bottom또는center중 어디에 둘지입니다.
반환값
응답의 result 필드에는 새로 생성된 Text to 3D 태스크의 ID가 담겨 있습니다.
실패 모드
- Name
400 - Bad Request- Description
요청을 실행할 수 없습니다. 오류 메시지에서 어떤 문제가 발견되었는지 알려줍니다. 예를 들면:
- 파라미터 누락:
prompt또는mode와 같은 필수 파라미터가 누락되었습니다. - Prompt가 너무 긺:
prompt가 문자 제한을 초과했습니다. - Ultra에 지원되지 않는 모델:
geometry_resolution이2k또는4k인데, 이를 실행할 수 없는ai_model을 사용했습니다.
요청을 수정한 후 다시 전송하세요. 오류를 참고하세요.
- 파라미터 누락:
- Name
401 - Unauthorized- Description
API 키가 없거나 유효하지 않습니다.
Authorization헤더를 확인하세요.
- Name
402 - Payment Required- Description
예를 들면:
- 크레딧 부족: 계정에 이 태스크를 수행할 충분한 크레딧이 없거나, 계정이 크레딧 한도에 도달했습니다. 크레딧 잔액을 확인한 후 다시 시도하세요.
- 무료 플랜: 태스크를 생성하려면 유료 플랜이 필요합니다. 구독 설정에서 플랜을 업그레이드한 후 다시 시도하세요.
- Name
403 - Forbidden- Description
콘텐츠 moderation이 prompt 또는 입력 이미지를 차단했습니다. 입력을 변경한 후 다시 시도하세요.
- Name
429 - Too Many Requests- Description
속도 제한을 초과했습니다. 잠시 기다린 후 다시 시도하세요. 속도 제한을 참고하세요.
Create a Text to 3D refine task
Text to 3D refine 작업을 생성합니다. 이 작업은 완료된 preview 작업의 메시에 텍스처를 입힙니다. 성공한 preview 작업의 ID를 preview_task_id로 보내세요. Text to 3D preview 작업 생성을 참고하세요. 이것은 2단계 워크플로우의 두 번째 단계입니다.
작업은 백그라운드에서 실행됩니다. 작업이 일반적으로 걸리는 시간은 처리 시간을 참고하세요.
Request
# Basic refine task
curl https://api.meshy.ai/openapi/v2/text-to-3d \
-H 'Authorization: Bearer ${YOUR_API_KEY}' \
-H 'Content-Type: application/json' \
-d '{
"mode": "refine",
"preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"enable_pbr": true
}'
# Refine with auto-size and GLB format
curl https://api.meshy.ai/openapi/v2/text-to-3d \
-H 'Authorization: Bearer ${YOUR_API_KEY}' \
-H 'Content-Type: application/json' \
-d '{
"mode": "refine",
"preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"target_formats": ["glb"],
"auto_size": true
}'
# Refine with Meshy N1 from the preview's stored reference image
curl https://api.meshy.ai/openapi/v2/text-to-3d \
-H 'Authorization: Bearer ${YOUR_API_KEY}' \
-H 'Content-Type: application/json' \
-d '{
"mode": "refine",
"preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"ai_model": "meshy-n1"
}'
Response
{
"result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
파라미터
- Name
- mode
- Type
- string
- 필수
- Description
2단계 워크플로우의 단계입니다. refine 작업을 생성하려면
refine을 보내세요.
- Name
- preview_task_id
- Type
- string
- 필수
- Description
텍스처를 입힐 preview 작업의 ID입니다. preview 작업의 상태는
SUCCEEDED여야 합니다.
- Name
- enable_pbr
- Type
- boolean
- 기본값 false
- Description
기본 색상과 함께 PBR 맵(메탈릭, 러프니스, 노멀)도 생성할지 여부입니다.
ai_model이meshy-6인 경우,texture_resolution: 8k를 제외하고 Meshy는 이미션 맵도 생성합니다.meshy-6-lite,meshy-7,meshy-7.1,latest는 이미션 맵을 생성하지 않습니다.ai_model을 설정하지 않은meshy-t2또는meshy-t2.5preview의 refine도 마찬가지입니다.ai_model: meshy-n1에서true를 보내면400이 반환됩니다.
- Name
- texture_resolution
- Type
- string
- 기본값 2k
- Description
기본 색상 텍스처의 해상도입니다. refine 작업에만 적용됩니다. preview에서 이 파라미터를 사용하면
400이 반환됩니다.사용 가능한 값:
2k: 2048×20484k: 4096×40968k: 8192×8192
해상도가 높을수록 표면 디테일을 더 많이 담아냅니다.
4k와8k는ai_model이meshy-6,meshy-7.1, 또는latest여야 합니다.meshy-n1에서는400이 반환됩니다.8k에서는 Meshy가 이미션 맵을 생성하지 않습니다.
- Name
- hd_texture
- Type
- boolean
- ⚠ 사용 중단
- 기본값 false
- Description
대신
texture_resolution을 보내세요.hd_texture: true는texture_resolution: "4k"와 동일합니다. 둘 다 보내면 Meshy는texture_resolution을 사용합니다.
- Name
- texture_prompt
- Type
- string
- Description
텍스처링을 안내하는 텍스트로, 최대 800자입니다. 더 긴 텍스트는
400을 반환합니다.texture_prompt또는texture_image_url중 하나만 보내세요. 둘 다 보내면 Meshy는texture_prompt를 사용합니다.ai_model: meshy-n1에서 이를 보내면400이 반환됩니다.
- Name
- texture_image_url
- Type
- string
- Description
텍스처링을 안내하는 2D 이미지로, 공개 URL 또는 base64로 인코딩된 data URI로 지정합니다. 예:
data:image/jpeg;base64,<your base64-encoded image data>.이미지는 최대 20MB, 각 변이 최소 32픽셀, 최대 178,956,970픽셀(너비 × 높이)인
.jpg,.jpeg,.png, 또는.webp파일이어야 합니다.ai_model: meshy-n1인 경우, Meshy는 이 이미지를 정면 뷰로 사용해 텍스처를 입힙니다.이미지 속 형태가 모델과 많이 다를 경우 이미지를 이용한 텍스처링이 잘 작동하지 않을 수 있습니다.
- Name
- ai_model
- Type
- string
- 기본값 inherited from the preview task
- Description
메시에 텍스처를 입히는 AI 모델입니다.
사용 가능한 값:
meshy-6-litemeshy-6meshy-7.1latest: Meshy 7.1meshy-n1: 참조 이미지만으로 만드는 2K 기본 색상 텍스처입니다. 텍스트 prompt, PBR 맵, 4K 또는 8K는 지원하지 않습니다.meshy-7(지원 중단): 대신meshy-7.1을 보내세요
비워두면 preview 작업의 모델을 사용하므로, preview와 그 refine이 처음부터 끝까지 동일한 모델에서 실행됩니다. 값을 보내면 이를 재정의합니다. 명시적으로
latest를 보내면 preview 작업에서와 동일한 방식으로 해석되므로,latestpreview와 그latestrefine은 항상 동일한 텍스처 모델을 사용합니다.meshy-n1인 경우, Meshy는texture_image_url로부터 텍스처를 입힙니다. 이를 보내지 않으면 Meshy는meshy-7.1또는latestpreview가 저장한 참조 이미지를 사용합니다. 다른 preview의 경우texture_image_url을 보내지 않으면400이 반환됩니다. preview는 최대 7,999,999개의 삼각형을 가질 수 있습니다. 쿼드로 리메시된 preview는400을 반환합니다.
- Name
- moderation
- Type
- boolean
- 기본값 false
- Description
생성 전에
texture_prompt와texture_image_url에 유해한 콘텐츠가 있는지 검사할지 여부입니다. Meshy가 유해한 콘텐츠를 감지하면 요청은400을 반환하며 Meshy는 작업을 생성하지 않습니다.
- Name
- remove_lighting
- Type
- boolean
- 기본값 true
- Description
기본 색상 텍스처에서 하이라이트와 그림자를 제거할지 여부입니다. 더 깔끔한 결과는 커스텀 조명 환경에서 더 잘 작동합니다.
ai_model이meshy-6일 때만 적용됩니다.meshy-7.1과latest는 이 값을 받아들이지만 무시하며,ai_model을 설정하지 않은meshy-t2또는meshy-t2.5preview의 refine도 마찬가지입니다.meshy-6-lite와 함께 보내면400이 반환됩니다.meshy-n1에서true를 보내면400이 반환됩니다.
- Name
- target_formats
- Type
- string[]
- Description
생성할 파일 형식입니다. Meshy는 이 형식들만 생성하여 반환하므로 작업 시간이 단축될 수 있습니다. 비워두면 Meshy는
3mf를 제외한 모든 형식을 생성하며,3mf는 요청할 때만 생성합니다.사용 가능한 값:
glbobjfbxstlusdz3mf
- Name
- alpha_thumbnail
- Type
- boolean
- 기본값 false
- Description
투명 배경(RGBA)의 미리보기도 함께 렌더링할지 여부입니다. 작업을 조회할 때
alpha_thumbnail_url로 반환됩니다.thumbnail_url은 변경되지 않습니다.
- Name
- auto_size
- Type
- boolean
- 기본값 false
- Description
AI 비전으로 객체의 실제 높이를 추정하여 모델 크기를 그에 맞게 조정할지 여부입니다.
origin_at을 설정하지 않으면 Meshy는 원점을 바닥에 둡니다.
auto_size = true- Name
- origin_at
- Type
- string
- 기본값 bottom
- Description
모델의 원점을 둘 위치로,
bottom또는center입니다.
반환 값
응답의 result 필드에 새 Text to 3D 작업의 ID가 담겨 있습니다.
실패 모드
- Name
400 - Bad Request- Description
요청을 실행할 수 없습니다. 오류 메시지에서 어떤 문제가 발견되었는지 알려줍니다. 예를 들면:
- 잘못된 작업 ID:
preview_task_id가 유효하지 않거나, 회원님의 preview 작업과 일치하지 않습니다. - 작업 준비 안 됨: preview 작업이 아직 성공하지 않았습니다.
- 모델 불일치: preview 작업의 AI 모델이 요청한 refine 모델과 맞지 않습니다.
- remove_lighting에 지원되지 않는 모델:
ai_model: "meshy-6-lite"와 함께remove_lighting을 보냈습니다. - Meshy N1용 참조 이미지 없음:
texture_image_url없이ai_model: meshy-n1을 보냈는데, preview에 Meshy N1이 사용할 수 있는 참조 이미지가 없습니다.texture_image_url을 보내세요. - Meshy N1용 쿼드 preview: 쿼드로 리메시된 preview에 대해
ai_model: meshy-n1을 보냈습니다. 다른ai_model로 refine하세요. - Meshy N1의 삼각형 수 초과:
ai_model: meshy-n1에서 preview의 삼각형 수가 7,999,999개를 초과합니다. 다른ai_model로 refine하세요. - Meshy N1에 지원되지 않는 옵션: 다음 옵션 중 하나와 함께
ai_model: meshy-n1을 보냈습니다:texture_promptenable_pbr: true4k또는8k의texture_resolutiontexture_resolution없이hd_texture: trueremove_lighting: true
요청을 수정한 뒤 다시 보내세요. 오류를 참고하세요.
- 잘못된 작업 ID:
- Name
401 - Unauthorized- Description
API 키가 없거나 유효하지 않습니다.
Authorization헤더를 확인하세요.
- Name
402 - Payment Required- Description
예를 들면:
- 크레딧 부족: 계정에 이 작업을 수행할 만큼 충분한 크레딧이 없거나, 계정이 크레딧 한도에 도달했습니다. 크레딧 잔액을 확인한 뒤 다시 시도하세요.
- 무료 플랜: 작업을 생성하려면 유료 플랜이 필요합니다. 구독 설정에서 플랜을 업그레이드한 뒤 다시 시도하세요.
- Name
403 - Forbidden- Description
콘텐츠 moderation이 prompt 또는 입력 이미지를 차단했습니다. 입력을 변경한 뒤 다시 시도하세요.
- Name
429 - Too Many Requests- Description
속도 제한을 초과했습니다. 잠시 기다린 뒤 다시 시도하세요. 속도 제한을 참고하세요.
텍스트로 3D 작업 가져오기
ID로 텍스트로 3D 작업을 반환합니다. preview 및 refine 작업 모두에 사용할 수 있습니다.
Request
curl https://api.meshy.ai/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "text-to-3d-preview",
"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=***",
"mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?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=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
"prompt": "a monster mask",
"progress": 100,
"started_at": 1692771667037,
"created_at": 1692771650657,
"finished_at": 1692771669037,
"status": "SUCCEEDED",
"texture_urls": [
{
"base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
}
],
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 20
}
매개변수
- Name
- id
- Type
- path
- Description
생성 응답에서 제공된 작업 ID입니다.
반환 값
텍스트로 3D 작업 객체입니다.
예시
아래 표는 각 mode에 대한 샘플 모델을 보여줍니다.
| Mode | 샘플 모델 |
|---|---|
| Preview | ![]() |
| Refine | ![]() |
Text to 3D 작업 삭제
Text to 3D 작업을 모델과 데이터를 포함하여 영구적으로 삭제합니다. 삭제는 취소할 수 없습니다.
Request
curl --request DELETE \
--url https://api.meshy.ai/openapi/v2/text-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 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가 반환됩니다.
Text to 3D 작업 목록 조회
사용자의 Text to 3D 작업 목록을 반환합니다.
Request
curl https://api.meshy.ai/openapi/v2/text-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
[
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "text-to-3d-preview",
"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=***",
"mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
"usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
"prompt": "a monster mask",
"progress": 100,
"started_at": 1692771667037,
"created_at": 1692771650657,
"finished_at": 1692771669037,
"status": "SUCCEEDED",
"texture_urls": [
{
"base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
}
],
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 20
}
]
매개변수
- 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: 최신 순
반환값
Text to 3D 작업 객체의 페이지네이션된 목록입니다.
텍스트로 3D 작업 스트리밍
텍스트로 3D 작업의 업데이트를 서버 전송 이벤트(SSE)로 스트리밍합니다.
Request
curl -N https://api.meshy.ai/openapi/v2/text-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.
// These examples are shortened. Each event holds the full task object.
event: message
data: {
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"progress": 0,
"status": "PENDING"
}
event: message
data: {
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"progress": 50,
"status": "IN_PROGRESS"
}
event: message
data: {
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "text-to-3d-preview",
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1692771650657,
"started_at": 1692771667037,
"finished_at": 1692771669037,
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
},
"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": null,
"consumed_credits": 20
}
매개변수
- Name
- id
- Type
- path
- Description
생성 응답에서 받은 작업 ID입니다.
반환값
텍스트로 3D 작업 객체의 스트림을 서버 전송 이벤트로 반환합니다.
각 이벤트는 Get 엔드포인트가 반환하는 것과 동일한 형태로 전체 작업 객체를 담고 있습니다. 작업이 PENDING 또는 IN_PROGRESS 상태인 동안에는 결과 필드에 아직 값이 없습니다.
Text to 3D 작업 객체
Text to 3D 작업 객체는 텍스트 prompt로부터 3D 모델을 생성하는 하나의 작업을 설명합니다. 이 객체는 상태, progress, 그리고 작업이 성공했을 때의 모델 파일을 담고 있습니다. 텍스트로 3D에는 preview와 refine이라는 두 단계가 있습니다. preview 작업은 메시만 있는 3D 모델을 생성하고, refine 작업은 preview 결과로부터 텍스처가 입혀진 3D 모델을 생성합니다.
속성
Example Text to 3D Task Object
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "text-to-3d-preview",
"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=***",
"usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
"mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
"stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
},
"prompt": "a monster mask",
"texture_prompt": "green slimy skin with scales and warts",
"texture_image_url": "",
"thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
"progress": 100,
"started_at": 1692771667037,
"created_at": 1692771650657,
"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": null,
"consumed_credits": 20
}
- Name
- id
- Type
- string
- Description
작업 ID입니다. 불투명한 문자열로 취급하고, 그 형식에 의존하지 마세요.
- Name
- type
- Type
- string
- Description
작업 유형으로, preview 작업의 경우
text-to-3d-preview, refine 작업의 경우text-to-3d-refine입니다.
- Name
- model_urls
- Type
- object
- Description
생성된 3D 모델의 다운로드 URL이며, 파일 형식별로 하나씩 제공됩니다. 작업에서 생성하지 않은 형식은 빈 문자열이 아니라 키 자체가 없습니다.
- Name
glb- Type
- string
- Description
GLB 파일입니다.
- Name
fbx- Type
- string
- Description
FBX 파일입니다.
- Name
usdz- Type
- string
- Description
USDZ 파일입니다.
- Name
obj- Type
- string
- Description
OBJ 파일입니다.
- Name
mtl- Type
- string
- Description
MTL 파일입니다.
- Name
stl- Type
- string
- Description
STL 파일입니다.
- Name
3mf- Type
- string
- Description
3MF 파일입니다.
target_formats에3mf가 포함된 경우에만 존재합니다.
- Name
- prompt
- Type
- string
- Description
작업을 생성할 때 보낸
prompt로, 수정되지 않은 원본입니다.
- Name
- texture_prompt
- Type
- string
- Description
refine 단계에서 텍스처링을 안내하기 위해 보낸 텍스트 prompt입니다.
- Name
- ultra_mode
- Type
- boolean
- ⚠ 사용 중단
- Description
대신
geometry_resolution을 참조하세요.
- Name
- geometry_resolution
- Type
- string
- Description
preview 작업이 실행된 Ultra 등급으로,
2k또는4k입니다.standard인 경우에는 이 필드가 없습니다.
- Name
- texture_image_url
- Type
- string
- Description
텍스처링을 안내하기 위해 보낸 이미지의 다운로드 URL입니다.
- Name
- thumbnail_url
- Type
- string
- Description
3D 모델의 썸네일 이미지 다운로드 URL입니다.
- Name
- alpha_thumbnail_url
- Type
- string
- Description
thumbnail_url의 배경이 투명한(RGBA) 버전의 다운로드 URL입니다.alpha_thumbnail: true로 작업을 생성했고 Meshy가 투명 미리보기를 렌더링한 경우에만 존재합니다.
- Name
- progress
- Type
- integer
- Description
작업이 얼마나 진행되었는지를 백분율로 나타냅니다. 작업이 시작되기 전까지는
0이고, 성공하면100입니다.
- Name
- started_at
- Type
- timestamp
- Description
작업이 시작된 시간으로, 유닉스 밀리초 단위입니다. 작업이 시작되기 전까지는
0입니다.
- Name
- created_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로, 객체 배열 형태입니다. 일반적으로 하나의 객체만 담겨 있습니다. 각 객체에는 다음 필드가 있습니다:
- Name
base_color- Type
- string
- Description
베이스 컬러 맵입니다.
- Name
metallic- Type
- string
- Description
메탈릭 맵입니다.
enable_pbr: false로 작업을 생성한 경우에는 존재하지 않습니다.
- Name
normal- Type
- string
- Description
노멀 맵입니다.
enable_pbr: false로 작업을 생성한 경우에는 존재하지 않습니다.
- Name
roughness- Type
- string
- Description
러프니스 맵입니다.
enable_pbr: false로 작업을 생성한 경우에는 존재하지 않습니다.
- Name
emission- Type
- string
- Description
이미션 맵입니다. 다음 중 어느 경우에도 존재하지 않습니다:
enable_pbr: false로 작업을 생성한 경우.ai_model이meshy-6-lite,meshy-7,meshy-7.1, 또는latest인 경우.texture_resolution이8k인 경우.ai_model을 설정하지 않고meshy-t2또는meshy-t2.5preview를 refine하는 작업인 경우.
- Name
- preceding_tasks
- Type
- integer
- Description
대기열에서 이 작업보다 앞에 있는 작업의 수입니다. 이 값은 작업이
PENDING상태일 때만 의미가 있습니다.
- Name
- task_error
- Type
- object
- Description
작업이 실패했을 때의 오류 세부 정보입니다. 상태가
FAILED가 아니면null입니다. 오류를 참조하세요.
- Name
- consumed_credits
- Type
- integer
- Description
작업에서 사용한 크레딧 수입니다. 상태가
PENDING,IN_PROGRESS,SUCCEEDED일 때 존재합니다.FAILED작업의 경우 Meshy가 크레딧을 환불하므로0입니다.

