Text to 3D API

Text to 3D API は、Meshy の Text to 3D 機能をあなた自身のアプリケーションに統合できる機能です。このセクションでは、この API を使い始めるために必要なすべての情報を確認できます。

Text to 3D は 2 段階のワークフローを使用します。まず、プレビュータスク（mode: "preview"）を作成して、テクスチャなしの 3D メッシュを生成し、形状を評価できるようにします。次に、完了したプレビューのタスク ID をリファインタスク（mode: "refine"）に渡して、メッシュにテクスチャを適用します。どちらの手順も同じ endpoint を共有します。

POST/openapi/v2/text-to-3d

Text to 3D プレビュータスクを作成

この endpoint は、テキストプロンプトからテクスチャなしの 3D メッシュ（ジオメトリのみ）を生成する Text to 3D プレビュータスクを作成します。これは 2 ステップワークフローの最初のステップです。プレビューが成功したら、返されたタスク ID を使用して、テクスチャ付けのためにリファインタスクを作成します。完全なレスポンススキーマについては Text to 3D タスクオブジェクトを参照してください。

パラメータ

Name
mode
Type
string
必須
Description
プレビュータスクを作成する場合、このフィールドは "preview" に設定する必要があります。
Name
prompt
Type
string
必須
Description
3D モデルがどのようなオブジェクトかを説明します。最大 600 文字です。
Name
model_type
Type
string
デフォルト standard
Description
3D メッシュ生成のタイプを指定します。
利用可能な値:
- standard: 通常の高精細 3D メッシュ生成。
- lowpoly: よりクリーンなポリゴン向けに最適化されたローポリメッシュを生成します。
lowpoly が選択されている場合、ai_model、topology、target_polycount、should_remesh は無視されます。
Name
ai_model
Type
string
デフォルト latest
Description
使用するモデルの ID。利用可能な値: meshy-5、meshy-6、latest (Meshy 6)。
Name
should_remesh
Type
boolean
デフォルト false (meshy-6), true (others)
Description
リメッシュフェーズを有効にするかどうかを制御します。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
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
art_style
Type
string
⚠ 非推奨
デフォルト realistic
Description
Meshy-6 ではサポートされていません。Meshy-6 を使用するリクエストでは art_style は無視され、一部の組み合わせではエラーが発生する場合があります。利用可能な値: realistic、sculpture。
Sculpture スタイルを使用する場合、enable_pbr は false に設定する必要があります。Sculpture スタイルは独自の PBR マップセットを生成するためです。
Name
moderation
Type
boolean
デフォルト false
Description
true に設定すると、入力コンテンツは潜在的に有害なコンテンツがないか自動的にスクリーニングされます。有害なコンテンツが検出された場合、タスクは生成に進みません。
prompt のテキストがスクリーニングされます。
Name
target_formats
Type
string[]
Description
出力に含める 3D ファイル形式を指定します。リクエストされた形式のみが生成されて返されるため、タスク完了時間を短縮できます。省略した場合、サポートされているすべての形式が含まれます。
利用可能な値: glb、obj、fbx、stl、usdz、3mf
省略した場合、3mf を除くすべての形式が生成されます。3mf は明示的に指定された場合のみ含まれます。
Name
alpha_thumbnail
Type
boolean
デフォルト false
Description
true に設定すると、タスクはプレビューの透明背景（RGBA）バージョンを追加でレンダリングし、GET レスポンスで alpha_thumbnail_url として返します。既存の thumbnail_url フィールドは変更されません。
Name
auto_size
Type
boolean
デフォルト false
Description
true に設定すると、サービスは AI ビジョンを使用してオブジェクトの実世界での高さを自動的に推定し、それに応じてモデルのサイズを変更します。origin_at が明示的に設定されていない限り、原点はデフォルトで bottom になります。

次の場合のみ適用 auto_size = true

Name
origin_at
Type
string
デフォルト bottom
Description
auto_size が有効な場合の原点の位置。
利用可能な値: bottom、center。

戻り値

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

失敗モード

Name
400 - Bad Request
Description
リクエストは受け入れられませんでした。一般的な原因:
- パラメータ不足: 必須パラメータ（例: prompt、mode）が不足しています。
- 無効なパラメータ: art_style が許可された値のいずれでもありません。
- プロンプトが長すぎる: prompt が文字数制限を超えています。
Name
401 - Unauthorized
Description
認証に失敗しました。API key を確認してください。
Name
402 - Payment Required
Description
このタスクを実行するためのクレジットが不足しています。
Name
429 - Too Many Requests
Description
レート制限を超過しました。

Request

POST

/openapi/v2/text-to-3d

# Simple preview with required params only
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a monster mask"
}'

# Preview with remesh and A-pose
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a futuristic robot warrior",
  "should_remesh": true,
  "target_polycount": 100000,
  "pose_mode": "a-pose",
  "target_formats": ["glb"]
}'

Response

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

POST/openapi/v2/text-to-3d

Text to 3D Refine タスクを作成

この endpoint は、完了したプレビュー mesh に texture を適用する Text to 3D refine タスクを作成します。成功したプレビュータスクの preview_task_id を指定する必要があります。これは 2 ステップワークフローの 2 番目のステップです。

パラメータ

Name
mode
Type
string
必須
Description
refine タスクを作成する場合、このフィールドは "refine" に設定する必要があります。
Name
preview_task_id
Type
string
必須
Description
対応するプレビュータスク ID。
指定されたプレビュータスクのステータスは SUCCEEDED である必要があります。
Name
enable_pbr
Type
boolean
デフォルト false
Description
ベースカラーに加えて PBR マップ（metallic、roughness、normal）を生成します。ai_model が meshy-6 または latest の場合は、emission マップも含まれます。
Name
hd_texture
Type
boolean
デフォルト false
Description
より高いディテールのために、ベースカラー texture を 4K（4096×4096）解像度で生成します。
ai_model が meshy-6 または latest の場合にのみサポートされます。PBR マップは常に 2K で生成されます。
Name
texture_prompt
Type
string
Description
texturing プロセスをガイドする追加のテキストプロンプトを指定します。最大 600 文字です。
Name
texture_image_url
Type
string
Description
texturing プロセスをガイドする 2D 画像を指定します。現在、.jpg、.jpeg、.png 形式をサポートしています。
画像を指定する方法は 2 つあります。
- 公開アクセス可能な URL: 公開インターネットからアクセス可能な URL
- Data URI: 画像の base64 エンコードされた data URI。data URI の例: data:image/jpeg;base64,<your base64-encoded image data>
元のアセットとアップロードされた画像の間に大きなジオメトリ差異がある場合、画像による texturing は最適に機能しない可能性があります。texturing プロセスをガイドするために使用できるのは、texture_image_url または texture_prompt のいずれか一方のみです。両方のパラメータが指定された場合、デフォルトでは texture_prompt がモデルの texture に使用されます。
Name
ai_model
Type
string
デフォルト latest
Description
refining に使用するモデルの ID。利用可能な値: meshy-5、meshy-6、latest（Meshy 6）。
Name
moderation
Type
boolean
デフォルト false
Description
true に設定すると、入力コンテンツは潜在的に有害なコンテンツがないか自動的にスクリーニングされます。有害なコンテンツが検出された場合、タスクは生成に進みません。
texture_prompt のテキストと texture_image_url の画像の両方がスクリーニングされます。
Name
remove_lighting
Type
boolean
デフォルト true
Description
ベースカラー texture からハイライトとシャドウを除去し、カスタムライティング設定下でより適切に機能する、よりクリーンな結果を生成します。
ai_model が meshy-6 または latest の場合にのみサポートされます。
Name
target_formats
Type
string[]
Description
出力に含める 3D ファイル形式を指定します。リクエストされた形式のみが生成されて返されるため、タスク完了時間を短縮できます。省略した場合、サポートされているすべての形式が含まれます。
利用可能な値: glb、obj、fbx、stl、usdz、3mf
省略した場合、3mf を除くすべての形式が生成されます。3mf は明示的に指定された場合にのみ含まれます。
Name
alpha_thumbnail
Type
boolean
デフォルト false
Description
true に設定すると、タスクは追加でプレビューの透過背景（RGBA）バージョンをレンダリングし、GET レスポンスで alpha_thumbnail_url として返します。既存の thumbnail_url フィールドは変更されません。
Name
auto_size
Type
boolean
デフォルト false
Description
true に設定すると、サービスは AI vision を使用してオブジェクトの実世界での高さを自動的に推定し、それに応じてモデルのサイズを変更します。origin_at が明示的に設定されていない限り、原点はデフォルトで bottom になります。

次の場合のみ適用 auto_size = true

Name
origin_at
Type
string
デフォルト bottom
Description
auto_size が有効な場合の原点の位置。
利用可能な値: bottom、center。

戻り値

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

失敗モード

Name
400 - Bad Request
Description
リクエストは受け入れられませんでした。一般的な原因:
- 無効なタスク ID: preview_task_id が無効であるか、存在しません。
- タスクが準備未完了: プレビュータスクはまだ成功していません。
- モデルの不一致: プレビュータスクの AI モデルは、リクエストされた refine モデルと互換性がありません。
Name
401 - Unauthorized
Description
認証に失敗しました。API key を確認してください。
Name
402 - Payment Required
Description
このタスクを実行するためのクレジットが不足しています。
Name
404 - Not Found
Description
preview_task_id で指定されたプレビュータスクが見つかりませんでした。
Name
429 - Too Many Requests
Description
レート制限を超過しました。

Request

POST

/openapi/v2/text-to-3d

# Basic refine task
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "enable_pbr": true
}'

# Refine with auto-size and GLB format
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "target_formats": ["glb"],
  "auto_size": true
}'

Response

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

GET/openapi/v2/text-to-3d/:id

Text to 3D タスクを取得する

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

この endpoint は、プレビュータスクとリファインタスクの両方で機能します。

パラメータ

Name
id
Type
path
Description
取得する Text to 3D タスクの一意の識別子。

戻り値

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

例

モード	サンプルモデル
プレビュー
リファイン

Request

GET

/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-3d-preview",
  "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=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?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=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "prompt": "a monster mask",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 20
}

DELETE/openapi/v2/text-to-3d/:id

Text to 3D タスクを削除

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

パスパラメータ

Name
id
Type
path
Description
削除する Text to 3D タスクの ID。

戻り値

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

Request

DELETE

/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

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

Response

// Returns 200 Ok on success.

GET/openapi/v2/text-to-3d

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

この endpoint では、Text to 3D タスクの一覧を取得できます。

パラメータ

Name
page_num
Type
integer
デフォルト 1
Description
ページネーション用のページ番号。
Name
page_size
Type
integer
デフォルト 10
Description
ページサイズの上限。許可される最大値は 50 件です。
Name
sort_by
Type
string
Description
ソートに使用するフィールド。
利用可能な値:
- +created_at: 作成時刻の昇順でソートします。
- -created_at: 作成時刻の降順でソートします。

戻り値

Text to 3D タスクオブジェクトのページネーションされた一覧を返します。

Request

GET

/openapi/v2/text-to-3d

curl https://api.meshy.ai/openapi/v2/text-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "text-to-3d-preview",
    "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=***",
      "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "prompt": "a monster mask",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {

      "message": ""

    },

    "consumed_credits": 20
  }
]

GET/openapi/v2/text-to-3d/:id/stream

Text to 3D タスクをストリーミングする

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

パラメータ

Name
id
Type
path
Description
ストリーミングする Text to 3D タスクの一意の識別子。

戻り値

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

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

Request

GET

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

curl -N https://api.meshy.ai/openapi/v2/text-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",
  "progress": 50,
  "status": "IN_PROGRESS"
}

event: message
data: {
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "text-to-3d-preview",
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1692771650657,
"started_at": 1692771667037,
"finished_at": 1692771669037,
"model_urls": {
  "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
},
"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": 20
}

テキストから3Dへのタスクオブジェクト

テキストから3Dへのタスクオブジェクトは、Meshy が テキスト 入力から3Dモデルを生成するために追跡する作業単位です。Text to 3D API には、preview と refine の2つのステージがあります。プレビューステージはメッシュのみの3Dモデルを生成するためのもので、リファインステージはプレビューステージの結果に基づいてテクスチャ付きの3Dモデルを生成するためのものです。

このオブジェクトには次のプロパティがあります:

プロパティ

Name
id
Type
string
Description
タスクの一意の識別子です。実装上の詳細として、タスクIDにはkソート可能なUUIDを使用していますが、 idの形式についてはいかなる仮定も行わないでください。
Name
type
Type
string
Description
Text to 3Dタスクの種類です。指定可能な値は、プレビューステージのタスクを表すtext-to-3d-previewと、リファインステージのタスクを表すtext-to-3d-refineです。
Name
model_urls
Type
object
Description
Meshyによって生成された、テクスチャ付き3Dモデルファイルのダウンロード可能なURLです。ある形式が生成されていない場合、空文字列を返すのではなく、その形式のプロパティは省略されます。
- Name
  glb
  Type
  string
  Description
  GLBファイルのダウンロード可能なURLです。
- Name
  fbx
  Type
  string
  Description
  FBXファイルのダウンロード可能なURLです。
- Name
  usdz
  Type
  string
  Description
  USDZファイルのダウンロード可能なURLです。
- Name
  obj
  Type
  string
  Description
  OBJファイルのダウンロード可能なURLです。
- Name
  mtl
  Type
  string
  Description
  MTLファイルのダウンロード可能なURLです。
- Name
  stl
  Type
  string
  Description
  STLファイルのダウンロード可能なURLです。
- Name
  3mf
  Type
  string
  Description
  3MFファイルのダウンロード可能なURLです。target_formatsを介して3mfが要求された場合にのみ存在します。
Name
prompt
Type
string
Description
これは、タスクの作成に使用された未変更のpromptです。
Name
negative_prompt
Type
string
⚠ 非推奨
Description
後方互換性のために維持されています。このフィールドは生成されるモデルに機能的な影響を与えません。
Name
art_style
Type
string
⚠ 非推奨
Description
プレビュータスクの作成に使用された未変更のart_styleです。Meshy-6ではサポートされていません。
Name
texture_richness
Type
string
⚠ 非推奨
Description
後方互換性のために維持されています。このフィールドは生成されるモデルに機能的な影響を与えません。
Name
texture_prompt
Type
string
Description
リファインステージでテクスチャリングプロセスをガイドするために提供される追加のテキストプロンプトです。
Name
texture_image_url
Type
string
Description
テクスチャリングプロセスをガイドするために使用されたテクスチャ画像のダウンロード可能なURLです。
Name
thumbnail_url
Type
string
Description
モデルファイルのサムネイル画像のダウンロード可能なURLです。
Name
alpha_thumbnail_url
Type
string
Description
thumbnail_urlの透明背景（RGBA）バージョンへのダウンロード可能なURLです。タスクがalpha_thumbnail: trueで作成され、透明プレビューのレンダリングに成功した場合にのみ存在します。それ以外の場合、このフィールドは省略されます。
Name
video_url
Type
string
⚠ 非推奨
Description
プレビュービデオのダウンロード可能なURLです。今後のリリースで削除される予定です。
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
finished_at
Type
timestamp
Description
タスクが完了した時刻のタイムスタンプ（ミリ秒）です。タスクがまだ完了していない場合、このプロパティは0になります。
Name
status
Type
string
Description
タスクのステータスです。指定可能な値はPENDING、IN_PROGRESS、SUCCEEDED、FAILED、CANCELEDのいずれかです。
Name
texture_urls
Type
array
Description
タスクから生成されるテクスチャURLオブジェクトの配列です。通常、これには1つのテクスチャURLオブジェクトのみが含まれます。各テクスチャURLには次のプロパティがあります。
- Name
  base_color
  Type
  string
  Description
  ベースカラーマップ画像のダウンロード可能なURLです。
- Name
  metallic
  Type
  string
  Description
  メタリックマップ画像のダウンロード可能なURLです。
  タスクがenable_pbr: falseで作成された場合、このプロパティは省略されます。
- Name
  normal
  Type
  string
  Description
  ノーマルマップ画像のダウンロード可能なURLです。
  タスクがenable_pbr: falseで作成された場合、このプロパティは省略されます。
- Name
  roughness
  Type
  string
  Description
  ラフネスマップ画像のダウンロード可能なURLです。
  タスクがenable_pbr: falseで作成された場合、このプロパティは省略されます。
- Name
  emission
  Type
  string
  Description
  エミッションマップ画像のダウンロード可能なURLです。
  タスクがenable_pbr: falseで作成された場合、またはai_modelがmeshy-5の場合、このプロパティは省略されます。
Name
preceding_tasks
Type
integer
Description
先行タスクの数です。
このフィールドの値は、タスクのステータスがPENDINGの場合にのみ意味を持ちます。
Name
task_error
Type
object
Description
失敗したタスクのエラー詳細です。完全なtask_errorオブジェクトリファレンスについては、Errorsを参照してください。
Name
consumed_credits
Type
integer
Description
このタスクによって消費されたクレジット数です。タスクのステータスがPENDING、IN_PROGRESS、またはSUCCEEDEDの場合に存在します。FAILEDタスクでは0を返します（失敗時にクレジットは返金されます）。

Example Text to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-3d-preview",
  "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=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  },
  "prompt": "a monster mask",
  "texture_prompt": "green slimy skin with scales and warts",
  "texture_image_url": "",
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "progress": 100,
  "seed": 1234,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "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": 20
}