画像から3D API
画像から3D APIは、Meshyの画像から3Dへの変換機能を独自のアプリケーションに統合できる機能です。このセクションでは、このAPIを使い始めるために必要なすべての情報を 確認できます。
Image to 3D タスクを作成
この endpoint では、新しい Image to 3D タスクを作成できます。 Image to 3D タスクオブジェクトに含まれるプロパティについては、 Image to 3D タスクオブジェクトを参照してください。
パラメータ
input_task_id または image_url のいずれか一方のみが必須です。両方が指定された場合、input_task_id が優先されます。
- Name
- input_task_id
- Type
- string
- 必須
- Description
出力を入力画像として使用する、完了済み画像生成タスクの ID。このタスクは、Text to Image または Image to Image のいずれかである必要があります。さらに、API 経由で実行され、ステータスが
SUCCEEDEDであり、画像をちょうど 1 枚生成している必要があります。
- Name
- image_url
- Type
- string
- 必須
- Description
Meshy がモデル作成に使用する画像を指定します。現在、
.jpg、.jpeg、.png形式をサポートしています。画像を指定する方法は 2 つあります。
- 公開アクセス可能な URL: 公開インターネットからアクセス可能な URL。
- データ URI: 画像の base64 エンコード済みデータ URI。データ URI の例:
data:image/jpeg;base64,<your base64-encoded image data>。
- Name
- model_type
- Type
- string
- デフォルト standard
- Description
3D メッシュ生成の種類を指定します。
利用可能な値:
standard: 通常の高精細 3D メッシュ生成。lowpoly: よりクリーンなポリゴン向けに最適化されたローポリメッシュを生成します。
lowpolyが選択されている場合、ai_model、topology、target_polycount、should_remesh、save_pre_remeshed_modelは無視されます。
- 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 マップ(メタリック、ラフネス、法線)を生成します。
ai_modelがmeshy-6またはlatestの場合は、エミッションマップも含まれます。
- 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
- データ URI: 画像の base64 エンコード済みデータ URI。データ URI の例:
data:image/jpeg;base64,<your base64-encoded image data>
元のアセットとアップロードされた画像の間に大きなジオメトリの差異がある場合、画像によるテクスチャリングは最適に機能しない可能性があります。テクスチャリングプロセスをガイドするには、
texture_image_urlまたはtexture_promptのいずれか一方のみを使用できます。両方のパラメータが指定された場合、デフォルトではtexture_promptがモデルのテクスチャリングに使用されます。テキストまたは画像によるテクスチャリングには、タスクごとに 10 クレジットがかかります。
- Name
- should_remesh
- Type
- boolean
- デフォルト false (meshy-6), true (others)
- Description
remesh フェーズを有効にするかどうかを制御します。
falseに設定すると、API は最高精度の三角形メッシュを返します。
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 は remesh フェーズが完了する前に追加の 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_url、texture_image_url、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 プロパティには、新しく作成された Image to 3D タスクのタスク id が含まれます。
失敗モード
- Name
400 - Bad Request- Description
リクエストは受け付けられませんでした。一般的な原因:
- パラメータ不足:
image_urlまたはinput_task_idのいずれかを指定する必要があります。 - 無効な入力タスク:
input_task_idは、画像をちょうど 1 枚生成するSUCCEEDED状態の Text to Image または Image to Image タスクを参照している必要があります。 - 無効な画像形式: 指定された
image_urlはサポートされている形式(.jpg、.jpeg、.png)ではありません。 - 到達不能な URL:
image_urlをダウンロードできませんでした(404 またはタイムアウト)。 - 無効なデータ URI: base64 文字列の形式が不正です。
- 無効なパラメータの組み合わせ:
enable_pbrはshould_textureが true の場合のみサポートされます。
- パラメータ不足:
- Name
401 - Unauthorized- Description
認証に失敗しました。API key を確認してください。
- Name
402 - Payment Required- Description
このタスクを実行するためのクレジットが不足しています。
- Name
429 - Too Many Requests- Description
レート制限を超過しました。
Request
# Simple request with required params
curl https://api.meshy.ai/openapi/v1/image-to-3d \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"image_url": "<your publicly accessible image url or base64-encoded data URI>"
}'
# With remesh, PBR, and A-pose
curl https://api.meshy.ai/openapi/v1/image-to-3d \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"image_url": "<your publicly accessible image url or base64-encoded data URI>",
"enable_pbr": true,
"should_remesh": true,
"target_polycount": 100000,
"should_texture": true,
"pose_mode": "a-pose",
"target_formats": ["glb"]
}'
Response
{
"result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
Image to 3D タスクを取得
この endpoint では、有効なタスク id を指定して Image to 3D タスクを取得できます。
Image to 3D タスクオブジェクトに含まれるプロパティについては、
Image to 3D タスクオブジェクト を参照してください。
パラメータ
- Name
- id
- Type
- path
- Description
取得する Image to 3D タスクの一意の識別子。
戻り値
レスポンスには Image to 3D タスクオブジェクトが含まれます。詳細については、 Image to 3D タスクオブジェクト セクションを確認してください。
Request
curl https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "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
}
Image to 3D タスクを削除
この endpoint は、関連するすべてのモデルとデータを含め、Image to 3D タスクを完全に削除します。この操作は取り消せません。
パスパラメータ
- Name
- id
- Type
- path
- Description
削除する Image to 3D タスクの ID。
戻り値
成功時に 200 OK を返します。
Request
curl --request DELETE \
--url https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
// Returns 200 Ok on success.
画像から3Dへのタスク一覧
この endpoint では、画像から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へのタスクオブジェクト のページ分割された一覧を返します。
Request
curl https://api.meshy.ai/openapi/v1/image-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
[
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "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
}
]
Image to 3D タスクをストリーミングする
この endpoint は、Server-Sent Events (SSE) を使用して Image to 3D タスクのリアルタイム更新をストリーミングします。
パラメータ
- Name
- id
- Type
- path
- Description
ストリーミングする Image to 3D タスクの一意の識別子。
戻り値
Server-Sent Events として Image to 3D タスクオブジェクト のストリームを返します。
PENDING または IN_PROGRESS のタスクでは、レスポンスストリームには必要な progress および status フィールドのみが含まれます。
Request
curl -N https://api.meshy.ai/openapi/v1/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": "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
}
Image to 3Dタスクオブジェクト
Image to 3Dタスクオブジェクトは、画像入力から3Dモデルを生成するためにMeshyが追跡する作業単位です。 このオブジェクトには以下のプロパティがあります:
プロパティ
- Name
- id
- Type
- string
- Description
タスクの一意識別子です。実装の詳細として、タスクIDには k-sortable UUID を使用していますが、 IDの形式については一切仮定しないでください。
- Name
- type
- Type
- string
- Description
画像から3Dタスクのタイプです。値は
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_url
- Type
- string
- Description
テクスチャ作成プロセスをガイドするために使用されたテクスチャ画像へのダウンロード可能なURLです。
- 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 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オブジェクトリファレンスについては、エラー を参照してください。
- Name
- consumed_credits
- Type
- integer
- Description
このタスクによって消費されたクレジット数です。タスクステータスが
PENDING、IN_PROGRESS、またはSUCCEEDEDの場合に存在します。FAILEDタスクの場合は0を返します(失敗時にはクレジットが返還されます)。
Example Image to 3D Task Object
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "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": "",
"texture_image_url": "",
"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
}