画像から3D API

画像から3D APIは、Meshyの画像から3D機能をあなたのアプリケーションに統合することを可能にする機能です。このセクションでは、このAPIの使い始めに必要なすべての情報を提供しています。

POST/openapi/v1/image-to-3d

画像から3Dタスクの作成

このエンドポイントを使用して、新しい画像から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形式をサポートしています。
画像を提供する方法は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: Smart Topology モデルをai_model (meshy-t1 または meshy-t2) で選択。
- 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モデル — クリーンなトポロジー、ネイティブに分離された部分、三角形の出力、およびtarget_polycountで設定可能なフェースカウント
- meshy-t1: 古いローポリモデル。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)のいずれか。高解像度はより多くの表面の詳細を捉えます。
ai_model: meshy-5では4kおよび8kは使用できません。8kでは放射マップは生成されません。
Name
hd_texture
Type
boolean
⚠ 非推奨
デフォルト false
Description
texture_resolutionを使用してください — texture_resolution: "4k"と等しいです。両方が設定されている場合、texture_resolutionが優先されます。
Name
texture_prompt
Type
string
Description
テクスチャリングプロセスをガイドするテキストプロンプトを提供します。最大600文字。
Name
texture_image_url
Type
string
Description
テクスチャリングプロセスをガイドする2D画像を提供します。現在、.jpg、.jpeg、および.png形式をサポートしています。
画像を提供する方法は2つあります:
- 公開可能なURL: 公開インターネットからアクセス可能なURL
- Data URI: 画像のbase64エンコードされたData URI。例：data: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
生成されたモデルのトポロジーを指定します。
使用可能な値:
- 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は次の場合に効果があります:
- リメッシュ — should_remesh: trueを使用したstandardモデルで。メッシュは概ねこのカウントにリメッシュ（デシメーション）されます。範囲100～300,000、デフォルト30,000。decimation_modeが設定されていると、それが優先されtarget_polycountは無視されます。
- スマートトポロジー — 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
リクエストは受け入れられませんでした。一般的な原因:
- Missing parameter: image_urlもしくはinput_task_idのいずれかが提供されている必要があります。
- Invalid input task: input_task_idは、SUCCEEDEDステータスのテキストから画像もしくは画像から画像タスクで、正確に1枚の画像を生成している必要があります。
- Invalid image format: 提供されたimage_urlがサポートされている形式ではありません（.jpg、.jpeg、.png）。
- Unreachable URL: image_urlをダウンロードできませんでした（404またはタイムアウト）。
- Invalid Data URI: base64文字列が不正です。
- Invalid parameter combination: should_textureがtrueの場合にのみ、enable_pbrがサポートされます。
Name
401 - Unauthorized
Description
認証に失敗しました。APIキーを確認してください。
Name
402 - Payment Required
Description
このタスクを実行するのに十分なクレジットがありません。
Name
429 - Too Many Requests
Description
レート制限を超えました。

リクエスト

POST

/openapi/v1/image-to-3d

# 必須パラメータを含む簡単なリクエスト
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>"
  }'

# リメッシュ、PBR、およびAポーズを使用したもの
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"]
  }'

レスポンス

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

GET/openapi/v1/image-to-3d/:id

画像から3Dタスクの取得

このエンドポイントは、有効なタスクidを指定して画像から3Dタスクを取得することを可能にします。画像から3Dタスクオブジェクトに含まれるプロパティについては画像から3Dタスクオブジェクトを参照してください。

パラメータ

Name
id
Type
path
Description
取得する画像から3Dタスクの一意の識別子。

戻り値

レスポンスには画像から3Dタスクオブジェクトが含まれています。詳細については画像から3Dタスクオブジェクトセクションを確認してください。

リクエスト

GET

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

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
}

DELETE/openapi/v1/image-to-3d/:id

画像から3Dタスクの削除

このエンドポイントは、画像から3Dタスクおよびそれに関連するすべてのモデルとデータを永久に削除します。このアクションは取り消せません。

パスパラメータ

Name
id
Type
path
Description
削除する画像から3DタスクのID。

戻り値

成功時には200 OKを返します。

リクエスト

DELETE

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

レスポンス

// 成功時には200 Okを返します。

GET/openapi/v1/image-to-3d

画像から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タスクオブジェクトのリストを返します。

リクエスト

GET

/openapi/v1/image-to-3d

curl https://api.meshy.ai/openapi/v1/image-to-3d?page_size=10 \
-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=***",
      "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
  }
]

GET/openapi/v1/image-to-3d/:id/stream

画像から3Dタスクのストリーム

このエンドポイントは、サーバー送信イベント (SSE) を使用して画像から3Dタスクのリアルタイム更新をストリームします。

パラメータ

Name
id
Type
path
Description
ストリームする画像から3Dタスクの一意の識別子。

戻り値

サーバー送信イベントとして画像から3Dタスクオブジェクトのストリームを返します。

PENDING または IN_PROGRESS のタスクの場合、レスポンスストリームには必要なprogress およびstatusフィールドのみが含まれます。

リクエスト

GET

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

レスポンスストリーム

// エラーイベントの例
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// メッセージイベントの例はタスクの進行を示しています。
// PENDINGまたはIN_PROGRESSのタスクの場合、レスポンスストリームにすべてのフィールドは含まれません。
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "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モデルを生成するために追跡する作業単位です。 This object has the following properties:

プロパティ

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
  テクスチャが存在する場合、OBJエクスポートと共に返されるMTLファイルへのダウンロード可能なURL。
- Name
  stl
  Type
  string
  Description
  STLファイルへのダウンロード可能なURL。
- Name
  3mf
  Type
  string
  Description
  3MFファイルへのダウンロード可能なURL。3mfがtarget_formatsを通じて要求されたときにのみ存在します。
- Name
  pre_remeshed_glb
  Type
  string
  Description
  リメッシュ前のオリジナルのGLB出力へのダウンロード可能なURL。
  should_remesh: trueとsave_pre_remeshed_model: trueの両方でタスクが作成された場合にのみ利用可能です。
Name
thumbnail_url
Type
string
Description
モデルファイルのサムネイル画像へのダウンロード可能なURL。存在する場合、thumbnail_urls.frontに相当し、後方互換性のために保持されています。
Name
alpha_thumbnail_url
Type
string
Description
thumbnail_urlの透明背景（RGBA）バージョンへのダウンロード可能なURL。タスクがalpha_thumbnail: trueで作成され、透明プレビューが正常にレンダリングされた場合にのみ存在します。それ以外の場合、このフィールドは省略されます。
Name
thumbnail_urls
Type
object
Description
生成された3Dモデルの四方のサムネイル画像へのダウンロード可能な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の値をそのまま返します。ultra_modeを明示的に設定したmeshy-7(またはlatest)のタスクにのみ存在し、それ以外の場合は省略されます。
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オブジェクトの配列。通常は一つのテクスチャ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を返します。

例画像から3Dタスクオブジェクト

{
  "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
}

画像から3D API

画像から3Dタスクの作成

パラメータ

戻り値

失敗の原因

リクエスト

レスポンス

画像から3Dタスクの取得

パラメータ

戻り値

リクエスト

レスポンス

画像から3Dタスクの削除

パスパラメータ

戻り値

リクエスト

レスポンス

画像から3Dタスクの一覧

パラメータ

オプションの属性

戻り値

リクエスト

レスポンス

画像から3Dタスクのストリーム

パラメータ

戻り値

リクエスト

レスポンスストリーム

画像から3Dタスクオブジェクト

プロパティ

例 画像から3Dタスクオブジェクト

例画像から3Dタスクオブジェクト