画像から3D API
画像から3D APIは、Meshyの画像から3D機能をあなたのアプリケーションに統合することを可能にする機能です。このセクションでは、このAPIを使い始めるために必要なすべての情報を見つけることができます。
画像から3Dタスクを作成
このエンドポイントを使用すると、新しい画像から3Dタスクを作成できます。画像から3Dタスクオブジェクトに含まれるプロパティについては、 The Image to 3D Task Object を参照してください。
パラメータ
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形式に対応しています。画像を指定するには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(非推奨):よりクリーンなポリゴンに最適化されたローポリメッシュを生成します。代わりにsmart-topologyの使用を推奨します。
smart-topologyが選択されている場合、topology、should_remesh、save_pre_remeshed_modelは無視されます。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-5、meshy-6、meshy-7、latest(Meshy 7)
Smart Topology生成(
model_type: smart-topology):meshy-t2(デフォルト):Smart Topologyモデル — よりクリーンなtopology、ネイティブに分離されたパーツ、三角形出力、target_polycountで設定可能な面数。
- 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_model: meshy-5では利用できません。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がモデルのテクスチャ生成に使用されます。テキストまたは画像のいずれによるテクスチャ生成も、タスクごとに10クレジットかかります。
- Name
- should_remesh
- Type
- boolean
- デフォルト false (meshy-6, meshy-7), 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
生成されるモデルのポーズモードを指定します。
利用可能な値:
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の場合にのみサポートされます。
- 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が含まれます。
失敗モード
- Name
400 - Bad Request- Description
リクエストが受け付けられませんでした。一般的な原因:
- パラメータの不足:
image_urlまたはinput_task_idのいずれかを指定する必要があります。 - 無効な入力タスク:
input_task_idは、正確に1枚の画像を生成するSUCCEEDED状態のテキストから画像または画像から画像タスクを参照している必要があります。 - 無効な画像形式:指定された
image_urlがサポートされている形式(.jpg、.jpeg、.png)ではありません。 - 到達不能なURL:
image_urlをダウンロードできませんでした(404またはtimeout)。 - 無効なData URI:base64文字列の形式が不正です。
- 無効なパラメータの組み合わせ:
enable_pbrはshould_textureがtrueの場合にのみサポートされます。
- パラメータの不足:
- 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 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"
}
画像から3Dタスクを取得する
このエンドポイントを使用すると、有効なタスクidを指定して画像から3Dタスクを取得できます。
画像から3Dタスクオブジェクトに含まれるプロパティについては、画像から3Dタスクオブジェクトを参照してください。
パラメータ
- Name
- id
- Type
- path
- Description
取得する画像から3Dタスクの一意の識別子。
戻り値
レスポンスには画像から3Dタスクオブジェクトが含まれています。詳細は画像から3Dタスクオブジェクトセクションを確認してください。
リクエスト
curl https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
レスポンス
{
"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。
戻り値
成功時には 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タスクを一覧表示
このエンドポイントを使用して、画像から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
}
]
画像から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/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タスクオブジェクトは、Meshyが画像入力から3Dモデルを生成するために追跡する作業単位です。 このオブジェクトには以下のプロパティがあります:
プロパティ
- Name
- id
- Type
- string
- Description
タスクの一意の識別子です。タスクIDにはkソート可能な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モデルの四方位サムネイルのダウンロード可能な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
- ultra_mode
- Type
- boolean
- Description
タスクが作成されたときの
ultra_mode値をエコーします。meshy-7(またはlatest)タスクで明示的にultra_modeを設定した場合にのみ存在し、それ以外の場合は省略されます。
- 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、meshy-7、または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
}