Creative Lab Brick Figure API

写真をブロック風のコレクティブル3Dミニフィギュアに変換する処理は、2段階で行われます。プロトタイプタスクは、写真からコンセプト画像を生成します。ビルドタスクは、その画像をテクスチャ付きの3Dモデルに変換し、プロトタイプタスクのIDを input_task_id として受け取ります。

POST /openapi/creative-lab/brick-figure/v1/prototype
POST /openapi/creative-lab/brick-figure/v1/build

POST/openapi/creative-lab/brick-figure/v1/prototype

ブリックフィギュアのプロトタイプタスクを作成する

写真から1枚のブロック風コンセプト画像を生成します。3Dモデルを構築するには、このタスクのIDをinput_task_idとしてbuildエンドポイントに渡してください。タスクのフィールドについては、Brick Figureプロトタイプタスクオブジェクトを参照してください。

Request

POST

/openapi/creative-lab/brick-figure/v1/prototype

# Stage 1: generate a brick-style concept image
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/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"
}

パラメータ

Name
image_url
Type
string
必須
Description
ブリックミニフィギュアに変換する写真。公開URLまたはdata URI（data:image/jpeg;base64,<your base64-encoded image data>）として指定します。
画像はJPG、JPEG、PNG、またはWebPファイルで、最大20MBまでです。
Name
name
Type
string
Description
タスクの名前（最大100文字）。タスクのnameフィールドに返されます。これより長い名前を指定すると400が返されます。
Name
remove_background
Type
boolean
デフォルト false
Description
プロトタイプ画像の背景を削除するかどうか。trueにすると透明なRGBA PNGが返されるため、被写体を任意の背景に配置できます。ビルドも背景を除去した画像から開始されます。Meshyが背景を削除できない場合は、背景付きの画像が返され、タスクはそのまま成功します。

返り値

resultフィールドには、新しいプロトタイプタスクのIDが格納されます。statusがSUCCEEDEDになるまでタスクを取得するか、ストリーミングしてください。その後、このIDをinput_task_idとしてbuildエンドポイントに渡します。

失敗モード

Name
400 - Bad Request
Description
リクエストを実行できません。例えば次のような場合です。
- image_urlが指定されていない。
- 画像がJPG、JPEG、PNG、またはWebPファイルではない。
- 画像が小さすぎる、20MBを超えている、または最大ピクセル数を超えている。
- Meshyが画像をダウンロードできない（例えば、URLが404を返す、またはタイムアウトする場合）。
- data URIが有効なbase64ではない。
- 画像がNSFWとしてフラグ付けされた。
エラーメッセージには、検出された問題が記載されます。リクエストを修正してから、再送信してください。
Name
401 - Unauthorized
Description
APIキーが指定されていないか、無効です。Authorizationヘッダーを確認してください。
Name
402 - Payment Required
Description
次のいずれかに該当します。
- アカウントのクレジットが不足している。
- APIキー、ワークスペース、またはメンバーがクレジット上限に達した。
- アカウントが無料プランである。
クレジットとプランを確認してから、再試行してください。
Name
403 - Forbidden
Description
あなたのチームでIPフィルタリングが有効になっており、Meshyがこの画像を第三者の知的財産としてフラグ付けしました。利用権限のある画像を送信してください。
Name
429 - Too Many Requests
Description
次のいずれかの制限に達しました。
- レート制限で許可されている数を超えるリクエストを送信した。数秒待ってから再試行してください。レート制限を参照してください。
- キューに入っている、または実行中のタスクが多すぎる。いくつか完了するのを待ってから再試行してください。
- クレジットが残っていない無制限プランで、クレジットなしで実行できるタスク数に達した。タスクの完了を待つか、クレジットを追加してください。
Name
500 - Internal Server Error
Description
Meshyでサーバーエラーが発生しました。例えば、画像の知的財産チェックを実行できなかった場合などです。Meshyはタスクを作成せず、課金されたクレジットがあれば返金します。リクエストを再試行してください。

POST/openapi/creative-lab/brick-figure/v1/build

Brick Figureビルドタスクを作成する

成功したプロトタイプタスクから、テクスチャ付きの3Dミニフィギュアを生成します。フィールドについてはThe Brick Figure build task objectを参照してください。

Request

POST

/openapi/creative-lab/brick-figure/v1/build

# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578"
  }'

Response

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

パラメータ

Name
input_task_id
Type
string
必須
Description
ビルド対象のプロトタイプタスクのIDです。POST /openapi/creative-lab/brick-figure/v1/prototypeであなたのアカウントが作成した、ステータスがSUCCEEDEDのタスクである必要があります。
あなたのアカウントのBrick FigureプロトタイプタスクではないID（ウェブアプリで作成されたプロトタイプを含む）を指定すると、404が返されます。
Name
name
Type
string
Description
タスクの名前で、最大100文字です。タスクのnameフィールドに反映されます。これより長い名前を指定すると400が返されます。

戻り値

resultフィールドには、新しいビルドタスクのIDが格納されます。statusがSUCCEEDEDになるまでタスクを取得するか、ストリーミングで取得してください。その後、model_urls.glbからテクスチャ付きGLBをダウンロードします。代わりにOBJを取得したい場合は、model_urls.objとそのマテリアルファイルをmodel_urls.mtlからダウンロードしてください。

失敗モード

Name
400 - Bad Request
Description
リクエストを実行できません。例えば、次のようなケースです。
- input_task_idが指定されていない、または有効なタスクIDではない。
- プロトタイプタスクのステータスがSUCCEEDEDではない。まだ実行中の場合は、しばらく待ってから再試行してください。失敗またはキャンセルされた場合は、新しいプロトタイプタスクを作成してください。
- プロトタイプタスクは成功したものの、画像がない。新しいプロトタイプタスクを作成してください。
エラーメッセージには、検出された問題の内容が記載されています。
Name
401 - Unauthorized
Description
APIキーが指定されていないか、無効です。Authorizationヘッダーを確認してください。
Name
402 - Payment Required
Description
次のいずれかに該当します。
- アカウントのクレジットが不足している。
- APIキー、ワークスペース、またはメンバーがクレジット上限に達している。
- アカウントが無料プランである。
クレジットとプランを確認してから、再試行してください。
Name
404 - Not Found
Description
input_task_idが、あなたのアカウントがAPIで作成したBrick Figureプロトタイプタスクのいずれとも一致しません。ウェブアプリで作成されたプロトタイプの場合も404が返されます。プロトタイプ作成レスポンスのresultIDを送信してください。
Name
429 - Too Many Requests
Description
次のいずれかの制限に達しました。
- レート制限で許可されている数を超えるリクエストを送信した。数秒待ってから再試行してください。詳しくはレート制限を参照してください。
- キューに入っている、または実行中のタスクが多すぎる。いくつか完了するのを待ってから再試行してください。
- クレジットが残っていない無制限プランで、クレジットなしで実行できるタスク数に達した。タスクが完了するのを待つか、クレジットを追加してください。

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

Brick Figureタスクを取得

prototypeタスクまたはbuildタスクを返します。パスはタスクのステージと一致している必要があります。/prototype/:id を通じてリクエストされたbuildタスクは 404 を返し、/build/:id を通じてリクエストされたprototypeタスクも同様に 404 を返します。

各フィールドについては、Brick Figure prototypeタスクオブジェクトおよびBrick Figure buildタスクオブジェクトを参照してください。

Request

GET

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

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

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

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-brick-figure-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-brick-figure-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": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}

パラメータ

Name
id
Type
path
Description
作成レスポンスから取得したタスクIDです。

戻り値

パス内のステージに対応する、prototypeタスクオブジェクトまたはbuildタスクオブジェクトです。

失敗モード

Name
400 - Bad Request
Description
id が有効なタスクIDではありません。作成レスポンスの result IDを送信してください。
Name
403 - Forbidden
Description
あなたのチームで IPフィルタリング が有効になっており、Meshyがタスクの画像を第三者の知的財産として検出しました。Enterpriseプランのチームにはこのエラーは発生しません。利用権限のある画像からprototypeタスクを作成してください。
Name
404 - Not Found
Description
このIDのBrick Figureタスクがアカウントに存在しない、またはタスクのステージがパスと一致しません。IDを確認し、タスクに合わせて /prototype または /build を使用してください。
Name
500 - Internal Server Error
Description
Meshyが知的財産チェックを実行できませんでした。リクエストを再試行してください。

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

Brick Figureタスクを削除する

Brick Figureタスクをキャンセルします。PENDINGタスクをキャンセルすると、そのクレジットが返金されます。IN_PROGRESSタスクは、すでにワーカーが処理を開始しているため、返金なしでキャンセルされます。最終ステータス（SUCCEEDED、FAILED、またはCANCELED）のタスクはキャンセルできません。

パスはタスクのステージと一致している必要があります。たとえば、build タスクのIDを指定して/prototype/:idに対してDELETEを実行すると、404が返されます。

Request

DELETE

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

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

Response

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

パスパラメータ

Name
id
Type
path
Description
キャンセルするタスクのID。

戻り値

空のボディを伴う204 No Content。

失敗モード

Name
400 - Bad Request
Description
以下のいずれかに該当します。
- idが有効なタスクIDではありません。作成時のレスポンスに含まれるresultのIDを送信してください。
- タスクはすでに最終ステータス（SUCCEEDED、FAILED、またはCANCELED）であるため、キャンセルできません。
Name
404 - Not Found
Description
このIDを持つBrick Figureタスクはお使いのアカウントに存在しないか、タスクのステージがパスと一致していません。IDを確認し、タスクに合わせて/prototypeまたは/buildを使用してください。

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

ブリックフィギュアタスクをストリーミングする

ブリックフィギュアタスクの更新情報をサーバー送信イベント（SSE）としてストリーミングします。パスはタスクのステージと一致している必要があります。一致しない場合、例えばビルドタスクのIDを /prototype/:id/stream に指定した場合、ストリームは status_code: 404 を含む error イベントを1件送信してからクローズします。

Request

GET

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

curl -N https://api.meshy.ai/openapi/creative-lab/brick-figure/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 following PENDING frame is shortened 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-brick-figure-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}

パラメータ

Name
id
Type
path
Description
作成レスポンスから取得したタスクIDです。

返り値

prototype または build タスクオブジェクトのストリームです。各イベントには、ブリックフィギュアタスクを取得するが返すものと同じ完全なタスクオブジェクトが含まれます。タスクが PENDING または IN_PROGRESS の間は、出力フィールドはまだ空（null、[]、または {}）であり、finished_at は null です。

IPフィルタリング によってタスクの結果がブロックされた場合、ストリームはその代わりに error イベントを1件送信し、get リクエストで返されるはずの status_code を含みます。

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

Brick Figure タスク一覧を取得

1つのステージの Brick Figure タスクを、1ページずつ返します。パスでステージを選択します。/prototype は prototype タスクのみを返し、/build は build タスクのみを返します。

Request

GET

/openapi/creative-lab/brick-figure/v1/prototype

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

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

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-brick-figure-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=***"
    ]
  }
]

パスパラメータ

Name
stage
Type
path
必須
Description
一覧表示するステージ。prototype または build。

クエリパラメータ

Name
page_num
Type
integer
デフォルト 1
Description
返すページ番号。1 から 255 まで。0 を指定すると最初のページを返します。0 から 255 の範囲外の値を指定すると 400 が返されます。
Name
page_size
Type
integer
デフォルト 10
Description
1ページあたりのタスク数。最大 100。101 から 255 の値を指定すると100件のタスクが返され、0 を指定するとデフォルト値が使用されます。0 から 255 の範囲外の値を指定すると 400 が返されます。
Name
sort_by
Type
string
デフォルト -created_at
Description
並び順。
使用可能な値:
- -created_at: 新しい順
- +created_at: 古い順

戻り値

パス内のステージに対応する、prototype タスクオブジェクトまたは build タスクオブジェクトの配列。

Brick Figure プロトタイプタスクオブジェクト

プロトタイプタスクは、写真からブロック風のコンセプト画像を生成します。この画像を3Dモデルに変換するには、タスクのIDをinput_task_idとしてbuildエンドポイントに渡してください。

プロパティ

Example Brick Figure Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-brick-figure-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=***"
  ]
}

Name
id
Type
string
Description
タスクID。この形式に依存しないでください。
Name
type
Type
string
Description
タスクタイプ。常にcreative-lab-brick-figure-prototypeです。
Name
name
Type
string
Description
タスク作成時に送信したname。送信しなかった場合は""です。
Name
status
Type
string
Description
タスクのステータス。
使用可能な値:
- PENDING: キューで待機中
- IN_PROGRESS: 結果を生成中
- SUCCEEDED: 最終状態。結果あり
- FAILED: 最終状態。理由はtask_errorに記載
- CANCELED: 最終状態。結果なし
Name
progress
Type
integer
Description
作業の完了率を0から100で表します。タスクが開始するまでは0で、成功すると100になります。
Name
created_at
Type
timestamp
Description
タスクが作成された時刻（Unixミリ秒）。
Name
started_at
Type
timestamp
Description
ワーカーがタスクを開始した時刻（Unixミリ秒）。開始するまではnullです。
Name
finished_at
Type
timestamp
Description
タスクが最終ステータスに達した時刻（Unixミリ秒）。それまではnullです。
Name
expires_at
Type
timestamp
Description
タスクの結果が期限切れになる時刻（Unixミリ秒）。finished_atの3日後、またはタスクが完了するまではcreated_atの3日後です。APIの結果を無期限に保持するEnterpriseアカウントの場合は、約100年後になります。アセット保持期間を参照してください。
Name
preceding_tasks
Type
integer
Description
タスクがPENDINGの間のキュー内での位置。1は次に開始することを意味します。タスクがキューを離れると0になり、リスト結果では常に0です。
Name
task_error
Type
object
Description
タスクが失敗した理由。statusがFAILEDでない限りnullです。エラーを参照してください。
Name
consumed_credits
Type
integer
Description
タスクに対して課金されたクレジット数（返金後）。エラーを返すリクエストには課金されません。失敗したタスクはMeshyが返金するため0になります。キャンセルによる返金は、タスクがPENDINGの間のみ行われます。Meshyが課金内容を読み取れない場合、getまたはstreamのレスポンスではこのフィールドが省略され、listリクエストは500を返します。その場合はリクエストを再試行してください。
Name
image_urls
Type
array of strings
Description
コンセプト画像のダウンロードURL。タスクが成功すると配列には1つのURLが含まれ、それまでは空です。

Brick Figure ビルドタスクオブジェクト

ビルドタスクは、成功したプロトタイプタスクから、テクスチャ付きの3Dミニフィギュアを生成します。その model_urls、thumbnail_url、texture_urls フィールドは、画像から3D タスクオブジェクトと同じ形式です。

プロパティ

Example Brick Figure Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-brick-figure-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": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}

Name
id
Type
string
Description
タスクID。その形式に依存しないでください。
Name
type
Type
string
Description
タスクの種類。常に creative-lab-brick-figure-build です。
Name
name
Type
string
Description
タスク作成時に送信した name。送信しなかった場合は "" になります。
Name
status
Type
string
Description
タスクのステータス。
使用可能な値：
- PENDING：キュー内で待機中
- IN_PROGRESS：結果を生成中
- SUCCEEDED：最終状態。結果あり
- FAILED：最終状態。理由は task_error に記載
- CANCELED：最終状態。結果なし
Name
progress
Type
integer
Description
処理の進捗率。0 から 100 までの値を取ります。タスクが開始するまでは 0、成功すると 100 になります。
Name
created_at
Type
timestamp
Description
タスクが作成された時刻。Unixミリ秒。
Name
started_at
Type
timestamp
Description
ワーカーがタスクを開始した時刻。Unixミリ秒。開始するまでは null です。
Name
finished_at
Type
timestamp
Description
タスクが最終ステータスに達した時刻。Unixミリ秒。達するまでは null です。
Name
expires_at
Type
timestamp
Description
タスクの結果の有効期限が切れる時刻。Unixミリ秒。finished_at の3日後、またはタスクが完了するまでは created_at の3日後です。APIの結果を無期限に保持するEnterpriseアカウントの場合は、約100年後になります。アセット保持期間を参照してください。
Name
preceding_tasks
Type
integer
Description
PENDING 状態にある間のキュー内でのタスクの位置。1 は次に開始することを意味します。タスクがキューから外れると 0 になり、リスト結果では常に 0 です。
Name
task_error
Type
object
Description
タスクが失敗した理由。status が FAILED でない限り null です。エラーを参照してください。
Name
consumed_credits
Type
integer
Description
タスクに対して返金後に請求されたクレジット数。エラーを返したリクエストには課金されません。失敗したタスクはMeshyが返金するため 0 になります。キャンセルによる返金は、タスクが PENDING の間のみ行われます。Meshyが請求額を読み取れない場合、get・streamレスポンスではこのフィールドが省略され、listリクエストは 500 を返します。その場合はリクエストを再試行してください。
Name
prompt
Type
string
Description
Brick Figure ビルドタスクでは常に "" です。
Name
negative_prompt
Type
string
Description
prompt と同様、Brick Figure ビルドタスクでは常に "" です。
Name
texture_prompt
Type
string
Description
prompt と同様、Brick Figure ビルドタスクでは常に "" です。
Name
texture_image_url
Type
string
Description
prompt と同様、Brick Figure ビルドタスクでは常に "" です。
Name
model_urls
Type
object
Description
3Dモデルのダウンロード用URL。テクスチャ付きGLBと、MTLファイルを伴うOBJファイルとして提供されます。
- Name
  glb
  Type
  string
  Description
  テクスチャ付きGLBファイルのダウンロードURL。
- Name
  obj
  Type
  string
  Description
  ジオメトリとUVを含むOBJファイルのダウンロード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
テクスチャマップ。ベースカラーマップを保持するオブジェクトを1つ含む配列です。
- Name
  base_color
  Type
  string
  Description
  ベースカラーマップのダウンロードURL。