API Cetakan Pelbagai Warna

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

POST/openapi/v1/print/multi-color

Cipta Tugas Cetakan 3D Berbilang Warna

Endpoint ini mencipta tugas cetakan 3D berbilang warna yang baru. Tugas 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 tugas yang berjaya untuk digunakan sebagai input. Jenis tugas yang disokong: Imej ke 3D, Berbilang Imej ke 3D, Teks ke 3D, Remesh, dan Retekstur. Tugas mesti mempunyai status SUCCEEDED.

Name
model_url
Type
string
Diperlukan
Description
URL atau Data URI model 3D yang boleh diakses secara umum. Kami kini 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
style
Type
string
lalai realistic
Description
Gaya warna visual fail 3MF yang dihasilkan.
Nilai yang tersedia:
- realistic: Sampel warna secara langsung dari tekstur model untuk perincian foto-realistik yang halus. Menghasilkan fail yang lebih besar.
- cartoon: Meratakan warna ke dalam kawasan bersih dan seragam untuk penampilan bergaya. Menghasilkan fail yang lebih kecil.

Pulangan

Properti result dalam respons mengandungi id tugas cetakan 3D yang baru dicipta.

Mod Kegagalan

Name
400 - Bad Request
Description
Permintaan tidak dapat diterima. Punca biasa:
- Parameter hilang: 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 boleh dicapai: model_url tidak dapat dimuat turun.
- Tugas input tidak sah: input_task_id mesti merujuk kepada tugas yang berjaya.
- max_colors tidak sah: Nilai mesti antara 1 dan 16.
- Gaya tidak sah: Nilai mesti realistic atau cartoon.
Name
401 - Unauthorized
Description
Pengesahan gagal. Sila semak kunci API anda.
Name
402 - Payment Required
Description
Kredit tidak mencukupi untuk melaksanakan tugas ini.
Name
429 - Too Many Requests
Description
Anda telah melebihi had kadar anda.

Permintaan

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

Respons

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

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

Dapatkan Tugas Cetakan 3D Pelbagai Warna

Endpoint ini mendapatkan tugas cetakan 3D pelbagai warna berdasarkan ID-nya.

Parameter

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

Pulangan

Objek Tugas Cetakan 3D.

Permintaan

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

Respons

{
  "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 Pelbagai Warna

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

Parameter Laluan

Name
id
Type
path
Description
ID tugas cetakan 3D pelbagai warna untuk dipadamkan.

Pemulangan

Mengembalikan 200 OK jika berjaya.

Permintaan

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

Respons

// Returns 200 Ok on success.

GET/openapi/v1/print/multi-color

Senarai Tugasan Cetak 3D Pelbagai Warna

Endpoint ini membolehkan anda mendapatkan senarai tugasan cetak 3D pelbagai 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 adalah 50 item.
Name
sort_by
Type
string
Description
Medan untuk disusun. Nilai yang tersedia:
- +created_at: Susun mengikut masa penciptaan dalam susunan menaik.
- -created_at: Susun mengikut masa penciptaan dalam susunan menurun.

Pulangan

Mengembalikan senarai berpenomboran halaman bagi Objek Tugasan Cetak 3D.

Permintaan

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

Respons

[
  {
    "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 Pelbagai Warna

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

Parameter

Name
id
Type
path
Description
Pengenal pasti unik untuk tugas cetakan 3D pelbagai warna untuk distrim.

Pulangan

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

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

Permintaan

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

Strim Respons

// 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 Tugas Cetakan 3D

Name
id
Type
string
Description
Pengenal unik untuk tugas ini. Walaupun kami menggunakan UUID yang boleh diurutkan k untuk id tugas sebagai butiran pelaksanaan, anda tidak seharusnya membuat sebarang andaian tentang format id tersebut.
Name
type
Type
string
Description
Jenis tugas Cetakan 3D. Nilainya adalah print-multi-color.
Name
model_urls
Type
object
Description
URL yang boleh dimuat turun untuk fail model 3D yang dihasilkan oleh Meshy. Harta untuk format akan diabaikan jika format tidak dihasilkan dan bukannya mengembalikan rentetan kosong.
- Name
  3mf
  Type
  string
  Description
  URL yang boleh dimuat turun untuk fail 3MF berwarna-warni.
Name
progress
Type
integer
Description
Kemajuan tugas. Jika tugas belum dimulakan, harta ini akan menjadi 0. Setelah tugas berjaya, ini akan menjadi 100.
Name
status
Type
string
Description
Status tugas. Nilai yang mungkin adalah salah satu daripada PENDING, IN_PROGRESS, SUCCEEDED, FAILED.
Name
preceding_tasks
Type
integer
Description
Bilangan tugas terdahulu.
Nilai medan ini hanya bermakna jika status tugas adalah PENDING.
Name
created_at
Type
timestamp
Description
Cap masa apabila tugas dicipta, dalam milisaat.
Name
started_at
Type
timestamp
Description
Cap masa apabila tugas dimulakan, dalam milisaat. Jika tugas belum dimulakan, harta ini akan menjadi 0.
Name
finished_at
Type
timestamp
Description
Cap masa apabila tugas selesai, dalam milisaat. Jika tugas belum selesai, harta ini akan menjadi 0.
Name
task_error
Type
object
Description
Butiran ralat untuk tugas yang gagal. Lihat Ralat untuk rujukan penuh objek task_error.
Name
consumed_credits
Type
integer
Description
Bilangan kredit yang digunakan oleh tugas ini. Hadir apabila status tugas adalah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk tugas FAILED (kredit dikembalikan jika 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
}