API cetakan pelbagai warna

Tukar model 3D kepada format 3MF pelbagai warna untuk pencetakan 3D, dengan palet warna boleh dikonfigurasi sehingga 16 warna.

POST/openapi/v1/print/multi-color

Cipta Tugasan Cetakan 3D Berbilang Warna

Endpoint ini mencipta tugasan cetakan 3D berbilang warna baharu. Tugasan ini menukar model 3D kepada fail 3MF berbilang warna yang sesuai untuk pencetakan 3D.

Parameter

Hanya satu daripada input_task_id atau model_url adalah diperlukan. Jika kedua-duanya disediakan, input_task_id mengambil keutamaan.

Name
input_task_id
Type
string
Diperlukan
Description
ID tugasan yang berjaya untuk digunakan sebagai input. Jenis tugasan yang disokong: Imej ke 3D, Berbilang Imej ke 3D, Teks ke 3D, Remesh, dan Retekstur. Tugasan mesti mempunyai status SUCCEEDED.

Name
model_url
Type
string
Diperlukan
Description
URL yang boleh diakses secara awam atau Data URI bagi model 3D. Kami pada masa ini menyokong format .glb dan .fbx.

Name
max_colors
Type
integer
lalai 4
Description
Bilangan maksimum warna dalam palet output.
Julat sah: 1 hingga 16.
Name
max_depth
Type
integer
lalai 4
Description
Kedalaman quadtree untuk ketepatan warna. Nilai yang lebih tinggi menghasilkan sempadan warna yang lebih halus tetapi meningkatkan saiz fail.
Julat sah: 3 hingga 6.

Pulangan

Sifat result dalam respons mengandungi id tugasan cetakan 3D yang baru dicipta.

Mod Kegagalan

Name
400 - Bad Request
Description
Permintaan tidak boleh diterima. Punca lazim:
- Parameter tiada: Sama ada model_url atau input_task_id mesti disediakan.
- Format model tidak sah: model_url menunjuk kepada fail dengan sambungan yang tidak disokong (hanya .glb dan .fbx disokong).
- URL tidak dapat dicapai: model_url tidak dapat dimuat turun.
- Tugasan input tidak sah: input_task_id mesti merujuk kepada tugasan yang berjaya.
- max_colors tidak sah: Nilai mesti antara 1 dan 16.
- max_depth tidak sah: Nilai mesti antara 3 dan 6.
Name
401 - Unauthorized
Description
Pengesahan gagal. Sila semak kunci API anda.
Name
402 - Payment Required
Description
Kredit tidak mencukupi untuk melaksanakan tugasan ini.
Name
429 - Too Many Requests
Description
Anda telah melebihi had kadar anda.

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,
    "max_depth": 5
  }'

Response

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

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

Dapatkan Semula Tugas Cetakan 3D Berbilang Warna

endpoint ini mendapatkan semula tugas cetakan 3D berbilang warna berdasarkan IDnya.

Parameter

Name
id
Type
path
Description
ID tugas cetakan 3D yang hendak didapatkan semula.

Mengembalikan

Objek Tugas Cetakan 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

Padam Tugas Cetakan 3D Berbilang Warna

Endpoint ini memadamkan secara kekal tugas cetakan 3D berbilang warna, termasuk semua model dan data yang berkaitan. Tindakan ini tidak boleh dibatalkan.

Parameter Laluan

Name
id
Type
path
Description
ID tugas cetakan 3D berbilang warna yang hendak dipadamkan.

Pulangan

Mengembalikan 200 OK apabila berjaya.

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

// Returns 200 Ok on success.

GET/openapi/v1/print/multi-color

Senaraikan Tugasan Cetakan 3D Berbilang Warna

endpoint ini membolehkan anda mendapatkan senarai tugasan cetakan 3D berbilang warna.

Parameter

Atribut pilihan

Name
page_num
Type
integer
Description
Nombor halaman untuk penomboran halaman. Bermula dan lalai kepada 1.
Name
page_size
Type
integer
Description
Had saiz halaman. Lalai kepada 10 item. Maksimum yang dibenarkan ialah 50 item.
Name
sort_by
Type
string
Description
Medan untuk diisih mengikut. Nilai yang tersedia:
- +created_at: Isih mengikut masa penciptaan dalam tertib menaik.
- -created_at: Isih mengikut masa penciptaan dalam tertib menurun.

Pulangan

Mengembalikan senarai berhalaman bagi Objek Tugasan Cetakan 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

Strim Tugas Cetakan 3D Berbilang Warna

Endpoint ini menstrim kemas kini masa nyata untuk tugas cetakan 3D berbilang warna menggunakan Server-Sent Events (SSE).

Parameter

Name
id
Type
path
Description
Pengecam unik untuk tugas cetakan 3D berbilang warna yang akan distrim.

Pulangan

Mengembalikan strim Objek Tugas Cetakan 3D sebagai Server-Sent Events.

Untuk tugas PENDING atau IN_PROGRESS, strim respons hanya akan menyertakan medan progress dan status yang diperlukan.

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.
// 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
}

Objek Tugasan Cetakan 3D

Name
id
Type
string
Description
Pengecam unik untuk tugasan. Walaupun kami menggunakan UUID boleh isih-k untuk id tugasan sebagai butiran pelaksanaan, anda tidak sepatutnya membuat sebarang andaian tentang format id tersebut.
Name
type
Type
string
Description
Jenis tugasan Cetakan 3D. Nilainya ialah print-multi-color.
Name
model_urls
Type
object
Description
URL boleh dimuat turun ke fail model 3D yang dijana oleh Meshy. Sifat bagi sesuatu format akan ditinggalkan jika format tersebut tidak dijana, dan bukannya mengembalikan rentetan kosong.
- Name
  3mf
  Type
  string
  Description
  URL boleh dimuat turun ke fail 3MF pelbagai warna.
Name
progress
Type
integer
Description
Progress tugasan. Jika tugasan belum dimulakan, sifat ini akan menjadi 0. Setelah tugasan berjaya, ini akan menjadi 100.
Name
status
Type
string
Description
Status tugasan. Nilai yang mungkin ialah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED.
Name
preceding_tasks
Type
integer
Description
Bilangan tugasan terdahulu.
Nilai medan ini hanya bermakna jika status tugasan ialah PENDING.
Name
created_at
Type
timestamp
Description
Cap masa apabila tugasan dicipta, dalam milisaat.
Name
started_at
Type
timestamp
Description
Cap masa apabila tugasan dimulakan, dalam milisaat. Jika tugasan belum dimulakan, sifat ini akan menjadi 0.
Name
finished_at
Type
timestamp
Description
Cap masa apabila tugasan selesai, dalam milisaat. Jika tugasan belum selesai, sifat ini akan menjadi 0.
Name
task_error
Type
object
Description
Butiran ralat untuk tugasan yang gagal. Lihat Ralat untuk rujukan objek task_error penuh.
Name
consumed_credits
Type
integer
Description
Bilangan kredit yang digunakan oleh tugasan ini. Hadir apabila status tugasan ialah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugasan FAILED (kredit dipulangkan semula apabila gagal).

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
}