Auto Split API
3Dモデルを、自動で、指定したパーツ名で、または色の領域ごとに、個別に印刷可能なパーツへ分割します。コネクタをオプションで追加でき、カットによって生じた薄い領域は常に補強されるため、どのパーツも中実(ソリッド)に印刷されます。
分割結果では、入力時のテクスチャは保持されません。 Auto Split はテクスチャ付きの入力を受け付けるため、should_texture: false でモデルを再生成する必要はありません。カットされたパーツを再構築し、それぞれに単色の頂点カラーを割り当てます。入力時のテクスチャマップは、どのエクスポート形式にも引き継がれません。
Auto Splitタスクを作成する
このエンドポイントは、新しいAuto Splitタスクを作成します。このタスクは、以前のタスクのモデルを個別に印刷可能なパーツに切り分け、分割されたモデルを返します。各パーツはファイル内でそれぞれ独立したオブジェクトになります。
タスクはバックグラウンドで実行されます。通常どのくらいの時間がかかるかについては、処理時間を参照してください。
パラメータ
- Name
- input_task_id
- Type
- string
- 必須
- Description
分割対象のモデルを持つ、成功したタスクのIDです。サポートされるタスクタイプ: 画像から3D、マルチ画像から3D、テキストから3D(プレビュー)、リメッシュ、変換、リサイズ。タスクのステータスは
SUCCEEDEDである必要があり、そのモデルはMeshy 6またはMeshy 7(ai_modelがmeshy-6、meshy-7、meshy-7.1、またはlatest)で生成されている必要があります。ローポリおよびSmart Topology(meshy-t2、meshy-t2.5)モデルはサポートされていません。テクスチャ付きモデルは受け付けられますが、そのテクスチャは結果に引き継がれません。
- Name
- mode
- Type
- string
- デフォルト auto
- Description
モデルをパーツに分割する方法です。
利用可能な値:
mode = by_parts or by_color- Name
- prompt
- Type
- string
- 必須
- Description
分割先のパーツを、任意の言語で記述します。Meshyはここから1〜10個のパーツ名を読み取るため、モデルを説明するのではなく、パーツに名前を付けてください。例えば
split into the figure and the base、またはhead, torso, left arm, right arm, legsのようにします。パーツを1つだけ指定することも可能です。名前を付けなかった部分はすべて1つの残りのパーツとなるため、the headと指定すると、ウェブアプリと同様に、モデルは頭とそれ以外の部分に分割されます。最大600文字です。まったく分割しないことを求める説明や、10個を超えるパーツを指定する説明は400で拒否され、料金は発生しません。Meshyが説明からパーツ名を1つも読み取れない場合は、代わりに選択したmodeにおいて、モデルの参照画像から識別したパーツに沿って分割します。この場合もタスクは実行され、課金されますが、prompt_ignored: trueが付与されます。モデルに参照画像がない場合、またはMeshyがその中から2つ未満のパーツしか見つけられない場合は、そのリクエストは代わりに400で拒否され、料金は発生しません。
- Name
- target_formats
- Type
- array
- デフォルト ["glb"]
- Description
分割後のモデルをエクスポートする形式です。シーンオブジェクトをサポートする形式(
glb、obj、fbx、usdz、blend、3mf)は、各パーツを個別のオブジェクトとして保持します。stlには個別のオブジェクトという概念がないため、layoutで配置されたすべてのパーツを1つの立体に統合します(スライサーで個別に選択可能なパーツが必要な場合は3mfをリクエストしてください)。glbは常に生成され、model_urlsで返されます。それ以外に必要な形式があれば追加で指定してください。利用可能な値:
glb、obj、fbx、stl、usdz、blend、3mf。
- Name
- layout
- Type
- string
- デフォルト assembled
- Description
各出力形式およびサムネイルにおけるパーツの配置方法です。
利用可能な値:
assembled: パーツはソースモデルにあった位置にとどまります。on_plate: パーツは平らに並べられ、ビルドプレート上に広げられ、すぐにスライスできる状態になります。これはウェブアプリのOn Plate表示と同じ配置です。
どちらの配置においても、切断によって生じた潰れた薄片や点状の残りパーツは、エクスポート前に除去されるため、取得するパーツはすべて印刷可能です。シーンオブジェクトをサポートする形式では、パーツごとに1つのオブジェクトを保持します。
stlはそれらを1つの立体に統合します。
- Name
- connectors
- Type
- boolean
- デフォルト false
- Description
各切断面にほぞ継ぎ(mortise-and-tenon)のコネクタを追加し、印刷したパーツ同士がはまり合うようにします。
connectors = true- Name
- connector_type
- Type
- string
- デフォルト cube
- Description
各切断面におけるコネクタの形状です。
利用可能な値:
cube、cylinder。
- Name
- connector_size
- Type
- number
- デフォルト 0.5
- Description
切断面に対する相対的なコネクタのサイズです。
有効範囲:
0.1〜0.8。
- Name
- connector_height
- Type
- number
- デフォルト 0.1
- Description
切断面に対する相対的な、コネクタが切断面からどれだけ突き出るかです。
有効範囲:
0.1〜0.8。
戻り値
レスポンスのresultプロパティには、新しく作成されたAuto Splitタスクのidが含まれます。
失敗モード
- Name
400 - Bad Request- Description
リクエストが受理できませんでした。一般的な原因:
- promptの欠落:
modeがby_partsまたはby_colorの場合、promptは必須です。 - promptが分割を求めていない、またはパーツが多すぎる:
by_parts/by_colorは1〜10個の名前付きパーツを受け付けます。モデルを1つのままにしておくことを求める説明や、10個を超えるパーツを指定する説明は拒否されます。料金は発生しません。 - サポートされていない入力タスク:
input_task_idは、Meshy 6またはMeshy 7で生成された、サポート対象タイプの成功したタスクを参照している必要があります。 - 参照画像がない:
by_colorには、アップロードされた画像から生成された入力が必要です。 - コネクタの値が範囲外:
connector_sizeまたはconnector_heightが0.1〜0.8の範囲外です。
- promptの欠落:
- Name
401 - Unauthorized- Description
認証に失敗しました。APIキーを確認してください。
- Name
402 - Payment Required- Description
このタスクを実行するためのクレジットが不足しています。
- Name
404 - Not Found- Description
input_task_idが存在しないか、あなたのアカウントに属していません。
- Name
429 - Too Many Requests- Description
レート制限を超過しました。
by_partsとby_colorのリクエストは、アカウントごとに1分あたり12リクエストというprompt解析用の制限も共有しています。
- Name
503 - Service Unavailable- Description
prompt based splitting(
by_partsとby_color)は一時的に利用できません。後で再試行するか、その影響を受けないmode: "auto"を使用してください。料金は発生しません。
Request
# Simple request: let Meshy choose the cuts
curl https://api.meshy.ai/openapi/v1/print/split \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578"
}'
# Advanced request: name the parts, add connectors, export glb and obj
curl https://api.meshy.ai/openapi/v1/print/split \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"mode": "by_parts",
"prompt": "split into the figure and the base",
"target_formats": ["glb", "obj"],
"layout": "on_plate",
"connectors": true,
"connector_type": "cylinder",
"connector_size": 0.4
}'
Response
{
"result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}
Auto Splitタスクを取得する
このエンドポイントは、IDを指定してAuto Splitタスクを取得します。
パラメータ
- Name
- id
- Type
- path
- Description
取得するAuto SplitタスクのID。
戻り値
Auto Split Taskオブジェクト。
Request
curl https://api.meshy.ai/openapi/v1/print/split/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
{
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "print-split",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
"part_count": 4,
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000082000,
"task_error": null,
"consumed_credits": 10
}
Auto Splitタスクを削除する
このエンドポイントは、関連するすべてのモデルとデータを含め、Auto Splitタスクを完全に削除します。この操作は取り消せません。
パスパラメータ
- Name
- id
- Type
- path
- Description
削除するAuto SplitタスクのID。
タスクのステータス
まだPENDING状態のタスクは削除され、作成時に消費されたクレジットは
返金されます。
すでにIN_PROGRESS状態のタスクは削除できません。リクエストは
409 Conflictで拒否され、タスクは実行され続けます。ワーカーがすでに
開始したタスクのクレジットは返金対象外のため、実行途中で削除すると
クレジットと結果の両方を失うことになります。SUCCEEDED、FAILED、または
CANCELEDになるまで待ってから削除してください。
終了状態(SUCCEEDED、FAILED、またはCANCELED)にあるタスクは、
返金なしで削除されます。
戻り値
成功時は200 OKを返し、タスクがIN_PROGRESSの場合は
409 Conflictを返します。
Request
curl --request DELETE \
--url https://api.meshy.ai/openapi/v1/print/split/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-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."
}
Auto Split タスク一覧の取得
このエンドポイントでは、Auto Split タスクの一覧を取得できます。
パラメータ
任意の属性
- Name
- page_num
- Type
- integer
- Description
ページネーションのページ番号。
1から始まり、デフォルトは1です。
- Name
- page_size
- Type
- integer
- Description
ページサイズの上限。デフォルトは
10件です。最大値は100件で、これを超える値は100に制限されます。
- Name
- sort_by
- Type
- string
- Description
並び替えに使用するフィールド。使用可能な値:
+created_at:作成時刻の昇順で並び替えます。-created_at:作成時刻の降順で並び替えます。
戻り値
Auto Split タスクオブジェクトのページネーションされたリストを返します。
Request
curl https://api.meshy.ai/openapi/v1/print/split?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
[
{
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "print-split",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
"part_count": 4,
"progress": 100,
"status": "SUCCEEDED",
"preceding_tasks": 0,
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000082000,
"task_error": null,
"consumed_credits": 10
}
]
Auto Split タスクをストリーミングする
このエンドポイントは、Server-Sent Events(SSE)を使用して Auto Split タスクのリアルタイム更新をストリーミングします。
パラメータ
- Name
- id
- Type
- path
- Description
ストリーミング対象の Auto Split タスクを識別する一意の ID です。
返り値
Auto Split タスクオブジェクトのストリームを Server-Sent Events として返します。
各 message イベントは、Auto Split タスクを取得するで返されるものと同じ完全なタスクオブジェクトを運びます。これには consumed_credits、各種タイムスタンプ、prompt_ignored が含まれます。タスクが PENDING または IN_PROGRESS の間はフレームごとに変化するフィールドが progress、status、started_at、preceding_tasks であり、SUCCEEDED に到達すると model_urls、thumbnail_url、part_count が現れます。error イベントには status_code と message のみが含まれるため、status を読む前にイベント名で分岐してください。
Request
curl -N https://api.meshy.ai/openapi/v1/print/split/a43b5c6d-7e8f-901a-234b-567c890d1e2f/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 (other task fields omitted here for brevity;
// each frame is the full task object).
event: message
data: {
"id": "a43b5c6d-7e8f-901a-234b-567c890d1e2f",
"progress": 0,
"status": "PENDING"
}
event: message
data: {
"id": "a43b5c6d-7e8f-901a-234b-567c890d1e2f",
"type": "print-split",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/a43b5c6d-7e8f-901a-234b-567c890d1e2f/output/model.glb?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/a43b5c6d-7e8f-901a-234b-567c890d1e2f/output/preview.png?Expires=***",
"part_count": 4,
"progress": 100,
"status": "SUCCEEDED",
"preceding_tasks": 0,
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000082000,
"task_error": null,
"consumed_credits": 10
}
Auto Split タスクオブジェクト
Auto Split タスクには以下のプロパティのみが含まれます。他のタスクオブジェクトに含まれる生成プロンプト関連のフィールド(name、object_prompt、texture_prompt など)、単一の model_url、および texture_urls は、分割タスクでは決して設定されず、返されません。タスクの実行中に埋まっていくプロパティ(thumbnail_url、model_urls、各タイムスタンプ)は常に存在し、値が入るまでは空のままなので、キーの集合は PENDING と SUCCEEDED の間で変化しません。
- Name
- id
- Type
- string
- Description
タスクの一意な識別子です。実装の詳細として、タスク ID には k-sortable UUID を使用していますが、id のフォーマットについて何らかの前提を置くべきではありません。
- Name
- type
- Type
- string
- Description
タスクのタイプです。値は
print-splitです。
- Name
- model_urls
- Type
- object
- Description
分割されたモデルのダウンロード可能な URL で、リクエストしたフォーマットごとに1つずつ提供されます。シーンオブジェクトをサポートするフォーマットでは各パーツが別々のオブジェクトとして保持されますが、
stlはそれらを1つのソリッドに融合します。リクエストされなかったフォーマットのプロパティは省略されます。- Name
glb- Type
- string
- Description
GLB フォーマットの分割モデルへのダウンロード可能な URL です。
- Name
obj- Type
- string
- Description
OBJ フォーマットの分割モデルへのダウンロード可能な URL です。
- Name
fbx- Type
- string
- Description
FBX フォーマットの分割モデルへのダウンロード可能な URL です。
- Name
stl- Type
- string
- Description
STL フォーマットの分割モデルへのダウンロード可能な URL です。すべてのパーツは1つのソリッドに融合されます。個別に選択可能なパーツが必要な場合は
3mfをリクエストしてください。
- Name
usdz- Type
- string
- Description
USDZ フォーマットの分割モデルへのダウンロード可能な URL です。
- Name
blend- Type
- string
- Description
Blender フォーマットの分割モデルへのダウンロード可能な URL です。
- Name
3mf- Type
- string
- Description
3MF フォーマットの分割モデルへのダウンロード可能な URL です。
- Name
- thumbnail_url
- Type
- string
- Description
分割されたモデルのレンダリングプレビューへのダウンロード可能な URL で、各パーツが異なる色で表示され、リクエストされた
layoutで表示されます。
- Name
- prompt_ignored
- Type
- boolean
- Description
by_partsまたはby_colorリクエストのpromptでパーツ名が指定されなかった場合にtrueとなり、この場合 Meshy は自動的にモデルを分割します — 結果に含まれるパーツ名はあなたが指定したものではなく Meshy によるものです。PENDING以降は常に存在します。autoタスクの場合、および prompt が反映された場合は省略されます。
- Name
- part_count
- Type
- integer
- Description
分割によって生成された印刷可能なパーツの数です。シーンオブジェクトをサポートするフォーマットではパーツごとに1つのオブジェクトを持ちますが、
stlはそれらを1つのソリッドに融合し、その場合でもカウントはパーツ数を示します。セグメンテーションによって印刷可能なパーツにできなかった潰れた断片は、エクスポート前にファイルから除去され、カウントには含まれません。
- Name
- progress
- Type
- integer
- Description
タスクの進行状況です。タスクがまだ開始されていない場合、このプロパティは
0になります。タスクが成功すると100になります。
- Name
- status
- Type
- string
- Description
タスクのステータスです。取り得る値は
PENDING、IN_PROGRESS、SUCCEEDED、FAILED、CANCELEDのいずれかです。
- Name
- preceding_tasks
- Type
- integer
- Description
先行するタスクの数です。
このフィールドの値は、タスクのステータスが
PENDINGの場合にのみ意味を持ちます。
- Name
- created_at
- Type
- timestamp
- Description
タスクが作成された時刻のタイムスタンプ(ミリ秒)です。
- Name
- started_at
- Type
- timestamp
- Description
タスクが開始された時刻のタイムスタンプ(ミリ秒)です。タスクがまだ開始されていない場合、このプロパティは
0になります。
- Name
- finished_at
- Type
- timestamp
- Description
タスクが終了した時刻のタイムスタンプ(ミリ秒)です。タスクがまだ終了していない場合、このプロパティは
0になります。
- Name
- consumed_credits
- Type
- integer
- Description
このタスクで消費されたクレジット数です。常に存在し、タスクが受理されると
10になり、FAILEDタスクの場合は失敗時に課金が返金されるため0になります。PENDINGのままタスクを削除した場合も返金されます。
The Auto Split Task Object
{
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "print-split",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
"part_count": 4,
"progress": 100,
"status": "SUCCEEDED",
"preceding_tasks": 0,
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000082000,
"task_error": null,
"consumed_credits": 10
}