テキストから3D API
テキストから3D APIは、Meshyのテキストから3Dへの機能をあなたのアプリケーションに統合することを可能にする機能です。このセクションでは、このAPIを使い始めるために必要なすべての情報が見つかります。
テキストから3Dは、2ステップのワークフローを使用します。まず、プレビュータスク (mode: "preview") を作成して、テクスチャなしの3Dメッシュを生成し、形状を評価します。その後、完了したプレビューのタスクIDをリファインタスク (mode: "refine") に渡して、メッシュにテクスチャを適用します。両方のステップは同じエンドポイントを共有します。
Text to 3Dプレビュータスクを作成する
このエンドポイントは、テキストのpromptからテクスチャなしの3Dメッシュ(ジオメトリのみ)を生成するText to 3Dプレビュータスクを作成します。これは2ステップのワークフローの最初のステップです。プレビューが成功したら、返されたタスクIDを使用してリファインタスクを作成し、テクスチャリングを行います。完全なレスポンススキーマについては、Text to 3D Task オブジェクトを参照してください。
パラメータ
- Name
- mode
- Type
- string
- 必須
- Description
プレビュータスクを作成する場合、このフィールドは "preview" に設定する必要があります。
- Name
- prompt
- Type
- string
- 必須
- Description
3Dモデルがどのようなオブジェクトかを説明します。最大800文字です。
- Name
- model_type
- Type
- string
- デフォルト standard
- Description
生成する3Dメッシュの種類を指定します。
利用可能な値:
standard: 通常の高詳細な3Dメッシュ生成。smart-topology:ai_model(meshy-t2)でSmart Topologyモデルを選択します。lowpoly(非推奨): よりクリーンなポリゴンに最適化されたローポリメッシュを生成します。代わりにsmart-topologyを使用することを推奨します。
smart-topologyを選択した場合、should_remeshとdecimation_modeは無視され、topology: triangleのみが受け付けられます。lowpolyを選択した場合、ai_model、topology、target_polycount、should_remeshは無視されます。
- Name
- ai_model
- Type
- string
- デフォルト latest
- Description
使用するモデルのID。利用可能な値は
model_typeに依存します。標準生成(
model_type: standard):meshy-5、meshy-6、meshy-7、latest(Meshy 7)
Smart Topology生成(
model_type: smart-topology):meshy-t2(デフォルト): Smart Topologyモデル — よりクリーンなtopology、ネイティブに分離されたパーツ、三角形出力、target_polycountで設定可能な面数を提供します。
- Name
- ultra_mode
- Type
- boolean
- デフォルト false
- Description
より精細な表面のディテールを持つ高忠実度のジオメトリのために、Ultra生成を有効にします。生成にはより長い時間がかかり、5クレジットが追加されます。
ai_modelがmeshy-7(またはlatest)の場合のみサポートされ、かつpreviewモードでのみ利用可能です。
- Name
- should_remesh
- Type
- boolean
- デフォルト false (meshy-6, meshy-7), true (others)
- Description
リメッシュフェーズを有効にするかどうかを制御します。最高品質のモデルを得るには、
should_remeshをfalseに設定することを推奨します。
should_remesh = true- Name
- topology
- Type
- string
- デフォルト triangle
- Description
生成されるモデルのtopologyを指定します。
利用可能な値:
quad: 四角形主体のメッシュを生成します。triangle: 削減された三角形メッシュを生成します。
Smart Topologyの出力は三角形のみです。
ai_model: meshy-t2と一緒にquadをリクエストするとエラーが返されます。
- Name
- decimation_mode
- Type
- integer
- Description
ポリゴン数レベルを設定することで、アダプティブ削減を有効にします。設定すると、
target_polycountは無視されます。利用可能な値:
1: アダプティブ — ウルトラポリゴン数。2: アダプティブ — 高ポリゴン数。3: アダプティブ — 中ポリゴン数。4: アダプティブ — 低ポリゴン数。
- Name
- target_polycount
- Type
- integer
- Description
出力のポリゴン(面)の目標数です。実際の数はジオメトリによって目標値から乖離する場合があります。
target_polycountは2つの独立したケースで有効になります:- リメッシュ —
standardモデルでshould_remesh: trueを指定した場合。メッシュはこの数に近似するようにリメッシュ(削減)されます。範囲は100〜300,000、デフォルトは30,000です。decimation_modeが設定されている場合、それが優先されtarget_polycountは無視されます。 - Smart Topology —
model_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
生成されるモデルのポーズmodeを指定します。
利用可能な値:
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スタイルは独自のPBRマップ一式を生成するため、Sculptureスタイルを使用する場合は
enable_pbrをfalseに設定する必要があります。
- 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が長すぎる:
promptが文字数制限を超えています。
- パラメータの欠落: 必須パラメータ(例:
- Name
401 - Unauthorized- Description
認証に失敗しました。APIキーを確認してください。
- Name
402 - Payment Required- Description
このタスクを実行するためのクレジットが不足しています。
- Name
429 - Too Many Requests- Description
レート制限を超えました。
Request
# 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"
}
Create a Text to 3D Refine Task
このエンドポイントは、完成したプレビューメッシュにテクスチャを適用する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マップ(メタリック、ラフネス、ノーマル)を生成します。
ai_modelがmeshy-6の場合、texture_resolution: 8kの場合を除いてエミッションマップも含まれます(8kではエミッションマップは生成されません)。meshy-7(およびlatest)ではエミッションマップは生成されません。
- Name
- texture_resolution
- Type
- string
- デフォルト 2k
- Description
ベースカラーテクスチャの解像度。
2k(2048×2048)、4k(4096×4096)、8k(8192×8192)のいずれか。解像度が高いほど、より多くの表面の詳細を捉えることができます。refinemode にのみ適用されます。4kおよび8kを使用するには、ai_modelがmeshy-6、meshy-7、またはlatestである必要があります。8kでは、エミッションマップは生成されません。
- 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>
元のアセットとアップロードされた画像との間に大きなジオメトリの差異がある場合、画像によるテクスチャ生成は最適に機能しないことがあります。テクスチャ生成プロセスをガイドするには、
texture_image_urlまたはtexture_promptのいずれか一方のみを使用できます。両方のパラメータが指定された場合、デフォルトではtexture_promptがモデルのテクスチャ生成に使用されます。
- Name
- ai_model
- Type
- string
- デフォルト latest
- Description
リファインに使用するモデルのID。利用可能な値:
meshy-5、meshy-6、meshy-7、latest(Meshy 7)。latestはここでもプレビュータスクの場合と全く同じように解決されます(現在はMeshy 7)。そのため、latestのプレビューとそのlatestのrefineは常に同じテクスチャモデルになります。
- Name
- moderation
- Type
- boolean
- デフォルト false
- Description
trueに設定すると、入力コンテンツが潜在的に有害なコンテンツについて自動的にスクリーニングされます。有害なコンテンツが検出された場合、タスクは生成に進みません。texture_promptからのテキストとtexture_image_urlからの画像の両方がスクリーニングされます。
- Name
- remove_lighting
- Type
- boolean
- デフォルト true
- Description
ベースカラーテクスチャからハイライトとシャドウを除去し、カスタムライティング設定下でより良く機能するクリーンな結果を生成します。
ai_modelがmeshy-6の場合にのみ有効です。meshy-7(および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 プロパティには、新しく作成されたText to 3Dタスクのタスク id が含まれます。
失敗モード
- Name
400 - Bad Request- Description
リクエストが受け付けられませんでした。一般的な原因:
- 無効なタスクID:
preview_task_idが無効または存在しません。 - タスクが未完了:プレビュータスクがまだ成功していません。
- モデルの不一致:プレビュータスクのAIモデルが要求されたrefineモデルと互換性がありません。
- 無効なタスクID:
- Name
401 - Unauthorized- Description
認証に失敗しました。APIキーを確認してください。
- Name
402 - Payment Required- Description
このタスクを実行するためのクレジットが不足しています。
- Name
404 - Not Found- Description
preview_task_idで指定されたプレビュータスクが見つかりませんでした。
- Name
429 - Too Many Requests- Description
レート制限を超過しました。
Request
# 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"
}
テキストから3Dタスクを取得する
このエンドポイントを使用すると、有効なタスクidを指定してテキストから3Dタスクを取得できます。
テキストから3Dタスクオブジェクトに含まれるプロパティについては、テキストから3Dタスクオブジェクトを参照してください。
このエンドポイントは、プレビュータスクとリファインタスクの両方に対応しています。
パラメータ
- Name
- id
- Type
- path
- Description
取得するテキストから3Dタスクの一意の識別子。
戻り値
レスポンスにはテキストから3Dタスクオブジェクトが含まれます。詳細はテキストから3Dタスクオブジェクトセクションを確認してください。
例
| モード | サンプルモデル |
|---|---|
| プレビュー | ![]() |
| リファイン | ![]() |
リクエスト
curl https://api.meshy.ai/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
レスポンス
{
"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
}
テキストから3Dタスクを削除する
このエンドポイントは、関連するすべてのモデルとデータを含むテキストから3Dタスクを永久に削除します。この操作は元に戻せません。
パスパラメータ
- Name
- id
- Type
- path
- Description
削除するテキストから3DタスクのID。
戻り値
成功時には 200 OK を返します。
Request
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.
テキストから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: 作成時間で降順にソート。
戻り値
ページネーションされたテキストから3Dタスクオブジェクトの一覧を返します。
リクエスト
curl https://api.meshy.ai/openapi/v2/text-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
レスポンス
[
{
"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
}
]
テキストから3Dタスクをストリームする
このエンドポイントは、Server-Sent Events (SSE) を使用してテキストから3Dタスクのリアルタイム更新をストリームします。
パラメータ
- Name
- id
- Type
- path
- Description
ストリームするテキストから3Dタスクの一意の識別子。
戻り値
Server-Sent Eventsとしてテキストから3Dタスクオブジェクトのストリームを返します。
PENDING または IN_PROGRESS のタスクの場合、レスポンスストリームには必要な progress と status フィールドのみが含まれます。
Request
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モデルを生成するために追跡する作業単位です。テキストから3D APIには、previewとrefineの2つのステージがあります。プレビューステージはメッシュのみの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
- ultra_mode
- Type
- boolean
- Description
プレビューステージタスクが作成されたときの
ultra_mode値をエコーします。meshy-7(またはlatest)プレビューステージタスクでultra_modeが明示的に設定された場合にのみ存在し、それ以外の場合は省略されます。
- 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オブジェクトのリファレンスについては、エラーを参照してください。
- 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
}

