Creative Lab — ランプ API
ソース写真を2段階で3Dプリント可能なランプシェードに変換します。
prototype(プロトタイプ)ではスタイライズされたマットホワイトのコンセプト画像を生成し、それを中空の3Dモデル(GLB)に変換します。続いてbuild(ビルド)では、そのモデルに対してランププロセッサを実行し、プリント可能なSTLパーツを生成します — これは光源フィクスチャ用のベースプレートを備えた底の開いたランプシェードと、フィクスチャマウント自体です。この2つの段階はinput_task_idによって紐付けられます。
POST /openapi/creative-lab/lamp/v1/prototypePOST /openapi/creative-lab/lamp/v1/build
ランププロトタイプタスクの作成
参照写真から単色のマットホワイトのコンセプト画像を1枚生成し、それを中空の3Dランプシェードモデルに変換します。レスポンスにはコンセプト画像(image_urls)と3Dモデル(thumbnail_urlを含むmodel_urls.glb)の両方が含まれます。返されるタスクIDは、build エンドポイントにinput_task_idとして渡すものです。レスポンスの形式については、
The Lamp Prototype Task Object
を参照してください。
パラメータ
- Name
- image_url
- Type
- string
- 必須
- Description
Meshy がランプシェードの視覚的な参照として使用するソース写真です。現在、
.jpg、.jpeg、.png、.webp形式をサポートしています。画像を提供する方法は2つあります:
- 公開アクセス可能なURL: インターネット上から公開アクセス可能なURL。
- Data URI: 画像のbase64エンコードされたdata URI。Data URIの例:
data:image/jpeg;base64,<your base64-encoded image data>。
- Name
- image_subject
- Type
- string
- デフォルト character
- Description
スタイライゼーションのpromptを選択するための被写体カテゴリのヒントです。利用可能な値:
character(デフォルト) — 単一のキャラクター/オブジェクト被写体(フィギュア、動物、マスコットなど)。landscape— 屋外シーン/パノラマ被写体(山、都市景観、森など)。
- Name
- name
- Type
- string
- Description
表示用のオプションのタスク名です。最大100文字。
- Name
- remove_background
- Type
- boolean
- デフォルト false
- Description
trueに設定すると、プロトタイプ画像は背景が削除された透明なRGBA PNGとして返されるため、被写体を任意の背景に合成できます。
戻り値
レスポンスのresultプロパティには、新しく作成されたランププロトタイプタスクのタスクidが含まれます。タスクがSUCCEEDEDに到達するまでGet a Taskエンドポイントをポーリングするか、streamを購読し、その後そのIDをbuild endpointに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によってフラグ付けされました。
- 無効な
image_subject:character/landscapeのいずれでもありません。
- パラメータの不足:
- Name
401 - Unauthorized- Description
認証に失敗しました。APIキーを確認してください。
- Name
402 - Payment Required- Description
このタスクを実行するためのクレジットが不足しています。
- Name
429 - Too Many Requests- Description
レート制限を超えました。
Request
# Stage 1: concept image + hollow 3D lampshade model from a source photo
curl https://api.meshy.ai/openapi/creative-lab/lamp/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>",
"image_subject": "character"
}'
Response
{
"result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}


ランプビルドタスクを作成
成功したプロトタイプタスクから、3Dプリント可能な最終パーツを生成します。
ビルドはプロトタイプの3Dモデルに対してランププロセッサーを実行します:モデルを
diameter_mm にスケーリングし、底面を cut_amount_percent でフラットにカットし、
thickness_mm に中空化し、底面を開口し、そして — フィクスチャプリセットが選択されている場合 —
フィクスチャ用の穴を備えたベースプレートと、光源用の独立したマウントを追加します。
レスポンスの形式については
ランプビルドタスクオブジェクト を参照してください。
パラメータ
- Name
- input_task_id
- Type
- string
- 必須
- Description
この同じOpenAPIエンドポイント経由で作成されたプロトタイプタスクのタスクID。プロトタイプは同じAPIキーで作成され、
SUCCEEDEDに到達していて、3Dモデルを生成している必要があります。webapp経由で作成されたプロトタイプタスクは受け付けられません — ビルドエンドポイントは
POST /openapi/creative-lab/lamp/v1/prototypeによって生成されたプロトタイプタスクのみを受け付け、それ以外のソースは404で拒否します。
- Name
- name
- Type
- string
- Description
表示用のオプションのタスク名。最大100文字。
options
ランプシェードのジオメトリに関するオプションの調整パラメータです。すべてのフィールドには適切なデフォルト値が設定されています — 上書きしたいものだけを送信してください。
- Name
- diameter_mm
- Type
- number
- デフォルト 150
- Description
ランプシェードのバウンディングボックスの目標最大寸法(ミリメートル単位)。メッシュはこれに合わせて一様にスケーリングされます。範囲:
[50, 400]。
- Name
- thickness_mm
- Type
- number
- デフォルト 1
- Description
中空のランプシェードの肉厚(ミリメートル単位)。範囲:
(0, 10]。
- Name
- cut_amount_percent
- Type
- number
- デフォルト 1
- Description
底面でフラットにカットされるモデル高さのパーセンテージ。これにより、ランプシェードはプリントベッドの上に置かれ、フィクスチャ用の開口部が生まれます。範囲:
[1, 100]。
- Name
- light_source_preset
- Type
- string
- デフォルト bambu_mh001_60mm
- Description
底面の構築方法を決定する光源フィクスチャプリセット。利用可能な値:
bambu_mh001_60mm(デフォルト) — 底面が開いたランプシェードと、60mmのフィクスチャ穴を備えたベースプレート(いずれもmodel_urls.lamp_stlに含まれます)、およびフィクスチャマウントがmodel_urls.base_stlとして提供されます。none— 単一の密閉されたランプシェードがmodel_urls.lamp_stlに含まれます。model_urls.base_stlは省略されます。
- Name
- fixture_offset_x_mm
- Type
- number
- デフォルト 0
- Description
ランプシェードの中心を基準とした、ベースプレート上のフィクスチャ穴のX軸方向のオフセット(ミリメートル単位)。
light_source_presetがnoneでない場合のみ意味を持ちます。範囲:[-80, 80]。
- Name
- fixture_offset_z_mm
- Type
- number
- デフォルト 0
- Description
ランプシェードの中心を基準とした、ベースプレート上のフィクスチャ穴のZ軸(奥行き)方向のオフセット(ミリメートル単位)。
light_source_presetがnoneでない場合のみ意味を持ちます。範囲:[-80, 80]。
- Name
- rotate_x_deg
- Type
- number
- デフォルト 0
- Description
処理前にモデルに適用されるX軸周りの回転(度単位)。3つの回転はモデルの中心を基準としたXYZオイラー角として適用されます。範囲:
[-360, 360]。
- Name
- rotate_y_deg
- Type
- number
- デフォルト 0
- Description
処理前にインポートされたメッシュに適用されるY軸周りの回転(度単位)。範囲:
[-360, 360]。
- Name
- rotate_z_deg
- Type
- number
- デフォルト 0
- Description
処理前にインポートされたメッシュに適用されるZ軸周りの回転(度単位)。範囲:
[-360, 360]。
- Name
- include_result_json
- Type
- boolean
- デフォルト false
- Description
trueかつoutput.formatがzipの場合、バンドル内にランププロセッサーのresult.json(パイプライン名、警告、成果物のパス)を含めます。output.formatがstlの場合は無視されます。
output
オプションのワイヤーフォーマットセレクター。デフォルトは stl です。
- Name
- format
- Type
- string
- デフォルト stl
- Description
ビルドから返される成果物バンドル。利用可能な値:
stl(デフォルト) —model_urls.lamp_stl(ランプシェード。フィクスチャプリセットが設定されている場合はベースプレートも含む)を返し、light_source_presetがnoneでない場合はさらにmodel_urls.base_stlを返します。zip— プロセッサーが生成するすべての成果物(lamp.stl、オプションのbase.stl、オプションのresult.json)を単一のzipにパッケージ化し、model_urls.bundle_zipとして返します。
戻り値
レスポンスの result プロパティには、新しく作成されたランプビルドタスクのタスク id が含まれます。タスクを取得 エンドポイントをポーリングするか、ストリーム を購読して、タスクが SUCCEEDED に達するまで待ち、その後 model_urls から成果物をダウンロードしてください。
失敗モード
- Name
400 - Bad Request- Description
リクエストが受理できませんでした。よくある原因:
- パラメータ不足:
input_task_idは必須です。 - 無効なUUID:
input_task_idが有効なUUIDではありません。 - 親タスク未成功: 参照されているプロトタイプタスクがまだ
SUCCEEDEDに到達していません。 - モデルなし: プロトタイプタスクは成功しましたが、3Dモデルを生成しませんでした。
- オプションが範囲外:
optionsのいずれかのフィールドが許容される範囲または列挙値のセットから外れています。
- パラメータ不足:
- Name
401 - Unauthorized- Description
認証に失敗しました。APIキーを確認してください。
- Name
402 - Payment Required- Description
このタスクを実行するにはクレジットが不足しています。
- Name
404 - Not Found- Description
参照されているプロトタイプタスクが存在しない、別のユーザーに属している、またはwebapp経由で作成されたものです(APIモードで作成されたプロトタイプタスクのみがビルドに連鎖できます)。
- Name
429 - Too Many Requests- Description
レート制限を超過しました。
Request
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/lamp/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": {
"diameter_mm": 120,
"thickness_mm": 2,
"light_source_preset": "bambu_mh001_60mm",
"cut_amount_percent": 30
},
"output": {
"format": "stl"
}
}'
Response
{
"result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}

ランプタスクの取得
有効なタスク id を指定して、プロトタイプまたはビルドタスクを取得します。URLパスはタスクのステージと一致している必要があります。ビルドタスクを/prototype/:id経由で取得すると404が返され、その逆も同様です。
レスポンスの形式については、The Lamp Prototype Task Object およびThe Lamp Build Task Objectを参照してください。
パラメータ
- Name
- id
- Type
- path
- Description
取得するランプタスクの一意の識別子です。
返り値
レスポンスにはランプタスクオブジェクトが含まれます。その形式はどのステージがリクエストされたかによって異なります。
Request
# Prototype
curl https://api.meshy.ai/openapi/creative-lab/lamp/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
# Build
curl https://api.meshy.ai/openapi/creative-lab/lamp/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Prototype Response
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "creative-lab-lamp-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": 30,
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
"image_urls": [
"https://assets.meshy.ai/***/concept.png?Expires=***"
]
}
Build Response
{
"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
"type": "creative-lab-lamp-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": 6,
"model_urls": {
"lamp_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/lamp.stl?Expires=***",
"base_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/base.stl?Expires=***"
}
}
ランプタスクの削除
ランプタスクをキャンセルします。タスクがまだ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
curl --request DELETE \
--url https://api.meshy.ai/openapi/creative-lab/lamp/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
// Returns 204 No Content on success (empty body).
ランプタスクをストリーミングする
ランプタスクのリアルタイム更新を、Server-Sent Events(SSE)を介してストリーミングします。
URLパスはタスクのステージと一致している必要があります。/prototype/:buildId/stream
でストリームを開くと、status_code: 404 を含む単一の event: error ペイロードが送信され、ストリームが閉じられます。
パラメータ
- Name
- id
- Type
- path
- Description
ストリーミング対象のランプタスクを識別する一意のIDです。
戻り値
Lamp Prototype または
Lamp Build のタスクオブジェクトを、
Server-Sent Events としてストリーミングで返します。PENDING または
IN_PROGRESS のタスクについては、レスポンスストリームには必要な
progress と status フィールドのみが含まれます。
Request
curl -N https://api.meshy.ai/openapi/creative-lab/lamp/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-lamp-build",
"status": "SUCCEEDED",
"progress": 100,
"created_at": 1729123500000,
"started_at": 1729123510000,
"finished_at": 1729123535000,
"expires_at": 1729382735000,
"task_error": null,
"consumed_credits": 6,
"model_urls": {
"lamp_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/lamp.stl?Expires=***",
"base_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/base.stl?Expires=***"
}
}
ランプタスク一覧の取得
1つのステージに関するランプタスクのページネーションされた一覧を取得します。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
# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/lamp/v1/prototype?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/lamp/v1/build?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response (List Prototype Tasks)
[
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "creative-lab-lamp-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": 30,
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
"image_urls": [
"https://assets.meshy.ai/***/concept.png?Expires=***"
]
}
]
The Lamp Prototype Task Object
Lamp Prototype Taskオブジェクトは、Meshyが管理する作業単位であり、元となる写真からスタイライズされたマットホワイトのコンセプト画像を生成し、それを中空の3Dモデルに変換します。この段階の出力は、input_task_id を介してビルド段階へと連結されます。
プロパティ
- Name
- id
- Type
- string
- Description
タスクの一意な識別子です。タスクIDには実装の詳細としてk-sortable UUIDを使用していますが、このidの形式について何らかの前提を置くべきではありません。
- Name
- type
- Type
- string
- Description
タスクの種類です。値は
creative-lab-lamp-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 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
- model_urls
- Type
- object
- Description
コンセプト画像から生成された3Dモデルのダウンロード可能なURLです。タスクが成功すると存在するようになり、それまでは
{}です。- Name
glb- Type
- string
- Description
GLB形式の、中空のマットホワイトのランプシェードモデルへのダウンロード可能なURLです。これはビルド段階が処理するモデルです。
- Name
- thumbnail_url
- Type
- string
- Description
3Dモデルのレンダリングプレビューへのダウンロード可能なURLです。タスクが成功するまでは空文字列です。
- Name
- image_urls
- Type
- array of strings
- Description
このprototypeタスクによって生成されたコンセプト画像候補のダウンロード可能なURLです。現在、APIは常にちょうど1つの候補を返しますが、このフィールドは配列であるため、将来的な改訂で破壊的変更を伴わずに複数の候補を提供できるようになっています。
Example Lamp Prototype Task Object
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "creative-lab-lamp-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": 30,
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
"image_urls": [
"https://assets.meshy.ai/***/concept.png?Expires=***"
]
}
ランプビルドタスクオブジェクト
ランプビルドタスクオブジェクトは、Meshy が管理する作業単位で、成功したプロトタイプタスクから印刷可能な最終的な3Dランプシェードを生成します。このビルドは、プロトタイプの3Dモデルに対してランププロセッサを実行し、中空化、底面のフラット化と開口を行い、(フィクスチャプリセットを使用している場合は)ベースプレートとフィクスチャマウントを追加します。
プロパティ
- Name
- id
- Type
- string
- Description
タスクの一意の識別子です。
- Name
- type
- Type
- string
- Description
タスクのタイプです。値は
creative-lab-lamp-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
このタスクで消費された consumed_credits の数です。
FAILEDタスクの場合は0を返します(失敗時にはクレジットが返還されます)。
- Name
- model_urls
- Type
- object
- Description
生成された成果物のダウンロード可能な URL で、成果物名をキーとします。キーの集合は
output.formatとoptions.light_source_presetによって異なります。- Name
lamp_stl- Type
- string
- Description
lamp.stlへのダウンロード可能な URL です。これは、フィクスチャ用の穴を持つベースプレートを備えた開口底面のランプシェード、またはoptions.light_source_presetがnoneだった場合は単一の密閉されたランプシェードです。output.formatがstl(デフォルト)だった場合に存在します。
- Name
base_stl- Type
- string
- Description
base.stlへのダウンロード可能な URL で、光源フィクスチャマウントです。output.formatがstlかつoptions.light_source_presetがnoneでなかった場合に存在します。フィクスチャプリセットがnoneの場合は省略されます。
- Name
bundle_zip- Type
- string
- Description
プロセッサが出力するすべての成果物(
lamp.stl、任意のbase.stl、およびoptions.include_result_jsonがtrueの場合はresult.json)をまとめた zip バンドルへのダウンロード可能な URL です。output.formatがzipだった場合に存在します。bundle_zipが存在する場合、lamp_stl/base_stlは省略されます。
Example Lamp Build Task Object
{
"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
"type": "creative-lab-lamp-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": 6,
"model_urls": {
"lamp_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/lamp.stl?Expires=***",
"base_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/base.stl?Expires=***"
}
}