Auto Split API

3Dモデルを、個別に印刷可能なパーツへ分割します——自動で、指定したパーツ名で、あるいは色領域ごとに——オプションでコネクターを付けることもできます。カットによって生じる薄い部分は常に補強されるため、すべてのパーツがしっかりと印刷されます。


POST/openapi/v1/print/split

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)のモデルはサポートされていません。テクスチャ付きモデルは受け付けられますが、そのテクスチャは結果に引き継がれません。

  • Name
    mode
    Type
    string
    デフォルト auto
    Description

    モデルをパーツに分割する方法。

    利用可能な値:

    • auto:Meshyが分割位置を選択します。prompt は無視されます。
    • by_parts:prompt で指定した頭部、腕、胴体などの構造的なパーツに沿って分割します。
    • by_color:prompt で指定した色の領域に沿って分割します。アップロードされた画像から生成された入力(画像から3D または マルチ画像から3D)が必要です。その他の入力は 400 で拒否されます。色領域の境界は、入力モデルのテクスチャではなく、元の画像から取得されます。マルチ画像から3Dの場合、Auto Splitは最初のソース画像を使用します。
次の場合のみ適用 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文字。失敗するケースは2つあります:分割をまったく求めていない記述、または10個を超えるパーツを指定した場合は 400 で拒否され、料金は発生しません。一方、Meshyがまったく解釈できない記述の場合は auto にフォールバックし、タスクはそのまま実行されて課金され、レスポンスには prompt_ignored: true が含まれます。

  • 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表示と同じ配置です。

    どちらのlayoutでも、分割によって生じた潰れた薄片や点のようなパーツは、エクスポート前に除去されるため、得られるすべてのパーツは印刷可能です。シーンオブジェクトをサポートする形式では、パーツごとに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 の範囲外です。
  • 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指定による分割(by_parts および by_color)は一時的に利用できません。しばらく待ってから再試行するか、影響を受けない mode: "auto" を使用してください。料金は発生しません。

Request

POST
/openapi/v1/print/split
# 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"
}

GET/openapi/v1/print/split/:id

Auto Split タスクの取得

このエンドポイントは、IDによってAuto Splitタスクを取得します。

パラメータ

  • Name
    id
    Type
    path
    Description

    取得するAuto SplitタスクのID。

戻り値

Auto Split Taskオブジェクト。

Request

GET
/openapi/v1/print/split/a43b5c6d-7e8f-901a-234b-567c890d1e2f
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
}

DELETE/openapi/v1/print/split/:id

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

DELETE
/openapi/v1/print/split/a43b5c6d-7e8f-901a-234b-567c890d1e2f
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."
}

GET/openapi/v1/print/split

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

GET
/openapi/v1/print/split
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
  }
]

GET/openapi/v1/print/split/:id/stream

Auto Split タスクをストリーミングする

このエンドポイントは、Server-Sent Events (SSE) を使用して Auto Split タスクのリアルタイム更新をストリーミングします。

パラメータ

  • Name
    id
    Type
    path
    Description

    ストリーミングする Auto Split タスクの一意の識別子。

返り値

Server-Sent Events としてAuto Split タスクオブジェクトのストリームを返します。

すべての 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

GET
/openapi/v1/print/split/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream
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を使用していますが、この形式についてはいかなる前提も置かないでください。

  • 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 でパーツ名が指定されなかったために、Meshyが代わりに自動でモデルを分割した場合に true になります。この場合、結果に含まれるパーツ名はあなたが指定したものではなく、Meshyが付けたものです。PENDING 以降常に存在します。auto タスクの場合、およびプロンプトの指示に従って分割できた場合は省略されます。

  • 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

    先行するタスクの数です。

  • Name
    created_at
    Type
    timestamp
    Description

    タスクが作成された時刻のタイムスタンプ(ミリ秒)です。

  • Name
    started_at
    Type
    timestamp
    Description

    タスクが開始された時刻のタイムスタンプ(ミリ秒)です。タスクがまだ開始されていない場合、このプロパティは 0 です。

  • Name
    finished_at
    Type
    timestamp
    Description

    タスクが完了した時刻のタイムスタンプ(ミリ秒)です。タスクがまだ完了していない場合、このプロパティは 0 です。

  • Name
    task_error
    Type
    object
    Description

    失敗したタスクのエラー詳細です。task_error オブジェクトの完全なリファレンスは エラー を参照してください。

  • 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
}