Creative Lab Vinyl Figure API

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

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

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

Vinyl Figureプロトタイプタスクの作成

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

Request

POST

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

# Stage 1: generate a vinyl-figure-style concept image
curl https://api.meshy.ai/openapi/creative-lab/vinyl-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": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de"
}

Prototype example

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

Source photo used as the Creative Lab Vinyl Figure input — Prototype input

Big-head vinyl figure prototype image generated from the source photo — Prototype output

パラメータ

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 Filteringが有効になっており、Meshyが画像をサードパーティの知的財産としてフラグ付けしました。使用する権利を持つ画像を送信してください。
Name
429 - Too Many Requests
Description
以下のいずれかの制限に達しました：
- レート制限で許可されている数を超えるリクエストを送信した。数秒待ってから再試行してください。レート制限を参照してください。
- キューに入っている、または実行中のタスクが多すぎる。いくつか完了するのを待ってから再試行してください。
- クレジットが残っていない無制限プランで、クレジットなしで実行できるタスク数に達した。タスクの完了を待つか、クレジットを追加してください。
Name
500 - Internal Server Error
Description
Meshyでサーバーエラーが発生しました。例えば、画像の知的財産チェックを実行できなかった場合です。Meshyはタスクを作成せず、請求されたクレジットがあれば返金します。リクエストを再試行してください。

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

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

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

Request

POST

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

# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de"
  }'

Response

{
  "result": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef"
}

パラメータ

Name
input_task_id
Type
string
必須
Description
ビルドするプロトタイプタスクのIDです。POST /openapi/creative-lab/vinyl-figure/v1/prototypeによってアカウントで作成され、ステータスがSUCCEEDEDであるタスクである必要があります。
APIから作成されたあなたのVinyl 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で作成したVinyl Figureプロトタイプタスクのいずれとも一致しません。ウェブアプリで作成されたプロトタイプも404を返します。プロトタイプ作成レスポンスのresult IDを送信してください。
Name
429 - Too Many Requests
Description
以下のいずれかの制限に達しました：
- レート制限で許可されている数より多くのリクエストを送信しました。数秒待ってから再試行してください。Rate limitsを参照してください。
- キューに入っている、または実行中のタスクが多すぎます。いくつか完了するのを待ってから再試行してください。
- クレジットが残っていない無制限プランで、クレジットなしで実行できるタスク数に達しました。タスクが完了するのを待つか、クレジットを追加してください。

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

ビニールフィギュアタスクを取得する

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

フィールドについては、ビニールフィギュアプロトタイプタスクオブジェクトとビニールフィギュアビルドタスクオブジェクトを参照してください。

Request

GET

/openapi/creative-lab/vinyl-figure/v1/prototype/019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de

# Prototype
curl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/prototype/019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de",
  "type": "creative-lab-vinyl-figure-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1752969600000,
  "started_at": 1752969604000,
  "finished_at": 1752969630000,
  "expires_at": 1753228830000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef",
  "type": "creative-lab-vinyl-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1752969700000,
  "started_at": 1752969710000,
  "finished_at": 1752969735000,
  "expires_at": 1753228935000,
  "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/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/texture_0.png?Expires=***"
    }
  ]
}

パラメーター

Name
id
Type
path
Description
作成レスポンスからのタスクIDです。

返り値

パス内のステージに対応する、プロトタイプタスクオブジェクトまたはビルドタスクオブジェクト。

失敗モード

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

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

Vinyl Figureタスクを削除

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

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

Request

DELETE

/openapi/creative-lab/vinyl-figure/v1/prototype/019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/prototype/019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de \
  -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のVinyl Figureタスクがあなたのアカウントに属していないか、タスクのステージがパスと一致していません。IDを確認し、タスクに合わせて /prototype または /build を使用してください。

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

Vinyl Figureタスクをストリーミングする

Vinyl Figureタスクの更新情報をServer-Sent Events（SSE）としてストリーミングします。パスはタスクのステージと一致している必要があります。一致しない場合、例えばbuildタスクのIDを/prototype/:id/streamに指定した場合、ストリームはstatus_code: 404を伴うerrorイベントを1件送信してクローズします。

Request

GET

/openapi/creative-lab/vinyl-figure/v1/build/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/stream

curl -N https://api.meshy.ai/openapi/creative-lab/vinyl-figure/v1/build/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/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": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef",
  "type": "creative-lab-vinyl-figure-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1752969700000,
  "started_at": 1752969710000,
  "finished_at": 1752969735000,
  "expires_at": 1753228935000,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/texture_0.png?Expires=***"
    }
  ]
}

パラメータ

Name
id
Type
path
Description
作成レスポンスに含まれるタスクIDです。

戻り値

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

IP Filteringがタスクの結果をブロックする場合、ストリームはその代わりに1件のerrorイベントを送信します。そのstatus_codeは、getリクエストを行った場合に返されるものと同じです。

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

Vinyl Figureタスクの一覧取得

1つのステージのVinyl Figureタスクを、1ページずつ返します。パスによってステージが決まります。/prototypeはプロトタイプタスクのみを返し、/buildはビルドタスクのみを返します。

Request

GET

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

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

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

Response (List Prototype Tasks)

[
  {
    "id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de",
    "type": "creative-lab-vinyl-figure-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1752969600000,
    "started_at": 1752969604000,
    "finished_at": 1752969630000,
    "expires_at": 1753228830000,
    "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: 古い順

戻り値

パスで指定したステージに対応する、プロトタイプタスクオブジェクトまたはビルドタスクオブジェクトの配列。

ヴァイナルフィギュアのプロトタイプタスクオブジェクト

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

プロパティ

Example Vinyl Figure Prototype Task Object

{
  "id": "019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de",
  "type": "creative-lab-vinyl-figure-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1752969600000,
  "started_at": 1752969604000,
  "finished_at": 1752969630000,
  "expires_at": 1753228830000,
  "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-vinyl-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が入り、それまでは空です。

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

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

プロパティ

Example Vinyl Figure Build Task Object

{
  "id": "019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef",
  "type": "creative-lab-vinyl-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1752969700000,
  "started_at": 1752969710000,
  "finished_at": 1752969735000,
  "expires_at": 1753228935000,
  "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/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c8a31-6e2f-7b4d-9a55-4c3098b2d5ef/output/texture_0.png?Expires=***"
    }
  ]
}

Name
id
Type
string
Description
タスクID。この形式に依存しないでください。
Name
type
Type
string
Description
タスクの種類。常に creative-lab-vinyl-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
Vinyl Figureビルドタスクでは常に "" です。
Name
negative_prompt
Type
string
Description
prompt と同様に、Vinyl Figureビルドタスクでは常に "" です。
Name
texture_prompt
Type
string
Description
prompt と同様に、Vinyl Figureビルドタスクでは常に "" です。
Name
texture_image_url
Type
string
Description
prompt と同様に、Vinyl 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。