画像から3D API
画像から3D APIは、Meshyの画像から3D機能を自分のアプリケーションに統合できる機能です。このセクションでは、このAPIを使い始めるために 必要なすべての情報を紹介します。
Create an Image to 3D Task
このエンドポイントを使用すると、新しい画像から3Dタスクを作成できます。画像から3Dタスクオブジェクトに含まれるプロパティについては、 画像から3Dタスクオブジェクトを参照してください。
このタスクはバックグラウンドで実行されます。通常の所要時間については、処理時間を参照してください。
パラメータ
input_task_id または image_url のいずれか一方のみが必須です。両方が指定された場合は、input_task_id が優先されます。
- Name
- input_task_id
- Type
- string
- 必須
- Description
出力を入力画像として使用する、完了済みの画像生成タスクのIDです。このタスクは以下のいずれかである必要があります: テキストから画像または画像から画像。さらに、API経由で実行され、ステータスが
SUCCEEDEDであり、画像をちょうど1枚生成している必要があります。
- Name
- image_url
- Type
- string
- 必須
- Description
Meshyがモデル作成に使用する画像を指定します。現在、
.jpg、.jpeg、.png、.webp形式をサポートしています。最大ファイルサイズ: 20 MB。
画像を指定する方法は2通りあります:
- 公開アクセス可能なURL: パブリックインターネットからアクセス可能なURL。
- Data URI: 画像のBase64エンコードされたdata URI。data URIの例:
data:image/jpeg;base64,<your base64-encoded image data>。
- Name
- model_type
- Type
- string
- デフォルト standard
- Description
3Dメッシュ生成の種類を指定します。
使用可能な値:
standard: 通常の高精細な3Dメッシュ生成。smart-topology:ai_model(meshy-t2)を使ってSmart Topologyモデルを選択します。lowpoly(非推奨、2026年10月30日に廃止予定): よりクリーンなポリゴンに最適化されたローポリメッシュを生成します。代わりにMeshy T2を推奨します:meshy-t2によるsmart-topology。
smart-topologyを選択した場合、topology、should_remesh、save_pre_remeshed_modelは無視されます。lowpolyは2026年10月30日に廃止されます。その日以降、model_type: "lowpoly"を指定したリクエストはエラーを返します。Meshy T2(ai_model: "meshy-t2"を伴うmodel_type: "smart-topology")への切り替えを推奨します。lowpolyを選択した場合、ai_model、topology、target_polycount、should_remesh、save_pre_remeshed_modelは無視されます。
- Name
- ai_model
- Type
- string
- デフォルト latest
- Description
使用するモデルのIDです。使用可能な値は
model_typeによって異なります。標準生成(
model_type: standard):meshy-6-lite、meshy-6、meshy-7.1、latest(Meshy 7.1)meshy-7(非推奨): 代わりにmeshy-7.1を使用してください。
Smart Topology生成(
model_type: smart-topology):meshy-t2(デフォルト): Smart Topologyモデル — よりクリーンなtopology、ネイティブに分離されたパーツ、三角形出力、target_polycountで設定可能な面数を提供します。
- Name
- geometry_resolution
- Type
- string
- デフォルト standard
- Description
ジオメトリ生成パスです。
2kは2048³でUltraパスを実行し、4kは4096³で実行して、 最も精細な表面ディテールを得られます。使用可能な値:
standard、2k、4kmeshy-7.1またはlatestが必要です。
- 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-liteの場合には使用できません。8kの場合、エミッションマップは生成されません。
- Name
- hd_texture
- Type
- boolean
- ⚠ 非推奨
- デフォルト false
- Description
代わりに
texture_resolutionを使用してください —texture_resolution: "4k"と同等です。両方が設定されている場合、texture_resolutionが優先されます。
- Name
- texture_prompt
- Type
- string
- Description
テクスチャ生成プロセスを誘導するためのテキストプロンプトを指定します。最大800文字です。
- Name
- texture_image_url
- Type
- string
- Description
テクスチャ生成プロセスを誘導するための2D画像を指定します。現在、
.jpg、.jpeg、.png、.webp形式をサポートしています。最大ファイルサイズ: 20 MB。
画像を指定する方法は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がモデルのテクスチャリングに使用されます。テキストまたは画像によるテクスチャリングには、タスクあたり10クレジットかかります。
- 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
- decimation_mode
- Type
- integer
- Description
ポリゴン数レベルを設定することで、適応的な間引きを有効にします。設定された場合、
target_polycountは無視されます。使用可能な値:
1: 適応的 — 超高ポリゴン数。2: 適応的 — 高ポリゴン数。3: 適応的 — 中ポリゴン数。4: 適応的 — 低ポリゴン数。
- Name
- save_pre_remeshed_model
- Type
- boolean
- デフォルト false
- Description
trueに設定すると、Meshyはリメッシュフェーズが完了する前の追加のGLBファイルも保存します。
- Name
- target_polycount
- Type
- integer
- Description
出力のポリゴン(面)数の目標値です。実際の数は、ジオメトリによって目標値から変動する場合があります。
target_polycountは、独立した2つのケースで有効になります:- リメッシュ —
standardモデルでshould_remesh: trueを指定した場合。メッシュはほぼこの数になるようにリメッシュ(間引き)されます。範囲は100〜300,000で、デフォルトは30,000です。decimation_modeが設定されている場合、そちらが優先されtarget_polycountは無視されます。 - Smart Topology —
model_type: smart-topologyとai_model: meshy-t2を指定した場合。モデルはこの面数で直接生成され、リメッシュは実行されず、should_remeshは不要です。範囲は100〜15,000で、デフォルトは4,000です。
- リメッシュ —
- Name
- symmetry_mode
- Type
- string
- ⚠ 非推奨
- デフォルト auto
- Description
非推奨です。このパラメータはもはや出力に影響しません。
symmetry_modeフィールドは、モデル生成プロセス中の対称動作を制御します。有効な値は以下のとおりです:
off: 対称を無効にします。auto: 入力ジオメトリに基づいて自動的に対称を判定し適用します。on: 生成時に対称を強制します。
- Name
- pose_mode
- Type
- string
- デフォルト ""
- Description
生成されるモデルのpose modeを指定します。
使用可能な値:
a-pose: モデルをAポーズで生成します。t-pose: モデルをTポーズで生成します。""(空文字列): 特定のポーズを適用しません。
- Name
- is_a_t_pose
- Type
- boolean
- ⚠ 非推奨
- デフォルト false
- Description
代わりに
pose_modeを使用してください。モデルをA/Tポーズで生成するかどうかです。
- Name
- surface_mode
- Type
- string
- ⚠ 非推奨
- Description
もはや出力に影響しません。これは既に廃止されたモデル生成を選択するものでした。代わりに
ai_modelを使用してください。受け付けられる値は
organicとhardです。それ以外の値は400を返します。
- 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の場合にのみサポートされます。
- 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 プロパティには、新しく作成された画像から3DタスクのタスクIDである id が含まれます。
失敗モード
- Name
400 - Bad Request- Description
リクエストが受理できませんでした。主な原因:
- パラメータの不足:
image_urlまたはinput_task_idのいずれかを指定する必要があります。 - 無効な入力タスク:
input_task_idは、画像をちょうど1枚生成する、SUCCEEDED状態のテキストから画像または画像から画像タスクを参照している必要があります。 - 無効な画像形式: 指定された
image_urlがサポートされている形式(.jpg、.jpeg、.png、.webp)ではありません。 - 到達不能なURL:
image_urlをダウンロードできませんでした(404またはtimeout)。 - 画像サイズが大きすぎる:
image_urlまたはtexture_image_urlの画像が20 MBを超えています。 - 無効なData URI: Base64文字列の形式が不正です。
- 無効なパラメータの組み合わせ:
enable_pbrはshould_textureがtrueの場合にのみサポートされます。 - ローポリに対応していないモデル:
ai_model: "meshy-6-lite"はmodel_type: "lowpoly"をサポートしていません。 - Ultraに対応していないモデル:
geometry_resolutionにはmeshy-7.1またはlatestが必要です。
- パラメータの不足:
- Name
401 - Unauthorized- Description
認証に失敗しました。APIキーを確認してください。
- 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 Ultra 4K geometry, 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>",
"ai_model": "meshy-7.1",
"geometry_resolution": "4k",
"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"
}
画像から3Dタスクを取得
このエンドポイントでは、有効なタスク id を指定して画像から3Dタスクを取得できます。
画像から3Dタスクオブジェクトに含まれるプロパティについては、画像から3Dタスクオブジェクトを参照してください。
パラメータ
- Name
- id
- Type
- path
- Description
取得対象の画像から3Dタスクの一意の識別子です。
返り値
レスポンスには画像から3Dタスクオブジェクトが含まれます。詳細は 画像から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
}
画像から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/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/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
}
]
画像から3DタスクをStreamする
このエンドポイントは、Server-Sent Events(SSE)を使用して画像から3Dタスクのリアルタイム更新をストリーミングします。
パラメータ
- Name
- id
- Type
- path
- Description
ストリーミングする画像から3Dタスクの一意の識別子です。
返り値
画像から3DタスクオブジェクトのストリームをServer-Sent Eventsとして返します。
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
}
画像から3Dタスクオブジェクト
画像から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
テクスチャリング処理を誘導するために使用されたテキストprompt です。
- Name
- texture_image_url
- Type
- string
- Description
テクスチャリング処理を誘導するために使用されたテクスチャ画像へのダウンロード可能なURLです。
- Name
- ultra_mode
- Type
- boolean
- ⚠ 非推奨
- Description
非推奨です。代わりに
geometry_resolutionを参照してください。
- Name
- geometry_resolution
- Type
- string
- Description
タスクが実行されたUltraのティア(
2kまたは4k)です。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秒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、meshy-7.1、latestのいずれかである場合、このプロパティは省略されます。
- 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
}