Multi-Image to 3D API
Multi-Image to 3D API は、Meshy の Multi-Image to 3D 機能をあなた自身のアプリケーションに統合できる機能です。このセクションでは、この API を使い始めるために必要なすべての情報を 確認できます。
Multi-Image to 3Dタスクの作成
このendpointを使用すると、新しいMulti-Image to 3Dタスクを作成できます。 Multi-Image to 3Dタスクオブジェクトに含まれるプロパティについては、 Multi-Image to 3Dタスクオブジェクトを参照してください。
パラメータ
input_task_id または image_urls のいずれか一方のみが必須です。両方が指定された場合は、input_task_id が優先されます。
- Name
- input_task_id
- Type
- string
- 必須
- Description
出力(1〜4枚の画像)を入力として使用する、完了済みの画像生成タスクのIDです。このタスクは、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形式をサポートしています。最良の結果を得るには、すべての画像で同じオブジェクトを異なる角度から示す必要があります。各画像の指定方法は2つあります。
- 公開アクセス可能なURL: 公開インターネットからアクセス可能なURL。
- Data URI: 画像のbase64エンコードされたdata URI。data URIの例:
data:image/jpeg;base64,<your base64-encoded image data>。
- Name
- ai_model
- Type
- string
- デフォルト latest
- Description
使用するモデルのID。利用可能な値:
meshy-5、meshy-6、latest(Meshy 6)。
- Name
- should_texture
- Type
- boolean
- デフォルト true
- Description
テクスチャを生成するかどうかを決定します。
falseに設定するとテクスチャフェーズがスキップされ、テクスチャなしのメッシュが提供されます。
should_texture = true- Name
- enable_pbr
- Type
- boolean
- デフォルト false
- Description
ベースカラーに加えてPBRマップ(metallic、roughness、normal)を生成します。
ai_modelがmeshy-6またはlatestの場合は、emission mapも含まれます。
- Name
- hd_texture
- Type
- boolean
- デフォルト false
- Description
より高いディテールのために、ベースカラーテクスチャを4K(4096×4096)解像度で生成します。
ai_modelがmeshy-6またはlatestの場合のみサポートされます。PBRマップは常に2Kで生成されます。
- 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
リメッシュフェーズを有効にするかどうかを制御します。
falseに設定すると、APIは最高精度の三角形メッシュを返します。
should_remesh = true- Name
- topology
- Type
- string
- デフォルト triangle
- Description
生成されるモデルのトポロジーを指定します。
利用可能な値:
quad: quad主体のメッシュを生成します。triangle: 間引きされた三角形メッシュを生成します。
- Name
- target_polycount
- Type
- integer
- デフォルト 30,000
- Description
生成されるモデルの目標ポリゴン数を指定します。実際のポリゴン数は、ジオメトリの複雑さに応じて目標からずれる場合があります。
有効な値の範囲はユーザー階層によって異なります:
- 100〜300,000(両端を含む)
- Name
- decimation_mode
- Type
- integer
- Description
ポリゴン数レベルを設定してアダプティブデシメーションを有効にします。設定された場合、
target_polycountは無視されます。利用可能な値:
1: Adaptive — 超高ポリゴン数。2: Adaptive — 高ポリゴン数。3: Adaptive — 中ポリゴン数。4: Adaptive — 低ポリゴン数。
- 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またはlatestの場合のみサポートされます。
- Name
- remove_lighting
- Type
- boolean
- デフォルト true
- Description
ベースカラーテクスチャからハイライトと影を除去し、カスタムライティング環境でより適切に機能するクリーンな結果を生成します。
ai_modelがmeshy-6または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 visionを使用してオブジェクトの実世界での高さを自動的に推定し、それに応じてモデルのサイズを変更します。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つの基本方向ビューのサムネイル(front、right、back、left)を追加でレンダリングし、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枚の画像を含める必要があります。 - 無効な画像形式:
image_urls内の1つ以上の画像がサポートされていない形式です。 - 到達不能なURL: 1つ以上の
image_urlsをダウンロードできませんでした。
- パラメータ不足:
- Name
401 - Unauthorized- Description
認証に失敗しました。API keyを確認してください。
- 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"
}
Multi-Image to 3D タスクを取得する
この endpoint では、有効なタスク id を指定して Multi-Image to 3D タスクを取得できます。
Multi-Image to 3D タスクオブジェクトに含まれるプロパティについては、
Multi-Image to 3D タスクオブジェクト を参照してください。
パラメータ
- Name
- id
- Type
- path
- Description
取得する Multi-Image to 3D タスクの一意の識別子。
戻り値
レスポンスには Multi-Image to 3D タスクオブジェクトが含まれます。詳細については、 Multi-Image to 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
}
Multi-Image to 3D タスクの削除
この endpoint は、関連するすべてのモデルとデータを含む Multi-Image to 3D タスクを完全に削除します。この操作は元に戻せません。
パスパラメータ
- Name
- id
- Type
- path
- Description
削除する Multi-Image to 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.
Multi-Image to 3D タスクの一覧取得
この endpoint では、Multi-Image to 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: 作成時刻の降順でソートします。
戻り値
Multi-Image to 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
}
]
Multi-Image to 3Dタスクをストリーミングする
このendpointは、Server-Sent Events(SSE)を使用して、Multi-Image to 3Dタスクのリアルタイム更新をストリーミングします。
パラメータ
- Name
- id
- Type
- path
- Description
ストリーミングするMulti-Image to 3Dタスクの一意の識別子。
戻り値
Server-Sent Eventsとして、Multi-Image to 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 ソート可能な UUID を使用していますが、 ID の形式についてはいかなる仮定も行わないでください。
- Name
- type
- Type
- string
- Description
Multi-Image to 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
- 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 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-5の場合、このプロパティは省略されます。
- Name
- preceding_tasks
- Type
- integer
- Description
先行タスクの数です。
このフィールドの値は、タスクのステータスが
PENDINGの場合にのみ意味があります。
- Name
- task_error
- Type
- object
- Description
失敗したタスクのエラー詳細です。完全な
task_errorオブジェクトのリファレンスについては、Errors を参照してください。
- 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,
}