Creative Lab — ブリックフィギュア API
元となる写真を、ブリック風のコレクティブル3Dミニフィギュアへと2段階で変換します。
プロトタイプでは、入力した写真からスタイル化されたコンセプト画像を生成し、続く
ビルドでは、そのコンセプト画像をテクスチャ付きの3Dモデルへと変換します。この2つの段階は
input_task_id によって連携されます。
POST /openapi/creative-lab/brick-figure/v1/prototypePOST /openapi/creative-lab/brick-figure/v1/build
ブリックフィギュアプロトタイプタスクの作成
元の写真から、単一のブリックスタイルのコンセプト画像を生成します。返されるタスクIDは、ビルドエンドポイントに input_task_id として渡す値です。レスポンスの形式については、
The Brick Figure 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として返されるため、被写体を任意の背景に合成できます。
返り値
レスポンスの result プロパティには、新規に作成されたブリックフィギュアプロトタイプタスクのタスク id が含まれます。Get a Task エンドポイントをポーリングするか、stream を購読して、タスクが 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 moderationによってフラグ付けされました。
- パラメータの欠落:
- Name
401 - Unauthorized- Description
認証に失敗しました。APIキーをご確認ください。
- Name
402 - Payment Required- Description
このタスクを実行するためのクレジットが不足しています。
- Name
403 - Forbidden- Description
入力画像が知的財産権侵害としてフラグ付けされました。
- Name
429 - Too Many Requests- Description
レート制限を超過しました。
Request
# 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"
}
ブリックフィギュアビルドタスクの作成
成功したプロトタイプタスクから、最終的なテクスチャ付き3Dブリックフィギュアを生成します。ビルドは画像から3Dと同じ画像から3Dへのパイプラインで実行されるため、レスポンスオブジェクトの形式と出力URLのリストは完全に一致します。レスポンスの形状については、ブリックフィギュアビルドタスクオブジェクトを参照してください。
パラメータ
- Name
- input_task_id
- Type
- string
- 必須
- Description
同じOpenAPIエンドポイント経由で作成されたプロトタイプタスクのタスクIDです。プロトタイプは同じAPIキーで作成されたものである必要があり、
SUCCEEDEDに達している必要があり、候補画像を正確に1つ生成している必要があります。webapp経由で作成されたプロトタイプタスクは受け付けられません——buildエンドポイントは
POST /openapi/creative-lab/brick-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
参照されたプロトタイプタスクが存在しないか、別のユーザーに属しているか、webapp経由で作成されました(APIモードのプロトタイプタスクのみがbuildにチェーンできます)。
- Name
429 - Too Many Requests- Description
レート制限を超過しました。
Request
# 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"
}
ブリックフィギュアタスクを取得する
有効なタスク id を指定して、プロトタイプまたはビルドタスクを取得します。URLパスは
タスクのステージと一致している必要があります。プロトタイプのタスクを
/prototype/:id で取得しようとすると404が返され、逆の場合も同様です。
レスポンスの形式については、ブリックフィギュアプロトタイプタスクオブジェクト およびブリックフィギュアビルドタスクオブジェクトを参照してください。
パラメーター
- Name
- id
- Type
- path
- Description
取得するブリックフィギュアタスクの一意の識別子です。
戻り値
レスポンスにはブリックフィギュアタスクオブジェクトが含まれます。その形式は、リクエストされた ステージによって異なります。
Request
# 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=***"
}
]
}
ブリックフィギュアタスクの削除
ブリックフィギュアタスクをキャンセルします。タスクがまだ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/brick-figure/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
ストリーミング対象のブリックフィギュアタスクを一意に識別する識別子。
戻り値
Brick Figure Prototype
または Brick Figure Build タスクオブジェクトのストリームを
Server-Sent Events として返します。各フレームには、そのステージの完全なタスクオブジェクトが含まれます — Get
エンドポイントが返すものと同じ形状です — そのため、タスクが PENDING または IN_PROGRESS の間は、
出力フィールドはまだ値が設定されておらず(null、[] または {})、finished_at は null になります。
Request
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 PENDING frame below is abbreviated 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=***"
}
]
}
フィギュアタスク一覧の取得
単一のステージに対する、ブリックフィギュアタスクのページ分けされたリストを取得します。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
1ページあたりの件数制限です。最大許容値は
100件です。
- 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/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=***"
]
}
]
ブロックフィギュア プロトタイプタスクオブジェクト
ブロックフィギュア プロトタイプタスクオブジェクトは、Meshy がソース写真からブロック風のコンセプト画像を生成するために管理する作業単位です。この段階の出力は、input_task_id を介してビルド段階に連結されます。
プロパティ
- Name
- id
- Type
- string
- Description
タスクの一意識別子です。実装の詳細としてタスク ID には k-sortable UUID を使用していますが、id のフォーマットについていかなる前提も置くべきではありません。
- Name
- type
- Type
- string
- Description
タスクのタイプです。値は
creative-lab-brick-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
タスクが作成された時刻のタイムスタンプ(ミリ秒)です。
タイムスタンプは、RFC 3339
標準に従い、1970年1月1日 UTC からの経過ミリ秒数を表します。 例えば、2023年9月1日金曜日12:00:00 PM GMT は1693569600000と表されます。これは Meshy API のすべてのタイムスタンプに適用されます。
- Name
- started_at
- Type
- timestamp
- Description
タスクが開始された時刻のタイムスタンプ(ミリ秒)です。タスクがまだ開始されていない場合、このプロパティは
nullになります。
- Name
- finished_at
- Type
- timestamp
- Description
タスクが終了した時刻のタイムスタンプ(ミリ秒)です。タスクがまだ終了していない場合、このプロパティは
nullになります。
- 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 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=***"
]
}
ブリックフィギュアビルドタスクオブジェクト
ブリックフィギュアビルドタスクオブジェクトは、Meshy が成功したプロトタイプタスクからテクスチャ付きの3Dブリックフィギュアを生成するために追跡する作業単位です。これは画像から3Dで使用されているのと同じ画像から3Dへのパイプラインを実行するため、出力フィールドはそのエンドポイントのタスクオブジェクトを反映します。
プロパティ
- Name
- id
- Type
- string
- Description
タスクの一意の識別子。
- Name
- type
- Type
- string
- Description
タスクのタイプ。値は
creative-lab-brick-figure-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
このタスクによって消費されたクレジットの数。
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 のペアを出力します。このフィールドの形状は Image to 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 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=***"
}
]
}