Creative Lab — 키링 API

소스 사진을 3D 프린트 가능한 키링 메달리온으로 변환하세요 — 배지 모양의 컬러화된 깊이 부조 — 두 단계로: 프로토타입은 입력 사진에서 컬러화된 컨셉 이미지를 생성하고, 빌드는 그 컨셉 이미지를 부조 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
    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 문자열이 잘못되었습니다.
    • 콘텐츠 플래그됨: 입력 이미지가 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' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>"
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
프로토타입 예시
소스 사진으로 시작하여 키링 빌드 단계에서 사용되는 프로토타입 이미지를 생성합니다.
Creative Lab 키링 입력으로 사용된 소스 사진
프로토타입 입력
소스 사진에서 생성된 Creative Lab 키링 프로토타입 출력
프로토타입 출력

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

키링 빌드 작업 생성

성공한 프로토타입 작업에서 최종 3D 프린트 가능한 키링 메달리온을 생성합니다. 빌드는 프로토타입의 색상화된 컨셉 이미지를 기반으로 깊이 맵 부조 파이프라인을 실행하며, 요청한 형식으로 단일 메시 아티팩트를 제공합니다. 응답 형식에 대해서는 키링 빌드 작업 객체를 참조하세요.

파라미터

  • 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_curvegamma일 때만 의미 있음). 범위: (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를 반환합니다.
    • objmodel.obj + model.mtl + texture.png를 압축하여 model_urls.obj 아래에 번들을 반환합니다.
    • zip — 생성기가 내보낸 모든 아티팩트를 압축하여 model_urls.bundle_zip 아래에 번들을 반환합니다.

반환값

응답의 result 속성에는 새로 생성된 키링 빌드 작업의 작업 id가 포함됩니다. 작업이 SUCCEEDED 상태에 도달할 때까지 작업 가져오기 엔드포인트를 폴링하거나 스트림에 구독한 후, 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"
}
빌드 예시
빌드 작업은 선택된 프로토타입 이미지를 3D 프린트 가능한 키링 모델로 변환합니다.
Creative Lab 키링 빌드 모델 미리보기
빌드 모델 미리보기

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에서 DELETE404를 반환합니다.

경로 매개변수

  • 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

키링 작업 스트리밍

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

매개변수

  • Name
    id
    Type
    path
    Description

    스트리밍할 키링 작업의 고유 식별자입니다.

반환값

키링 프로토타입 또는 키링 빌드 작업 객체를 Server-Sent Events로 스트리밍합니다. PENDING 또는 IN_PROGRESS 작업의 경우, 응답 스트림에는 필요한 progressstatus 필드만 포함됩니다.

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.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
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

    페이지 크기 제한입니다. 최대 허용 항목 수는 50입니다.

  • 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=***"
    ]
  }
]

키링 프로토타입 작업 객체

키링 프로토타입 작업 객체는 Meshy가 소스 사진으로부터 색상화된 컨셉 이미지를 생성하기 위해 추적하는 작업 단위입니다. 이 단계의 출력물은 input_task_id를 통해 빌드 단계로 연결됩니다.

속성

  • Name
    id
    Type
    string
    Description

    작업의 고유 식별자입니다. 작업 ID에 대해 k-정렬 가능한 UUID를 구현 세부사항으로 사용하지만, ID의 형식에 대해 어떤 가정도 하지 않아야 합니다.

  • Name
    type
    Type
    string
    Description

    작업의 유형입니다. 값은 creative-lab-keychain-prototype입니다.

  • 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

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

  • Name
    finished_at
    Type
    timestamp
    Description

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

  • Name
    expires_at
    Type
    timestamp
    Description

    작업 결과가 만료되는 시점의 타임스탬프입니다. 밀리초 단위입니다.

  • Name
    preceding_tasks
    Type
    integer
    Description

    선행 작업의 수입니다.

  • 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": "",
  "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=***"
  ]
}

키링 빌드 작업 객체

키링 빌드 작업 객체는 Meshy가 추적하여 성공한 프로토타입 작업에서 최종 3D 키링 메시를 생성하는 작업 단위입니다. 빌드는 프로토타입의 개념 이미지에 깊이 맵 부조 파이프라인을 실행하고, 요청자가 요청한 형식으로 단일 메시 아티팩트를 게시합니다.

속성

  • 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

    작업의 진행 상황입니다. 작업이 아직 시작되지 않은 경우 이 속성은 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.formatglb(기본값)일 때 존재합니다.

    • Name
      obj
      Type
      string
      Description

      model.obj, model.mtl, 및 texture.png를 포함하는 zip 번들의 다운로드 가능한 URL입니다. output.formatobj일 때 존재합니다.

    • Name
      bundle_zip
      Type
      string
      Description

      생성기가 생성하는 모든 아티팩트의 zip 번들의 다운로드 가능한 URL입니다. output.formatzip일 때 존재합니다.

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