マルチ画像から3D API
マルチ画像から3D APIは、Meshyのマルチ画像から3D機能を独自のアプリケーションに統合できる機能です。このセクションでは、 このAPIを使い始めるために必要なすべての情報を紹介します。
Multi-Image to 3Dタスクを作成する
このエンドポイントを使用すると、新しいMulti-Image to 3Dタスクを作成できます。Multi-Image to 3Dタスクオブジェクトに含まれるプロパティについては、The Multi-Image to 3D Task Objectを参照してください。
このタスクはバックグラウンドで実行されます。通常の所要時間については、Processing Timesを参照してください。
パラメータ
input_task_idまたはimage_urlsのいずれか一方のみが必須です。両方が指定された場合は、input_task_idが優先されます。
- Name
- input_task_id
- Type
- string
- 必須
- Description
入力として使用する、完了済みの画像生成タスクのID(出力は1〜4枚の画像)。このタスクは、Text to Image、Image to Image、Text to Image Multi-View、またはImage to Image Multi-Viewのいずれかである必要があります。さらに、APIを介して実行され、ステータスが
SUCCEEDEDである必要があります。
- Name
- image_urls
- Type
- array
- 必須
- Description
Meshyがモデル作成に使用する画像を1〜4枚指定します。現在サポートしている形式は
.jpg、.jpeg、.png、.webpです。最良の結果を得るには、すべての画像が同じオブジェクトを異なる角度から写したものである必要があります。最大ファイルサイズ:画像1枚あたり20MB。
各画像の指定方法は2通りあります。
- 一般公開されているURL:インターネット上の誰からでもアクセス可能なURL。
- Data URI:画像をbase64エンコードしたdata URI。例:
data:image/jpeg;base64,<your base64-encoded image data>。
meshy-7.1(またはlatest)の場合、最初の画像が主要(正面)ビューとして使用されます。残りの画像の順序は問いません。
- Name
- ai_model
- Type
- string
- デフォルト latest
- Description
使用するモデルのID。
利用可能な値:
meshy-6-lite、meshy-6、meshy-7.1、latest(Meshy 7.1)meshy-7(非推奨):代わりにmeshy-7.1を使用してください。
- Name
- geometry_resolution
- Type
- string
- デフォルト standard
- Description
ジオメトリ生成パス。
2kは2048³でUltraパスを実行します。meshy-7.1またはlatestが必要です。利用可能な値:
standard、2k
- Name
- ultra_mode
- Type
- boolean
- ⚠ 非推奨
- デフォルト false
- Description
代わりに
geometry_resolutionを使用してください。ultra_mode: trueはgeometry_resolution: "2k"と同等です。
- Name
- should_texture
- Type
- boolean
- デフォルト true
- Description
テクスチャを生成するかどうかを決定します。
falseに設定すると、テクスチャ生成フェーズがスキップされ、テクスチャのないメッシュが提供されます。
should_texture = true- Name
- enable_pbr
- Type
- boolean
- デフォルト false
- Description
ベースカラーに加えて、PBRマップ(メタリック、ラフネス、ノーマル)を生成します。
ai_modelがmeshy-6の場合、texture_resolution: 8kを除き、エミッションマップも含まれます。meshy-6-lite、meshy-7.1、latestではエミッションマップは生成されません。
- Name
- texture_resolution
- Type
- string
- デフォルト 2k
- Description
ベースカラーテクスチャの解像度。
2k(2048×2048)、4k(4096×4096)、8k(8192×8192)のいずれかです。解像度が高いほど、より多くの表面の詳細を捉えることができます。4kと8kには、ai_modelとしてmeshy-6、meshy-7.1、またはlatestが必要です。8kの場合、エミッションマップは生成されません。
- Name
- hd_texture
- Type
- boolean
- ⚠ 非推奨
- デフォルト false
- Description
代わりに
texture_resolutionを使用してください —texture_resolution: "4k"と同等です。両方が設定されている場合は、texture_resolutionが優先されます。
- Name
- texture_prompt
- Type
- string
- Description
テクスチャ生成プロセスを誘導するテキストprompt。最大800文字。
- Name
- texture_image_url
- Type
- string
- Description
テクスチャ生成プロセスを誘導する2D画像を指定します。現在サポートしている形式は
.jpg、.jpeg、.png、.webpです。最大ファイルサイズ:20MB。
画像の指定方法は2通りあります。
- 一般公開されているURL:インターネット上の誰からでもアクセス可能なURL
- Data URI:画像をbase64エンコードしたdata URI。例:
data:image/jpeg;base64,<your base64-encoded image data>
元のアセットとアップロードした画像との間にジオメトリの大きな差異がある場合、画像によるテクスチャ生成が最適に機能しないことがあります。テクスチャ生成プロセスを誘導するために使用できるのは、
texture_image_urlまたはtexture_promptのいずれか一方のみです。両方のパラメータが指定された場合、デフォルトではtexture_promptがモデルのテクスチャ生成に使用されます。
- Name
- texture_image_urls
- Type
- string[]
- Description
テクスチャ生成を誘導するために、同じオブジェクトを異なるビューから写した画像を1〜4枚指定します。最初の画像が主要(正面)ビューであり、残りのビュー(左、背面、右)の順序は問いません。
各要素は
texture_image_urlと同じ形式(一般公開されているURL、またはbase64のdata URI、.jpg/.jpeg/.png/.webp)を受け付けます。最大ファイルサイズ:画像1枚あたり20MB。
これらの画像はテクスチャのみを誘導するものであり、
image_urlsとは独立しています — この2つのリストには異なる画像、異なる枚数の画像を含めることができます。ai_modelとしてmeshy-7.1またはlatestが必要です。texture_image_urlまたはtexture_promptと組み合わせることはできません。
- Name
- should_remesh
- Type
- boolean
- デフォルト false (Meshy 6 and Meshy 7 models), true (others)
- Description
リメッシュフェーズを有効にするかどうかを制御します。最高品質のモデルを得るには、
should_remeshをfalseに設定することをお勧めします。
should_remesh = true- Name
- topology
- Type
- string
- デフォルト triangle
- Description
生成されるモデルのtopologyを指定します。
利用可能な値:
quad:クアッドが主体のメッシュを生成します。triangle:デシメーションされた三角形メッシュを生成します。
- Name
- target_polycount
- Type
- integer
- デフォルト 30,000
- Description
生成されるモデルの目標ポリゴン数を指定します。実際のポリゴン数は、ジオメトリの複雑さによって目標値から変動する場合があります。
有効な値の範囲はユーザー階層によって異なります:
- 100〜300,000(両端を含む)
- Name
- decimation_mode
- Type
- integer
- Description
ポリゴン数レベルを設定することで、アダプティブデシメーションを有効にします。設定すると、
target_polycountは無視されます。利用可能な値:
1:アダプティブ — ウルトラポリゴン数。2:アダプティブ — 高ポリゴン数。3:アダプティブ — 中ポリゴン数。4:アダプティブ — 低ポリゴン数。
- Name
- save_pre_remeshed_model
- Type
- boolean
- デフォルト false
- Description
trueに設定すると、Meshyはリメッシュフェーズが完了する前のGLBファイルも追加で保存します。
- Name
- symmetry_mode
- Type
- string
- ⚠ 非推奨
- デフォルト auto
- Description
非推奨。このパラメータは出力に影響を与えなくなりました。
symmetry_modeフィールドは、モデル生成プロセス中の対称動作を制御します。有効な値:
off:対称を無効にします。auto:入力ジオメトリに基づいて対称を自動的に判定し、適用します。on:生成中に対称を強制します。
- Name
- pose_mode
- Type
- string
- デフォルト ""
- Description
生成されるモデルのポーズmodeを指定します。
利用可能な値:
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に設定します。ai_modelがmeshy-6、meshy-7.1、またはlatestの場合にのみサポートされます。
- Name
- remove_lighting
- Type
- boolean
- デフォルト true
- Description
ベースカラーテクスチャからハイライトと影を除去し、カスタムの照明設定下でより効果を発揮する、よりクリーンな結果を生成します。
ai_modelがmeshy-6、meshy-7.1、またはlatestの場合にのみサポートされます。
- Name
- moderation
- Type
- boolean
- デフォルト false
- Description
trueに設定すると、入力コンテンツが有害な可能性のあるコンテンツについて自動的にスクリーニングされます。有害なコンテンツが検出された場合、タスクは生成に進みません。image_urlsの各画像とtexture_promptのテキストがスクリーニングされます。
- Name
- target_formats
- Type
- string[]
- Description
出力に含める3Dファイル形式を指定します。指定された形式のみが生成・返却されるため、タスクの完了時間を短縮できる場合があります。
利用可能な値:
glb、obj、fbx、stl、usdz、3mf省略した場合、
3mfを除くすべての形式が生成されます。3mfは明示的に指定された場合にのみ含まれます。
- Name
- auto_size
- Type
- boolean
- デフォルト false
- Description
trueに設定すると、サービスはAIビジョンを使用してオブジェクトの実世界での高さを自動的に推定し、それに応じてモデルのサイズを変更します。origin_atが明示的に設定されていない限り、原点はデフォルトでbottomになります。
- Name
- alpha_thumbnail
- Type
- boolean
- デフォルト false
- Description
trueに設定すると、タスクは透明背景(RGBA)版のプレビューも追加でレンダリングし、GETレスポンスのalpha_thumbnail_urlとして返します。既存のthumbnail_urlフィールドは変更されません。
- Name
- multi_view_thumbnails
- Type
- boolean
- デフォルト false
- Description
trueに設定すると、タスクは4つの基本方向のビューサムネイル(正面、右、背面、左)を追加でレンダリングし、GETレスポンスのthumbnail_urlsとして返します。既存のthumbnail_urlフィールドは変更されず、引き続き正面ビューを指しているため、既存のクライアントに影響はありません。タスクのレイテンシに約3秒追加されます。
auto_size = true- Name
- origin_at
- Type
- string
- デフォルト bottom
- Description
auto_sizeが有効な場合の原点の位置。利用可能な値:bottom、center。
戻り値
レスポンスのresultプロパティには、新しく作成されたMulti-Image to 3Dタスクのタスクidが含まれます。
失敗モード
- Name
400 - Bad Request- Description
リクエストが受け入れられませんでした。よくある原因:
- パラメータの不足:
image_urlsまたはinput_task_idのいずれかを指定する必要があります。 - 無効な入力タスク:
input_task_idは、SUCCEEDED状態のText to Image、Image to Image、またはmulti-viewバリアントタスクを参照している必要があります。 - 無効な画像枚数:
image_urlsには1〜4枚の画像を含める必要があり、texture_image_urlsには1〜4枚を含める必要があります。 - 無効な画像形式:
image_urls内の1つ以上の画像がサポートされていない形式です。 - 競合するテクスチャ入力:
texture_image_urlsはtexture_image_urlまたはtexture_promptと組み合わせることができず、should_texture: trueが必要です。 - マルチビューテクスチャでサポートされていないモデル:
texture_image_urlsにはai_modelとしてmeshy-7.1またはlatestが必要です。 - 到達不能なURL:
image_urlsまたはtexture_image_urlsの1つ以上の要素をダウンロードできませんでした。 - 画像サイズが大きすぎる:
image_urls、texture_image_url、またはtexture_image_urlsの1つ以上の画像が20MBを超えています。 - マルチ画像入力でサポートされていない解像度:
geometry_resolution: "4k"はこのエンドポイントでは利用できません。2kまたはstandardを使用してください。
- パラメータの不足:
- Name
401 - Unauthorized- Description
認証に失敗しました。APIキーを確認してください。
- Name
402 - Payment Required- Description
このタスクを実行するためのクレジットが不足しています。
- Name
429 - Too Many Requests- Description
レート制限を超過しました。
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"
}
マルチ画像から3Dタスクを取得する
このエンドポイントでは、有効なタスクidを指定してマルチ画像から3Dタスクを取得できます。
マルチ画像から3Dタスクオブジェクトに含まれるプロパティについては、マルチ画像から3Dタスクオブジェクトを参照してください。
パラメータ
- Name
- id
- Type
- path
- Description
取得するマルチ画像から3Dタスクの一意の識別子です。
戻り値
レスポンスにはマルチ画像から3Dタスクオブジェクトが含まれます。詳細は マルチ画像から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",
"emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
}
],
"preceding_tasks": 0,
"task_error": {
"message": ""
},
"consumed_credits": 30
}
マルチ画像から3Dタスクを削除
このエンドポイントは、関連するすべてのモデルとデータを含め、マルチ画像から3Dタスクを完全に削除します。この操作は元に戻せません。
パスパラメータ
- Name
- id
- Type
- path
- Description
削除するマルチ画像から3Dタスクの ID。
タスクステータス
まだ PENDING の状態のタスクは削除され、作成時に消費されたクレジットは払い戻されます。
すでに IN_PROGRESS の状態のタスクは削除できません。リクエストは
409 Conflict で拒否され、タスクは実行され続けます。ワーカーがすでに開始したタスクのクレジットは
払い戻し不可のため、実行中に削除するとクレジットと結果の両方を失うことになります。
SUCCEEDED、FAILED、または CANCELED になるのを待ってから削除してください。
終了状態(SUCCEEDED、FAILED、または CANCELED)にあるタスクは、
払い戻しなしで削除されます。
戻り値
成功時は 200 OK を返し、タスクが IN_PROGRESS の場合は 409 Conflict を返します。
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 is left 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."
}
マルチ画像から3Dタスクの一覧取得
このエンドポイントでは、マルチ画像から3Dタスクのリストを取得できます。
パラメータ
任意の属性
- Name
- page_num
- Type
- integer
- Description
ページネーション用のページ番号。
1から始まり、デフォルトは1です。
- Name
- page_size
- Type
- integer
- Description
ページサイズの上限。デフォルトは
10件です。最大で100件まで指定できます。
- Name
- sort_by
- Type
- string
- Description
並び替えに使用するフィールド。使用可能な値:
+created_at:作成日時の昇順で並び替えます。-created_at:作成日時の降順で並び替えます。
戻り値
マルチ画像から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",
"emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
}
],
"preceding_tasks": 0,
"task_error": {
"message": ""
},
"consumed_credits": 30
}
]
マルチ画像から3Dタスクをストリーミング
このエンドポイントは、Server-Sent Events(SSE)を使用してマルチ画像から3Dタスクのリアルタイム更新をストリーミングします。
パラメータ
- Name
- id
- Type
- path
- Description
ストリーミングするマルチ画像から3Dタスクの一意の識別子です。
返り値
Server-Sent Eventsとしてマルチ画像から3Dタスクオブジェクトのストリームを返します。
PENDINGまたはIN_PROGRESSのタスクの場合、レスポンスストリームには必要なprogressとstatusフィールドのみが含まれます。
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.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
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",
"emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
}
],
"preceding_tasks": 0,
"task_error": {
"message": ""
},
"consumed_credits": 30
}
マルチ画像から3D タスクオブジェクト
マルチ画像から3D タスクオブジェクトは、複数の画像(1枚から4枚まで)から3Dモデルを生成するために Meshy が追跡する作業単位です。画像は同じオブジェクトのものであり、理想的には異なる視点やアングルから撮影されたものであるべきです。 このオブジェクトには以下のプロパティがあります。
プロパティ
- Name
- id
- Type
- string
- Description
タスクの一意の識別子です。実装の詳細として k-sortable な UUID をタスク ID に使用していますが、id のフォーマットについて何らかの前提を置くべきではありません。
- Name
- type
- Type
- string
- Description
マルチ画像から3D タスクのタイプです。値は
multi-image-to-3dです。
- Name
- model_urls
- Type
- object
- Description
Meshy が生成したテクスチャ付き3Dモデルファイルのダウンロード可能な URL です。あるフォーマットが生成されなかった場合、そのフォーマットのプロパティは空文字列を返す代わりに省略されます。
- Name
glb- Type
- string
- Description
GLB ファイルのダウンロード可能な URL です。
- Name
fbx- Type
- string
- Description
FBX ファイルのダウンロード可能な URL です。
- Name
obj- Type
- string
- Description
OBJ ファイルのダウンロード可能な URL です。
- Name
usdz- Type
- string
- Description
USDZ ファイルのダウンロード可能な URL です。
- Name
mtl- Type
- string
- Description
MTL ファイルのダウンロード可能な URL で、テクスチャが存在する場合に OBJ のエクスポートと一緒に返されます。
- Name
stl- Type
- string
- Description
STL ファイルのダウンロード可能な URL です。
- Name
3mf- Type
- string
- Description
3MF ファイルのダウンロード可能な URL です。
target_formatsで3mfがリクエストされた場合にのみ存在します。
- Name
pre_remeshed_glb- Type
- string
- Description
リメッシュ前の元の GLB 出力へのダウンロード可能な URL です。
タスクが
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で作成され、透明プレビューが正常にレンダリングされた場合にのみ存在します。それ以外の場合、このフィールドは省略されます。
- Name
- thumbnail_urls
- Type
- object
- Description
生成された3Dモデルの4方向のサムネイルへのダウンロード可能な URL です。各値は、
thumbnail_urlと同じマテリアルとライティングでレンダリングされた 512×512 の PNG への署名付き URL です。GLB をダウンロードせずにバッチパイプラインで複数のアングルからモデルをプレビューするのに役立ちます。タスクが
multi_view_thumbnails: trueで作成され、SUCCEEDEDに到達した場合にのみ存在します。古いタスクやオプトインなしで作成されたタスクにはこのフィールドは含まれません。- 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
タスクの progress です。タスクがまだ開始されていない場合、このプロパティは
0になります。タスクが成功すると、これは100になります。
- Name
- started_at
- Type
- timestamp
- Description
タスクが開始された時刻をミリ秒で表したタイムスタンプです。タスクがまだ開始されていない場合、このプロパティは
0になります。タイムスタンプは、RFC 3339
標準に従って、1970年1月1日 UTC からの経過ミリ秒数を表します。 例えば、2023年9月1日金曜日 12:00:00 PM GMT は1693569600000と表されます。これは Meshy API におけるすべてのタイムスタンプに適用されます。
- Name
- created_at
- Type
- timestamp
- Description
タスクが作成された時刻をミリ秒で表したタイムスタンプです。
- Name
- expires_at
- Type
- timestamp
- Description
タスクの結果が期限切れになる時刻をミリ秒で表したタイムスタンプです。
- Name
- finished_at
- Type
- timestamp
- Description
タスクが完了した時刻をミリ秒で表したタイムスタンプです。タスクがまだ完了していない場合、このプロパティは
0になります。
- Name
- status
- Type
- string
- Description
タスクのステータスです。可能な値は
PENDING、IN_PROGRESS、SUCCEEDED、FAILED、CANCELEDのいずれかです。
- Name
- texture_urls
- Type
- array
- Description
タスクから生成されたテクスチャ URL オブジェクトの配列です。通常、これには1つのテクスチャ URL オブジェクトのみが含まれます。各テクスチャ URL には以下のプロパティがあります。
- Name
base_color- Type
- string
- Description
ベースカラーマップ画像へのダウンロード可能な URL です。
- Name
metallic- Type
- string
- Description
メタリックマップ画像へのダウンロード可能な URL です。
タスクが
enable_pbr: falseで作成された場合、このプロパティは省略されます。
- Name
normal- Type
- string
- Description
ノーマルマップ画像へのダウンロード可能な URL です。
タスクが
enable_pbr: falseで作成された場合、このプロパティは省略されます。
- Name
roughness- Type
- string
- Description
ラフネスマップ画像へのダウンロード可能な URL です。
タスクが
enable_pbr: falseで作成された場合、このプロパティは省略されます。
- Name
emission- Type
- string
- Description
エミッションマップ画像へのダウンロード可能な URL です。
タスクが
enable_pbr: falseで作成された場合、またはai_modelがmeshy-6-liteの場合、このプロパティは省略されます。
- 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を返します(クレジットは失敗時に返還されます)。
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",
"emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
}
],
"preceding_tasks": 0,
"task_error": {
"message": ""
},
"consumed_credits": 30,
}