Meerkleurenprint-API

Converteren van 3D-modellen naar meerkleurig 3MF-formaat voor 3D-printen, met een configureerbaar kleurenpalet van maximaal 16 kleuren.

POST/openapi/v1/print/multi-color

Een meerkleurige 3D-printtaak aanmaken

Deze endpoint maakt een nieuwe meerkleurige 3D-printtaak aan. De taak converteert een 3D-model naar een meerkleurig 3MF-bestand dat geschikt is voor 3D-printen.

Parameters

Slechts één van input_task_id of model_url is vereist. Als beide worden opgegeven, krijgt input_task_id prioriteit.

  • Name
    model_url
    Type
    string
    Verplicht
    Description

    Publiek toegankelijke URL of Data URI van een 3D-model. We ondersteunen momenteel de formaten .glb en .fbx.

  • Name
    max_colors
    Type
    integer
    standaard 4
    Description

    Maximaal aantal kleuren in het uitvoerpalet.

    Geldig bereik: 1 tot 16.

  • Name
    max_depth
    Type
    integer
    standaard 4
    Description

    Quadtree-diepte voor kleurprecisie. Hogere waarden leveren fijnere kleurgrenzen op, maar vergroten de bestandsgrootte.

    Geldig bereik: 3 tot 6.

Retourneert

De eigenschap result van de respons bevat de id van de nieuw aangemaakte 3D-printtaak.

Foutmodi

  • Name
    400 - Bad Request
    Description

    De aanvraag was onaanvaardbaar. Veelvoorkomende oorzaken:

    • Ontbrekende parameter: Ofwel model_url of input_task_id moet worden opgegeven.
    • Ongeldig modelformaat: De model_url verwijst naar een bestand met een niet-ondersteunde extensie (alleen .glb en .fbx worden ondersteund).
    • Onbereikbare URL: De model_url kon niet worden gedownload.
    • Ongeldige invoertaak: De input_task_id moet verwijzen naar een succesvolle taak.
    • Ongeldige max_colors: De waarde moet tussen 1 en 16 liggen.
    • Ongeldige max_depth: De waarde moet tussen 3 en 6 liggen.
  • Name
    401 - Unauthorized
    Description

    Authenticatie mislukt. Controleer je API-sleutel.

  • Name
    402 - Payment Required
    Description

    Onvoldoende credits om deze taak uit te voeren.

  • Name
    429 - Too Many Requests
    Description

    Je hebt je rate limit overschreden.

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

Een meerkleurige 3D-printtaak ophalen

Deze endpoint haalt een meerkleurige 3D-printtaak op via de ID.

Parameters

  • Name
    id
    Type
    path
    Description

    De ID van de 3D-printtaak om op te halen.

Retourneert

Het 3D-printtaakobject.

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

Meerkleurige 3D-printtaak verwijderen

Deze endpoint verwijdert permanent een meerkleurige 3D-printtaak, inclusief alle bijbehorende modellen en gegevens. Deze actie is onomkeerbaar.

Padparameters

  • Name
    id
    Type
    path
    Description

    De ID van de meerkleurige 3D-printtaak die moet worden verwijderd.

Retourneert

Retourneert 200 OK bij succes.

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

Meerkleurige 3D-printtaken weergeven

Met deze endpoint kun je een lijst met meerkleurige 3D-printtaken ophalen.

Parameters

Optionele attributen

  • Name
    page_num
    Type
    integer
    Description

    Paginanummer voor paginering. Begint bij en is standaard 1.

  • Name
    page_size
    Type
    integer
    Description

    Limiet voor paginagrootte. Standaard 10 items. Maximaal toegestaan is 50 items.

  • Name
    sort_by
    Type
    string
    Description

    Veld om op te sorteren. Beschikbare waarden:

    • +created_at: Sorteer op aanmaaktijd in oplopende volgorde.
    • -created_at: Sorteer op aanmaaktijd in aflopende volgorde.

Retourneert

Retourneert een gepagineerde lijst van De 3D-printtaakobjecten.

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

Stream een meerkleurige 3D-printtaak

Deze endpoint streamt realtime-updates voor een meerkleurige 3D-printtaak met Server-Sent Events (SSE).

Parameters

  • Name
    id
    Type
    path
    Description

    Unieke identificatie voor de meerkleurige 3D-printtaak die moet worden gestreamd.

Retourneert

Retourneert een stream van De 3D-printtaakobjecten als Server-Sent Events.

Voor PENDING- of IN_PROGRESS-taken bevat de responsstream alleen de noodzakelijke velden progress en 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
}

Het 3D-printtaakobject

  • Name
    id
    Type
    string
    Description

    Unieke identificatie voor de taak. Hoewel we een k-sorteerbare UUID gebruiken voor taak-id's als implementatiedetail, moet je geen aannames doen over de indeling van het id.

  • Name
    type
    Type
    string
    Description

    Type van de 3D-printtaak. De waarde is print-multi-color.

  • Name
    model_urls
    Type
    object
    Description

    Downloadbare URL naar het 3D-modelbestand dat door Meshy is gegenereerd. De eigenschap voor een indeling wordt weggelaten als de indeling niet is gegenereerd, in plaats van een lege tekenreeks terug te geven.

    • Name
      3mf
      Type
      string
      Description

      Downloadbare URL naar het meerkleurige 3MF-bestand.

  • Name
    progress
    Type
    integer
    Description

    progress van de taak. Als de taak nog niet is gestart, is deze eigenschap 0. Zodra de taak is geslaagd, wordt dit 100.

  • Name
    status
    Type
    string
    Description

    Status van de taak. Mogelijke waarden zijn een van PENDING, IN_PROGRESS, SUCCEEDED, FAILED.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Het aantal voorafgaande taken.

    De waarde van dit veld is alleen betekenisvol als de taakstatus PENDING is.

  • Name
    created_at
    Type
    timestamp
    Description

    tijdstempel van wanneer de taak is aangemaakt, in milliseconden.

  • Name
    started_at
    Type
    timestamp
    Description

    tijdstempel van wanneer de taak is gestart, in milliseconden. Als de taak nog niet is gestart, is deze eigenschap 0.

  • Name
    finished_at
    Type
    timestamp
    Description

    tijdstempel van wanneer de taak is voltooid, in milliseconden. Als de taak nog niet is voltooid, is deze eigenschap 0.

  • Name
    task_error
    Type
    object
    Description

    Foutdetails voor mislukte taken. Zie Fouten voor de volledige objectreferentie van task_error.

  • Name
    consumed_credits
    Type
    integer
    Description

    Het aantal credits dat door deze taak is verbruikt. Aanwezig wanneer de taakstatus PENDING, IN_PROGRESS of SUCCEEDED is. Retourneert 0 voor FAILED-taken (credits worden terugbetaald bij mislukking).

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
}