マルチ画像から3D API
同一の被写体を異なる角度から撮影した1枚から4枚の画像から、3Dモデルを生成します。
マルチ画像から3Dタスクを作成する
マルチ画像から3Dタスクを作成します。タスクはバックグラウンドで実行されます。タスクに通常どのくらいの時間がかかるかについては、処理時間を参照してください。タスクが持つフィールドについては、マルチ画像から3Dタスクオブジェクトを参照してください。
Request
# Simple request
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"image_urls": [
"<your publicly accessible image url or base64-encoded data URI>",
"<your second publicly accessible image url or base64-encoded data URI>"
]
}'
# With Ultra 2K geometry, PBR texturing, and GLB format
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"image_urls": [
"<your publicly accessible image url or base64-encoded data URI>",
"<your second publicly accessible image url or base64-encoded data URI>"
],
"ai_model": "meshy-7.1",
"geometry_resolution": "2k",
"should_texture": true,
"enable_pbr": true,
"target_formats": ["glb"]
}'
# Textured with Meshy N1 from the input images, the first as the front view
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"image_urls": [
"<your front view image url or base64-encoded data URI>",
"<your back view image url or base64-encoded data URI>"
],
"ai_model": "meshy-7.1",
"texture_model": "meshy-n1"
}'
Response
{
"result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
パラメータ
- Name
- input_task_id
- Type
- string
- 必須
- Description
image_urlsを送信する場合を除き必須です。テキストから画像または画像から画像のタスク(マルチビューのものを含む)のIDです。Meshyはその1〜4枚の画像を入力として使用します。タスクはAPIで作成し、ステータスがSUCCEEDEDであるものでなければなりません。
- Name
- image_urls
- Type
- array
- 必須
- Description
input_task_idを送信する場合を除き必須です。1〜4枚の画像を、それぞれ公開URLまたはData URI(data:image/jpeg;base64,<your base64-encoded image data>など)として指定します。両方を送信した場合、Meshyはinput_task_idを使用します。各画像は
.jpg、.jpeg、.png、または.webpファイルで、最大20MB、各辺が最小32ピクセル、最大178,956,970ピクセル(幅×高さ)である必要があります。4枚を超える画像を送信すると400が返されます。最良の結果を得るには、画像は同じオブジェクトを異なる角度から写したものにしてください。
meshy-7.1またはlatestでは、Meshyは最初の画像を正面ビューとして使用し、他の画像の順序は問いません。
- Name
- ai_model
- Type
- string
- デフォルト latest
- Description
3Dモデルを生成するAIモデルです。
利用可能な値:
latest:Meshy 7.1meshy-7.1meshy-6meshy-6-litemeshy-7:非推奨、代わりにmeshy-7.1を送信してください。2026年12月31日に廃止されます。
実物オブジェクトや3Dプリントなど、プロジェクトに適したモデルについてはモデルを参照してください。
- Name
- geometry_resolution
- Type
- string
- デフォルト standard
- Description
生成するジオメトリの詳細度です。
利用可能な値:
standard2k:2048³でUltraパスを実行します。meshy-7.1、latest、または非推奨のmeshy-7が必要です。
- Name
- ultra_mode
- Type
- boolean
- ⚠ 非推奨
- デフォルト false
- Description
代わりに
geometry_resolutionを送信してください。ultra_mode: trueはgeometry_resolution: "2k"と同じです。
- Name
- should_texture
- Type
- boolean
- デフォルト true
- Description
テクスチャを生成するかどうかです。
trueはテクスチャ付きモデルを返し、falseはテクスチャ生成ステップをスキップしてテクスチャなしのメッシュを返します。
should_texture = true- Name
- texture_model
- Type
- string
- デフォルト depends on ai_model
- Description
同じタスク内で、複数のビューから3Dモデルにテクスチャを適用するAIモデルです。省略すると、お使いの
ai_modelのデフォルトのテクスチャモデルが使用されます。クレジットのコストは変わりません。利用可能な値:
meshy-7:Meshy 7、PBRマップと最大8Kのテクスチャに対応meshy-n1:Meshy N1、参照画像のみから生成される2Kのベースカラーテクスチャ
すべての
ai_modelが両方を利用できます。meshy-6またはmeshy-6-liteでテクスチャ付きリクエストを送信すると400が返され、選択したテクスチャモデルがサポートしていないオプションを指定した場合も同様です。should_texture: falseの場合、Meshyはtexture_modelを無視しますが、未知の値を指定すると400が返されます。meshy-n1では、Meshyはtexture_image_urlsまたはtexture_image_urlから、またはどちらも送信しない場合は入力画像からテクスチャを生成します。最初の画像が正面ビューです。生成されたモデルの三角形数が7,999,999を超えるとタスクは失敗し、Meshyはクレジットを返金します。各テクスチャモデルの機能とどれを選ぶべきかについては、モデルを参照してください。
- Name
- enable_pbr
- Type
- boolean
- デフォルト false
- Description
ベースカラーに加えて、メタリック、ラフネス、法線マップも生成するかどうかです。Meshy 6テクスチャモデルは、
texture_resolution: 8kの場合を除き、エミッションマップも生成します。texture_model: meshy-n1でtrueを指定すると400が返されます。
- Name
- texture_resolution
- Type
- string
- デフォルト 2k
- Description
ベースカラーテクスチャのサイズです。サイズが大きいほど、より多くの表面の詳細を捉えます。
利用可能な値:
2k:2048×20484k:4096×40968k:8192×8192
4kと8kはMeshy 7またはMeshy 6テクスチャモデルが必要で、それ以外では400が返されます。8kでは、Meshyはエミッションマップを生成しません。
- Name
- hd_texture
- Type
- boolean
- ⚠ 非推奨
- デフォルト false
- Description
代わりに
texture_resolutionを送信してください。hd_texture: trueはtexture_resolution: "4k"と同じです。両方を送信した場合、Meshyはtexture_resolutionを使用します。
- Name
- texture_prompt
- Type
- string
- Description
テクスチャの指針となるテキストで、最大800文字です。これより長いテキストは
400を返します。texture_model: meshy-n1で送信すると400が返されます。
- Name
- texture_image_url
- Type
- string
- Description
テクスチャの指針となる1枚の2D画像で、公開URLまたはData URI(
data:image/jpeg;base64,<your base64-encoded image data>など)として指定します。画像は.jpg、.jpeg、.png、または.webpファイルで、最大20MB、各辺が最小32ピクセル、最大178,956,970ピクセル(幅×高さ)である必要があります。texture_image_urlとtexture_promptの両方を送信した場合、Meshyはtexture_promptを使用します。texture_model: meshy-n1の場合、Meshyはこの画像を正面ビューとしてテクスチャを生成します。画像内の形状が3Dモデルと大きく異なる場合、テクスチャがうまく仕上がらないことがあります。
- Name
- texture_image_urls
- Type
- string[]
- Description
テクスチャの指針となる、異なる視点からのオブジェクトの1〜4枚の画像です。Meshyは最初の画像を正面ビューとして使用します。他のビュー(左、背面、右)の順序は問いません。
各画像は
texture_image_urlと同じルールに従います。公開URLまたはData URIで、.jpg、.jpeg、.png、または.webp形式、最大20MB、各辺が最小32ピクセル、最大178,956,970ピクセル(幅×高さ)である必要があります。これらの画像はテクスチャのみに影響し、
image_urlsには依存しません。この2つのリストは異なる画像、異なる枚数の画像を保持できます。texture_image_urlsにはMeshy 7またはMeshy N1テクスチャモデルが必要です。次のいずれかと一緒に送信してください:meshy-7.1、latest、または非推奨のmeshy-7のai_modelmeshy-7またはmeshy-n1のtexture_model
texture_image_urlやtexture_promptと一緒に送信することはできません。
- Name
- should_remesh
- Type
- boolean
- デフォルト true (meshy-6-lite), false (other models)
- Description
生成後にモデルをリメッシュするかどうかです。最高品質の3Dモデルを得るには、
falseに設定してください。
should_remesh = true- Name
- topology
- Type
- string
- デフォルト triangle
- Description
リメッシュされたモデルの面タイプです。
利用可能な値:
quad:クアッド優位のメッシュtriangle:デシメーションされた三角形メッシュ
texture_model: meshy-n1では、モデルがリメッシュされる場合(meshy-6-liteではデフォルトでそうなります)、quadは400を返します。
- Name
- target_polycount
- Type
- integer
- デフォルト 30000
- Description
目標とする面の数で、
100から300000までです。モデルのジオメトリによっては、結果が目標値と異なる場合があります。範囲外の値を指定すると400が返されます。
- Name
- decimation_mode
- Type
- integer
- Description
レベル別のアダプティブな面数です。これを設定すると、Meshyは
target_polycountを無視します。利用可能な値:
1:ウルトラ2:高3:中4:低
- Name
- save_pre_remeshed_model
- Type
- boolean
- デフォルト false
- Description
リメッシュ前のGLBも保存するかどうかです。
model_urls.pre_remeshed_glbに返されます。
- Name
- symmetry_mode
- Type
- string
- ⚠ 非推奨
- デフォルト auto
- Description
省略してください。出力には影響しません。
利用可能な値:
off:対称なしauto:入力ジオメトリに基づく対称on:強制対称
- Name
- pose_mode
- Type
- string
- Description
キャラクターモデルのポーズで、
a-poseまたはt-poseです。ポーズなしにするには、pose_modeとis_a_t_poseを省略してください。
- Name
- is_a_t_pose
- Type
- boolean
- ⚠ 非推奨
- デフォルト false
- Description
代わりに
pose_modeを送信してください。モデルをAポーズまたはTポーズで生成するかどうかです。
- Name
- image_enhancement
- Type
- boolean
- デフォルト true
- Description
生成前に入力画像を最適化するかどうかです。
falseは、スタイル処理を行わず入力画像の見た目をそのまま維持します。meshy-6、meshy-7.1、またはlatestでのみサポートされます。meshy-6-liteで送信すると400が返されます。
- Name
- remove_lighting
- Type
- boolean
- デフォルト true
- Description
ベースカラーテクスチャからハイライトと影を除去するかどうかです。この処理によりきれいになった結果は、自分で照明を当てる際により良く機能します。これを使用するのはMeshy 6テクスチャモデルのみで、
texture_resolution: 8kでは常に照明を除去します。texture_model: meshy-n1でtrueを指定すると400が返されます。ai_model: meshy-6-liteとそのデフォルトのテクスチャモデルで送信すると400が返されます。
- Name
- moderation
- Type
- boolean
- デフォルト false
- Description
入力に有害なコンテンツが含まれていないかを審査するかどうかです。Meshyは各入力画像、
texture_image_urlまたはtexture_image_urls内の各画像、およびtexture_prompt内のテキストを審査します。Meshyが有害なコンテンツを検出した場合、リクエストは400を返し、Meshyはタスクを作成しません。
- Name
- target_formats
- Type
- string[]
- Description
生成する3Dファイル形式です。Meshyはリストした形式のみを生成して返すため、タスクの時間を短縮できます。
利用可能な値:
glbobjfbxstlusdz3mf
省略した場合、Meshyは
3mfを除くすべての形式を生成します。3mfはリストに含めた場合のみ生成されます。
- Name
- auto_size
- Type
- boolean
- デフォルト false
- Description
AIビジョンでオブジェクトの実際の高さを推定し、モデルをそのサイズにリサイズするかどうかです。
origin_atを設定しない限り、Meshyは原点を底に配置します。
auto_size = true- Name
- origin_at
- Type
- string
- デフォルト bottom
- Description
モデルの原点をどこに配置するかで、
bottomまたはcenterです。
- Name
- alpha_thumbnail
- Type
- boolean
- デフォルト false
- Description
透明な背景(RGBA)のプレビューも生成するかどうかです。タスク取得時に
alpha_thumbnail_urlに返されます。thumbnail_urlは変わりません。
- Name
- multi_view_thumbnails
- Type
- boolean
- デフォルト false
- Description
正面、右、背面、左のプレビューも生成するかどうかです。タスク取得時に
thumbnail_urlsに返されます。thumbnail_urlは変わらず、引き続き正面ビューを示します。これによりタスクに約5秒追加されます。
戻り値
レスポンスのresultフィールドには、新しいマルチ画像から3Dタスクのidが保持されます。
失敗モード
- Name
400 - Bad Request- Description
リクエストを実行できません。エラーメッセージには検出された問題が示されます。例:
- パラメータの欠落:
image_urlsとinput_task_idのどちらも送信されませんでした。 - 無効な入力タスク:
input_task_idがSUCCEEDEDのテキストから画像または画像から画像のタスク(マルチビューのものを含む)ではありません。 - 無効な画像数:
image_urlsまたはtexture_image_urlsが1〜4枚の画像を保持していません。 - 無効な画像形式:
image_urls内の画像がサポートされている形式ではありません。 - 競合するテクスチャ入力:
texture_image_urlsがtexture_image_url、texture_prompt、またはshould_texture: falseと一緒に送信されました。 - マルチビューテクスチャに対応していないモデル:
texture_image_urlsがai_modelのmeshy-6またはmeshy-6-liteと一緒に送信されました(texture_modelがmeshy-7またはmeshy-n1である場合を除く)。 - 到達不能なURL:Meshyが
image_urlsまたはtexture_image_urls内の画像をダウンロードできません。 - 画像サイズが大きすぎる:
image_urls、texture_image_url、またはtexture_image_urls内の画像が20MBを超えています。 - 無効な画像サイズ:
image_urls、texture_image_url、またはtexture_image_urls内の画像の辺が32ピクセル未満、または178,956,970ピクセル(幅×高さ)を超えています。 - マルチ画像入力に対応していない解像度:
geometry_resolutionが"4k"ですが、このエンドポイントはこれをサポートしていません。2kまたはstandardを使用してください。 - 画像オプションに対応していないモデル:
image_enhancementがai_model: "meshy-6-lite"と一緒に送信されたか、remove_lightingがai_model: "meshy-6-lite"とそのデフォルトのテクスチャモデルと一緒に送信されました。 - 無効なテクスチャモデル:
texture_modelが有効なテクスチャモデル名ではありません。 - テクスチャモデルが利用不可:テクスチャ付きリクエストで
texture_modelにmeshy-6またはmeshy-6-liteが送信されました。マルチ画像から3Dは、複数のビューからテクスチャを生成するテクスチャモデルのみを受け付けます。meshy-7またはmeshy-n1を送信するか、texture_modelを省略してください。 - テクスチャモデルに対応していないオプション:リクエストが、テクスチャモデルがサポートしていないオプション(
meshy-n1でのenable_pbr: trueや、meshy-6-liteでの4kテクスチャなど)を要求しています。モデルを参照してください。
リクエストを修正してから、再度送信してください。エラーを参照してください。
- パラメータの欠落:
- Name
401 - Unauthorized- Description
APIキーが欠落しているか無効です。
Authorizationヘッダーを確認してください。
- Name
402 - Payment Required- Description
例:
- クレジット不足:アカウントにこのタスクに必要な十分なクレジットがないか、アカウントがクレジット上限に達しています。クレジット残高を確認してから、再試行してください。
- 無料プラン:タスクの作成には有料プランが必要です。サブスクリプション設定でプランをアップグレードしてから、再試行してください。
- Name
403 - Forbidden- Description
コンテンツモデレーションによりプロンプトまたは入力画像がブロックされました。入力を変更してから、再試行してください。
- Name
404 - Not Found- Description
input_task_idがお使いのどのタスクとも一致しません。タスクIDを確認してから、リクエストを再度送信してください。
- Name
429 - Too Many Requests- Description
レート制限を超過しました。しばらく待ってから、再試行してください。レート制限を参照してください。
マルチ画像から3Dタスクを取得する
IDを指定してマルチ画像から3Dタスクを返します。
Request
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "multi-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"
}
],
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 30
}
マルチ画像から3Dタスクを削除
マルチ画像から3Dタスクを、そのモデルやデータも含めて完全に削除します。削除を取り消すことはできません。
Request
curl --request DELETE \
--url https://api.meshy.ai/openapi/v1/multi-image-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 keeps 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."
}
パスパラメータ
- Name
- id
- Type
- path
- Description
削除するタスクのID。
タスクのステータス
PENDING のタスクを削除すると、作成時に使用したクレジットが返金されます。
IN_PROGRESS のタスクは削除できません。リクエストは 409 Conflict を返し、
タスクは実行を続けます。Meshyはすでに開始されたタスクについては返金を行わないため、
削除するとクレジットと結果の両方を失うことになります。タスクが
SUCCEEDED、FAILED、または CANCELED のいずれかに達するのを待ってから削除してください。
最終ステータス(SUCCEEDED、FAILED、または CANCELED)にあるタスクを削除しても、
クレジットは返金されません。
戻り値
タスクが削除された場合は 200 OK、タスクが IN_PROGRESS の場合は 409 Conflict が返されます。
Multi-Image to 3Dタスクの一覧取得
お客様のマルチ画像から3Dタスクの一覧を返します。
Request
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
[
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "multi-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"
}
],
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 30
}
]
パラメータ
- Name
- page_num
- Type
- integer
- デフォルト 1
- Description
返すページ番号。最大
255まで指定できます。これより大きい値を指定すると400が返されます。
- Name
- page_size
- Type
- integer
- デフォルト 10
- Description
ページあたりのタスク数。最大
100まで指定できます。
- Name
- sort_by
- Type
- string
- Description
ソート順。
利用可能な値:
+created_at: 古い順-created_at: 新しい順
戻り値
Multi-Image to 3Dタスクオブジェクトのページネーションされたリスト。
マルチ画像から3Dタスクをストリーミングする
マルチ画像から3Dタスクの更新をServer-Sent Events(SSE)としてストリーミングします。
Request
curl -N https://api.meshy.ai/openapi/v1/multi-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.
// These examples are shortened. Each event holds the full task object.
event: message
data: {
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"progress": 0,
"status": "PENDING"
}
event: message
data: {
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "multi-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"
}
],
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 30
}
パラメータ
- Name
- id
- Type
- path
- Description
作成レスポンスから取得したタスクID。
戻り値
マルチ画像から3DタスクオブジェクトのストリームをServer-Sent Eventsとして返します。
各イベントは、Getエンドポイントが返すものと同じ形式で、タスクオブジェクト全体を保持します。タスクがPENDINGまたはIN_PROGRESSの間は、結果フィールドにはまだ値が入っていません。
Multi-Image to 3D タスクオブジェクト
Multi-Image to 3D タスクオブジェクトは、1つのオブジェクトの1枚から4枚の画像から3Dモデルを生成する1回分の処理を表します。タスクの状態、進行状況、そしてタスクが成功した場合のモデルファイルを保持します。
プロパティ
Example Multi-Image to 3D Task Object
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "multi-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"
}
],
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 30
}
- Name
- id
- Type
- string
- Description
タスクID。不透明な文字列として扱い、その形式に依存しないでください。
- Name
- type
- Type
- string
- Description
タスクタイプ。常に
multi-image-to-3dです。
- Name
- model_urls
- Type
- object
- Description
生成された3DモデルのダウンロードURL。ファイル形式ごとに1つずつ存在します。タスクが生成しなかった形式は、空文字列ではなくキー自体が存在しません。
- Name
glb- Type
- string
- Description
GLBファイル。
- Name
fbx- Type
- string
- Description
FBXファイル。
- Name
obj- Type
- string
- Description
OBJファイル。
- Name
usdz- Type
- string
- Description
USDZファイル。
- Name
mtl- Type
- string
- Description
MTLファイル。モデルにテクスチャがある場合、OBJファイルと共に返されます。
- Name
stl- Type
- string
- Description
STLファイル。
- Name
3mf- Type
- string
- Description
3MFファイル。
target_formatsに3mfが含まれる場合にのみ存在します。
- Name
pre_remeshed_glb- Type
- string
- Description
リメッシュ前のGLBファイル。
should_remesh: trueとsave_pre_remeshed_model: trueの両方を指定してタスクを作成した場合にのみ存在します。
- Name
- thumbnail_url
- Type
- string
- Description
モデルのプレビュー画像のダウンロードURL。
thumbnail_urls.frontが存在する場合、そのフィールドと同じ値になります。
- Name
- alpha_thumbnail_url
- Type
- string
- Description
thumbnail_urlの背景を透過(RGBA)にしたバージョンのダウンロードURL。タスクをalpha_thumbnail: trueで作成し、Meshyが透過プレビューをレンダリングした場合にのみ存在します。
- Name
- thumbnail_urls
- Type
- object
- Description
3Dモデルを4方向から見たプレビュー画像のダウンロードURL。それぞれ512×512のPNGへの署名付きURLで、
thumbnail_urlと同じマテリアルとライティングでレンダリングされています。GLBをダウンロードせずに、複数の角度からモデルをプレビューするために使用できます。タスクを
multi_view_thumbnails: trueで作成し、タスクがSUCCEEDEDに達した場合にのみ存在します。multi_view_thumbnails: trueを指定せずに作成されたタスクには、このフィールドはありません。- 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_urls
- Type
- string[]
- Description
タスクの作成時に使用したテクスチャ参照画像のダウンロードURL。送信した順序で並びます。タスクを
texture_image_urlsで作成した場合にのみ存在します。
- Name
- ultra_mode
- Type
- boolean
- ⚠ 非推奨
- Description
代わりに
geometry_resolutionを参照してください。
- Name
- geometry_resolution
- Type
- string
- Description
タスクが実行されたUltraティア。値は
2kです。standardのタスクにはこのフィールドはありません。
- Name
- progress
- Type
- integer
- Description
タスクの完了度合いをパーセンテージで示します。タスクが開始するまでは
0、成功すると100になります。
- Name
- started_at
- Type
- timestamp
- Description
タスクが開始した時刻(UnixミリSecond)。タスクが開始するまでは
0です。
- Name
- created_at
- Type
- timestamp
- Description
タスクが作成された時刻(Unixミリ秒)。
- Name
- expires_at
- Type
- timestamp
- Description
タスクの結果が失効する時刻(Unixミリ秒)。
- Name
- finished_at
- Type
- timestamp
- Description
タスクが完了した時刻(Unixミリ秒)。タスクが完了するまでは
0です。
- Name
- status
- Type
- string
- Description
タスクの状態。
PENDING、IN_PROGRESS、SUCCEEDED、FAILED、CANCELEDのいずれかです。
- Name
- texture_urls
- Type
- array
- Description
タスクが生成したテクスチャマップのダウンロードURLを、オブジェクトの配列として保持します。通常はオブジェクトを1つだけ保持します。各オブジェクトには次のフィールドがあります。
- Name
base_color- Type
- string
- Description
ベースカラーマップ。
- Name
metallic- Type
- string
- Description
メタリックマップ。タスクを
enable_pbr: falseで作成した場合は含まれません。
- Name
normal- Type
- string
- Description
ノーマルマップ。タスクを
enable_pbr: falseで作成した場合は含まれません。
- Name
roughness- Type
- string
- Description
ラフネスマップ。タスクを
enable_pbr: falseで作成した場合は含まれません。
- Name
emission- Type
- string
- Description
エミッションマップ。次のすべての条件でタスクを作成した場合にのみ含まれます。
ai_model: meshy-6(デフォルトのテクスチャモデルを使用)enable_pbr: truetexture_resolutionが2kまたは4k
- Name
- preceding_tasks
- Type
- integer
- Description
キュー内でこのタスクより前にあるタスクの数。この値はタスクが
PENDINGの間のみ意味を持ちます。
- Name
- task_error
- Type
- object
- Description
タスクが失敗した場合のエラー詳細。状態が
FAILEDでない限りnullです。エラーを参照してください。
- Name
- consumed_credits
- Type
- integer
- Description
タスクが使用したクレジット数。状態が
PENDING、IN_PROGRESS、SUCCEEDEDのいずれかの場合に存在します。タスクが失敗した場合、Meshyはクレジットを返金するため、FAILEDのタスクでは0になります。