원본 사진을 두 단계로 커다란 머리를 가진 비닐 수집용 3D 피규어로 변환합니다:
prototype은 입력 사진으로부터 스타일이 적용된 콘셉트 이미지를 생성하고, 그 다음
build는 해당 콘셉트 이미지를 텍스처가 적용된 3D 모델로 변환합니다.
두 단계는 input_task_id를 통해 연결됩니다.
POST /openapi/creative-lab/vinyl-figure/v1/prototype
소스 사진으로부터 비닐 피규어 스타일의 콘셉트 이미지를 하나 생성합니다. 반환된 태스크 ID는 빌드 엔드포인트에 input_task_id로 전달하는 값입니다. 응답 형식은
피규어 프로토타입 태스크 객체를
참고하세요.
파라미터
Name
image_url
Type
string
필수
Description
Meshy가 빅헤드 비닐 피규어로 스타일화할 소스 사진입니다. 현재 .jpg, .jpeg, .png, .webp 형식을 지원합니다.
이미지를 제공하는 방법은 두 가지가 있습니다:
공개적으로 접근 가능한 URL: 공용 인터넷에서 접근 가능한 URL입니다.
Data URI: 이미지를 base64로 인코딩한 data URI입니다. data URI 예시: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
표시용 선택적 태스크 이름입니다. 최대 100자입니다.
Name
remove_background
Type
boolean
기본값 false
Description
true로 설정하면 프로토타입 이미지가 배경이 제거된 투명 RGBA PNG로 반환되어, 피사체를 어떤 배경에든 합성할 수 있습니다.
반환값
응답의 result 속성에는 새로 생성된 비닐 피규어 프로토타입 태스크의 id가 포함됩니다. 태스크 가져오기 엔드포인트를 폴링하거나 스트림을 구독하여 태스크가 SUCCEEDED에 도달할 때까지 기다린 다음, 해당 ID를 빌드 엔드포인트에 input_task_id로 전달하세요.
실패 모드
Name
400 - Bad Request
Description
요청이 허용되지 않았습니다. 일반적인 원인:
파라미터 누락: image_url은 필수입니다.
잘못된 이미지 형식: 제공된 image_url이 지원되는 형식(.jpg, .jpeg, .png, .webp)이 아닙니다.
이미지 크기 범위 초과: 이미지가 너무 작거나, 최대 파일 크기를 초과하거나, 최대 픽셀 수를 초과했습니다.
접근 불가능한 URL: image_url을 다운로드할 수 없습니다(404 또는 timeout).
잘못된 Data URI: base64 문자열의 형식이 올바르지 않습니다.
콘텐츠 플래그 지정: 입력 이미지가 NSFW 또는 지적 재산권 moderation에 의해 플래그 처리되었습니다.
Name
401 - Unauthorized
Description
인증에 실패했습니다. API 키를 확인해주세요.
Name
402 - Payment Required
Description
이 작업을 수행하기에 크레딧이 부족합니다.
Name
429 - Too Many Requests
Description
속도 제한을 초과했습니다.
Request
POST
/openapi/creative-lab/vinyl-figure/v1/prototype
# Stage 1: generate a vinyl-figure-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/prototype \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_url": "<your publicly accessible image url or base64-encoded data URI>" }'
Response
{"result":"019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de"}
Prototype example
Start with a source photo, then generate the prototype image used by the build stage.
성공한 프로토타입 작업으로부터 최종 텍스처가 적용된 3D 비닐 피규어를 생성합니다. 빌드는
이미지로 3D와 동일한 image-to-3D 파이프라인을 실행하므로, 응답 객체 형식과
출력 URL 목록이 정확히 일치합니다. 응답 형태에 대해서는
비닐 피규어 빌드 작업 객체를
참조하세요.
파라미터
Name
input_task_id
Type
string
필수
Description
동일한 OpenAPI 엔드포인트를 통해 생성된 프로토타입 작업의 작업 ID입니다. 프로토타입은 동일한 API 키로 생성되었어야 하며, SUCCEEDED 상태에 도달했어야 하고, 정확히 하나의 후보 이미지를 생성했어야 합니다.
웹앱을 통해 생성된 프로토타입 작업은 허용되지 않습니다 — 빌드 엔드포인트는 POST /openapi/creative-lab/vinyl-figure/v1/prototype을 통해 생성된 프로토타입 작업만 허용하며, 다른 출처는 모두 404로 거부합니다.
Name
name
Type
string
Description
표시용 선택적 작업 이름입니다. 최대 100자입니다.
반환값
응답의 result 속성에는 새로 생성된 비닐 피규어 빌드 작업의 작업 id가 포함됩니다. 작업 조회 엔드포인트를 폴링하거나 스트림을 구독하여 작업이 SUCCEEDED 상태에 도달할 때까지 기다린 다음, model_urls.glb에서 텍스처가 적용된 GLB를 다운로드하세요 (또는 다운스트림 파이프라인에서 OBJ를 선호하는 경우 model_urls.obj와 model_urls.mtl에서 OBJ + MTL 쌍을 다운로드하세요).
실패 모드
Name
400 - Bad Request
Description
요청을 수용할 수 없습니다. 일반적인 원인:
파라미터 누락: input_task_id가 필요합니다.
잘못된 UUID: input_task_id가 유효한 UUID가 아닙니다.
부모 작업이 성공하지 않음: 참조된 프로토타입 작업이 아직 SUCCEEDED 상태에 도달하지 않았습니다.
후보 없음: 프로토타입 작업은 성공했지만 후보 이미지를 생성하지 못했습니다.
Name
401 - Unauthorized
Description
인증에 실패했습니다. API 키를 확인하세요.
Name
402 - Payment Required
Description
이 작업을 수행하기에 크레딧이 부족합니다.
Name
404 - Not Found
Description
참조된 프로토타입 작업이 존재하지 않거나, 다른 사용자에게 속해 있거나, 웹앱을 통해 생성되었습니다 (API 모드 프로토타입 작업만 빌드로 연결됩니다).
Name
429 - Too Many Requests
Description
속도 제한을 초과했습니다.
Request
POST
/openapi/creative-lab/vinyl-figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de" }'
비닐 피규어 작업을 취소합니다. 작업이 아직 PENDING 상태라면 생성 시점에
소비된 크레딧이 환불됩니다. 이미 IN_PROGRESS 상태인 작업은 환불 없이
취소됩니다(워커가 이미 리소스를 소모하고 있을 수 있습니다). 이미 최종
상태(SUCCEEDED, FAILED, CANCELED)에 도달한 작업은 취소할 수 없습니다.
피규어 태스크의 실시간 업데이트를 Server-Sent Events(SSE)를 통해 스트리밍합니다. URL 경로는 태스크의
단계와 일치해야 합니다 — /prototype/:buildId/stream에서 스트림을 열면 status_code: 404가 포함된
단일 event: error 페이로드가 발생하고 스트림이 종료됩니다.
매개변수
Name
id
Type
path
Description
스트리밍할 피규어 태스크의 고유 식별자입니다.
반환값
Server-Sent Events로 피규어 프로토타입
또는 피규어 빌드 태스크 객체의 스트림을 반환합니다.
모든 프레임은 해당 단계의 전체 태스크 객체를 담고 있습니다 — Get 엔드포인트가 반환하는 것과
동일한 형태입니다 — 따라서 태스크가 PENDING 또는 IN_PROGRESS 상태인 동안 출력 필드는
아직 채워지지 않은 상태(null, [] 또는 {})이며 finished_at은 null입니다.
Vinyl Figure Prototype Task 객체는 소스 사진으로부터 비닐 피규어 스타일의 컨셉 이미지를 생성하기 위해 Meshy가 추적하는 작업 단위입니다.
이 단계의 출력물은 input_task_id를 통해
빌드 단계로 연결됩니다.
속성
Name
id
Type
string
Description
작업의 고유 식별자입니다. 구현 세부 사항으로 작업 id에 k-sortable UUID를 사용하고 있지만, id의 형식에 대해 어떠한 가정도 하지 않아야 합니다.
Name
type
Type
string
Description
작업의 유형입니다. 값은 creative-lab-vinyl-figure-prototype입니다.
Name
name
Type
string
Description
작업이 생성될 때 제공된 작업 이름입니다. 이름이 제공되지 않은 경우 빈 문자열입니다.
Name
status
Type
string
Description
작업의 상태입니다. 가능한 값은 PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED 중 하나입니다.
Name
progress
Type
integer
Description
작업의 progress입니다. 작업이 아직 시작되지 않은 경우 이 속성은 0입니다. 작업이 성공하면 100이 됩니다.
Name
created_at
Type
timestamp
Description
작업이 생성된 시점의 타임스탬프(밀리초 단위)입니다.
타임스탬프는 RFC 3339 표준에 따라
1970년 1월 1일 UTC부터 경과한 밀리초 수를 나타냅니다.
예를 들어, 2023년 9월 1일 금요일 12:00:00 PM GMT는 1693569600000으로 표현됩니다. 이는 Meshy API의
모든 타임스탬프에 적용됩니다.
Name
started_at
Type
timestamp
Description
작업이 시작된 시점의 타임스탬프(밀리초 단위)입니다. 작업이 아직 시작되지 않은 경우 이 속성은 0입니다.
Name
finished_at
Type
timestamp
Description
작업이 완료된 시점의 타임스탬프(밀리초 단위)입니다. 작업이 아직 완료되지 않은 경우 이 속성은 0입니다.
Name
expires_at
Type
timestamp
Description
작업 결과가 만료되는 시점의 타임스탬프(밀리초 단위)입니다.
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을 반환합니다(실패 시 크레딧이 환불됩니다).
Name
image_urls
Type
array of strings
Description
이 프로토타입 작업으로 생성된 컨셉 이미지 후보들의 다운로드 가능한 URL입니다. 현재 API는 항상 정확히 하나의 후보를 반환하지만, 이 필드는 배열이므로 향후 버전에서 호환성을 깨지 않고 여러 후보를 제공할 수 있습니다.
비닐 피규어 빌드 작업 객체는 성공한 프로토타입 작업으로부터 텍스처가 적용된 3D 비닐 피규어를 생성하기 위해 Meshy가 추적하는 작업 단위입니다.
이 작업은 이미지로 3D에서 사용되는 것과 동일한 image-to-3D 파이프라인을 실행하므로,
출력 필드는 해당 엔드포인트의 작업 객체와 동일한 구조를 가집니다.
속성
Name
id
Type
string
Description
작업의 고유 식별자입니다.
Name
type
Type
string
Description
작업의 유형입니다. 값은 creative-lab-vinyl-figure-build입니다.
Name
name
Type
string
Description
작업 생성 시 제공된 작업 이름입니다. 이름이 제공되지 않은 경우 빈 문자열입니다.
Name
status
Type
string
Description
작업의 상태입니다. 가능한 값은 PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED 중 하나입니다.
Name
progress
Type
integer
Description
작업의 진행 상태입니다. 작업이 아직 시작되지 않은 경우 이 속성은 0입니다. 작업이 성공하면 100이 됩니다.
Name
created_at
Type
timestamp
Description
작업이 생성된 시각의 타임스탬프이며, 밀리초 단위입니다.
Name
started_at
Type
timestamp
Description
작업이 시작된 시각의 타임스탬프이며, 밀리초 단위입니다.
Name
finished_at
Type
timestamp
Description
작업이 종료된 시각의 타임스탬프이며, 밀리초 단위입니다.
Name
expires_at
Type
timestamp
Description
작업 결과가 만료되는 시각의 타임스탬프이며, 밀리초 단위입니다.
Name
preceding_tasks
Type
integer
Description
선행 작업의 개수입니다. 상태가 PENDING일 때만 의미가 있습니다.
Name
task_error
Type
object
Description
실패한 작업에 대한 오류 세부 정보입니다. task_error 객체 전체 참조는 오류를 참고하세요.
Name
consumed_credits
Type
integer
Description
이 작업에서 소비된 크레딧 수입니다. FAILED 작업의 경우 0을 반환합니다(실패 시 크레딧은 환불됩니다).
Name
prompt
Type
string
Description
비닐 피규어 빌드에서는 항상 비어 있습니다. 이미지로 3D에서 사용되는 공유 V2ImageTo3DTaskResponse 형식과의 엔드포인트 간 호환성을 위해 존재합니다.
Name
negative_prompt
Type
string
Description
비닐 피규어 빌드에서는 항상 비어 있습니다. 엔드포인트 간 호환성을 위해 존재합니다.
Name
texture_prompt
Type
string
Description
비닐 피규어 빌드에서는 항상 비어 있습니다. 엔드포인트 간 호환성을 위해 존재합니다.
Name
texture_image_url
Type
string
Description
비닐 피규어 빌드에서는 항상 비어 있습니다. 엔드포인트 간 호환성을 위해 존재합니다.
Name
model_urls
Type
object
Description
생성된 3D 모델의 다운로드 가능한 URL입니다. 비닐 피규어 빌드는 텍스처가 적용된 GLB와 함께, Wavefront OBJ를 선호하는 파이프라인을 위한 OBJ + MTL 쌍을 생성합니다. 이 필드 구조는 이미지로 3D의 model_urls 객체와 일치하므로, 향후 형식이 추가되어도 호환성이 깨지지 않습니다.
Name
glb
Type
string
Description
텍스처가 적용된 GLB 파일의 다운로드 가능한 URL입니다.
Name
obj
Type
string
Description
Wavefront OBJ 파일(지오메트리 + UV)의 다운로드 가능한 URL입니다.
Name
mtl
Type
string
Description
OBJ와 짝을 이루는 MTL 머티리얼 파일의 다운로드 가능한 URL입니다. obj 및 texture_urls[0].base_color 항목과 함께 사용하세요.
Name
thumbnail_url
Type
string
Description
모델 파일의 썸네일 이미지에 대한 다운로드 가능한 URL입니다.
Name
texture_urls
Type
array
Description
이 작업에서 생성된 텍스처 URL 객체의 배열입니다. 현재는 기본 색상 맵이 담긴 단일 객체만 포함합니다.