API Druku Wielokolorowego

Konwertuj modele 3D do wielokolorowego formatu 3MF do druku 3D, z konfigurowalną paletą kolorów do 16 kolorów.

POST/openapi/v1/print/multi-color

Utwórz zadanie druku 3D w wielu kolorach

Ten punkt końcowy tworzy nowe zadanie druku 3D w wielu kolorach. Zadanie konwertuje model 3D na plik 3MF w wielu kolorach, odpowiedni do druku 3D.

Parametry

Tylko jeden z input_task_id lub model_url jest wymagany. Jeśli oba są podane, input_task_id ma priorytet.

Name
input_task_id
Type
string
Wymagane
Description
ID zakończonego sukcesem zadania do użycia jako wejście. Obsługiwane typy zadań: Obraz na 3D, Wiele obrazów na 3D, Tekst na 3D, Remesh i Reteksturowanie. Zadanie musi mieć status SUCCEEDED.

Name
model_url
Type
string
Wymagane
Description
Publicznie dostępny URL lub Data URI modelu 3D. Obecnie obsługujemy formaty .glb i .fbx.

Name
max_colors
Type
integer
domyślne 4
Description
Maksymalna liczba kolorów w palecie wyjściowej.
Prawidłowy zakres: 1 do 16.
Name
style
Type
string
domyślne realistic
Description
Wizualny styl kolorów generowanego pliku 3MF.
Dostępne wartości:
- realistic: Pobiera kolory bezpośrednio z tekstury modelu dla drobnych, fotorealistycznych detali. Tworzy większy plik.
- cartoon: Spłaszcza kolory w czyste, jednolite obszary dla stylizowanego wyglądu. Tworzy mniejszy plik.

Zwraca

Właściwość result odpowiedzi zawiera id nowo utworzonego zadania druku 3D.

Tryby awarii

Name
400 - Bad Request
Description
Żądanie było nieakceptowalne. Typowe przyczyny:
- Brakujący parametr: Należy podać model_url lub input_task_id.
- Nieprawidłowy format modelu: model_url wskazuje na plik z nieobsługiwanym rozszerzeniem (obsługiwane są tylko .glb i .fbx).
- Nieosiągalny URL: Nie można było pobrać model_url.
- Nieprawidłowe zadanie wejściowe: input_task_id musi odnosić się do zakończonego sukcesem zadania.
- Nieprawidłowe max_colors: Wartość musi być pomiędzy 1 a 16.
- Nieprawidłowy styl: Wartość musi być realistic lub cartoon.
Name
401 - Unauthorized
Description
Uwierzytelnianie nie powiodło się. Proszę sprawdzić swój klucz API.
Name
402 - Payment Required
Description
Niewystarczająca liczba kredytów do wykonania tego zadania.
Name
429 - Too Many Requests
Description
Przekroczyłeś swój limit szybkości.

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

Pobierz zadanie druku 3D w wielu kolorach

Ten punkt końcowy pobiera zadanie druku 3D w wielu kolorach na podstawie jego ID.

Parametry

Name
id
Type
path
Description
ID zadania druku 3D do pobrania.

Zwraca

Obiekt zadania druku 3D.

Żądanie

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

Odpowiedź

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

Usuń zadanie druku 3D w wielu kolorach

Ten punkt końcowy trwale usuwa zadanie druku 3D w wielu kolorach, w tym wszystkie powiązane modele i dane. Ta akcja jest nieodwracalna.

Parametry ścieżki

Name
id
Type
path
Description
ID zadania druku 3D w wielu kolorach do usunięcia.

Zwraca

Zwraca 200 OK w przypadku sukcesu.

Żądanie

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

Odpowiedź

// Returns 200 Ok on success.

GET/openapi/v1/print/multi-color

Lista zadań druku 3D w wielu kolorach

Ten punkt końcowy pozwala na pobranie listy zadań druku 3D w wielu kolorach.

Parametry

Opcjonalne atrybuty

Name
page_num
Type
integer
Description
Numer strony dla stronicowania. Zaczyna się i domyślnie wynosi 1.
Name
page_size
Type
integer
Description
Limit rozmiaru strony. Domyślnie 10 pozycji. Maksymalnie dozwolone to 50 pozycji.
Name
sort_by
Type
string
Description
Pole do sortowania. Dostępne wartości:
- +created_at: Sortuj według czasu utworzenia w porządku rosnącym.
- -created_at: Sortuj według czasu utworzenia w porządku malejącym.

Zwraca

Zwraca stronicowaną listę Obiektów Zadań Druku 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

Streamuj zadanie druku 3D w wielu kolorach

Ten punkt końcowy przesyła w czasie rzeczywistym aktualizacje dla zadania druku 3D w wielu kolorach, używając Server-Sent Events (SSE).

Parametry

Name
id
Type
path
Description
Unikalny identyfikator dla zadania druku 3D w wielu kolorach do streamowania.

Zwraca

Zwraca strumień Obiektów Zadań Druku 3D jako Server-Sent Events.

Dla zadań PENDING lub IN_PROGRESS, strumień odpowiedzi będzie zawierał tylko niezbędne pola progress i status.

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
}

Obiekt Zadania Druku 3D

Name
id
Type
string
Description
Unikalny identyfikator zadania. Chociaż używamy UUID sortowalnego według klucza k dla identyfikatorów zadań jako szczegółu implementacji, nie powinieneś zakładać żadnych założeń dotyczących formatu id.
Name
type
Type
string
Description
Typ zadania Druku 3D. Wartość to print-multi-color.
Name
model_urls
Type
object
Description
Pobieralny URL do pliku modelu 3D wygenerowanego przez Meshy. Właściwość dla formatu zostanie pominięta, jeśli format nie zostanie wygenerowany, zamiast zwracać pusty ciąg.
- Name
  3mf
  Type
  string
  Description
  Pobieralny URL do pliku 3MF w wielu kolorach.
Name
progress
Type
integer
Description
Postęp zadania. Jeśli zadanie jeszcze się nie rozpoczęło, ta właściwość będzie miała wartość 0. Gdy zadanie zostanie zakończone sukcesem, stanie się 100.
Name
status
Type
string
Description
Status zadania. Możliwe wartości to PENDING, IN_PROGRESS, SUCCEEDED, FAILED.
Name
preceding_tasks
Type
integer
Description
Liczba poprzedzających zadań.
Wartość tego pola ma znaczenie tylko wtedy, gdy status zadania to PENDING.
Name
created_at
Type
timestamp
Description
Znacznik czasu, kiedy zadanie zostało utworzone, w milisekundach.
Name
started_at
Type
timestamp
Description
Znacznik czasu, kiedy zadanie zostało rozpoczęte, w milisekundach. Jeśli zadanie jeszcze się nie rozpoczęło, ta właściwość będzie miała wartość 0.
Name
finished_at
Type
timestamp
Description
Znacznik czasu, kiedy zadanie zostało zakończone, w milisekundach. Jeśli zadanie jeszcze się nie zakończyło, ta właściwość będzie miała wartość 0.
Name
task_error
Type
object
Description
Szczegóły błędu dla nieudanych zadań. Zobacz Błędy dla pełnej referencji obiektu task_error.
Name
consumed_credits
Type
integer
Description
Liczba kredytów zużytych przez to zadanie. Obecne, gdy status zadania to PENDING, IN_PROGRESS lub SUCCEEDED. Zwraca 0 dla zadań FAILED (kredyty są zwracane w przypadku niepowodzenia).

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
}