多色プリントAPI

3Dモデルを3Dプリント用の多色3MF形式に変換し、最大16色のカラーパレットを設定可能です。

POST/openapi/v1/print/multi-color

マルチカラー3Dプリントタスクを作成する

このエンドポイントは、新しいマルチカラー3Dプリントタスクを作成します。このタスクは3Dモデルを3Dプリントに適したマルチカラー3MFファイルに変換します。

パラメータ

input_task_id または model_url のいずれか一方が必須です。両方が提供された場合、input_task_id が優先されます。

Name
input_task_id
Type
string
必須
Description
入力として使用する成功したタスクのID。サポートされているタスクタイプ：画像から3D、マルチ画像から3D、テキストから3D、リメッシュ、およびリテクスチャ。タスクはSUCCEEDEDのステータスである必要があります。

Name
model_url
Type
string
必須
Description
公開アクセス可能な3DモデルのURLまたはData URI。現在、.glbおよび.fbx形式をサポートしています。

Name
max_colors
Type
integer
デフォルト 4
Description
出力パレットの最大色数。
有効範囲：1から16。
Name
style
Type
string
デフォルト realistic
Description
生成された3MFファイルの視覚的な色スタイル。
利用可能な値：
- realistic: モデルのテクスチャから直接色をサンプリングし、細かくフォトリアリスティックなディテールを提供します。より大きなファイルを生成します。
- cartoon: 色をクリーンで均一な領域に平坦化し、スタイライズされた外観を提供します。より小さなファイルを生成します。

戻り値

レスポンスのresultプロパティには、新しく作成された3Dプリントタスクのidが含まれています。

失敗モード

Name
400 - Bad Request
Description
リクエストが受け入れられませんでした。一般的な原因：
- パラメータが不足しています: model_urlまたはinput_task_idのいずれかを提供する必要があります。
- 無効なモデル形式: model_urlがサポートされていない拡張子のファイルを指しています（.glbと.fbxのみサポート）。
- 到達不能なURL: model_urlをダウンロードできませんでした。
- 無効な入力タスク: input_task_idは成功したタスクを参照する必要があります。
- 無効なmax_colors: 値は1から16の間でなければなりません。
- 無効なスタイル: 値はrealisticまたはcartoonでなければなりません。
Name
401 - Unauthorized
Description
認証に失敗しました。APIキーを確認してください。
Name
402 - Payment Required
Description
このタスクを実行するためのクレジットが不足しています。
Name
429 - Too Many Requests
Description
レート制限を超えました。

Request

POST

/openapi/v1/print/multi-color

# Convert a 3D model to multi-color 3MF for printing
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
  }'

Response

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

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

マルチカラー3Dプリントタスクを取得する

このエンドポイントは、IDによってマルチカラー3Dプリントタスクを取得します。

パラメータ

Name
id
Type
path
Description
取得する3DプリントタスクのID。

戻り値

3Dプリントタスクオブジェクト。

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
}

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

マルチカラー3Dプリントタスクの削除

このエンドポイントは、関連するすべてのモデルとデータを含むマルチカラー3Dプリントタスクを永久に削除します。この操作は元に戻せません。

パスパラメータ

Name
id
Type
path
Description
削除するマルチカラー3DプリントタスクのID。

戻り値

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

リクエスト

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

レスポンス

// Returns 200 Ok on success.

GET/openapi/v1/print/multi-color

マルチカラー3Dプリントタスクの一覧

このエンドポイントは、マルチカラー3Dプリントタスクの一覧を取得することができます。

パラメーター

オプション属性

Name
page_num
Type
integer
Description
ページネーションのページ番号。1から始まり、デフォルトも1です。
Name
page_size
Type
integer
Description
ページサイズの制限。デフォルトは10アイテムです。最大許可数は50アイテムです。
Name
sort_by
Type
string
Description
ソートするフィールド。利用可能な値:
- +created_at: 作成時間で昇順にソート。
- -created_at: 作成時間で降順にソート。

戻り値

ページネーションされた3Dプリントタスクオブジェクトのリストを返します。

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

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

マルチカラー3Dプリントタスクをストリームする

このエンドポイントは、Server-Sent Events (SSE) を使用してマルチカラー3Dプリントタスクのリアルタイム更新をストリームします。

パラメータ

Name
id
Type
path
Description
ストリームするマルチカラー3Dプリントタスクの一意の識別子。

戻り値

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

PENDING または IN_PROGRESS のタスクの場合、レスポンスストリームには必要な progress と status フィールドのみが含まれます。

リクエスト

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

レスポンスストリーム

// Error event example
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
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
}

3Dプリントタスクオブジェクト

Name
id
Type
string
Description
タスクの一意の識別子です。タスクIDにはk-sortable UUIDを使用していますが、IDの形式については何も仮定しないでください。
Name
type
Type
string
Description
3Dプリントタスクのタイプです。値はprint-multi-colorです。
Name
model_urls
Type
object
Description
Meshyによって生成された3Dモデルファイルのダウンロード可能なURLです。フォーマットが生成されない場合、空の文字列を返す代わりにそのフォーマットのプロパティは省略されます。
- Name
  3mf
  Type
  string
  Description
  マルチカラー3MFファイルのダウンロード可能なURLです。
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
タスクが作成された時のタイムスタンプ（ミリ秒単位）です。
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
このタスクによって消費されたクレジットの数です。タスクのステータスがPENDING、IN_PROGRESS、またはSUCCEEDEDの場合に存在します。FAILEDタスクの場合は0を返します（失敗時にはクレジットが返金されます）。

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
}