Creative Lab — 冷蔵庫マグネット API

写真をカスタム冷蔵庫マグネットに変換します — 平らなマグネット面を持つ、角丸長方形のカラー化されたレリーフで、冷蔵庫サイズに合わせて作られます — 処理は2段階に分かれています。prototype は入力写真からカラー化されたコンセプト画像を生成し、続く build はそのコンセプト画像をレリーフ状の3Dモデルへと変換します。この2つの段階は input_task_id によって関連付けられます。

  • POST /openapi/creative-lab/fridge-magnet/v1/prototype
  • POST /openapi/creative-lab/fridge-magnet/v1/build

POST/openapi/creative-lab/fridge-magnet/v1/prototype

Create a Fridge Magnet Prototype Task

ソース写真から単一のカラー化されたコンセプト画像を生成します。返されるタスクIDは、build エンドポイントに input_task_id として渡すものです。レスポンスの形式については The Fridge Magnet 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
    name
    Type
    string
    Description

    表示用のオプションのタスク名です。最大100文字。

  • Name
    remove_background
    Type
    boolean
    デフォルト false
    Description

    true に設定すると、プロトタイプ画像は背景が除去された透明なRGBA PNGとして返されるため、被写体を任意の背景に合成できます。

    これはこのエンドポイントが返す画像のみを制御します。同名のbuildオプション(デフォルト true)とは別のもので、そちらはレリーフ加工前の背景除去を制御します。

戻り値

レスポンスの result プロパティには、新しく作成された冷蔵庫マグネットプロトタイプタスクのタスク id が含まれます。Get a Task エンドポイントをポーリングするか、stream を購読して、タスクが SUCCEEDED になるまで待ってから、そのIDを build endpointinput_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/fridge-magnet/v1/prototype
# Stage 1: generate a colorized fridge magnet concept image
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/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": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9"
}
Prototype example
Start with a source photo, then generate the prototype image used by the fridge magnet build stage.
Source landscape photo used as the Creative Lab Fridge Magnet input
Prototype input
Creative Lab Fridge Magnet prototype output generated from the source photo
Prototype output

POST/openapi/creative-lab/fridge-magnet/v1/build

冷蔵庫マグネットビルドタスクを作成する

成功したプロトタイプタスクから、3Dプリント可能な最終的な冷蔵庫マグネットを生成します。このビルドは、プロトタイプの色付けされたコンセプト画像に対して深度マップリリーフパイプラインを実行し、指定した形式で単一のメッシュアーティファクトを出力します。レスポンスの形については The Fridge Magnet Build Task Object を参照してください。

パラメータ

  • Name
    input_task_id
    Type
    string
    必須
    Description

    同一のOpenAPIエンドポイントを通じて作成されたプロトタイプタスクのタスクID。プロトタイプは同じAPIキーで作成され、SUCCEEDEDに到達し、候補画像をちょうど1枚生成している必要があります。

    Webアプリを通じて作成されたプロトタイプタスクは受け付けられません — ビルドエンドポイントはPOST /openapi/creative-lab/fridge-magnet/v1/prototypeによって生成されたプロトタイプタスクのみを受け付け、それ以外のソースは404で拒否します。

  • Name
    name
    Type
    string
    Description

    表示用の任意のタスク名。最大100文字。

options

リリーフジオメトリに対する任意の調整パラメータです。どのフィールドにも妥当なデフォルト値があるため、上書きしたいものだけを送信してください。

  • Name
    badge_shape
    Type
    string
    デフォルト rounded-rect
    Description

    冷蔵庫マグネットの輪郭シルエット。利用可能な値:

    • circle
    • rounded-rect(デフォルト)
    • hexagon
    • shield
    • star
  • Name
    size_mm
    Type
    number
    デフォルト 60
    Description

    冷蔵庫マグネットのバウンディング正方形の一辺の長さ(ミリメートル)。範囲: (0, 400]

  • Name
    relief_height_mm
    Type
    number
    デフォルト 3.3
    Description

    ベースからのリリーフの最大高さ(ミリメートル)。範囲: [0, 20]

  • Name
    relief_offset_mm
    Type
    number
    デフォルト 0
    Description

    押し出し前にリリーフに適用される垂直方向のオフセット(ミリメートル)。範囲: [0, 20]

  • Name
    base_thickness_mm
    Type
    number
    デフォルト 2.0
    Description

    リリーフの背面にあるフラットなベースプレートの厚さ(ミリメートル)。冷蔵庫マグネットのデフォルトはより厚めの2mmベースです — これにより、リリーフが脆く感じられることなく、マグネットが冷蔵庫にしっかり吸着するのに十分な厚みを持たせています。範囲: [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, 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をzip化し、model_urls.objの下にバンドルを返します。
    • zip — ジェネレータが出力するすべてのアーティファクトをzip化し、model_urls.bundle_zipの下にバンドルを返します。

戻り値

レスポンスのresultプロパティには、新しく作成された冷蔵庫マグネットビルドタスクのタスクidが含まれます。タスクがSUCCEEDEDに到達するまでGet a Taskエンドポイントをポーリングするか、streamを購読し、その後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

    参照先のプロトタイプタスクが存在しないか、別のユーザーに属しているか、Webアプリを通じて作成されたものです(ビルドに連鎖できるのはAPIモードのプロトタイプタスクのみです)。

  • Name
    429 - Too Many Requests
    Description

    レート制限を超過しました。

Request

POST
/openapi/creative-lab/fridge-magnet/v1/build
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
    "options": {
      "badge_shape": "rounded-rect",
      "size_mm": 60,
      "relief_height_mm": 3.3
    },
    "output": {
      "format": "glb"
    }
  }'

Response

{
  "result": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0"
}
Build example
The build task turns the selected prototype image into a 3D-printable fridge magnet model.
Creative Lab Fridge Magnet build model preview
Build model preview

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

冷蔵庫マグネットタスクを取得する

有効なタスク id を指定して、プロトタイプタスクまたはビルドタスクを取得します。URLパスは タスクのステージと一致している必要があります。ビルドタスクを /prototype/:id 経由で取得すると 404 が返され、逆の場合も同様です。

レスポンスの形式については、The Fridge Magnet Prototype Task Object および The Fridge Magnet Build Task Object を参照してください。

パラメーター

  • Name
    id
    Type
    path
    Description

    取得する冷蔵庫マグネットタスクの一意の識別子。

レスポンス

レスポンスには冷蔵庫マグネットタスクオブジェクトが含まれます。形式はリクエストされた ステージによって異なります。

Request

GET
/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9
# Prototype
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
  "type": "creative-lab-fridge-magnet-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543210000,
  "started_at": 1729543215000,
  "finished_at": 1729543242000,
  "expires_at": 1729802442000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

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

冷蔵庫マグネットタスクの削除

冷蔵庫マグネットタスクをキャンセルします。タスクがまだPENDINGの場合、作成時に消費されたクレジットは返金されます。すでに IN_PROGRESSのタスクは返金されずにキャンセルされます(ワーカーがすでにリソースを消費している可能性があるためです)。すでに終了状態 (SUCCEEDEDFAILEDCANCELED)に達しているタスクはキャンセルできません。

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/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9
curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

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

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

冷蔵庫マグネットタスクをストリーミング

冷蔵庫マグネットタスクのリアルタイム更新を、Server-Sent Events(SSE)経由でストリーミングします。 URLパスはタスクのステージと一致していなければなりません — /prototype/:buildId/stream でストリームを開くと、status_code: 404 を持つ単一の event: error ペイロードが送出され、 ストリームは閉じられます。

パラメータ

  • Name
    id
    Type
    path
    Description

    ストリーミング対象の冷蔵庫マグネットタスクを識別する一意のID。

レスポンス

Fridge Magnet Prototype または Fridge Magnet Build タスクオブジェクトのストリームを、Server-Sent Eventsとして返します。各フレームには、そのステージの タスクオブジェクト全体が含まれます — これはGetエンドポイントが返すものと同じ形状です — そのため、タスクが PENDING または IN_PROGRESS の間は、出力フィールドは単にまだ値が入っていない状態 (null[]{})であり、finished_atnull です。

Request

GET
/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/stream
curl -N https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/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": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "task_error": null,
  "consumed_credits": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

GET/openapi/creative-lab/fridge-magnet/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/fridge-magnet/v1/prototype
# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

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

Response (List Prototype Tasks)

[
  {
    "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
    "type": "creative-lab-fridge-magnet-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729543210000,
    "started_at": 1729543215000,
    "finished_at": 1729543242000,
    "expires_at": 1729802442000,
    "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-sortable な UUID を使用していますが、id の形式についていかなる前提も置かないでください。

  • Name
    type
    Type
    string
    Description

    タスクのタイプです。値は creative-lab-fridge-magnet-prototype です。

  • Name
    name
    Type
    string
    Description

    タスク作成時に指定されたタスク名です。名前が指定されなかった場合は空文字列になります。

  • Name
    status
    Type
    string
    Description

    タスクのステータスです。取り得る値は PENDINGIN_PROGRESSSUCCEEDEDFAILEDCANCELED のいずれかです。

  • Name
    progress
    Type
    integer
    Description

    タスクの progress です。タスクがまだ開始されていない場合、このプロパティは 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

    このタスクによって消費されたクレジット数です。タスクのステータスが PENDINGIN_PROGRESS、または SUCCEEDED の場合に存在します。FAILED タスクの場合は 0 が返されます(失敗時はクレジットが返還されます)。

  • Name
    image_urls
    Type
    array of strings
    Description

    このプロトタイプタスクによって生成されたコンセプト画像候補のダウンロード可能な URL です。現在、API は常にちょうど1つの候補を返しますが、このフィールドは配列になっており、将来のリビジョンで破壊的変更なしに複数の候補を提供できるようにしています。

Example Fridge Magnet Prototype Task Object

{
  "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
  "type": "creative-lab-fridge-magnet-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543210000,
  "started_at": 1729543215000,
  "finished_at": 1729543242000,
  "expires_at": 1729802442000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

冷蔵庫マグネットビルドタスクオブジェクト

冷蔵庫マグネットビルドタスクオブジェクトは、成功したプロトタイプタスクから最終的な3D冷蔵庫マグネットメッシュを生成するために、Meshyが追跡する作業単位です。ビルドはプロトタイプのコンセプト画像に対して深度マップリリーフパイプラインを実行し、呼び出し元が要求した形式で単一のメッシュアーティファクトを公開します。

プロパティ

  • Name
    id
    Type
    string
    Description

    タスクの一意な識別子です。

  • Name
    type
    Type
    string
    Description

    タスクの種類です。値は creative-lab-fridge-magnet-build です。

  • Name
    name
    Type
    string
    Description

    タスク作成時に指定されたタスク名です。名前が指定されていない場合は空文字列になります。

  • Name
    status
    Type
    string
    Description

    タスクのステータスです。取り得る値は PENDINGIN_PROGRESSSUCCEEDEDFAILEDCANCELED のいずれかです。

  • 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で、アーティファクト名をキーとします。常にちょうど1つのエントリのみを含み、それはビルドリクエストの output.format で要求された形式です。キーは要求された形式と一致します:

    • Name
      glb
      Type
      string
      Description

      GLBファイルへのダウンロード可能なURLです。output.formatglb(デフォルト)だった場合に存在します。

    • Name
      obj
      Type
      string
      Description

      model.objmodel.mtltexture.png を含むzipバンドルへのダウンロード可能なURLです。output.formatobj だった場合に存在します。

    • Name
      bundle_zip
      Type
      string
      Description

      ジェネレーターが出力するすべてのアーティファクトを含むzipバンドルへのダウンロード可能なURLです。output.formatzip だった場合に存在します。

Example Fridge Magnet Build Task Object

{
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}