Auto Split API

3Dモデルを個別に印刷可能なパーツに分割します——自動で、指定したパーツ名で、または色の領域ごとに——コネクタをオプションで付加でき、カットによって残された薄肉領域は常に補強されるため、すべてのパーツが確実に中実(ソリッド)で印刷されます。


POST/openapi/v1/print/split

Auto Split タスクを作成する

このエンドポイントは新しい Auto Split タスクを作成します。このタスクは、以前のタスクのモデルを個別に印刷可能なパーツに切り分け、分割されたモデルを返します。各パーツはファイル内でそれぞれ独立したオブジェクトになります。

パラメータ

  • Name
    input_task_id
    Type
    string
    必須
    Description

    分割対象のモデルを持つ、成功したタスクのIDです。対応するタスクタイプは、画像から3Dマルチ画像から3Dテキストから3D(プレビュー)、Remesh変換リサイズです。タスクのステータスは SUCCEEDED である必要があり、そのモデルは Meshy 6 または Meshy 7(ai_modelmeshy-6meshy-7、または latest)で生成されたものである必要があります。ローポリおよび Smart Topology(meshy-t2)モデルはサポートされていません。

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

    モデルをどのようにパーツに分割するかを指定します。

    使用可能な値:

    • auto: Meshy が切断位置を選択します。prompt は無視されます。
    • by_parts: prompt で指定した構造的なパーツ(頭、腕、胴体など)に沿って切断します。
    • by_color: prompt で指定した色の領域に沿って切断します。アップロードされた画像から生成された入力(画像から3D または マルチ画像から3D)が必要です。それ以外の入力は 400 で拒否されます。
次の場合のみ適用 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(頭、胴体、左腕、右腕、脚)のようにします。最大600文字です。失敗モードは2つあります。分割の説明のように読めるものの、2つ未満のパーツしか名前が挙げられていない場合(例えば split into individual parts(個々のパーツに分割する))は 400 で拒否され、料金は発生しません。Meshy がまったく解釈できない説明の場合は auto にフォールバックし、タスクはそのまま実行されて課金されますが、そのレスポンスには prompt_ignored: true が含まれます。

  • Name
    target_formats
    Type
    array
    デフォルト ["glb"]
    Description

    分割されたモデルをエクスポートする形式です。各パーツは、どの形式においても個別のオブジェクトになります。glb は常に生成され model_urls で返されます。これに加えて必要な他の形式を指定してください。

    使用可能な値:glbobjfbxusdzblend3mf

    3mf はスライサー向けに書き出されます。パーツごとに1つのオブジェクトとし、それぞれが独自のフィラメントスロットに割り当てられるため、Bambu Studio ではファイルを開くと個別に色分けされた、それぞれ選択可能なパーツとして表示されます(アーカイブには Bambu Studio のプロジェクト設定が含まれています。他のスライサーはジオメトリを読み取ります)。Meshy の他の印刷用フォーマットと同様に単位はミリメートルで、このエンドポイントは目標サイズを受け付けないため、モデル全体は最長辺が150 mmになるようスケーリングされます。これは他の印刷用フォーマットのエクスポートで使われているのと同じ上限で、主要なビルドプレートに収まるように選ばれています。layout: "on_plate" の場合、この上限はレイアウトされたプレート全体に適用されるため、そのままスライスできる状態になります。assembled の場合は、パーツは元のモデルにあった位置のまま配置され、スライサー側で配置を調整することになります。

  • Name
    layout
    Type
    string
    デフォルト assembled
    Description

    各出力形式およびサムネイルにおける、パーツの配置方法です。

    使用可能な値:

    • assembled: パーツは元のモデルにあった位置のまま配置されます。
    • on_plate: パーツは平らに並べられ、ビルドプレート上に広げて配置され、そのままスライスできる状態になります。これはウェブアプリの On Plate ビューと同じ配置です。

    どちらのレイアウトでも、エクスポートされるファイルにはパーツごとに1つのオブジェクトのみが含まれます。切断によって生じた、つぶれた薄片や点のようなパーツは、エクスポート前に除去されるため、ファイル内に存在するすべてのオブジェクトは印刷可能です。

  • Name
    connectors
    Type
    boolean
    デフォルト false
    Description

    各切断面にほぞ組み(mortise-and-tenon)コネクタを追加し、印刷されたパーツ同士がぴったりと組み合うようにします。

次の場合のみ適用 connectors = true
  • Name
    connector_type
    Type
    string
    デフォルト cube
    Description

    各切断面におけるコネクタの形状です。

    使用可能な値:cubecylinder

  • Name
    connector_size
    Type
    number
    デフォルト 0.5
    Description

    切断面に対する相対的なコネクタのサイズです。

    有効範囲:0.10.8

  • Name
    connector_height
    Type
    number
    デフォルト 0.1
    Description

    切断面に対する相対的な、コネクタが切断面からどれだけ突き出るかを示す値です。

    有効範囲:0.10.8

戻り値

レスポンスの result プロパティには、新しく作成された Auto Split タスクの id が含まれます。

失敗モード

  • Name
    400 - Bad Request
    Description

    リクエストが受理されませんでした。一般的な原因:

    • prompt が欠落している: modeby_parts または by_color の場合、prompt は必須です。
    • prompt で指定されたパーツが2つ未満: by_parts / by_color には、少なくとも2つの名前付きパーツ(例えば head, torso, base)が必要です。split into individual parts(個々のパーツに分割する)のような一般的な指示は拒否されます。料金は発生しません。
    • サポートされていない入力タスク: input_task_id は、サポートされているタイプの、成功したタスクを参照している必要があり、Meshy 6 または Meshy 7 で生成されている必要があります。
    • テクスチャ付きの入力: 入力モデルにテクスチャが付いています。現時点ではテクスチャなしのモデルのみサポートされています。
    • 参照画像がない: by_color には、アップロードされた画像から生成された入力が必要です。
    • サポートされていない形式: target_formatsstl が含まれています。
    • 範囲外のコネクタ設定: connector_size または connector_height0.10.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

    プロンプトベースの分割(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タスクオブジェクト。

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。

戻り値

成功時には200 OKを返します。

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

// Returns 200 Ok on success.

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タスクの一意の識別子。

戻り値

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

messageイベントには、Auto Splitタスクを取得するによって返されるものと同じ完全なタスクオブジェクトが含まれ、consumed_credits、タイムスタンプ、prompt_ignoredも含まれます。タスクがPENDINGまたはIN_PROGRESSの間は、フレーム間で変化するフィールドはprogressstatusstarted_atpreceding_tasksであり、SUCCEEDEDに達するとmodel_urlsthumbnail_urlpart_countpartsが出現します。errorイベントにはstatus_codemessageのみが含まれるため、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 タスクは以下のプロパティのみを持ちます。他のタスクオブジェクトに含まれる生成プロンプト系のフィールド(nameobject_prompttexture_prompt など)、単一の model_url、および texture_urls は、分割タスクでは決して設定されず、返されません。タスクの進行に伴って値が入るプロパティ(thumbnail_urlmodel_urls、各種タイムスタンプ)は常に存在し、値が入るまでは空のままなので、PENDINGSUCCEEDED の間でキーの集合が変わることはありません。

  • 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つずつ格納されます。各パーツはファイル内でそれぞれ別個のオブジェクトになります。リクエストされなかったフォーマットのプロパティは省略されます。

    • Name
      glb
      Type
      string
      Description

      GLB 形式の分割モデルのダウンロード可能な URL です。

    • Name
      obj
      Type
      string
      Description

      OBJ 形式の分割モデルのダウンロード可能な URL です。

    • Name
      fbx
      Type
      string
      Description

      FBX 形式の分割モデルのダウンロード可能な URL です。

    • Name
      usdz
      Type
      string
      Description

      USDZ 形式の分割モデルのダウンロード可能な URL です。

    • Name
      blend
      Type
      string
      Description

      Blender 形式の分割モデルのダウンロード可能な URL です。

    • Name
      3mf
      Type
      string
      Description

      3MF 形式の分割モデルのダウンロード可能な URL です。パーツごとに1つのオブジェクトとして、それぞれ別のフィラメントスロットに割り当てられ、単位はミリメートル、最長辺が150 mmになるようスケーリングされ、Bambu Studio のプロジェクト設定が付属します。

  • 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つにつき1パーツです。セグメンテーションによって印刷可能なパーツにできなかった潰れた薄片は、エクスポート前にファイルから取り除かれ、カウントには含まれません。

  • Name
    progress
    Type
    integer
    Description

    タスクの progress です。タスクがまだ開始されていない場合、このプロパティは 0 になります。タスクが成功すると、これは 100 になります。

  • Name
    status
    Type
    string
    Description

    タスクのステータスです。取り得る値は PENDINGIN_PROGRESSSUCCEEDEDFAILEDCANCELED のいずれかです。

  • 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

    このタスクによって消費されたクレジット数です。常に存在し、タスクが受理されると 10FAILED タスクの場合は失敗時にチャージが返金されるため 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
}