マルチ画像から3D API
同一の被写体を異なる角度から撮影した1枚から4枚の画像から、3Dモデルを生成します。
マルチ画像から3Dタスクを作成する
マルチ画像から3Dタスクを作成します。タスクはバックグラウンドで実行されます。タスクに通常どのくらいの時間がかかるかについては、処理時間を参照してください。タスクが持つフィールドについては、マルチ画像から3Dタスクオブジェクトを参照してください。
Request
# Simple request
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"image_urls": [
"<your publicly accessible image url or base64-encoded data URI>",
"<your second publicly accessible image url or base64-encoded data URI>"
]
}'
# With Ultra 2K geometry, PBR texturing, and GLB format
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"image_urls": [
"<your publicly accessible image url or base64-encoded data URI>",
"<your second publicly accessible image url or base64-encoded data URI>"
],
"ai_model": "meshy-7.1",
"geometry_resolution": "2k",
"should_texture": true,
"enable_pbr": true,
"target_formats": ["glb"]
}'
Response
{
"result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
パラメータ
- Name
- input_task_id
- Type
- string
- 必須
- Description
image_urlsを送信しない場合は必須です。Text to Image タスクまたは Image to Image タスク(マルチビューのものを含む)のIDです。Meshy はその1〜4枚の画像を入力として使用します。タスクはAPIで作成し、ステータスがSUCCEEDEDのものである必要があります。
- Name
- image_urls
- Type
- array
- 必須
- Description
input_task_idを送信しない場合は必須です。1〜4枚の画像を、それぞれ公開URLまたはData URI(例:data:image/jpeg;base64,<your base64-encoded image data>)として指定します。両方を送信した場合、Meshy はinput_task_idを使用します。各画像は
.jpg、.jpeg、.png、.webpのいずれかの形式で、最大20MBである必要があります。4枚を超える画像を送信すると400が返されます。最良の結果を得るには、画像は同じオブジェクトを異なる角度から撮影したものにしてください。
meshy-7.1またはlatestでは、Meshy は最初の画像を正面ビューとして使用し、他の画像の順序は関係ありません。
- Name
- ai_model
- Type
- string
- デフォルト latest
- Description
3Dモデルを生成するAIモデルです。
利用可能な値:
latest: Meshy 7.1meshy-7.1meshy-6meshy-6-litemeshy-7: 非推奨。代わりにmeshy-7.1を送信してください
- Name
- geometry_resolution
- Type
- string
- デフォルト standard
- Description
生成するジオメトリの詳細度です。
利用可能な値:
standard2k: 2048³でUltraパスを実行します。meshy-7.1、latest、または非推奨のmeshy-7が必要です。
- Name
- ultra_mode
- Type
- boolean
- ⚠ 非推奨
- デフォルト false
- Description
代わりに
geometry_resolutionを送信してください。ultra_mode: trueはgeometry_resolution: "2k"と同じです。
- Name
- should_texture
- Type
- boolean
- デフォルト true
- Description
テクスチャを生成するかどうかです。
trueの場合はテクスチャ付きモデルを返し、falseの場合はテクスチャ生成ステップをスキップしてテクスチャなしのメッシュを返します。
should_texture = true- Name
- enable_pbr
- Type
- boolean
- デフォルト false
- Description
ベースカラーに加えて、メタリック、ラフネス、ノーマルマップも生成するかどうかです。
meshy-6の場合、Meshy はtexture_resolution: 8kを除いてエミッションマップも生成します。他のモデルではエミッションマップは生成されません。
- Name
- texture_resolution
- Type
- string
- デフォルト 2k
- Description
ベースカラーテクスチャのサイズです。サイズが大きいほど、より多くの表面の詳細を捉えられます。
利用可能な値:
2k: 2048×20484k: 4096×40968k: 8192×8192
4kと8kにはmeshy-6、meshy-7.1、またはlatestが必要です。8kでは、Meshy はエミッションマップを生成しません。
- Name
- hd_texture
- Type
- boolean
- ⚠ 非推奨
- デフォルト false
- Description
代わりに
texture_resolutionを送信してください。hd_texture: trueはtexture_resolution: "4k"と同じです。両方を送信した場合、Meshy はtexture_resolutionを使用します。
- Name
- texture_prompt
- Type
- string
- Description
テクスチャを指示するテキストです。最大800文字まで指定できます。これより長いテキストを送信すると
400が返されます。
- Name
- texture_image_url
- Type
- string
- Description
テクスチャを指示する1枚の2D画像を、公開URLまたはData URI(例:
data:image/jpeg;base64,<your base64-encoded image data>)として指定します。画像は.jpg、.jpeg、.png、.webpのいずれかの形式で、最大20MBである必要があります。texture_image_urlとtexture_promptの両方を送信した場合、Meshy はtexture_promptを使用します。画像内の形状が3Dモデルと大きく異なる場合、テクスチャがうまく仕上がらないことがあります。
- Name
- texture_image_urls
- Type
- string[]
- Description
テクスチャを指示する、異なる視点から撮影したオブジェクトの1〜4枚の画像です。Meshy は最初の画像を正面ビューとして使用します。他のビュー(左、背面、右)の順序は関係ありません。
各画像は
texture_image_urlと同じルールに従います。公開URLまたはData URIで、.jpg、.jpeg、.png、.webp形式、最大20MBです。これらの画像はテクスチャのみを指示するものであり、
image_urlsには依存しません。2つのリストには異なる画像、異なる枚数の画像を含めることができます。texture_image_urlsにはmeshy-7.1、latest、または非推奨のmeshy-7が必要です。texture_image_urlやtexture_promptと一緒に送信することはできません。
- Name
- should_remesh
- Type
- boolean
- デフォルト true (meshy-6-lite), false (other models)
- Description
生成後にモデルをリメッシュするかどうかです。最高品質の3Dモデルを得るには、
falseに設定してください。
should_remesh = true- Name
- topology
- Type
- string
- デフォルト triangle
- Description
リメッシュ後のモデルの面タイプです。
利用可能な値:
quad: クアッド主体のメッシュtriangle: 削減された三角形メッシュ
- Name
- target_polycount
- Type
- integer
- デフォルト 30000
- Description
目標とする面の数で、
100から300000までです。結果はモデルのジオメトリによって目標値と異なる場合があります。範囲外の値を送信すると400が返されます。
- Name
- decimation_mode
- Type
- integer
- Description
レベル別のアダプティブな面数です。これを設定すると、Meshy は
target_polycountを無視します。利用可能な値:
1: ultra2: high3: medium4: low
- Name
- save_pre_remeshed_model
- Type
- boolean
- デフォルト false
- Description
リメッシュ前のGLBも保存するかどうかです。保存した場合、
model_urls.pre_remeshed_glbとして返されます。
- Name
- symmetry_mode
- Type
- string
- ⚠ 非推奨
- デフォルト auto
- Description
省略してください。出力には影響しません。
利用可能な値:
off: 対称なしauto: 入力ジオメトリに基づく対称on: 強制的な対称
- Name
- pose_mode
- Type
- string
- デフォルト ""
- Description
生成されるモデルのポーズです。
利用可能な値:
a-pose: Aポーズt-pose: Tポーズ""(空文字列): 特定のポーズなし
- Name
- is_a_t_pose
- Type
- boolean
- ⚠ 非推奨
- デフォルト false
- Description
代わりに
pose_modeを送信してください。モデルをAポーズまたはTポーズで生成するかどうかです。
- Name
- image_enhancement
- Type
- boolean
- デフォルト true
- Description
生成前に入力画像を最適化するかどうかです。
falseの場合、入力画像の見た目をそのまま維持し、スタイル処理を行いません。meshy-6、meshy-7.1、latestでのみサポートされます。meshy-6-liteと一緒に送信すると400が返されます。
- Name
- remove_lighting
- Type
- boolean
- デフォルト true
- Description
ベースカラーテクスチャからハイライトと影を除去するかどうかです。クリーンな結果は、お使いのライティング環境下でより良く機能します。これを使用するのは
meshy-6のみです。meshy-7、meshy-7.1、latestはこれを受け付けますが、無視します。texture_resolution: 8kの場合、Meshy は常にライティングを除去します。meshy-6-liteと一緒に送信すると400が返されます。
- Name
- moderation
- Type
- boolean
- デフォルト false
- Description
入力に有害なコンテンツが含まれていないかをチェックするかどうかです。Meshy は各入力画像、
texture_image_urlまたはtexture_image_urls内の各画像、およびtexture_prompt内のテキストをチェックします。Meshy が有害なコンテンツを検出した場合、リクエストは400を返し、Meshy はタスクを作成しません。
- Name
- target_formats
- Type
- string[]
- Description
生成する3Dファイル形式です。Meshy はリストされた形式のみを生成して返すため、タスクの時間を短縮できます。
利用可能な値:
glbobjfbxstlusdz3mf
省略した場合、Meshy は
3mfを除くすべての形式を生成します。Meshy は3mfをリストに含めた場合にのみ生成します。
- Name
- auto_size
- Type
- boolean
- デフォルト false
- Description
AIビジョンを使ってオブジェクトの実際の高さを推定し、モデルをそのサイズにリサイズするかどうかです。
origin_atを設定しない限り、Meshy は原点を底面に配置します。
auto_size = true- Name
- origin_at
- Type
- string
- デフォルト bottom
- Description
モデルの原点をどこに配置するかです。
bottomまたはcenterです。
- Name
- alpha_thumbnail
- Type
- boolean
- デフォルト false
- Description
透明な背景(RGBA)のプレビューも生成するかどうかです。生成した場合、タスクを取得する際に
alpha_thumbnail_urlとして返されます。thumbnail_urlは変わりません。
- Name
- multi_view_thumbnails
- Type
- boolean
- デフォルト false
- Description
正面、右、背面、左のプレビューも生成するかどうかです。生成した場合、タスクを取得する際に
thumbnail_urlsとして返されます。thumbnail_urlは変わらず、引き続き正面ビューを表示します。これにより、タスクの時間が約5秒増加します。
戻り値
レスポンスの result フィールドには、新しく作成されたマルチ画像から3DタスクのIDが格納されます。
失敗モード
- Name
400 - Bad Request- Description
リクエストを実行できません。エラーメッセージには、検出された問題が示されます。例:
- パラメータの不足:
image_urlsとinput_task_idのどちらも送信されませんでした。 - 無効な入力タスク:
input_task_idがSUCCEEDEDの Text to Image タスクまたは Image to Image タスク(マルチビューのものを含む)ではありません。 - 無効な画像数:
image_urlsまたはtexture_image_urlsに1〜4枚の画像が含まれていません。 - 無効な画像形式:
image_urls内の画像がサポートされている形式ではありません。 - テクスチャ入力の競合:
texture_image_urlsがtexture_image_url、texture_prompt、またはshould_texture: falseと一緒に送信されました。 - マルチビューテクスチャに非対応のモデル:
texture_image_urlsがmeshy-6またはmeshy-6-liteと一緒に送信されました。 - 到達不能なURL: Meshy が
image_urlsまたはtexture_image_urls内の画像をダウンロードできません。 - 画像が大きすぎる:
image_urls、texture_image_url、またはtexture_image_urls内の画像が20MBを超えています。 - マルチ画像入力でサポートされていない解像度:
geometry_resolutionが"4k"ですが、このエンドポイントではサポートされていません。2kまたはstandardを使用してください。 - 画像オプションに非対応のモデル:
image_enhancementまたはremove_lightingがai_model: "meshy-6-lite"と一緒に送信されました。
リクエストを修正してから、再度送信してください。エラーを参照してください。
- パラメータの不足:
- Name
401 - Unauthorized- Description
APIキーが見つからないか無効です。
Authorizationヘッダーを確認してください。
- Name
402 - Payment Required- Description
例:
- クレジット不足: アカウントにこのタスクを実行するための十分なクレジットがないか、アカウントがクレジット上限に達しています。クレジット残高を確認してから、再試行してください。
- 無料プラン: タスクの作成には有料プランが必要です。サブスクリプション設定でプランをアップグレードしてから、再試行してください。
- Name
404 - Not Found- Description
input_task_idがどのタスクとも一致しません。タスクIDを確認してから、再度リクエストを送信してください。
- Name
429 - Too Many Requests- Description
レート制限を超えました。しばらく待ってから再試行してください。レート制限を参照してください。
マルチ画像から3Dタスクを取得する
IDを指定してマルチ画像から3Dタスクを返します。
Request
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "multi-image-to-3d",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
"fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
"usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
"stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
"pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
"thumbnail_urls": {
"front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
"right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
"back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
"left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
},
"texture_prompt": "",
"progress": 100,
"started_at": 1692771667037,
"created_at": 1692771650657,
"expires_at": 1692771679037,
"finished_at": 1692771669037,
"status": "SUCCEEDED",
"texture_urls": [
{
"base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
"metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
"normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
"roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX"
}
],
"preceding_tasks": 0,
"task_error": {
"message": ""
},
"consumed_credits": 30
}
マルチ画像から3Dタスクを削除
マルチ画像から3Dタスクを、そのモデルやデータも含めて完全に削除します。削除を取り消すことはできません。
Request
curl --request DELETE \
--url https://api.meshy.ai/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS. The task keeps running:
{
"message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}
パスパラメータ
- Name
- id
- Type
- path
- Description
削除するタスクのID。
タスクのステータス
PENDING のタスクを削除すると、作成時に使用したクレジットが返金されます。
IN_PROGRESS のタスクは削除できません。リクエストは 409 Conflict を返し、
タスクは実行を続けます。Meshyはすでに開始されたタスクについては返金を行わないため、
削除するとクレジットと結果の両方を失うことになります。タスクが
SUCCEEDED、FAILED、または CANCELED のいずれかに達するのを待ってから削除してください。
最終ステータス(SUCCEEDED、FAILED、または CANCELED)にあるタスクを削除しても、
クレジットは返金されません。
戻り値
タスクが削除された場合は 200 OK、タスクが IN_PROGRESS の場合は 409 Conflict が返されます。
マルチ画像から3Dタスクの一覧取得
あなたのマルチ画像から3Dタスクの一覧を返します。
Request
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
[
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "multi-image-to-3d",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
"fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
"usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
"pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
"thumbnail_urls": {
"front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
"right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
"back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
"left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
},
"texture_prompt": "",
"progress": 100,
"started_at": 1692771667037,
"created_at": 1692771650657,
"expires_at": 1692771679037,
"finished_at": 1692771669037,
"status": "SUCCEEDED",
"texture_urls": [
{
"base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
"metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
"normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
"roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX"
}
],
"preceding_tasks": 0,
"task_error": {
"message": ""
},
"consumed_credits": 30
}
]
パラメータ
- Name
- page_num
- Type
- integer
- デフォルト 1
- Description
返すページ番号。
1から始まります。
- Name
- page_size
- Type
- integer
- デフォルト 10
- Description
1ページあたりのタスク数。最大
100まで。
- Name
- sort_by
- Type
- string
- Description
ソート順。
利用可能な値:
+created_at:古い順-created_at:新しい順
返り値
マルチ画像から3Dタスクオブジェクトのページネーションされたリスト。
マルチ画像から3Dタスクをストリーミングする
マルチ画像から3Dタスクの更新をServer-Sent Events(SSE)としてストリーミングします。
Request
curl -N https://api.meshy.ai/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response Stream
// Error event example
event: error
data: {
"status_code": 404,
"message": "Task not found"
}
// Message event examples illustrate task progress.
// These examples are shortened. Each event holds the full task object.
event: message
data: {
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"progress": 0,
"status": "PENDING"
}
event: message
data: {
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "multi-image-to-3d",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
"fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
"usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
"stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
"pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
"thumbnail_urls": {
"front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
"right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
"back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
"left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
},
"texture_prompt": "",
"progress": 100,
"started_at": 1692771667037,
"created_at": 1692771650657,
"expires_at": 1692771679037,
"finished_at": 1692771669037,
"status": "SUCCEEDED",
"texture_urls": [
{
"base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
"metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
"normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
"roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX"
}
],
"preceding_tasks": 0,
"task_error": {
"message": ""
},
"consumed_credits": 30
}
パラメータ
- Name
- id
- Type
- path
- Description
作成レスポンスに含まれるタスクID。
返り値
マルチ画像から3DタスクオブジェクトのストリームをServer-Sent Eventsとして返します。
各イベントには、Get エンドポイントが返すものと同じ形式で、タスクオブジェクト全体が保持されています。タスクが PENDING または IN_PROGRESS の間は、結果フィールドにはまだ値が入っていません。
マルチ画像から3D タスクオブジェクト
マルチ画像から3D タスクオブジェクトは、1つのオブジェクトの1〜4枚の画像から1つの3Dモデルを生成する処理を表します。タスクのステータス、progress、そしてタスクが成功した場合のモデルファイルを保持します。
プロパティ
Example Multi-Image to 3D Task Object
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "multi-image-to-3d",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
"fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
"usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
"stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
"pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
"thumbnail_urls": {
"front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
"right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
"back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
"left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
},
"texture_prompt": "",
"progress": 100,
"started_at": 1692771667037,
"created_at": 1692771650657,
"expires_at": 1692771679037,
"finished_at": 1692771669037,
"status": "SUCCEEDED",
"texture_urls": [
{
"base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
"metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
"normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
"roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX"
}
],
"preceding_tasks": 0,
"task_error": {
"message": ""
},
"consumed_credits": 30
}
- Name
- id
- Type
- string
- Description
タスクID。不透明な文字列として扱い、そのフォーマットに依存しないでください。
- Name
- type
- Type
- string
- Description
タスクタイプ。常に
multi-image-to-3dです。
- Name
- model_urls
- Type
- object
- Description
生成された3DモデルのダウンロードURLで、ファイル形式ごとに1つずつ用意されます。タスクが生成しなかった形式については、空の文字列ではなくキー自体が存在しません。
- Name
glb- Type
- string
- Description
GLBファイル。
- Name
fbx- Type
- string
- Description
FBXファイル。
- Name
obj- Type
- string
- Description
OBJファイル。
- Name
usdz- Type
- string
- Description
USDZファイル。
- Name
mtl- Type
- string
- Description
MTLファイル。モデルにテクスチャがある場合、OBJファイルと一緒に返されます。
- Name
stl- Type
- string
- Description
STLファイル。
- Name
3mf- Type
- string
- Description
3MFファイル。
target_formatsに3mfが含まれる場合のみ存在します。
- Name
pre_remeshed_glb- Type
- string
- Description
リメッシュ前のGLBファイル。
should_remesh: trueとsave_pre_remeshed_model: trueの両方を指定してタスクを作成した場合のみ存在します。
- Name
- thumbnail_url
- Type
- string
- Description
モデルのプレビュー画像のダウンロードURL。
thumbnail_urls.frontが存在する場合、それと同一の値になります。
- Name
- alpha_thumbnail_url
- Type
- string
- Description
thumbnail_urlの背景を透過(RGBA)にしたバージョンのダウンロードURL。alpha_thumbnail: trueを指定してタスクを作成し、Meshyが透過プレビューをレンダリングした場合のみ存在します。
- Name
- thumbnail_urls
- Type
- object
- Description
3Dモデルを4方向から見たプレビューのダウンロードURL。それぞれは512×512のPNGへの署名付きURLで、
thumbnail_urlと同じマテリアルとライティングでレンダリングされています。GLBをダウンロードせずに、複数の角度からモデルをプレビューするために利用できます。multi_view_thumbnails: trueを指定してタスクを作成し、タスクがSUCCEEDEDに達した場合のみ存在します。multi_view_thumbnails: trueを指定せずに作成されたタスクには、このフィールドはありません。- Name
- front
- Type
- string
- Description
正面ビュー。垂直軸周りの角度は0°です。
thumbnail_urlと一致します。
- Name
- right
- Type
- string
- Description
右側ビュー。角度は90°です。
- Name
- back
- Type
- string
- Description
背面ビュー。角度は180°です。
- Name
- left
- Type
- string
- Description
左側ビュー。角度は270°です。
- Name
- texture_prompt
- Type
- string
- Description
テクスチャの生成を導いたテキストprompt。
- Name
- texture_image_urls
- Type
- string[]
- Description
タスク作成時に使用したテクスチャ参照画像のダウンロードURLで、送信した順序で並びます。
texture_image_urlsを指定してタスクを作成した場合のみ存在します。
- Name
- ultra_mode
- Type
- boolean
- ⚠ 非推奨
- Description
代わりに
geometry_resolutionを参照してください。
- Name
- geometry_resolution
- Type
- string
- Description
タスクが実行されたUltraティア。値は
2kです。standardのタスクにはこのフィールドはありません。
- Name
- progress
- Type
- integer
- Description
タスクの進行度をパーセンテージで示します。タスクが開始するまでは
0、成功すると100になります。
- Name
- started_at
- Type
- timestamp
- Description
タスクが開始した時刻(UnixミリISEC秒)。タスクが開始するまでは
0です。
- Name
- created_at
- Type
- timestamp
- Description
タスクが作成された時刻(Unixミリ秒)。
- Name
- expires_at
- Type
- timestamp
- Description
タスクの結果が失効する時刻(Unixミリ秒)。
- Name
- finished_at
- Type
- timestamp
- Description
タスクが終了した時刻(Unixミリ秒)。タスクが終了するまでは
0です。
- Name
- status
- Type
- string
- Description
タスクのステータス。
PENDING、IN_PROGRESS、SUCCEEDED、FAILED、CANCELEDのいずれかです。
- Name
- texture_urls
- Type
- array
- Description
タスクが生成したテクスチャマップのダウンロードURLを、オブジェクトの配列として保持します。通常は1つのオブジェクトのみを保持します。各オブジェクトには次のフィールドがあります。
- Name
base_color- Type
- string
- Description
ベースカラーマップ。
- Name
metallic- Type
- string
- Description
メタリックマップ。
enable_pbr: falseを指定してタスクを作成した場合は含まれません。
- Name
normal- Type
- string
- Description
ノーマルマップ。
enable_pbr: falseを指定してタスクを作成した場合は含まれません。
- Name
roughness- Type
- string
- Description
ラフネスマップ。
enable_pbr: falseを指定してタスクを作成した場合は含まれません。
- Name
emission- Type
- string
- Description
エミッションマップ。
ai_model: meshy-6かつenable_pbr: trueで、texture_resolutionが2kまたは4kのときにタスクを作成した場合のみ含まれます。
- Name
- preceding_tasks
- Type
- integer
- Description
キュー内でこのタスクより前にあるタスクの数。この値はタスクが
PENDINGの間のみ意味を持ちます。
- Name
- task_error
- Type
- object
- Description
タスクが失敗した場合のエラー詳細。エラーを参照してください。
- Name
- consumed_credits
- Type
- integer
- Description
タスクが使用したクレジットの数。ステータスが
PENDING、IN_PROGRESS、SUCCEEDEDのいずれかの場合に存在します。FAILEDのタスクでは0になります。これは、タスクが失敗した場合、Meshyがクレジットを返金するためです。