Creative Lab — ビニールフィギュアAPI
ソース写真を2段階でビッグヘッドのビニールコレクティブル3Dフィギュアに変換します。プロトタイプは入力写真からスタイル化されたコンセプト画像を生成し、次にビルドがそのコンセプト画像をテクスチャ付き3Dモデルに変換します。2つの段階はinput_task_idを介してリンクされています。
POST /openapi/creative-lab/vinyl-figure/v1/prototypePOST /openapi/creative-lab/vinyl-figure/v1/build
ビニールフィギュアプロトタイプタスクを作成する
ソース写真から単一のビニールフィギュアスタイルのコンセプト画像を生成します。返されたタスクIDは、input_task_idとしてビルドエンドポイントに渡します。レスポンスの形式については、ビニールフィギュアプロトタイプタスクオブジェクトを参照してください。
パラメータ
- 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として返され、任意の背景に合成できます。
戻り値
レスポンスの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
# 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"
}


ビニールフィギュアビルドタスクの作成
成功したプロトタイプタスクから最終的なテクスチャ付き3Dビニールフィギュアを生成します。ビルドは画像から3Dと同じパイプラインを使用するため、レスポンスオブジェクトの形式と出力URLのリストは完全に一致します。レスポンスの形式についてはビニールフィギュアビルドタスクオブジェクトを参照してください。
パラメータ
- Name
- input_task_id
- Type
- string
- 必須
- Description
このOpenAPIエンドポイントを介して作成されたプロトタイプタスクのタスクIDです。プロトタイプは同じAPIキーで作成され、
SUCCEEDEDに達し、正確に1つの候補画像を生成している必要があります。Webアプリを通じて作成されたプロトタイプタスクは受け付けられません — ビルドエンドポイントは
POST /openapi/creative-lab/vinyl-figure/v1/prototypeによって生成されたプロトタイプタスクのみを受け入れ、他のソースは404で拒否されます。
- Name
- name
- Type
- string
- Description
表示目的のためのオプションのタスク名です。最大100文字。
戻り値
レスポンスのresultプロパティには、新しく作成されたビニールフィギュアビルドタスクのタスクidが含まれています。タスクの取得エンドポイントをポーリングするか、タスクがSUCCEEDEDに達するまでストリームにサブスクライブし、その後model_urls.glbからテクスチャ付きGLBをダウンロードします(または、ダウンストリームパイプラインがOBJを好む場合はmodel_urls.objとmodel_urls.mtlからOBJ + MTLペアをダウンロードします)。
失敗モード
- Name
400 - Bad Request- Description
リクエストが受け入れられませんでした。一般的な原因:
- パラメータが不足しています:
input_task_idが必要です。 - 無効なUUID:
input_task_idが有効なUUIDではありません。 - 親が成功していません: 参照されたプロトタイプタスクがまだ
SUCCEEDEDに達していません。 - 候補がありません: プロトタイプタスクは成功しましたが、候補画像を生成しませんでした。
- パラメータが不足しています:
- Name
401 - Unauthorized- Description
認証に失敗しました。APIキーを確認してください。
- Name
402 - Payment Required- Description
このタスクを実行するためのクレジットが不足しています。
- Name
404 - Not Found- Description
参照されたプロトタイプタスクが存在しない、異なるユーザーに属している、またはWebアプリを通じて作成された(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/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"
}
ビニールフィギュアタスクの取得
有効なタスク id を指定して、プロトタイプまたはビルドタスクを取得します。URL パスはタスクのステージに一致する必要があります。/prototype/:id を通じてビルドタスクを取得すると 404 が返され、その逆も同様です。
レスポンスの形状については、ビニールフィギュアプロトタイプタスクオブジェクトおよびビニールフィギュアビルドタスクオブジェクトを参照してください。
パラメータ
- Name
- id
- Type
- path
- Description
取得するビニールフィギュアタスクの一意の識別子。
戻り値
レスポンスにはビニールフィギュアタスクオブジェクトが含まれます。形状は要求されたステージに依存します。
リクエスト
# 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}"
プロトタイプレスポンス
{
"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=***"
]
}
ビルドレスポンス
{
"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=***"
}
]
}
ビニールフィギュアタスクの削除
ビニールフィギュアタスクをキャンセルします。タスクがまだ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/vinyl-figure/v1/prototype/019c8a2e-4b7d-7c3a-8d21-3f2987a1c4de \
-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
ストリームするビニールフィギュアタスクの一意の識別子。
戻り値
ビニールフィギュアプロトタイプ または ビニールフィギュアビルド タスクオブジェクトを Server-Sent Events としてストリームで返します。PENDING または IN_PROGRESS のタスクの場合、レスポンスストリームには必要な progress および status フィールドのみが含まれます。
Request
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.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
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=***"
}
]
}
ビニールフィギュアタスクの一覧
単一ステージのビニールフィギュアタスクのページネーションされたリストを取得します。
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/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=***"
]
}
]
ビニールフィギュアプロトタイプタスクオブジェクト
ビニールフィギュアプロトタイプタスクオブジェクトは、Meshyが追跡する作業単位であり、ソース写真からビニールフィギュアスタイルのコンセプト画像を生成します。この段階の出力は、input_task_idを介してビルド段階に連鎖されます。
プロパティ
- Name
- id
- Type
- string
- Description
タスクの一意の識別子。タスクIDにはkソート可能なUUIDを実装の詳細として使用していますが、IDの形式については何も仮定しないでください。
- Name
- type
- Type
- string
- Description
タスクの種類。値は
creative-lab-vinyl-figure-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
タスクが作成された時のタイムスタンプ(ミリ秒単位)。
タイムスタンプは、1970年1月1日UTCから経過したミリ秒数を表し、RFC 3339
標準に従います。例えば、2023年9月1日金曜日12:00:00 PM 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
- image_urls
- Type
- array of strings
- Description
このプロトタイプタスクによって生成されたコンセプト画像候補のダウンロード可能なURL。現在、APIは常に正確に1つの候補を返しますが、このフィールドは将来的な改訂で複数の候補を表面化できるように配列になっています。
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=***"
]
}
ビニールフィギュアビルドタスクオブジェクト
ビニールフィギュアビルドタスクオブジェクトは、Meshyが追跡する作業単位であり、成功したプロトタイプタスクからテクスチャ付きの3Dビニールフィギュアを生成します。これは画像から3Dで使用される同じ画像から3Dへのパイプラインを実行するため、出力フィールドはそのエンドポイントのタスクオブジェクトを反映しています。
プロパティ
- Name
- id
- Type
- string
- Description
タスクの一意の識別子。
- Name
- type
- Type
- string
- Description
タスクの種類。値は
creative-lab-vinyl-figure-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
- prompt
- Type
- string
- Description
ビニールフィギュアビルドでは常に空です。画像から3Dで使用される共有
V2ImageTo3DTaskResponse形状とのクロスエンドポイント互換性のために存在します。
- Name
- negative_prompt
- Type
- string
- Description
ビニールフィギュアビルドでは常に空です。クロスエンドポイント互換性のために存在します。
- Name
- texture_prompt
- Type
- string
- Description
ビニールフィギュアビルドでは常に空です。クロスエンドポイント互換性のために存在します。
- Name
- texture_image_url
- Type
- string
- Description
ビニールフィギュアビルドでは常に空です。クロスエンドポイント互換性のために存在します。
- Name
- model_urls
- Type
- object
- Description
生成された3Dモデルのダウンロード可能なURL。ビニールフィギュアビルドは、テクスチャ付きGLBとWavefront OBJを好むパイプラインのためのOBJ + MTLペアを生成します。このフィールドの形状は、将来のフォーマット追加が破壊的変更なしにスロットインできるように画像から3D model_urlsオブジェクトに一致しています。
- Name
glb- Type
- string
- Description
テクスチャ付きGLBファイルのダウンロード可能なURL。
- Name
obj- Type
- string
- Description
Wavefront OBJファイル(ジオメトリ + UV)のダウンロード可能な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
このタスクによって生成されたテクスチャURLオブジェクトの配列。現在はベースカラーマップを含む単一のオブジェクトが含まれています。
- Name
base_color- Type
- string
- Description
ベースカラーマップ画像のダウンロード可能なURL。
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=***"
}
]
}