Multi-Color Print API

3Dモデルを多色プリント用の3MFファイルに変換し、3Dプリントに使用します。最大16色のパレットと、プリンターのブランドに合わせたスライサープリセットを選択できます。

POST/openapi/v1/print/multi-color

多色プリントタスクを作成する

3Dモデルを3Dプリント用の多色3MFファイルに変換する、多色プリントタスクを作成します。タスクはバックグラウンドで実行されます。タスクに通常どれくらいの時間がかかるかについては、処理時間を参照してください。

Request

POST

/openapi/v1/print/multi-color

# Convert a 3D model to a multi-color 3MF with a Creality slicer preset
curl https://api.meshy.ai/openapi/v1/print/multi-color \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "max_colors": 8,
    "printer_brand": "creality"
  }'

Response

{
  "result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}

パラメータ

Name
input_task_id
Type
string
必須
Description
model_urlを送信しない場合は必須です。プリントしたいモデルを持つタスクのID、例えば画像から3D、マルチ画像から3D、テキストから3D、リメッシュ、リテクスチャのタスクです。このタスクはAPIで作成したものであり、ステータスがSUCCEEDEDである必要があります。
多色プリントはタスクのGLBファイルを読み取りますが、このファイルは最大8,000,000面までです。それより多い面数のモデルは400を返します。その場合は、まずそのモデルに対してリメッシュタスクを実行し、代わりにそのリメッシュタスクのIDを送信してください。

Name
model_url
Type
string
必須
Description
input_task_idを送信しない場合は必須です。プリントするモデルを、公開URLまたはData URIとして指定します。両方を送信した場合、Meshyはinput_task_idを使用します。
httpまたはhttpsのURLは、最大400MBの.glbまたは.fbxファイルを指す必要があります。Data URIは、最大100MBのbase64エンコードされたGLBファイルを保持する必要があります。data:model/gltf-binary;base64,を使用してください。.fbxファイルはhttpまたはhttpsのURLとして送信してください。
100MBを超えるファイルは、以下のルールにも従う必要があります。
- 最大8,000,000面までです。Meshyは面を三角形として数えるため、四角形は2面としてカウントされ、複数回描画されるメッシュはコピーごとに1回としてカウントされます。
- FBXファイルはバイナリFBX 7.1以降である必要があります。
- GLBファイルはDraco圧縮を使用していてはいけません。

Name
max_colors
Type
integer
デフォルト 4
Description
出力パレットの最大色数で、1から16までです。デフォルトを使用するには、0を送信するのではなく、このパラメータを省略してください。
Name
style
Type
string
デフォルト realistic
Description
3MFファイルのカラースタイルです。
利用可能な値:
- realistic: モデルのテクスチャから直接色をサンプリングし、精細でフォトリアリスティックなディテールを作り出します。ファイルサイズは大きくなります。
- cartoon: 色を均一な領域にフラット化し、スタイライズされた見た目にします。ファイルサイズは小さくなります。
モデルには色情報が必要です。realisticは、すべてのメッシュ部分にUVを持つ単一のベースカラーテクスチャが必要であり、cartoonは頂点カラーも受け付けます。Meshyはテクスチャのない（白い）モデルを拒否します。model_missing_textureを参照してください。
Name
max_depth
Type
integer
デフォルト 4
Description
Meshyがテクスチャの色をメッシュにサンプリングする際に使用する細分化の深度で、3から6までです。0は省略した場合と同じです。値が大きいほど、より精細な色のディテールを捉えられますが、ファイルサイズは大きくなります。これはrealisticスタイルのみで使用され、cartoonでは無視されます。
Name
printer_brand
Type
string
デフォルト bambu
Description
Meshyが3MFファイルに書き込むスライサープリセットのプリンターブランドです。このファイルは、対応するプリンター、フィラメント、プロセスプロファイルを備えた、そのブランドのスライサーで開くことができます。プリセットは、0.4mmノズルを備えたそのブランドのデフォルトプリンターを使用します。
利用可能な値:
- bambu
- anycubic
- creality
- elegoo
- flashforge
- prusa
- qidi
- snapmaker
- ankermake
それ以外の値は400を返します。

戻り値

レスポンスのresultフィールドには、新しい多色プリントタスクのIDが入ります。

失敗モード

Name
400 - Bad Request
Description
リクエストを実行できません。エラーメッセージには、検出された問題が示されます。例えば以下の通りです。
- パラメータが不足している: model_urlもinput_task_idも送信されていません。
- 無効なモデル形式: model_urlのファイルが.glbまたは.fbxファイルではありません。
- URLに到達できない: Meshyがmodel_urlのファイルをダウンロードできません。
- モデルファイルが大きすぎる: model_urlのファイルがhttpまたはhttpsのURLの場合400MBを超えている、またはData URIの場合100MBを超えています。
- 面数が多すぎる: model_urlのファイルが100MBを超えており、かつ8,000,000面を超えています。面数を減らしてから、ファイルを再送信してください。
- ASCII FBXが100MBを超えている: model_urlのファイルが100MBを超えるASCII FBXです。バイナリFBXまたはGLBとして送信してください。
- 読み取れないモデルファイル: model_urlのファイルが100MBを超えており、Meshyがそのヘッダーを読み取れません。例えば、Draco圧縮されたGLBや、7.1より古いバイナリFBXです。
- モデルヘッダーが複雑すぎる: model_urlのファイルが100MBを超えており、そのヘッダーにチェック対象のメッシュ、ノード、またはレコードが多すぎます。ファイル内のオブジェクト数を減らしてから、再送信してください。
- 無効な入力タスク: input_task_idが成功したタスクではありません。
- 入力タスクの面数が多すぎる: input_task_idのモデルが8,000,000面を超えています。そのモデルに対してリメッシュタスクを実行し、代わりにそのリメッシュタスクのIDを送信してください。
- 無効なmax_colors: max_colorsが負の値、または16を超えています。
- 無効なstyle: styleがrealisticまたはcartoonではありません。
- 無効なmax_depth: max_depthが3から6の範囲外であり、かつ0でもありません。
- 無効なprinter_brand: printer_brandが利用可能な値のいずれでもありません。
- 色情報のソースがない: モデルに、styleが必要とする色情報がありません。realisticは、すべてのメッシュ部分にUVを持つ単一のベースカラーテクスチャが必要です。cartoonはベースカラーテクスチャまたは頂点カラーを受け付けます。まずモデルにテクスチャを適用するか、頂点カラーを持つモデルにはcartoonを使用してください。Meshyは.fbxのアップロードについては、タスクがそれを正規化した後にのみチェックするため、タスクは代わりにmodel_missing_textureで失敗します。
リクエストを修正してから、再送信してください。エラーを参照してください。
Name
401 - Unauthorized
Description
APIキーが見つからないか無効です。Authorizationヘッダーを確認してください。
Name
402 - Payment Required
Description
例えば以下の通りです。
- クレジット不足: アカウントに、このタスクに十分なクレジットがない、またはアカウントがクレジット上限に達しています。クレジット残高を確認してから、再試行してください。
- 無料プラン: タスクの作成には有料プランが必要です。サブスクリプション設定でプランをアップグレードしてから、再試行してください。
Name
403 - Forbidden
Description
input_task_idがバスレリーフモデルであり、このエンドポイントではプリントできません。メッセージはThis model type does not support this operationです。別のモデルを送信してください。
Name
404 - Not Found
Description
input_task_idがあなたのどのタスクとも一致しません。タスクIDを確認してから、リクエストを再送信してください。
Name
429 - Too Many Requests
Description
レート制限を超えました。しばらく待ってから再試行してください。レート制限を参照してください。

GET/openapi/v1/print/multi-color/:id

多色プリントタスクを取得

IDを指定して多色プリントタスクを返します。

Request

GET

/openapi/v1/print/multi-color/a43b5c6d-7e8f-901a-234b-567c890d1e2f

curl https://api.meshy.ai/openapi/v1/print/multi-color/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "print-multi-color",
  "model_urls": {
      "3mf": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.3mf?Expires=***"
},
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
"consumed_credits": 10
}

パラメータ

Name
id
Type
path
Description
作成レスポンスから取得したタスクID。

戻り値

多色プリントタスクオブジェクト。

DELETE/openapi/v1/print/multi-color/:id

多色プリントタスクを削除

多色プリントタスクを、そのモデルやデータも含めて完全に削除します。削除を取り消すことはできません。

Request

DELETE

/openapi/v1/print/multi-color/a43b5c6d-7e8f-901a-234b-567c890d1e2f

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/print/multi-color/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 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 が返されます。

GET/openapi/v1/print/multi-color

多色プリントタスク一覧の取得

あなたの多色プリントタスクの一覧を返します。

Request

GET

/openapi/v1/print/multi-color

curl https://api.meshy.ai/openapi/v1/print/multi-color?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
    "type": "print-multi-color",
    "model_urls": {
      "3mf": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.3mf?Expires=***"
    },
    "progress": 100,
    "status": "SUCCEEDED",
    "preceding_tasks": 0,
    "created_at": 1699999999000,
    "started_at": 1700000000000,
    "finished_at": 1700000001000,
    "task_error": null,
  "consumed_credits": 10
  }
]

パラメータ

Name
page_num
Type
integer
デフォルト 1
Description
返すページ番号。ページ番号は 1 から始まります。
Name
page_size
Type
integer
デフォルト 10
Description
1ページあたりのタスク数。最大 100 まで指定できます。
Name
sort_by
Type
string
Description
並び順。
使用可能な値：
- +created_at：古い順
- -created_at：新しい順

返り値

多色プリントタスクオブジェクトのページ分割された一覧。

GET/openapi/v1/print/multi-color/:id/stream

多色プリントタスクをストリーム取得

多色プリントタスクの更新情報を、Server-Sent Events (SSE) としてストリーム配信します。

Request

GET

/openapi/v1/print/multi-color/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream

curl -N https://api.meshy.ai/openapi/v1/print/multi-color/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.
// These examples are shortened. Each event holds 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-multi-color",
  "model_urls": {
    "3mf": "https://assets.meshy.ai/***/tasks/a43b5c6d-7e8f-901a-234b-567c890d1e2f/output/model.3mf?Expires=***"
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
"consumed_credits": 10
}

パラメータ

Name
id
Type
path
Description
作成時のレスポンスに含まれるタスクID。

戻り値

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

各イベントには、Get エンドポイントが返すものと同じ形式で、完全なタスクオブジェクトが含まれます。タスクが PENDING または IN_PROGRESS の間は、結果フィールドにまだ値が入っていません。

多色プリントタスクオブジェクト

多色プリントタスクオブジェクトは、3Dモデルを多色3MFファイルに変換する1回の処理を表します。タスクのステータス、progress、そしてタスクが成功した場合の3MFファイルを保持します。

The 3D Print Task Object

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "print-multi-color",
  "model_urls": {
      "3mf": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.3mf?Expires=***"
},
  "progress": 100,
  "status": "SUCCEEDED",
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
"consumed_credits": 10
}

Name
id
Type
string
Description
タスクID。不透明な文字列として扱い、そのフォーマットに依存しないでください。
Name
type
Type
string
Description
タスクタイプ。常に print-multi-color です。
Name
model_urls
Type
object
Description
プリントされたモデルのダウンロードURL（ファイル形式ごとに1つ）。タスクが生成しなかった形式については、空文字列ではなくキー自体が存在しません。
- Name
  3mf
  Type
  string
  Description
  多色3MFファイル。
Name
progress
Type
integer
Description
タスクがどの程度完了しているかをパーセンテージで示します。タスクが開始するまでは 0 で、成功すると 100 になります。
Name
status
Type
string
Description
タスクのステータス。PENDING、IN_PROGRESS、SUCCEEDED、FAILED のいずれかです。
Name
preceding_tasks
Type
integer
Description
キュー内でこのタスクより前にあるタスクの数。この値はタスクが PENDING の間のみ意味を持ちます。
Name
created_at
Type
timestamp
Description
タスクが作成された時刻（Unixミリ秒）。
Name
started_at
Type
timestamp
Description
タスクが開始された時刻（Unixミリ秒）。タスクが開始するまでは 0 です。
Name
finished_at
Type
timestamp
Description
タスクが完了した時刻（Unixミリ秒）。タスクが完了するまでは 0 です。
Name
task_error
Type
object
Description
タスクが失敗した場合のエラー詳細。エラーを参照してください。
Name
consumed_credits
Type
integer
Description
タスクが使用したクレジット数。ステータスが PENDING、IN_PROGRESS、SUCCEEDED のいずれかの場合に存在します。FAILED タスクの場合は 0 です。これは、タスクが失敗した場合にMeshyがクレジットを返金するためです。