テキストから3D API

テキストから3D APIは、Meshyのテキストから3Dへの機能を独自のアプリケーションに統合する機能です。このセクションでは、このAPIを使用するためのすべての情報が見つかります。

テキストから3Dへのワークフローは2つのステップで構成されています。まず、プレビューミッション (mode: "preview") を作成して、テクスチャのない3Dメッシュを生成します。これにより形状を評価できます。次に、完成したプレビューのタスクIDをリファインミッション (mode: "refine") に渡して、メッシュにテクスチャを適用します。両方のステップは同じエンドポイントを共有します。

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

テキストから3Dプレビュータスクを作成する

このエンドポイントは、テキストプロンプトから無着色の3Dメッシュ (ジオメトリのみ) を生成するテキストから3Dプレビューミッションを作成します。これは、2ステップワークフローの最初のステップです。プレビューが成功したら、返されたタスクIDを使用してリファインミッションを作成し、テクスチャリングを行います。The Text to 3D Task Object を参照して、完全な応答スキーマをご覧ください。

パラメータ

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
リメッシュフェーズを有効にするかどうかを制御します。最高品質のモデルには、should_remesh を false に設定することをお勧めします。

次の場合のみ適用 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。
スカルプチャスタイルを使用する場合、enable_pbr は false に設定する必要があります。スカルプチャスタイルは独自の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プロパティは、新しく作成されたテキストから3Dタスクのidを含みます。

失敗時の動作

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

リクエスト

POST

/openapi/v2/text-to-3d

# 必要なパラメータのみを指定したシンプルなプレビュー
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"
}'

# リメッシュとAポーズを指定したプレビュー
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

テキストから3Dリファインミッションを作成する

このエンドポイントは、完成したプレビューメッシュにテクスチャを適用するテキストから3Dリファインミッションを作成します。成功したプレビューミッションの preview_task_id を指定する必要があります。これは2ステップワークフローの2番目のステップです。

パラメータ

Name
mode
Type
string
必須
Description
リファインミッションを作成する際は、このフィールドを"refine"に設定します。
Name
preview_task_id
Type
string
必須
Description
対応するプレビューミッションのID。
指定されたプレビューミッションのステータスはSUCCEEDEDでなければなりません。
Name
enable_pbr
Type
boolean
デフォルト false
Description
ベースカラーに加えて、メタリック、ラフネス、ノーマルのPBRマップを生成します。ai_modelがmeshy-6またはlatestの場合、texture_resolution: 8kではエミッションマップは生成されません。
Name
texture_resolution
Type
string
デフォルト 2k
Description
ベースカラーテクスチャの解像度。2k（2048×2048）、4k（4096×4096）、または8k（8192×8192）のいずれか。高解像度はより多くの表面の詳細をキャプチャします。refine mode にのみ適用されます。
4kおよび8kは、ai_model meshy-6またはlatestを必要とします。8kでは、エミッションマップは生成されません。
Name
hd_texture
Type
boolean
⚠ 非推奨
デフォルト false
Description
texture_resolution を使用してください — texture_resolution: "4k" に相当します。両方が設定されている場合、texture_resolution が優先されます。
Name
texture_prompt
Type
string
Description
テクスチャリングプロセスをガイドするための追加のテキストプロンプトを提供します。最大600文字。
Name
texture_image_url
Type
string
Description
テクスチャリングプロセスをガイドするための2D画像を提供します。現在は.jpg、.jpeg、および.png形式をサポートしています。
画像を提供する方法は2つあります：
- 公開アクセス可能なURL: インターネットからアクセスできるURL
- Data URI: 画像のbase64-エンコードされたData URI。Data URIの例：data:image/jpeg;base64,<your base64-encoded image data>
画像テクスチャリングは、元のアセットとアップロードされた画像との間に大きなジオメトリの違いがある場合、最適に機能しないことがあります。テクスチャリングプロセスをガイドするために使用できるのはtexture_image_urlまたはtexture_promptのいずれか一方のみです。両方のパラメータが提供された場合、デフォルトでtexture_promptが使用されてモデルのテクスチャリングが行われます。
Name
ai_model
Type
string
デフォルト latest
Description
リファインに使用するモデルの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
ベースカラーテクスチャからハイライトとシャドウを削除し、カスタム照明セットアップでより良く機能するクリーンな結果を生成します。
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ビジョンを使用してオブジェクトの現実世界の高さを自動的に推定し、モデルをそれに応じてリサイズします。origin_at が明示的に設定されていない限り、原点はデフォルトでbottomに設定されます。

次の場合のみ適用 auto_size = true

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

戻り値

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

失敗時の動作

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

リクエスト

POST

/openapi/v2/text-to-3d

# 基本的なリファインミッション
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
}'

# オートサイズとGLB形式のリファイン
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

テキストから3Dタスクを取得する

このエンドポイントを利用することで、有効なタスク id を指定してテキストから3Dへのタスクを取得できます。 The Text to 3D Task Objectを参照して、テキストから3Dタスクオブジェクトに含まれるプロパティを確認してください。

このエンドポイントは、プレビューとリファインの両方のタスクに対応しています。

パラメータ

Name
id
Type
path
Description
取得するテキストから3Dへのタスクのユニーク識別子です。

戻り値

レスポンスにはテキストから3Dタスクのオブジェクトが含まれます。詳細については、The Text to 3D Task Objectセクションをご覧ください。

例

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

リクエスト

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

テキストから3Dタスクを削除する

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

パスパラメータ

Name
id
Type
path
Description
削除するテキストから3DへのタスクのIDです。

戻り値

成功時は200 OKが返されます。

リクエスト

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

// 成功時は200 Okが返されます。

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

テキストから3Dタスクを一覧表示する

このエンドポイントを使用して、テキストから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: 作成時間を降順でソートします。

戻り値

The Text to 3D Task Objectsのページネートされたリストを返します。

リクエスト

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

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

このエンドポイントは、Server-Sent Events (SSE)を使用してテキストから3Dへのタスクのリアルタイムアップデートをストリーミングします。

パラメータ

Name
id
Type
path
Description
ストリームするテキストから3Dへのタスクのユニーク識別子です。

戻り値

Server-Sent EventsとしてストリームされたThe Text to 3D Task Objectsを返します。

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

リクエスト

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

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

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

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "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モデルを生成する作業単位です。テキストから3D APIには2つの段階があります： preview と refine。プレビューステージはメッシュのみの3Dモデルを生成するためのものであり、リファインステージはプレビューステージの結果に基づいてテクスチャ化された3Dモデルを生成します。

オブジェクトには以下のプロパティがあります：

プロパティ

Name
id
Type
string
Description
タスクのユニーク識別子です。タスクIDには実装の詳細としてkソート可能なUUIDを使用していますが、このIDの形式については何も仮定しないでください。
Name
type
Type
string
Description
テキストから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 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
失敗したタスクのエラーディテールです。Errorsを参照して、完全なtask_errorオブジェクトリファレンスを確認してください。
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,
  "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
}