画像から3D API

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


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

Image to 3Dタスクを作成

このエンドポイントを使用すると、新しい画像から3Dタスクを作成できます。画像から3Dタスクオブジェクトに含まれるプロパティについては、The Image to 3D Task Object を参照してください。

パラメータ

  • 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-topologyai_modelmeshy-t2)でSmart Topologyモデルを選択します。
    • lowpoly(非推奨):よりクリーンなポリゴンに最適化されたローポリメッシュを生成します。代わりに smart-topology の使用を推奨します。
  • Name
    ai_model
    Type
    string
    デフォルト latest
    Description

    使用するモデルのID。利用可能な値は model_type によって異なります。

    標準生成(model_type: standard):

    • meshy-6-litemeshy-6meshy-7.1latest(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³で実行してもっとも精細な表面ディテールを得られます。

    利用可能な値:standard2k4k

  • Name
    ultra_mode
    Type
    boolean
    非推奨
    デフォルト false
    Description

    代わりに geometry_resolution を使用してください。ultra_mode: truegeometry_resolution: "2k" と同等です。

  • Name
    should_texture
    Type
    boolean
    デフォルト true
    Description

    テクスチャを生成するかどうかを決定します。false に設定すると、テクスチャフェーズがスキップされ、テクスチャのないメッシュが提供されます。

次の場合のみ適用 should_texture = true
  • Name
    enable_pbr
    Type
    boolean
    デフォルト false
    Description

    ベースカラーに加えてPBRマップ(メタリック、ラフネス、ノーマル)を生成します。ai_modelmeshy-6 の場合、texture_resolution: 8k を除き、エミッションマップも含まれます。meshy-6-litemeshy-7.1latest はエミッションマップを生成しません。

  • Name
    texture_resolution
    Type
    string
    デフォルト 2k
    Description

    ベースカラーテクスチャの解像度。2k(2048×2048)、4k(4096×4096)、8k(8192×8192)のいずれか。解像度が高いほど、より多くの表面ディテールを捉えられます。

  • 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>
  • Name
    should_remesh
    Type
    boolean
    デフォルト false (Meshy 6 and Meshy 7 models), true (others)
    Description

    リメッシュフェーズを有効にするかどうかを制御します。最高品質のモデルを得るには、should_remeshfalse に設定することを推奨します。

次の場合のみ適用 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 Topologymodel_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 に設定すると、スタイル処理を行わずに入力画像の見た目をそのまま保持します。

  • Name
    remove_lighting
    Type
    boolean
    デフォルト true
    Description

    ベースカラーテクスチャからハイライトとシャドウを除去し、カスタムのライティング設定でよりよく機能するクリーンな結果を生成します。

  • Name
    moderation
    Type
    boolean
    デフォルト false
    Description

    true に設定すると、入力コンテンツが潜在的に有害なコンテンツかどうか自動的に審査されます。有害なコンテンツが検出された場合、タスクは生成に進みません。

    image_urltexture_image_urltexture_prompt の入力から得られるコンテンツが審査対象となります。

  • Name
    target_formats
    Type
    string[]
    Description

    出力に含める3Dファイル形式を指定します。指定された形式のみが生成・返却されるため、タスクの完了時間を短縮できます。省略した場合、サポートされているすべての形式が含まれます。

    利用可能な値:glbobjfbxstlusdz3mf

  • 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 フィールドは変更されず、引き続き正面ビューを指すため、既存のクライアントには影響がありません。

次の場合のみ適用 auto_size = true
  • Name
    origin_at
    Type
    string
    デフォルト bottom
    Description

    auto_size が有効なときの原点の位置。

    利用可能な値:bottomcenter

戻り値

レスポンスの result プロパティには、新しく作成された画像から3Dタスクのタスク id が含まれます。

失敗モード

  • Name
    400 - Bad Request
    Description

    リクエストが受け付けられませんでした。よくある原因:

    • パラメータ不足image_url または input_task_id のいずれかを指定する必要があります。
    • 無効な入力タスクinput_task_id は、画像を正確に1枚生成する SUCCEEDED 状態のテキストから画像または画像から画像のタスクを参照している必要があります。
    • 無効な画像形式:指定された image_url がサポートされている形式(.jpg、.jpeg、.png)ではありません。
    • 到達不能なURLimage_url をダウンロードできませんでした(404またはtimeout)。
    • 無効なData URI:base64文字列の形式が正しくありません。
    • 無効なパラメータの組み合わせenable_pbrshould_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

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

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

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

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

パラメータ

  • Name
    id
    Type
    path
    Description

    取得対象の画像から3Dタスクの一意の識別子です。

返り値

レスポンスには画像から3Dタスクオブジェクトが含まれます。詳細は 画像から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
}

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

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

このエンドポイントは、画像から3Dタスクを、関連するすべてのモデルとデータを含めて完全に削除します。この操作は取り消せません。

パスパラメータ

  • Name
    id
    Type
    path
    Description

    削除する画像から3DタスクのID。

タスクのステータス

まだ PENDING のタスクは削除され、作成時に消費された クレジットは返還されます。

すでに IN_PROGRESS のタスクは削除できません。リクエストは 409 Conflict で拒否され、タスクは実行され続けます。ワーカーがすでに 開始したタスクのクレジットは返還対象外のため、実行途中に削除すると クレジットと結果の両方を失うことになります。タスクが SUCCEEDEDFAILED、または CANCELED に達するのを待ってから削除してください。

終了状態(SUCCEEDEDFAILED、または CANCELED)にあるタスクは、 返金なしで削除されます。

戻り値

成功時は 200 OK を返し、タスクが IN_PROGRESS の場合は 409 Conflict を返します。

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

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

Image to 3Dタスクの一覧取得

このエンドポイントを使用すると、Image to 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: 作成時刻の降順でソートします。

戻り値

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

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

Image to 3Dタスクをストリームする

このエンドポイントは、Server-Sent Events (SSE) を使用してImage to 3Dタスクのリアルタイム更新をストリーミングします。

パラメーター

  • Name
    id
    Type
    path
    Description

    ストリーミングするImage to 3Dタスクの一意の識別子。

戻り値

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

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

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.
// 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_formats3mfがリクエストされた場合にのみ存在します。

    • Name
      pre_remeshed_glb
      Type
      string
      Description

      リメッシュ前の元のGLB出力へのダウンロード可能なURLです。

  • 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をダウンロードせずにバッチパイプライン内で複数の角度からモデルをプレビューする際に便利です。

    • 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です。

  • Name
    created_at
    Type
    timestamp
    Description

    タスクが作成された時点のタイムスタンプ(ミリ秒単位)です。

  • Name
    expires_at
    Type
    timestamp
    Description

    タスクの結果が期限切れになる時点のタイムスタンプ(ミリ秒単位)です。

  • Name
    finished_at
    Type
    timestamp
    Description

    タスクが完了した時点のタイムスタンプ(ミリ秒単位)です。タスクがまだ完了していない場合、このプロパティは0です。

  • Name
    status
    Type
    string
    Description

    タスクのステータスです。可能な値はPENDINGIN_PROGRESSSUCCEEDEDFAILEDCANCELEDのいずれかです。

  • Name
    texture_urls
    Type
    array
    Description

    タスクから生成されたテクスチャURLオブジェクトの配列です。通常これには1つのテクスチャURLオブジェクトのみが含まれます。各テクスチャURLには以下のプロパティがあります。

    • Name
      base_color
      Type
      string
      Description

      ベースカラーマップ画像へのダウンロード可能なURLです。

    • Name
      metallic
      Type
      string
      Description

      メタリックマップ画像へのダウンロード可能なURLです。

    • Name
      normal
      Type
      string
      Description

      ノーマルマップ画像へのダウンロード可能なURLです。

    • Name
      roughness
      Type
      string
      Description

      ラフネスマップ画像へのダウンロード可能なURLです。

    • Name
      emission
      Type
      string
      Description

      エミッションマップ画像へのダウンロード可能なURLです。

  • Name
    preceding_tasks
    Type
    integer
    Description

    先行タスクの数です。

  • Name
    task_error
    Type
    object
    Description

    失敗したタスクのエラー詳細です。task_errorオブジェクトの完全なリファレンスについては、エラーを参照してください。

  • Name
    consumed_credits
    Type
    integer
    Description

    このタスクによって消費されたクレジットの数です。タスクのステータスがPENDINGIN_PROGRESSSUCCEEDEDの場合に存在します。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
}