画像から3D API

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


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

Image to 3D タスクを作成

この endpoint では、新しい Image to 3D タスクを作成できます。 Image to 3D タスクオブジェクトに含まれるプロパティについては、 Image to 3D タスクオブジェクトを参照してください。

パラメータ

  • Name
    input_task_id
    Type
    string
    必須
    Description

    出力を入力画像として使用する、完了済み画像生成タスクの ID。このタスクは、Text to Image または Image to Image のいずれかである必要があります。さらに、API 経由で実行され、ステータスが SUCCEEDED であり、画像をちょうど 1 枚生成している必要があります。

  • Name
    image_url
    Type
    string
    必須
    Description

    Meshy がモデル作成に使用する画像を指定します。現在、.jpg.jpeg.png 形式をサポートしています。

    画像を指定する方法は 2 つあります。

    • 公開アクセス可能な URL: 公開インターネットからアクセス可能な URL。
    • データ URI: 画像の base64 エンコード済みデータ URI。データ URI の例: data:image/jpeg;base64,<your base64-encoded image data>
  • Name
    model_type
    Type
    string
    デフォルト standard
    Description

    3D メッシュ生成の種類を指定します。

    利用可能な値:

    • standard: 通常の高精細 3D メッシュ生成。
    • lowpoly: よりクリーンなポリゴン向けに最適化されたローポリメッシュを生成します。
  • Name
    ai_model
    Type
    string
    デフォルト latest
    Description

    使用するモデルの ID。利用可能な値: meshy-5meshy-6latest (Meshy 6)。

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

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

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

    ベースカラーに加えて PBR マップ(メタリック、ラフネス、法線)を生成します。ai_modelmeshy-6 または latest の場合は、エミッションマップも含まれます。

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

    より高いディテールのために、ベースカラーテクスチャを 4K(4096×4096)解像度で生成します。

  • Name
    texture_prompt
    Type
    string
    Description

    テクスチャリングプロセスをガイドするテキストプロンプトを指定します。最大 600 文字です。

  • Name
    texture_image_url
    Type
    string
    Description

    テクスチャリングプロセスをガイドする 2D 画像を指定します。現在、.jpg.jpeg.png 形式をサポートしています。

    画像を指定する方法は 2 つあります。

    • 公開アクセス可能な URL: 公開インターネットからアクセス可能な URL
    • データ URI: 画像の base64 エンコード済みデータ URI。データ URI の例: data:image/jpeg;base64,<your base64-encoded image data>
  • Name
    should_remesh
    Type
    boolean
    デフォルト false (meshy-6), true (others)
    Description

    remesh フェーズを有効にするかどうかを制御します。false に設定すると、API は最高精度の三角形メッシュを返します。

次の場合のみ適用 should_remesh = true
  • Name
    topology
    Type
    string
    デフォルト triangle
    Description

    生成されるモデルのトポロジーを指定します。

    利用可能な値:

    • quad: 四角形優勢のメッシュを生成します。
    • triangle: 間引きされた三角形メッシュを生成します。
  • Name
    target_polycount
    Type
    integer
    デフォルト 30,000
    Description

    生成されるモデルの目標ポリゴン数を指定します。実際のポリゴン数は、ジオメトリの複雑さに応じて目標からずれる場合があります。

    有効な値の範囲はユーザー階層によって異なります:

    • 100 から 300,000(両端を含む)
  • Name
    decimation_mode
    Type
    integer
    Description

    ポリゴン数レベルを設定してアダプティブデシメーションを有効にします。設定されている場合、target_polycount は無視されます。

    利用可能な値:

    • 1: アダプティブ — 超高ポリゴン数。
    • 2: アダプティブ — 高ポリゴン数。
    • 3: アダプティブ — 中ポリゴン数。
    • 4: アダプティブ — 低ポリゴン数。
  • Name
    save_pre_remeshed_model
    Type
    boolean
    デフォルト false
    Description

    true に設定すると、Meshy は remesh フェーズが完了する前に追加の GLB ファイルも保存します。

  • 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 プロパティには、新しく作成された Image to 3D タスクのタスク id が含まれます。

失敗モード

  • Name
    400 - Bad Request
    Description

    リクエストは受け付けられませんでした。一般的な原因:

    • パラメータ不足: image_url または input_task_id のいずれかを指定する必要があります。
    • 無効な入力タスク: input_task_id は、画像をちょうど 1 枚生成する SUCCEEDED 状態の Text to Image または Image to Image タスクを参照している必要があります。
    • 無効な画像形式: 指定された image_url はサポートされている形式(.jpg、.jpeg、.png)ではありません。
    • 到達不能な URL: image_url をダウンロードできませんでした(404 またはタイムアウト)。
    • 無効なデータ URI: base64 文字列の形式が不正です。
    • 無効なパラメータの組み合わせ: enable_pbrshould_texture が true の場合のみサポートされます。
  • Name
    401 - Unauthorized
    Description

    認証に失敗しました。API key を確認してください。

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

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

Image to 3D タスクを取得

この endpoint では、有効なタスク id を指定して Image to 3D タスクを取得できます。 Image to 3D タスクオブジェクトに含まれるプロパティについては、 Image to 3D タスクオブジェクト を参照してください。

パラメータ

  • Name
    id
    Type
    path
    Description

    取得する Image to 3D タスクの一意の識別子。

戻り値

レスポンスには Image to 3D タスクオブジェクトが含まれます。詳細については、 Image to 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

Image to 3D タスクを削除

この endpoint は、関連するすべてのモデルとデータを含め、Image to 3D タスクを完全に削除します。この操作は取り消せません。

パスパラメータ

  • Name
    id
    Type
    path
    Description

    削除する Image to 3D タスクの ID。

戻り値

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

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

// Returns 200 Ok on success.

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

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

この endpoint では、画像から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

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 タスクをストリーミングする

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

パラメータ

  • Name
    id
    Type
    path
    Description

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

戻り値

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

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

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
}

Image to 3Dタスクオブジェクト

Image to 3Dタスクオブジェクトは、画像入力から3Dモデルを生成するためにMeshyが追跡する作業単位です。 このオブジェクトには以下のプロパティがあります:

プロパティ

  • Name
    id
    Type
    string
    Description

    タスクの一意識別子です。実装の詳細として、タスクIDには k-sortable UUID を使用していますが、 IDの形式については一切仮定しないでください。

  • Name
    type
    Type
    string
    Description

    画像から3Dタスクのタイプです。値は image-to-3d です。

  • Name
    model_urls
    Type
    object
    Description

    Meshy によって生成されたテクスチャ付き3Dモデルファイルへのダウンロード可能なURLです。ある形式が生成されない場合、その形式のプロパティは空文字列を返すのではなく省略されます。

    • Name
      glb
      Type
      string
      Description

      GLBファイルへのダウンロード可能なURLです。

    • Name
      fbx
      Type
      string
      Description

      FBXファイルへのダウンロード可能なURLです。

    • Name
      obj
      Type
      string
      Description

      OBJファイルへのダウンロード可能なURLです。

    • Name
      usdz
      Type
      string
      Description

      USDZファイルへのダウンロード可能なURLです。

    • Name
      mtl
      Type
      string
      Description

      MTLファイルへのダウンロード可能なURLです。テクスチャが存在する場合、OBJエクスポートと一緒に返されます。

    • Name
      stl
      Type
      string
      Description

      STLファイルへのダウンロード可能なURLです。

    • Name
      3mf
      Type
      string
      Description

      3MFファイルへのダウンロード可能なURLです。target_formats を介して 3mf がリクエストされた場合にのみ存在します。

    • Name
      pre_remeshed_glb
      Type
      string
      Description

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

  • 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

    テクスチャ作成プロセスをガイドするために使用されたテキストプロンプトです。

  • Name
    texture_image_url
    Type
    string
    Description

    テクスチャ作成プロセスをガイドするために使用されたテクスチャ画像へのダウンロード可能なURLです。

  • Name
    progress
    Type
    integer
    Description

    タスクの進捗です。タスクがまだ開始されていない場合、このプロパティは 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_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
}