画像から3D API

画像を、テクスチャ付きまたはテクスチャなしの3Dモデルへ、お好みの形式で変換します。画像を送信するか、テキストから画像または画像から画像タスクの出力を使用してください。

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

Image to 3Dタスクを作成する

Image to 3Dタスクを作成します。タスクはバックグラウンドで実行されます。タスクに通常かかる時間については、処理時間を参照してください。

Request

POST

/openapi/v1/image-to-3d

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

パラメータ

Name
input_task_id
Type
string
必須
Description
image_urlを送信しない場合は必須です。入力として使用する画像を生成した、テキストから画像または画像から画像のタスクのIDです。このタスクは、APIで作成したもので、ステータスがSUCCEEDEDであり、画像をちょうど1枚生成したものでなければなりません。

Name
image_url
Type
string
必須
Description
input_task_idを送信しない場合は必須です。3Dモデルに変換する画像を、公開URLまたはbase64エンコードされたデータURI（data:image/jpeg;base64,<your base64-encoded image data>など）として指定します。両方を送信した場合、Meshyはinput_task_idを使用します。
画像は、JPG、JPEG、PNG、またはWebPファイルで、最大20MBまでです。

Name
model_type
Type
string
デフォルト standard
Description
生成する3Dメッシュの種類です。
利用可能な値:
- standard: 高精細なメッシュ
- smart-topology: Smart Topologyモデルによるメッシュで、ai_model（meshy-t2またはmeshy-t2.5）で選択します
smart-topologyの場合、Meshyはshould_remesh、save_pre_remeshed_model、decimation_modeを無視し、topology: triangleのみを受け付けます。
Name
ai_model
Type
string
デフォルト latest
Description
3Dモデルを生成するAIモデルです。利用可能な値はmodel_typeによって異なります。
標準モデル（model_type: standard）:
- latest: Meshy 7.1
- meshy-7.1
- meshy-6
- meshy-6-lite
- meshy-7（非推奨）: 代わりにmeshy-7.1を使用してください
Smart Topologyモデル（model_type: smart-topology）は三角形を生成し、面数はtarget_polycountで設定できます:
- meshy-t2: よりクリーンなtopologyと、ネイティブに分離されたパーツ
- meshy-t2.5（デフォルト）: ゲームアセット向けのよりシャープなディテール
Name
geometry_resolution
Type
string
デフォルト standard
Description
ジオメトリ生成のパスです。
利用可能な値:
- standard
- 2k: 2048³でUltraパスを実行
- 4k: 4096³でUltraパスを実行し、最も高い表面ディテールを得られます
2kにはmeshy-7.1、latest、または非推奨のmeshy-7が必要です。4kにはmeshy-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
テクスチャを生成するかどうかです。trueの場合、テクスチャ付きのモデルを返し、falseの場合、テクスチャリングをスキップしてテクスチャなしのメッシュを返します。

次の場合のみ適用 should_texture = true

Name
enable_pbr
Type
boolean
デフォルト false
Description
ベースカラーに加えて、PBRマップ（メタリック、ラフネス、ノーマル）も生成するかどうかです。trueにはshould_texture: trueが必要で、should_texture: falseの場合は400を返します。
meshy-6の場合、Meshyはtexture_resolution: 8kを除いて、エミッションマップも生成します。以下のモデルではエミッションマップは生成されません:
- meshy-6-lite
- meshy-7
- meshy-7.1
- meshy-t2
- meshy-t2.5
- latest
Name
texture_resolution
Type
string
デフォルト 2k
Description
ベースカラーテクスチャのサイズです。テクスチャが大きいほど、より多くの表面ディテールを捉えられます。
利用可能な値:
- 2k: 2048×2048
- 4k: 4096×4096
- 8k: 8192×8192
4kと8kはmeshy-6-liteでは利用できず、使用すると400を返します。8kの場合、Meshyはエミッションマップを生成しません。
Name
hd_texture
Type
boolean
⚠ 非推奨
デフォルト false
Description
代わりにtexture_resolutionを使用してください。hd_texture: trueはtexture_resolution: "4k"と同じです。両方を送信した場合、Meshyはtexture_resolutionを使用します。
Name
texture_prompt
Type
string
Description
テクスチャを誘導するテキストで、最大800文字までです。これより長いテキストは400を返します。
Name
texture_image_url
Type
string
Description
テクスチャを誘導する画像を、公開URLまたはbase64エンコードされたデータURI（data:image/jpeg;base64,<your base64-encoded image data>など）として指定します。画像は、JPG、JPEG、PNG、またはWebPファイルで、最大20MBまでです。
Meshyはtexture_promptとtexture_image_urlのどちらか一方のみでテクスチャを誘導します。両方を送信した場合、Meshyはtexture_promptを使用します。テクスチャ生成のクレジットコストについては、料金を参照してください。
画像の形状が3Dモデルのジオメトリと大きく異なる場合、画像からのテクスチャリングがうまく機能しないことがあります。

Name
should_remesh
Type
boolean
デフォルト true (meshy-6-lite), false (other models)
Description
リメッシュフェーズを実行するかどうかです。最高品質の3Dモデルを得るには、falseに設定してください。

次の場合のみ適用 should_remesh = true

Name
topology
Type
string
デフォルト triangle
Description
リメッシュ後のモデルの面の種類です。
利用可能な値:
- quad: クアッド優位のメッシュ
- triangle: デシメーションされた三角形メッシュ
Smart Topologyの出力は三角形のみのため、meshy-t2またはmeshy-t2.5でquadを指定すると400を返します。
Name
decimation_mode
Type
integer
Description
レベルごとの適応的な面数です。これを設定すると、Meshyはtarget_polycountを無視します。
利用可能な値:
- 1: ウルトラ
- 2: 高
- 3: 中
- 4: 低
Name
save_pre_remeshed_model
Type
boolean
デフォルト false
Description
リメッシュフェーズ前のモデルのGLBも保存するかどうかです。Meshyはそれをmodel_urls.pre_remeshed_glbで返します。

Name
target_polycount
Type
integer
Description
目標とする面の数です。モデルのジオメトリによっては、結果が目標値と異なる場合があります。
これは2つの別個のケースに適用されます:
- リメッシュ: standardモデルでshould_remeshがtrueの場合、Meshyはメッシュをこの数に近い値までデシメーションします。decimation_modeを設定した場合、Meshyはそれを使用し、target_polycountを無視します。
- Smart Topology: model_typeがsmart-topologyで、ai_modelがmeshy-t2またはmeshy-t2.5の場合、Meshyはこの面数でモデルを生成します。リメッシュは実行されず、should_remeshは不要です。
範囲とデフォルト値はケースによって異なります:
ケース範囲デフォルト
リメッシュ 100～300000 30000
meshy-t2 100～15000 4000
meshy-t2.5 100～30000 15000
範囲外の値は400を返します。

ケース	範囲	デフォルト
リメッシュ	`100`～`300000`	`30000`
`meshy-t2`	`100`～`15000`	`4000`
`meshy-t2.5`	`100`～`30000`	`15000`

Name
symmetry_mode
Type
string
⚠ 非推奨
デフォルト auto
Description
出力に影響しないため、省略してください。この値は、生成時の対称性を制御していました:
- 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
surface_mode
Type
string
⚠ 非推奨
Description
代わりにai_modelを使用してください。これが選択していたモデル生成方式は廃止されているため、出力に影響しません。
使用できる値はorganicとhardです。それ以外の値は400を返します。
Name
image_enhancement
Type
boolean
デフォルト true
Description
生成前に入力画像を最適化するかどうかです。falseの場合、スタイル処理を行わず、入力画像の見た目をそのまま維持します。
これはmeshy-6、meshy-7.1、またはlatestでのみ機能します。meshy-6-liteまたはmodel_type: smart-topologyの場合は400を返します。
Name
remove_lighting
Type
boolean
デフォルト true
Description
ベースカラーテクスチャからハイライトと影を除去するかどうかです。結果はよりクリーンになり、独自のライティング下でより良く機能します。
これはmeshy-6でのみ有効です。meshy-7.1とlatestはこれを受け付けますが、無視します。meshy-6-liteまたはmodel_type: smart-topologyの場合は400を返します。
Name
moderation
Type
boolean
デフォルト false
Description
生成前に、以下の入力に有害なコンテンツが含まれていないか審査するかどうかです:
- image_url
- texture_image_url
- texture_prompt
Meshyが有害なコンテンツを検知した場合、リクエストは400を返し、Meshyはタスクを作成しません。
Name
target_formats
Type
string[]
Description
生成するファイル形式です。Meshyはここに列挙された形式のみを生成して返すため、タスクを短縮できる場合があります。省略した場合、Meshyは3mfを除くすべての形式を生成します。3mfは明示的に指定した場合にのみ取得できます。
利用可能な値:
- glb
- obj
- fbx
- stl
- usdz
- 3mf
Name
auto_size
Type
boolean
デフォルト false
Description
AIビジョンでオブジェクトの実世界での高さを推定し、モデルをそれに合わせてリサイズするかどうかです。origin_atを設定しない限り、Meshyは原点を底面に配置します。
Name
alpha_thumbnail
Type
boolean
デフォルト false
Description
透明背景（RGBA）のプレビューも生成するかどうかです。タスクを取得した際にalpha_thumbnail_urlで返されます。thumbnail_urlは変更されません。
Name
multi_view_thumbnails
Type
boolean
デフォルト false
Description
前面、右側、背面、左側のプレビューも生成するかどうかです。タスクを取得した際にthumbnail_urlsで返されます。thumbnail_urlは変更されず、引き続き前面ビューを表示します。これによりタスクに約5秒追加されます。

次の場合のみ適用 auto_size = true

Name
origin_at
Type
string
デフォルト bottom
Description
モデルの原点を配置する位置で、bottomまたはcenterです。

戻り値

レスポンスのresultフィールドには、新しいImage to 3DタスクのIDが格納されます。

失敗モード

Name
400 - Bad Request
Description
リクエストを実行できません。エラーメッセージには、検出された問題が示されます。例:
- パラメータ不足: image_urlとinput_task_idのどちらも送信されていません。
- 無効な入力タスク: input_task_idが、画像をちょうど1枚生成したSUCCEEDED状態のテキストから画像または画像から画像のタスクではありません。
- 無効な画像形式: image_urlの画像がJPG、JPEG、PNG、またはWebPファイルではありません。
- 到達不能なURL: URLが404を返すかタイムアウトするため、Meshyがimage_urlの画像をダウンロードできません。
- 画像が大きすぎる: image_urlまたはtexture_image_urlの画像が20MBを超えています。
- 無効なデータURI: base64文字列の形式が不正です。
- 無効なパラメータの組み合わせ: enable_pbrがtrueで、should_textureがfalseです。
- Ultraに対応していないモデル: geometry_resolutionが2kまたは4kで、それを実行できないai_modelが指定されています。
- 画像オプションに対応していないモデル: ai_model: "meshy-6-lite"またはmodel_type: "smart-topology"と共にimage_enhancementまたはremove_lightingが送信されました。
リクエストを修正してから、再度送信してください。エラーを参照してください。
Name
401 - Unauthorized
Description
APIキーが欠落しているか無効です。Authorizationヘッダーを確認してください。
Name
402 - Payment Required
Description
例:
- クレジット不足: アカウントにこのタスクを実行するための十分なクレジットがないか、アカウントがクレジット上限に達しています。クレジット残高を確認してから、再試行してください。
- 無料プラン: タスクの作成には有料プランが必要です。サブスクリプション設定でプランをアップグレードしてから、再試行してください。
Name
404 - Not Found
Description
input_task_idがどのタスクとも一致しません。タスクIDを確認してから、リクエストを再送信してください。
Name
429 - Too Many Requests
Description
レート制限を超えました。しばらく待ってから再試行してください。レート制限を参照してください。

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

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

IDを指定して画像から3Dタスクを返します。

Request

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

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
}

パラメータ

Name
id
Type
path
Description
作成レスポンスから取得したタスクIDです。

戻り値

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

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

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

画像から3Dタスクを、モデルやデータを含めて完全に削除します。削除は元に戻せません。

Request

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

Response

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS. The task keeps 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."
}

パスパラメータ

Name
id
Type
path
Description
削除するタスクのID。

タスクのステータス

PENDING のタスクを削除すると、作成時に使用したクレジットが返金されます。

IN_PROGRESS のタスクは削除できません。リクエストは 409 Conflict を返し、タスクはそのまま実行され続けます。Meshyは開始済みのタスクに対して返金を行わないため、それを削除するとクレジットと結果の両方を失うことになります。 SUCCEEDED、FAILED、または CANCELED になるのを待ってから削除してください。

最終ステータス（SUCCEEDED、FAILED、または CANCELED）にあるタスクを削除しても、クレジットは返金されません。

レスポンス

タスクが削除された場合は 200 OK、タスクが IN_PROGRESS の場合は 409 Conflict が返されます。

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

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

お客様の画像から3Dタスクの一覧を返します。

Request

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

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
  }
]

パラメータ

Name
page_num
Type
integer
デフォルト 1
Description
返すページ番号。ページは1から始まります。
Name
page_size
Type
integer
デフォルト 10
Description
1ページあたりのタスク数。最大100。
Name
sort_by
Type
string
Description
並び順。
利用可能な値:
- +created_at: 古い順
- -created_at: 新しい順

返り値

画像から3Dタスクオブジェクトのページネーションされたリスト。

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

画像から3Dタスクをストリーミングする

画像から3Dタスクの更新をServer-Sent Events (SSE) としてストリーミングします。

Request

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

Response Stream

// Error event example
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// These examples are shortened. Each event holds the full task object.
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
}

パラメータ

Name
id
Type
path
Description
作成レスポンスから得られるタスクID。

返り値

画像から3DタスクオブジェクトのストリームをServer-Sent Eventsとして返します。

各イベントには、Getエンドポイントが返すものと同じ形式の完全なタスクオブジェクトが含まれます。タスクがPENDINGまたはIN_PROGRESSの間は、結果フィールドにまだ値がありません。

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

画像から3Dタスクオブジェクトは、画像から3Dモデルを生成する1回のタスクを表します。これはステータス、progress、およびタスクが成功した場合のモデルファイルを保持します。

プロパティ

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
}

Name
id
Type
string
Description
タスクID。不透明な文字列として扱い、その形式に依存しないでください。
Name
type
Type
string
Description
タスクタイプ。常に image-to-3d です。
Name
model_urls
Type
object
Description
生成された3DモデルのダウンロードURL。ファイル形式ごとに1つずつあります。タスクが生成しなかった形式には、空の文字列ではなくキー自体がありません。
- Name
  glb
  Type
  string
  Description
  GLBファイル。
- Name
  fbx
  Type
  string
  Description
  FBXファイル。
- Name
  obj
  Type
  string
  Description
  OBJファイル。
- Name
  usdz
  Type
  string
  Description
  USDZファイル。
- Name
  mtl
  Type
  string
  Description
  MTLファイル。モデルにテクスチャがある場合、OBJファイルとともに返されます。
- Name
  stl
  Type
  string
  Description
  STLファイル。
- Name
  3mf
  Type
  string
  Description
  3MFファイル。target_formats に 3mf が含まれる場合のみ存在します。
- Name
  pre_remeshed_glb
  Type
  string
  Description
  リメッシュ前のGLBファイル。タスクを should_remesh: true と save_pre_remeshed_model: true の両方で作成した場合のみ存在します。
Name
thumbnail_url
Type
string
Description
3Dモデルのプレビュー画像のダウンロードURL。thumbnail_urls が存在する場合、これは thumbnail_urls.front と同じ画像です。Meshyは後方互換性のためにこれを保持しています。
Name
alpha_thumbnail_url
Type
string
Description
背景が透明（RGBA）な thumbnail_url のバージョンのダウンロードURL。タスクを alpha_thumbnail: true で作成し、かつMeshyが透明プレビューをレンダリングした場合のみ存在します。
Name
thumbnail_urls
Type
object
Description
3Dモデルを4方向から見たプレビューのダウンロードURL。各値は512×512のPNGへの署名付きURLで、thumbnail_url と同じマテリアルとライティングでレンダリングされています。これらを使えば、たとえばバッチパイプラインの中で、GLBをダウンロードせずに複数の角度からモデルをプレビューできます。
タスクを multi_view_thumbnails: true で作成し、かつタスクが SUCCEEDED に達した場合のみ存在します。multi_view_thumbnails: true なしで作成されたタスクには、このフィールドは含まれません。
- 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
タスクの完了度合いをパーセンテージで示します。タスクが開始するまでは 0、成功すると 100 になります。
Name
started_at
Type
timestamp
Description
タスクが開始した時刻（Unixミリ秒）。タスクが開始するまでは 0 です。
Name
created_at
Type
timestamp
Description
タスクが作成された時刻（Unixミリ秒）。
Name
expires_at
Type
timestamp
Description
タスクの結果が失効する時刻（Unixミリ秒）。
Name
finished_at
Type
timestamp
Description
タスクが終了した時刻（Unixミリ秒）。タスクが終了するまでは 0 です。
Name
status
Type
string
Description
タスクのステータス。PENDING、IN_PROGRESS、SUCCEEDED、FAILED、CANCELED のいずれかです。
Name
texture_urls
Type
array
Description
タスクが生成したテクスチャマップ。オブジェクトの配列として表されます。通常は1つのオブジェクトを保持し、以下のフィールドを持ちます。
- 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 または texture_resolution: 8k で作成した場合、あるいは ai_model が以下のいずれかのモデルである場合、このフィールドは存在しません。
  
  meshy-6-lite
  
  meshy-7
  
  meshy-7.1
  
  meshy-t2
  
  meshy-t2.5
  
  latest
Name
preceding_tasks
Type
integer
Description
キュー内でこのタスクより前にあるタスクの数。この値は、タスクが PENDING である間のみ意味を持ちます。
Name
task_error
Type
object
Description
タスクが失敗した場合のエラー詳細。エラーを参照してください。
Name
consumed_credits
Type
integer
Description
タスクが使用したクレジットの数。ステータスが PENDING、IN_PROGRESS、または SUCCEEDED のときに存在します。FAILED タスクでは 0 です。これは、タスクが失敗した場合にMeshyがクレジットを払い戻すためです。