Creative Lab — 키링 API

원본 사진을 3D 프린팅이 가능한 키링 메달로 변환합니다 — 뱃지 모양의 컬러 깊이 부조로, 두 단계로 진행됩니다: prototype은 입력 사진으로부터 컬러 콘셉트 이미지를 생성하고, 이어서 build는 해당 콘셉트 이미지를 부조 3D 모델로 변환합니다. 두 단계는 input_task_id를 통해 연결됩니다.

POST /openapi/creative-lab/keychain/v1/prototype
POST /openapi/creative-lab/keychain/v1/build

POST/openapi/creative-lab/keychain/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_text를 사용하세요.
Name
name_text
Type
string
Description
키링에 각인할 텍스트로, 애완동물이나 사람의 이름 등을 지정합니다. 최대 10자이며 바이트가 아닌 유니코드 문자 기준으로 계산되므로, 10자의 중국어, 일본어, 한국어 이름도 허용됩니다. 각인 없는 키링을 만들려면 생략하세요.
텍스트가 사용되기 전에 앞뒤 공백은 제거되고 보이지 않는 서식 문자는 삭제됩니다. 결과 값은 프로토타입 작업 객체의 name_text로 반환되므로, 빌드 단계에 대한 비용을 지불하기 전에 정확히 어떤 내용이 각인될지 확인할 수 있습니다.
각인은 이 프로토타입 단계에서 적용됩니다. 빌드 단계는 이를 자동으로 상속하며 자체적으로 name_text를 받지 않습니다.
텍스트가 일반 ASCII가 아닌 경우, 요청 본문을 UTF-8로 전송하고 Content-Type: application/json; charset=utf-8을 설정하세요. Windows PowerShell의 Invoke-RestMethod를 포함한 일부 HTTP 클라이언트는 기본적으로 본문을 ISO-8859-1로 인코딩하는데, 이는 Meshy에 도달하기 전에 모든 비라틴 문자를 조용히 ?로 바꿔버립니다. API는 이를 실제로 요청한 각인과 구별할 수 없습니다.
Name
remove_background
Type
boolean
기본값 false
Description
true로 설정하면 프로토타입 이미지는 배경이 제거된 투명 RGBA PNG로 반환되므로, 대상을 원하는 배경에 합성할 수 있습니다.
이는 이 엔드포인트가 반환하는 이미지에만 적용됩니다. 동일한 이름의 빌드 옵션(기본값 true)과는 별개이며, 그 옵션은 렐리프 처리 전 배경 제거를 제어합니다.

반환값

응답의 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 문자열이 형식에 맞지 않습니다.
- 각인이 너무 긺: name_text가 10자를 초과합니다. 요청은 잘리지 않고 거부되므로, 이름이 축약된 상태로 각인된 키링에 대해 비용이 청구되는 일은 없습니다.
- 콘텐츠 플래그 처리됨: 입력 이미지가 NSFW 또는 지적 재산권 moderation에 의해 플래그 처리되었거나, name_text 각인이 NSFW moderation에 의해 플래그 처리되었습니다. 각인은 NSFW 콘텐츠에 대해서만 검사되며, 지적 재산권 검사는 이미지에만 적용됩니다.
Name
401 - Unauthorized
Description
인증에 실패했습니다. API 키를 확인하세요.
Name
402 - Payment Required
Description
이 작업을 수행하기에 크레딧이 부족합니다.
Name
429 - Too Many Requests
Description
속도 제한을 초과했습니다.

Request

POST

/openapi/creative-lab/keychain/v1/prototype

# Stage 1: generate a colorized keychain concept image
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json; charset=utf-8' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>",
    "name_text": "Luna"
  }'

Response

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

Prototype example

Start with a source photo, then generate the prototype image used by the keychain build stage.

Source photo used as the Creative Lab Keychain input — Prototype input

Creative Lab Keychain prototype output generated from the source photo — Prototype output

POST/openapi/creative-lab/keychain/v1/build

Keychain 빌드 작업 생성

성공한 프로토타입 작업으로부터 최종적으로 3D 프린팅 가능한 키체인 메달리온을 생성합니다. 빌드는 프로토타입의 색상화된 콘셉트 이미지에 대해 깊이 맵 릴리프 파이프라인을 실행하고, 요청한 형식으로 단일 메시 아티팩트를 제공합니다. 응답 형태에 대해서는 The Keychain Build Task Object를 참고하세요.

파라미터

Name
input_task_id
Type
string
필수
Description
동일한 OpenAPI 엔드포인트를 통해 생성된 프로토타입 작업의 작업 ID입니다. 프로토타입은 동일한 API 키로 생성되어야 하고, SUCCEEDED에 도달했어야 하며, 정확히 하나의 후보 이미지를 생성했어야 합니다.
웹앱을 통해 생성된 프로토타입 작업은 허용되지 않습니다 — 빌드 엔드포인트는 POST /openapi/creative-lab/keychain/v1/prototype로 생성된 프로토타입 작업만 허용하며, 다른 소스는 404로 거부합니다.
Name
name
Type
string
Description
표시용 선택적 작업 이름입니다. 최대 100자입니다.

`options`

릴리프 지오메트리에 대한 선택적 조정 파라미터입니다. 모든 필드에는 합리적인 기본값이 있으므로, 재정의하려는 항목만 전송하세요.

Name
badge_shape
Type
string
기본값 circle
Description
키체인 메달리온의 외곽선 실루엣입니다. 사용 가능한 값:
- circle (기본값)
- rounded-rect
- hexagon
- shield
- star
Name
size_mm
Type
number
기본값 40
Description
키체인의 경계 정사각형 한 변의 길이(밀리미터)입니다. 범위: (0, 400].
Name
relief_height_mm
Type
number
기본값 2.2
Description
베이스 위로 올라오는 최대 릴리프 높이(밀리미터)입니다. 범위: [0, 20].
Name
relief_offset_mm
Type
number
기본값 0
Description
압출 전 릴리프에 적용되는 수직 오프셋(밀리미터)입니다. 범위: [0, 20].
Name
base_thickness_mm
Type
number
기본값 0.1
Description
릴리프 뒤쪽 평평한 베이스 판의 두께(밀리미터)입니다. 범위: [0, 20].
Name
has_closed_back
Type
boolean
기본값 true
Description
메달리온의 뒷면이 밀폐된 표면으로 처리되는지 여부입니다. 열린 쉘로 만들려면 false로 설정하세요.
Name
relief_curve
Type
string
기본값 linear
Description
깊이 맵 값을 릴리프 높이로 매핑하는 전달 곡선입니다. 사용 가능한 값:
- linear (기본값)
- gamma
- s-curve
Name
curve_param
Type
number
기본값 1.0
Description
전달 곡선의 형태 파라미터입니다(relief_curve가 gamma일 때만 의미가 있음). 범위: (0, 10].
Name
invert_depth
Type
boolean
기본값 false
Description
깊이 맵 해석을 반전시켜 어두운 영역이 더 높은 릴리프가 되도록 합니다.
Name
smoothing
Type
number
기본값 0.24
Description
릴리프 추출 전 깊이 맵에 적용되는 스무딩 강도입니다. 범위: [0, 10].
Name
relief_scale
Type
number
기본값 1.0
Description
relief_height_mm 위에 적용되는 수직 스케일 배율입니다. 범위: (0, 10].
Name
depth_threshold
Type
number
기본값 0.1
Description
깊이 맵 값에 대한 저역 통과 임계값입니다. 이 값보다 낮은 값은 0으로 고정됩니다. 범위: [0, 1].
Name
remove_background
Type
boolean
기본값 true
Description
릴리프 처리 전에 프로토타입 콘셉트 이미지의 배경을 자동으로 제거합니다.
프로토타입 이미지 자체가 투명도와 함께 반환될지 여부를 제어하는, 동일한 이름을 가진 프로토타입 파라미터(기본값 false)와는 별개입니다.
Name
export_resolution
Type
integer
기본값 512
Description
내보내기에 사용되는 메시 해상도입니다. 범위: [64, 2048].

`output`

선택적 와이어 형식 선택자입니다. 기본값은 glb입니다.

Name
format
Type
string
기본값 glb
Description
빌드가 반환하는 아티팩트 묶음입니다. 사용 가능한 값:
- glb (기본값) — model_urls.glb 아래에 단일 model.glb를 반환합니다.
- obj — model.obj + model.mtl + texture.png를 압축하여 model_urls.obj 아래에 묶음을 반환합니다.
- zip — 생성기가 만들어내는 모든 아티팩트를 압축하여 model_urls.bundle_zip 아래에 묶음을 반환합니다.

반환값

응답의 result 속성에는 새로 생성된 키체인 빌드 작업의 작업 id가 포함됩니다. 작업이 SUCCEEDED에 도달할 때까지 Get a Task 엔드포인트를 폴링하거나 스트림을 구독한 다음, model_urls의 단일 항목에서 아티팩트를 다운로드하세요.

실패 모드

Name
400 - Bad Request
Description
요청이 허용되지 않았습니다. 일반적인 원인:
- 파라미터 누락: input_task_id는 필수입니다.
- 잘못된 UUID: input_task_id가 유효한 UUID가 아닙니다.
- 상위 작업이 성공하지 않음: 참조된 프로토타입 작업이 아직 SUCCEEDED에 도달하지 않았습니다.
- 후보 없음: 프로토타입 작업이 성공했지만 후보 이미지를 생성하지 못했습니다.
- 옵션 범위 초과: options 필드 중 하나가 허용된 범위 또는 열거값 집합을 벗어났습니다.
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/keychain/v1/build

# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "options": {
      "badge_shape": "circle",
      "size_mm": 40,
      "relief_height_mm": 2.5
    },
    "output": {
      "format": "glb"
    }
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}

Build example

The build task converts the selected prototype image into a 3D-printable keychain model.

Creative Lab Keychain build model preview — Build model preview

GET/openapi/creative-lab/keychain/v1/(prototype|build)/:id

키링 작업 조회

유효한 작업 id를 사용하여 프로토타입 또는 빌드 작업을 조회합니다. URL 경로는 작업의 단계와 일치해야 합니다 — /prototype/:id를 통해 조회된 빌드 작업은 404를 반환하며, 그 반대의 경우도 마찬가지입니다.

응답 형태에 대해서는 키링 프로토타입 작업 객체와 키링 빌드 작업 객체를 참고하세요.

매개변수

Name
id
Type
path
Description
조회할 키링 작업의 고유 식별자입니다.

반환값

응답에는 키링 작업 객체가 포함됩니다. 그 형태는 요청된 단계에 따라 달라집니다.

Request

GET

/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578

# Prototype
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-keychain-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-keychain-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}

DELETE/openapi/creative-lab/keychain/v1/(prototype|build)/:id

키링 작업 삭제

키링 작업을 취소합니다. 작업이 아직 PENDING 상태인 경우, 생성 시 소모된 크레딧이 환불됩니다. 이미 IN_PROGRESS 상태인 작업은 환불 없이 취소됩니다 (워커가 이미 리소스를 소모하고 있을 수 있습니다). 이미 최종 상태 (SUCCEEDED, FAILED, CANCELED)에 도달한 작업은 취소할 수 없습니다.

URL 경로는 작업의 단계와 일치해야 합니다 — /prototype/:buildId에 대한 DELETE는 404를 반환합니다.

경로 매개변수

Name
id
Type
path
Description
취소할 키링 작업의 고유 식별자입니다.

반환값

성공 시 빈 본문과 함께 204 No Content를 반환합니다.

실패 모드

Name
400 - Bad Request
Description
작업이 이미 최종 상태이므로 취소할 수 없습니다.
Name
404 - Not Found
Description
작업이 존재하지 않거나, 다른 사용자에게 속해 있거나, 단계가 URL 경로와 일치하지 않습니다.

Request

DELETE

/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 204 No Content on success (empty body).

GET/openapi/creative-lab/keychain/v1/(prototype|build)/:id/stream

Stream a Keychain Task

Server-Sent Events(SSE)를 통해 키링 작업의 실시간 업데이트를 스트리밍합니다. URL 경로는 작업의 단계와 일치해야 합니다 — /prototype/:buildId/stream에서 스트림을 열면 status_code: 404가 포함된 단일 event: error 페이로드가 발생하고 스트림이 종료됩니다.

Parameters

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

Returns

Server-Sent Events로 Keychain Prototype 또는 Keychain Build 작업 객체의 스트림을 반환합니다. 모든 프레임은 해당 단계의 전체 작업 객체를 담고 있습니다 — Get 엔드포인트가 반환하는 것과 동일한 형태입니다 — 따라서 작업이 PENDING 또는 IN_PROGRESS 상태인 동안에는 출력 필드가 아직 채워지지 않았을 뿐이며 (null, [] 또는 {}) finished_at은 null입니다.

Request

GET

/openapi/creative-lab/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream

curl -N https://api.meshy.ai/openapi/creative-lab/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example (wrong stage or task not found)
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// Every frame is the full task object; fields not yet populated are null / empty.
// The PENDING frame below is abbreviated to the fields that change.
event: message
data: {
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-keychain-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}

GET/openapi/creative-lab/keychain/v1/(prototype|build)

키링 작업 목록 조회

단일 단계에 대한 키링 작업의 페이지네이션된 목록을 조회합니다. URL 경로가 단계를 선택합니다 — /prototype은 프로토타입 작업을 반환하고, /build 는 빌드 작업을 반환합니다. 다른 단계의 작업은 두 응답 중 어느 쪽에도 포함되지 않습니다.

경로 매개변수

Name
stage
Type
path
필수
Description
prototype 또는 build 중 하나입니다. 이 컬렉션은 URL과 일치하는 단계의 작업만 반환합니다 — /prototype을 조회하면 빌드 작업은 절대 반환되지 않으며 그 반대도 마찬가지입니다.

쿼리 매개변수

Name
page_num
Type
integer
기본값 1
Description
페이지네이션을 위한 페이지 번호입니다.
Name
page_size
Type
integer
기본값 10
Description
페이지 크기 제한입니다. 최대 허용 값은 100개 항목입니다.
Name
sort_by
Type
string
기본값 -created_at
Description
정렬 기준 필드입니다. 사용 가능한 값:
- +created_at: 생성 시간 오름차순으로 정렬합니다.
- -created_at: 생성 시간 내림차순으로 정렬합니다.

반환값

단계별 작업 객체의 페이지네이션된 목록을 반환합니다 — /prototype을 조회할 때는 키링 프로토타입 작업 객체를, /build를 조회할 때는 키링 빌드 작업 객체를 반환합니다.

Request

GET

/openapi/creative-lab/keychain/v1/prototype

# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/build?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-keychain-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729123456000,
    "started_at": 1729123460000,
    "finished_at": 1729123486000,
    "expires_at": 1729382686000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "image_urls": [
      "https://assets.meshy.ai/***/concept.png?Expires=***"
    ]
  }
]

The Keychain Prototype Task Object

Keychain Prototype Task 객체는 소스 사진으로부터 컬러 컨셉 이미지를 생성하기 위해 Meshy가 추적하는 작업 단위입니다. 이 단계의 출력은 input_task_id를 통해 빌드 단계로 연결됩니다.

Properties

Name
id
Type
string
Description
태스크의 고유 식별자입니다. 구현 세부사항으로 태스크 id에 k-sortable UUID를 사용하지만, id의 형식에 대해서는 어떠한 가정도 하지 말아야 합니다.
Name
type
Type
string
Description
태스크의 유형입니다. 값은 creative-lab-keychain-prototype입니다.
Name
name
Type
string
Description
태스크가 생성될 때 제공된 태스크 이름입니다. 이름이 제공되지 않은 경우 빈 문자열입니다.
Name
name_text
Type
string
Description
트리밍 및 보이지 않는 서식 문자 제거 후, 이 키링에 적용된 각인 문구입니다. 태스크가 name_text 없이 생성된 경우에는 존재하지 않습니다. 텍스트가 HTTP 클라이언트의 인코딩을 통해 손상 없이 전달되었는지 확인하려면 여러분이 보낸 값과 비교해 보세요.
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초 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는 항상 정확히 하나의 후보만 반환하지만, 향후 개정에서 호환성을 깨지 않고 여러 후보를 노출할 수 있도록 이 필드는 배열로 되어 있습니다.

Example Keychain Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-keychain-prototype",
  "name": "",
  "name_text": "Luna",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

키링 빌드 태스크 객체

키링 빌드 태스크 객체는 성공한 프로토타입 태스크로부터 최종 3D 키링 메시를 생성하기 위해 Meshy가 추적하는 작업 단위입니다. 빌드는 프로토타입의 콘셉트 이미지에 대해 깊이 맵(depth-map) 릴리프 파이프라인을 실행하고, 호출자가 요청한 형식으로 단일 메시 산출물을 게시합니다.

속성

Name
id
Type
string
Description
태스크의 고유 식별자입니다.
Name
type
Type
string
Description
태스크의 유형입니다. 값은 creative-lab-keychain-build입니다.
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
태스크가 생성된 시점의 타임스탬프(밀리초)입니다.
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
model_urls
Type
object
Description
생성된 산출물의 다운로드 가능한 URL로, 산출물 이름을 키로 사용합니다. 항상 정확히 하나의 항목만 포함하며, 이는 빌드 요청의 output.format을 통해 요청된 형식입니다. 키는 요청된 형식과 일치합니다:
- Name
  glb
  Type
  string
  Description
  GLB 파일에 대한 다운로드 가능한 URL입니다. output.format이 glb(기본값)였을 때 존재합니다.
- Name
  obj
  Type
  string
  Description
  model.obj, model.mtl, texture.png를 포함하는 zip 번들에 대한 다운로드 가능한 URL입니다. output.format이 obj였을 때 존재합니다.
- Name
  bundle_zip
  Type
  string
  Description
  생성기가 출력하는 모든 산출물의 zip 번들에 대한 다운로드 가능한 URL입니다. output.format이 zip이었을 때 존재합니다.

Example Keychain Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-keychain-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}