マルチ画像から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
モデル生成に使用する画像を1〜4枚Meshyに提供します。現在、
.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
- 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
テクスチャリングプロセスを指示するためのテキストプロンプトを提供します。最大600文字です。
- 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
- should_remesh
- Type
- boolean
- デフォルト false (meshy-6), true (others)
- Description
リメッシュフェーズを有効にするかどうかを制御します。最高品質のモデルを得るには、
should_remeshをfalseに設定することをお勧めします。
should_remesh = true- Name
- topology
- Type
- string
- デフォルト triangle
- Description
生成されるモデルのトポロジーを指定します。
使用可能な値:
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が含まれます。
失敗モード
- Name
400 - Bad Request- Description
リクエストが受け入れられませんでした。一般的な原因:
- パラメーターの欠如:
image_urlsまたはinput_task_idのいずれかを指定する必要があります。 - 無効な入力タスク:
input_task_idはSUCCEEDED状態のテキストから画像、画像から画像、またはそのマルチビュー版のタスクを指す必要があります。 - 無効な画像数:
image_urlsには1〜4枚の画像が含まれている必要があります。 - 無効な画像フォーマット:
image_urls内の1つ以上の画像がサポートされていないフォーマットです。 - 到達不能なURL: 1つ以上の
image_urlsをダウンロードできませんでした。
- パラメーターの欠如:
- Name
401 - Unauthorized- Description
認証に失敗しました。APIキーを確認してください。
- Name
402 - Payment Required- Description
このタスクを実行するためのクレジットが不足しています。
- Name
429 - Too Many Requests- Description
レート制限を超えています。
リクエスト
# 簡単なリクエスト
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>"
]
}'
# PBRテクスチャリングとGLBフォーマットを指定
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"]
}'
レスポンス
{
"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を返します。
リクエスト
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}"
レスポンス
// 成功時に200 Okが返ります。
マルチ画像から3Dタスク一覧
このエンドポイントでは、マルチ画像から3Dタスクのリストを取得できます。
パラメーター
オプション属性
- Name
- page_num
- Type
- integer
- Description
ページネーションのページ番号。開始値およびデフォルトは
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タスクをストリームする
このエンドポイントは、サーバー送信イベント(SSE)を使用してマルチ画像から3Dタスクのリアルタイム更新をストリームします。
パラメーター
- Name
- id
- Type
- path
- Description
ストリームするマルチ画像から3Dタスクの一意の識別子。
戻り値
サーバー送信イベントとしてマルチ画像から3Dタスクオブジェクトのストリームを返します。
PENDINGまたはIN_PROGRESSのタスクの場合、レスポンスストリームには必要なprogressとstatusフィールドのみが含まれます。
リクエスト
curl -N https://api.meshy.ai/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"
レスポンスストリーム
// エラーイベントの例
event: error
data: {
"status_code": 404,
"message": "Task not found"
}
// メッセージイベントの例は、タスクの進捗を示します。
// PENDINGまたはIN_PROGRESSのタスクの場合、レスポンスストリームにはすべてのフィールドは含まれません。
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タスクオブジェクトは、Meshyが複数の画像(1〜4枚)から3Dモデルを生成するために追跡する作業単位です。画像は同じオブジェクトのもので、理想的には異なるビューまたは角度からのものである必要があります。 このオブジェクトは次のプロパティを持ちます:
プロパティ
- Name
- id
- Type
- string
- Description
タスクの一意の識別子。実装の詳細としてタスクidにkソート可能な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。
3mfがtarget_formatsで要求された場合のみ存在します。
- 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
- progress
- Type
- integer
- Description
タスクの進捗。タスクがまだ開始されていない場合、このプロパティは
0になります。タスクが成功すると、100になります。
- Name
- started_at
- Type
- timestamp
- Description
タスクが開始された時点のタイムスタンプ(ミリ秒単位)。タスクがまだ開始されていない場合、このプロパティは
0になります。タイムスタンプは、1970年1月1日UTCから経過したミリ秒数を表し、 RFC 3339
標準に従います。 たとえば、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を返します(失敗時にはクレジットが払い戻されます)。
マルチ画像から3Dタスクオブジェクトの例
{
"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,
}