マルチ画像から3D API
マルチ画像から3D APIは、Meshyのマルチ画像から3D機能をあなたのアプリケーションに統合することを可能にする機能です。このセクションでは、このAPIを始めるために必要なすべての情報が見つかります。
マルチ画像から3D タスクを作成する
このエンドポイントを使用すると、新しいマルチ画像から3Dタスクを作成できます。マルチ画像から3Dタスクオブジェクトに含まれるプロパティについては、マルチ画像から3Dタスクオブジェクトを参照してください。
パラメータ
input_task_id または image_urls のいずれか一方のみが必須です。両方が指定された場合、input_task_id が優先されます。
- Name
- input_task_id
- Type
- string
- 必須
- Description
出力(1〜4枚の画像)を入力として使用する、完了済み画像生成タスクのIDです。このタスクは、テキストから画像、画像から画像、テキストから画像 マルチビュー、または 画像から画像 マルチビュー のいずれかである必要があります。さらに、APIを通じて実行され、ステータスが
SUCCEEDEDである必要があります。
- Name
- image_urls
- Type
- array
- 必須
- Description
Meshyがモデル作成に使用する1〜4枚の画像を指定します。現在サポートしている形式は
.jpg、.jpeg、.pngです。最良の結果を得るには、すべての画像が同じオブジェクトを異なる角度から捉えたものである必要があります。各画像は次の2つの方法のいずれかで指定できます:
- パブリックアクセス可能なURL:インターネットから公開アクセス可能なURL。
- Data URI:画像のbase64エンコードされたdata URI。data URIの例:
data:image/jpeg;base64,<your base64-encoded image data>。
meshy-7(またはlatest)の場合、最初の画像がプライマリ(正面)ビューとして使用されます。残りの画像の順序は関係ありません。
- Name
- ai_model
- Type
- string
- デフォルト latest
- Description
使用するモデルのIDです。使用可能な値:
meshy-5、meshy-6、meshy-7、latest(Meshy 7)。
- Name
- ultra_mode
- Type
- boolean
- デフォルト false
- Description
より忠実度の高いジオメトリと、より細かい表面ディテールを実現するUltra生成を有効にします。
ai_modelがmeshy-7(またはlatest)の場合のみサポートされます。
- 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-7およびlatestはエミッションマップを生成しません。
- Name
- texture_resolution
- Type
- string
- デフォルト 2k
- Description
ベースカラーテクスチャの解像度です。
2k(2048×2048)、4k(4096×4096)、8k(8192×8192)のいずれかです。解像度が高いほど、表面のディテールがより多く捉えられます。4kと8kにはai_modelmeshy-6、meshy-7、または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です。画像は次の2つの方法のいずれかで指定できます:
- パブリックアクセス可能なURL:インターネットから公開アクセス可能なURL
- Data URI:画像のbase64エンコードされたdata URI。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データURI、.jpg/.jpeg/.png)を受け付けます。これらの画像はテクスチャのみを誘導するものであり、
image_urlsとは独立しています — 両方のリストは異なる画像や異なる枚数の画像を含むことができます。ai_modelmeshy-7またはlatestが必要です。texture_image_urlまたはtexture_promptと組み合わせることはできません。
- Name
- should_remesh
- Type
- boolean
- デフォルト false (meshy-6), 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
生成されるモデルのポーズモードを指定します。
使用可能な値:
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、またはlatestの場合のみサポートされます。
- Name
- remove_lighting
- Type
- boolean
- デフォルト true
- Description
ベースカラーテクスチャからハイライトと影を除去し、カスタムライティング設定下でより良く機能するクリーンな結果を生成します。
ai_modelがmeshy-6、meshy-7、または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 プロパティには、新しく作成されたマルチ画像から3DタスクのタスクID id が含まれます。
失敗モード
- Name
400 - Bad Request- Description
リクエストが受け入れられませんでした。一般的な原因:
- パラメータの欠如:
image_urlsまたはinput_task_idのいずれかを指定する必要があります。 - 無効な入力タスク:
input_task_idは、SUCCEEDEDステータスのテキストから画像、画像から画像、またはマルチビューバリアントタスクを参照している必要があります。 - 無効な画像数:
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_modelmeshy-7またはlatestが必要です。 - 到達不能なURL:
image_urlsまたはtexture_image_urlsの1つ以上の要素をダウンロードできませんでした。
- パラメータの欠如:
- 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 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>"
],
"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タスクオブジェクトセクションを確認してください。
リクエスト
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
レスポンス
{
"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。
戻り値
成功時には 200 OK を返します。
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
// Returns 200 Ok on success.
マルチ画像から3Dタスクの一覧
このエンドポイントを使用して、マルチ画像から3Dタスクの一覧を取得できます。
パラメータ
オプション属性
- Name
- page_num
- Type
- integer
- Description
ページネーションのページ番号。
1から開始し、デフォルトも1です。
- Name
- page_size
- Type
- integer
- Description
ページサイズの制限。デフォルトは
10アイテムです。最大許容は50アイテムです。
- Name
- sort_by
- Type
- string
- Description
ソートするフィールド。利用可能な値:
+created_at: 作成時間で昇順にソート。-created_at: 作成時間で降順にソート。
戻り値
ページネーションされたマルチ画像から3Dタスクオブジェクトの一覧を返します。
リクエスト
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
レスポンス
[
{
"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
タスクの一意の識別子です。タスクIDの実装の詳細としてk-sortable UUIDを使用していますが、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
テクスチャリングプロセスを導くために使用されたテキストプロンプトです。
- Name
- texture_image_urls
- Type
- string[]
- Description
タスクの作成に使用されたテクスチャ参照画像のダウンロード可能なURLで、提供された順序で表示されます。タスクが
texture_image_urlsで作成された場合にのみ存在します。
- Name
- ultra_mode
- Type
- boolean
- Description
タスクが作成された際の
ultra_modeの値を反映します。ultra_modeを明示的に設定したmeshy-7(またはlatest)タスクにのみ存在し、それ以外の場合は省略されます。
- Name
- progress
- Type
- integer
- Description
タスクの進行状況です。タスクがまだ開始されていない場合、このプロパティは
0になります。タスクが成功すると、100になります。
- Name
- started_at
- Type
- timestamp
- Description
タスクが開始された時刻のタイムスタンプ(ミリ秒)です。タスクがまだ開始されていない場合、このプロパティは
0になります。タイムスタンプは、RFC 3339
標準に従い、1970年1月1日UTCからの経過ミリ秒数を表します。 例えば、2023年9月1日金曜日午後12時00分00秒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-5の場合、このプロパティは省略されます。
- 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,
}