テキストから3D API

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

テキストから3Dは2段階のワークフローを使用します。まず、previewタスク（mode: "preview"）を作成して、テクスチャのない3Dメッシュを生成し、形状を評価できるようにします。次に、完了したpreviewのタスクIDをrefineタスク（mode: "refine"）に渡して、メッシュにテクスチャを適用します。両方のステップは同じエンドポイントを共有します。

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

Create a Text to 3D Preview Task

このエンドポイントは、Text to 3D プレビュータスクを作成します。これは、テキストプロンプトからテクスチャのない3Dメッシュ（ジオメトリのみ）を生成します。これは2段階ワークフローの最初のステップです。プレビューが成功したら、返されたタスクIDを使用してrefineタスクを作成し、テクスチャリングを行います。完全なレスポンススキーマについては、 The Text to 3D Task Objectを参照してください。

タスクはバックグラウンドで実行されます。通常の所要時間については、処理時間を参照してください。

パラメータ

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（非推奨、2026年10月30日に廃止予定）: よりクリーンなポリゴンに最適化されたローポリメッシュを生成します。代わりに Meshy T2 を推奨します: meshy-t2 を使用した smart-topology。
smart-topology が選択されている場合、should_remesh と decimation_mode は無視され、topology: triangle のみが受け付けられます。
lowpoly は2026年10月30日に廃止予定です。それ以降、model_type: "lowpoly" を指定したリクエストはエラーを返します。Meshy T2（ai_model: "meshy-t2" を使用した model_type: "smart-topology"）への切り替えを推奨します。lowpoly が選択されている場合、ai_model、topology、target_polycount、should_remesh は無視されます。
Name
ai_model
Type
string
デフォルト latest
Description
使用するモデルのID。利用可能な値は model_type によって異なります。
標準生成（model_type: standard）:
- meshy-6-lite、meshy-6、meshy-7.1、latest（Meshy 7.1）
- meshy-7（非推奨）: 代わりに meshy-7.1 を使用してください。
Smart Topology 生成（model_type: smart-topology）:
- meshy-t2（デフォルト）: Smart Topology モデル — よりクリーンな topology、ネイティブに分離されたパーツ、triangle 出力、そして target_polycount で設定可能な面数。
Name
geometry_resolution
Type
string
デフォルト standard
Description
ジオメトリ生成パス。2k は2048³で Ultra パスを実行し、4k は4096³で実行して最も精細な表面ディテールを得ます。
利用可能な値: standard、2k、4k
preview mode でのみサポートされます。meshy-7.1 または latest が必要です。
Name
ultra_mode
Type
boolean
⚠ 非推奨
デフォルト false
Description
代わりに geometry_resolution を使用してください。ultra_mode: true は geometry_resolution: "2k" と同等です。
Name
should_remesh
Type
boolean
デフォルト false (Meshy 6 and Meshy 7 models), true (others)
Description
remesh フェーズを有効にするかどうかを制御します。最高品質のモデルの場合、should_remesh を false に設定することを推奨します。

次の場合のみ適用 should_remesh = true

Name
topology
Type
string
デフォルト triangle
Description
生成されるモデルの topology を指定します。
利用可能な値:
- quad: quad を主体としたメッシュを生成します。
- triangle: 間引かれた triangle メッシュを生成します。
Smart Topology の出力は triangle のみです。ai_model: meshy-t2 と同時に quad をリクエストするとエラーが返されます。
Name
decimation_mode
Type
integer
Description
ポリゴン数レベルを設定することで、アダプティブな decimation を有効にします。設定すると、target_polycount は無視されます。
利用可能な値:
- 1: アダプティブ — 超高ポリゴン数。
- 2: アダプティブ — 高ポリゴン数。
- 3: アダプティブ — 中ポリゴン数。
- 4: アダプティブ — 低ポリゴン数。

Name
target_polycount
Type
integer
Description
出力におけるポリゴン（面）の目標数。ジオメトリによっては、実際の数は目標値から外れる場合があります。
target_polycount は2つの独立したケースで効果を発揮します:
- リメッシュ — standard モデルで should_remesh: true を使用した場合。メッシュはこの数に近づくようにリメッシュ（decimation）されます。範囲は100〜300,000、デフォルトは30,000です。decimation_mode が設定されている場合、そちらが優先され target_polycount は無視されます。
- Smart Topology — model_type: smart-topology と ai_model: meshy-t2 を使用した場合。モデルはこの面数で直接生成され、remesh は実行されず 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
生成されるモデルの pose 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 が文字数制限を超えています。
- low poly でサポートされないモデル: 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/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 Ultra 4K geometry, 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",
  "ai_model": "meshy-7.1",
  "geometry_resolution": "4k",
  "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

Create a Text to 3D Refine Task

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

タスクはバックグラウンドで実行されます。通常の所要時間については、Processing Timesを参照してください。

パラメータ

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-6-lite、meshy-7.1、latestではエミッションマップは生成されません。
Name
texture_resolution
Type
string
デフォルト 2k
Description
ベースカラーテクスチャの解像度です。2k（2048×2048）、4k（4096×4096）、8k（8192×8192）のいずれかを指定します。解像度が高いほど、より多くの表面の詳細を捉えることができます。refine modeにのみ適用されます。
4kおよび8kにはai_modelとしてmeshy-6、meshy-7.1、または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、.webp形式をサポートしています。
最大ファイルサイズ：20 MB。
画像を指定する方法は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
デフォルト inherited from the preview task
Description
refineに使用するモデルのIDです。
利用可能な値：
- meshy-6-lite、meshy-6、meshy-7.1、latest（Meshy 7.1）
- meshy-7（非推奨）：代わりにmeshy-7.1を使用してください。
このパラメータを省略すると、プレビュータスクで使用されたモデルを継承し、プレビューとそのrefineを最初から最後まで同じモデルに保ちます。この継承を上書きするには、明示的な値を渡してください。
明示的にlatestを指定した場合、ここではプレビュータスクの場合と全く同じように解決されます（現在はMeshy 7.1）。そのため、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の場合にのみ有効です。他のモデルではこの設定は無視されます。
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モデルと互換性がありません。
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

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

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

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

このエンドポイントは、previewタスクとrefineタスクの両方に対応しています。

パラメータ

Name
id
Type
path
Description
取得するテキストから3Dタスクの一意の識別子。

戻り値

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

例

Mode	サンプルモデル
Preview
Refine

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

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

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

パスパラメータ

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

タスクステータス

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

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

終了状態（SUCCEEDED、FAILED、またはCANCELED）にあるタスクは、返金なしで削除されます。

戻り値

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

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

// 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/v2/text-to-3d

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

このエンドポイントを使用すると、Text to 3Dタスクの一覧を取得できます。

パラメータ

Name
page_num
Type
integer
デフォルト 1
Description
ページネーション用のページ番号。
Name
page_size
Type
integer
デフォルト 10
Description
ページサイズの上限。最大100件まで指定できます。
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タスクをストリーミングする

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

パラメータ

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

戻り値

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

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
}

Text to 3D Task オブジェクト

Text to 3D Task オブジェクトは、テキスト入力から3Dモデルを生成するためにMeshyが管理する作業単位です。Text to 3D APIにはpreviewとrefineの2つのステージがあります。previewステージはメッシュのみの3Dモデルを生成するためのもので、refineステージはpreviewステージの結果をもとにテクスチャ付きの3Dモデルを生成するためのものです。

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

プロパティ

Name
id
Type
string
Description
タスクの一意な識別子です。実装の詳細としてタスクIDにはk-sortable UUIDを使用していますが、このidのフォーマットについていかなる前提も置かないでください。
Name
type
Type
string
Description
Text to 3Dタスクのタイプです。指定可能な値は、previewステージのタスクを表すtext-to-3d-previewと、refineステージのタスクを表す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
previewタスクの作成に使用された、変更されていないart_styleです。Meshy-6ではサポートされていません。
Name
texture_richness
Type
string
⚠ 非推奨
Description
後方互換性のために維持されています。このフィールドは生成されるモデルに機能的な影響を与えません。
Name
texture_prompt
Type
string
Description
refineステージでのテクスチャリングプロセスを導くために提供される追加のテキストプロンプトです。
Name
ultra_mode
Type
boolean
⚠ 非推奨
Description
非推奨です。代わりにgeometry_resolutionを参照してください。
Name
geometry_resolution
Type
string
Description
previewタスクが実行されたUltraのティア（2kまたは4k）です。standardの場合は省略されます。
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
タスクのprogressです。タスクがまだ開始されていない場合、このプロパティは0になります。タスクが成功すると、100になります。
Name
started_at
Type
timestamp
Description
タスクが開始された時刻をミリ秒単位で表したタイムスタンプです。タスクがまだ開始されていない場合、このプロパティは0になります。
タイムスタンプは、RFC 3339標準に従い、1970年1月1日UTCからの経過ミリ秒数を表します。例えば、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
タスクから生成されたtexture URLオブジェクトの配列です。通常、これには1つのtexture URLオブジェクトのみが含まれます。各texture 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-6-liteの場合、このプロパティは省略されます。
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
}