Auto Split API

Splits een 3D-model op in afzonderlijk printbare onderdelen — automatisch, op basis van door u benoemde onderdelen, of per kleurgebied — met optionele connectors; dunne gebieden die door een snede ontstaan, worden altijd versterkt zodat elk onderdeel massief print.


POST/openapi/v1/print/split

Een Auto Split-taak aanmaken

Deze endpoint maakt een nieuwe Auto Split-taak aan. De taak snijdt het model van een eerdere taak in afzonderlijk printbare onderdelen en retourneert het gesegmenteerde model, waarbij elk onderdeel een eigen object in het bestand is.

Parameters

  • Name
    input_task_id
    Type
    string
    Verplicht
    Description

    De ID van een geslaagde taak waarvan het model gesplitst moet worden. Ondersteunde taaktypen: Afbeelding naar 3D, Multi-afbeelding naar 3D, Tekst naar 3D (preview), Remesh, Converteren en Formaat wijzigen. De taak moet de status SUCCEEDED hebben, en het model moet zijn gegenereerd met Meshy 6 of Meshy 7 (ai_model meshy-6, meshy-7, of latest). Low-poly- en Smart Topology-modellen (meshy-t2) worden niet ondersteund.

  • Name
    mode
    Type
    string
    standaard auto
    Description

    Hoe het model in onderdelen wordt verdeeld.

    Beschikbare waarden:

    • auto: Meshy bepaalt de sneden. prompt wordt genegeerd.
    • by_parts: Snijdt langs de structurele onderdelen die je noemt in prompt, zoals hoofd, armen en romp.
    • by_color: Snijdt langs de kleurgebieden die je noemt in prompt. Vereist een invoer die is gegenereerd op basis van een geüploade afbeelding (Afbeelding naar 3D of Multi-afbeelding naar 3D); andere invoer wordt afgewezen met 400.
Alleen van toepassing wanneer mode = by_parts or by_color
  • Name
    prompt
    Type
    string
    Verplicht
    Description

    Beschrijft de onderdelen waarin gesplitst moet worden, in elke taal. Meshy leest hieruit 1 tot 10 onderdeelnamen, dus benoem de stukken in plaats van het model te beschrijven — bijvoorbeeld split into the figure and the base, of head, torso, left arm, right arm, legs. Maximaal 600 tekens. Er zijn twee foutmodi: een beschrijving die als een splitsing overkomt maar minder dan twee onderdelen noemt (bijvoorbeeld split into individual parts) wordt afgewezen met 400 en er wordt niets in rekening gebracht; een beschrijving die Meshy helemaal niet kan interpreteren valt terug op auto, de taak wordt dan toch uitgevoerd en in rekening gebracht, en het antwoord bevat prompt_ignored: true.

  • Name
    target_formats
    Type
    array
    standaard ["glb"]
    Description

    Formaten waarin het gesplitste model wordt geëxporteerd. Elk onderdeel is een apart object in elk formaat. glb wordt altijd geproduceerd en geretourneerd in model_urls; vermeld eventuele andere gewenste formaten daarnaast.

    Beschikbare waarden: glb, obj, fbx, usdz, blend, 3mf.

    3mf wordt geschreven voor slicers: één object per onderdeel, elk op een eigen filamentslot, zodat Bambu Studio het bestand opent als afzonderlijk gekleurde, apart selecteerbare onderdelen (het archief bevat een Bambu Studio-projectconfiguratie; andere slicers lezen de geometrie). Zoals bij de andere printformaten van Meshy is dit in millimeters en, omdat deze endpoint geen doelgrootte accepteert, wordt het hele model geschaald zodat de langste zijde 150 mm is — dezelfde limiet die de andere printformaat-exports gebruiken, gekozen om op elk gangbaar bouwplatform te passen. Met layout: "on_plate" geldt de limiet voor het uitgelegde plateau als geheel, zodat het bestand klaar is om te slicen; met assembled blijven de onderdelen op de plek waar het bronmodel ze had, en regel je de plaatsing zelf in de slicer.

  • Name
    layout
    Type
    string
    standaard assembled
    Description

    Hoe de onderdelen worden gerangschikt in elk uitvoerformaat, en in de thumbnail.

    Beschikbare waarden:

    • assembled: Onderdelen blijven op de plek waar het bronmodel ze had.
    • on_plate: Onderdelen worden plat neergelegd en uitgespreid op het bouwplatform, klaar om te slicen — dezelfde indeling als de On Plate-weergave van de web-app.

    In beide indelingen bevatten de geëxporteerde bestanden precies één object per onderdeel en verder niets: een ingeklapt splintertje of puntachtig restant van een snede wordt vóór het exporteren verwijderd, zodat elk object dat je in het bestand aantreft printbaar is.

  • Name
    connectors
    Type
    boolean
    standaard false
    Description

    Voegt verbindingen met pen-en-gatverbinding toe bij elke snede, zodat de geprinte onderdelen in elkaar passen.

Alleen van toepassing wanneer connectors = true
  • Name
    connector_type
    Type
    string
    standaard cube
    Description

    De vorm van de verbinding bij elk snijvlak.

    Beschikbare waarden: cube, cylinder.

  • Name
    connector_size
    Type
    number
    standaard 0.5
    Description

    Grootte van de verbinding ten opzichte van het snijvlak.

    Geldig bereik: 0.1 tot 0.8.

  • Name
    connector_height
    Type
    number
    standaard 0.1
    Description

    Hoe ver de verbinding uitsteekt vanaf het snijvlak, ten opzichte van het snijvlak.

    Geldig bereik: 0.1 tot 0.8.

Retourwaarden

De eigenschap result van de respons bevat de id van de nieuw aangemaakte Auto Split-taak.

Foutmodi

  • Name
    400 - Bad Request
    Description

    Het verzoek was onaanvaardbaar. Veelvoorkomende oorzaken:

    • Ontbrekende prompt: prompt is verplicht wanneer mode by_parts of by_color is.
    • Prompt noemt minder dan twee onderdelen: by_parts / by_color heeft minstens twee benoemde stukken nodig (bijvoorbeeld head, torso, base); een algemene instructie zoals split into individual parts wordt afgewezen. Er wordt niets in rekening gebracht.
    • Niet-ondersteunde invoertaak: input_task_id moet verwijzen naar een geslaagde taak van een ondersteund type, gegenereerd met Meshy 6 of Meshy 7.
    • Invoer met textures: Het invoermodel heeft textures. Vooralsnog worden alleen modellen zonder textures ondersteund.
    • Geen referentieafbeelding: by_color vereist een invoer die is gegenereerd op basis van een geüploade afbeelding.
    • Niet-ondersteund formaat: target_formats bevat stl.
    • Verbinding buiten bereik: connector_size of connector_height valt buiten 0.1 tot 0.8.
  • Name
    401 - Unauthorized
    Description

    Authenticatie mislukt. Controleer je API-sleutel.

  • Name
    402 - Payment Required
    Description

    Onvoldoende credits om deze taak uit te voeren.

  • Name
    404 - Not Found
    Description

    De input_task_id bestaat niet of behoort niet tot jouw account.

  • Name
    429 - Too Many Requests
    Description

    Je hebt je rate limit overschreden. by_parts- en by_color-verzoeken delen ook een limiet van 12 verzoeken per minuut per account voor het verwerken van prompts.

  • Name
    503 - Service Unavailable
    Description

    Op prompts gebaseerd splitsen (by_parts en by_color) is tijdelijk niet beschikbaar. Probeer het later opnieuw, of gebruik mode: "auto", wat hier niet door wordt beïnvloed. Er wordt niets in rekening gebracht.

Request

POST
/openapi/v1/print/split
# Simple request: let Meshy choose the cuts
curl https://api.meshy.ai/openapi/v1/print/split \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578"
  }'

# Advanced request: name the parts, add connectors, export glb and obj
curl https://api.meshy.ai/openapi/v1/print/split \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "mode": "by_parts",
    "prompt": "split into the figure and the base",
    "target_formats": ["glb", "obj"],
    "layout": "on_plate",
    "connectors": true,
    "connector_type": "cylinder",
    "connector_size": 0.4
  }'

Response

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

GET/openapi/v1/print/split/:id

Een Auto Split-taak ophalen

Dit endpoint haalt een Auto Split-taak op aan de hand van de ID.

Parameters

  • Name
    id
    Type
    path
    Description

    De ID van de Auto Split-taak die moet worden opgehaald.

Retourwaarden

Het Auto Split Task-object.

Request

GET
/openapi/v1/print/split/a43b5c6d-7e8f-901a-234b-567c890d1e2f
curl https://api.meshy.ai/openapi/v1/print/split/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "print-split",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
  "part_count": 4,
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000082000,
  "task_error": null,
  "consumed_credits": 10
}

DELETE/openapi/v1/print/split/:id

Een Auto Split-taak verwijderen

Dit endpoint verwijdert een Auto Split-taak permanent, inclusief alle bijbehorende modellen en gegevens. Deze actie is onomkeerbaar.

Padparameters

  • Name
    id
    Type
    path
    Description

    De ID van de Auto Split-taak die verwijderd moet worden.

Retourwaarden

Retourneert 200 OK bij succes.

Request

DELETE
/openapi/v1/print/split/a43b5c6d-7e8f-901a-234b-567c890d1e2f
curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/print/split/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 200 Ok on success.

GET/openapi/v1/print/split

Lijst met Auto Split-taken

Deze endpoint stelt je in staat om een lijst met Auto Split-taken op te halen.

Parameters

Optionele attributen

  • Name
    page_num
    Type
    integer
    Description

    Paginanummer voor paginering. Begint en heeft standaard de waarde 1.

  • Name
    page_size
    Type
    integer
    Description

    Limiet voor paginagrootte. Standaard 10 items. Maximaal toegestaan is 100 items; hogere waarden worden begrensd op 100.

  • 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.

Retourwaarden

Retourneert een gepagineerde lijst van The Auto Split Task Objects.

Request

GET
/openapi/v1/print/split
curl https://api.meshy.ai/openapi/v1/print/split?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
    "type": "print-split",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
    "part_count": 4,
    "progress": 100,
    "status": "SUCCEEDED",
    "preceding_tasks": 0,
    "created_at": 1699999999000,
    "started_at": 1700000000000,
    "finished_at": 1700000082000,
    "task_error": null,
    "consumed_credits": 10
  }
]

GET/openapi/v1/print/split/:id/stream

Stream een Auto Split-taak

Dit endpoint streamt realtime updates voor een Auto Split-taak met behulp van Server-Sent Events (SSE).

Parameters

  • Name
    id
    Type
    path
    Description

    Unieke identifier voor de Auto Split-taak die gestreamd moet worden.

Retourwaarden

Retourneert een stream van The Auto Split Task Objects als Server-Sent Events.

Elk message-event bevat het volledige taakobject zoals geretourneerd door Retrieve an Auto Split Task, inclusief consumed_credits, de timestamps en prompt_ignored; terwijl de taak PENDING of IN_PROGRESS is, zijn de velden die tussen frames veranderen progress, status, started_at en preceding_tasks, en model_urls, thumbnail_url, part_count en parts verschijnen zodra de taak SUCCEEDED bereikt. Een error-event bevat alleen status_code en message, dus vertak op basis van de eventnaam voordat je status uitleest.

Request

GET
/openapi/v1/print/split/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream
curl -N https://api.meshy.ai/openapi/v1/print/split/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 (other task fields omitted here for brevity;
// each frame is the full task object).
event: message
data: {
  "id": "a43b5c6d-7e8f-901a-234b-567c890d1e2f",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "a43b5c6d-7e8f-901a-234b-567c890d1e2f",
  "type": "print-split",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/a43b5c6d-7e8f-901a-234b-567c890d1e2f/output/model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/a43b5c6d-7e8f-901a-234b-567c890d1e2f/output/preview.png?Expires=***",
  "part_count": 4,
  "progress": 100,
  "status": "SUCCEEDED",
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000082000,
  "task_error": null,
  "consumed_credits": 10
}

Het Auto Split-taakobject

Een Auto Split-taak bevat alleen de onderstaande eigenschappen. De generatie-promptvelden die andere taakobjecten wel bevatten (name, object_prompt, texture_prompt enzovoort), de enkele model_url, en texture_urls worden bij een split nooit ingevuld en worden niet geretourneerd. Eigenschappen die tijdens het uitvoeren van de taak worden ingevuld (thumbnail_url, model_urls, de tijdstempels) zijn altijd aanwezig, leeg totdat ze een waarde hebben, zodat de set sleutels niet verandert tussen PENDING en SUCCEEDED.

  • Name
    id
    Type
    string
    Description

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

  • Name
    type
    Type
    string
    Description

    Type van de taak. De waarde is print-split.

  • Name
    model_urls
    Type
    object
    Description

    Downloadbare URL's naar het gesplitste model, één per aangevraagd formaat. Elk onderdeel is een apart object in het bestand. De eigenschap voor een formaat wordt weggelaten als dat formaat niet is aangevraagd.

    • Name
      glb
      Type
      string
      Description

      Downloadbare URL naar het gesplitste model in GLB-formaat.

    • Name
      obj
      Type
      string
      Description

      Downloadbare URL naar het gesplitste model in OBJ-formaat.

    • Name
      fbx
      Type
      string
      Description

      Downloadbare URL naar het gesplitste model in FBX-formaat.

    • Name
      usdz
      Type
      string
      Description

      Downloadbare URL naar het gesplitste model in USDZ-formaat.

    • Name
      blend
      Type
      string
      Description

      Downloadbare URL naar het gesplitste model in Blender-formaat.

    • Name
      3mf
      Type
      string
      Description

      Downloadbare URL naar het gesplitste model in 3MF-formaat: één object per onderdeel, elk op zijn eigen filamentslot, in millimeters, geschaald zodat de langste zijde 150 mm is, met een Bambu Studio-projectconfiguratie.

  • Name
    thumbnail_url
    Type
    string
    Description

    Downloadbare URL naar een gerenderde preview van het gesplitste model, met elk onderdeel in een aparte kleur, in de aangevraagde layout.

  • Name
    prompt_ignored
    Type
    boolean
    Description

    true wanneer bij een by_parts- of by_color-aanvraag de prompt geen onderdelen benoemde, waardoor Meshy het model automatisch heeft gesplitst — de onderdeelnamen in het resultaat zijn dan van Meshy, niet van jou. Aanwezig vanaf PENDING. Weggelaten voor auto-taken en wanneer de prompt wel is gevolgd.

  • Name
    part_count
    Type
    integer
    Description

    Aantal printbare onderdelen in het gesplitste model — één per object in de geëxporteerde bestanden. Ingeklapte flinters die de segmentatie niet in een printbaar stuk kon omzetten, worden vóór het exporteren uit de bestanden verwijderd en niet meegeteld.

  • Name
    progress
    Type
    integer
    Description

    Voortgang 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 PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Het aantal voorafgaande taken.

  • 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 afgerond, in milliseconden. Als de taak nog niet is afgerond, is deze eigenschap 0.

  • Name
    task_error
    Type
    object
    Description

    Foutdetails voor mislukte taken. Zie Fouten voor de volledige referentie van het task_error-object.

  • Name
    consumed_credits
    Type
    integer
    Description

    Het aantal credits dat door deze taak is verbruikt. Altijd aanwezig: 10 zodra de taak is geaccepteerd, en 0 voor FAILED-taken omdat de kosten bij falen worden terugbetaald. Het verwijderen van een taak terwijl deze nog PENDING is, betaalt het bedrag ook terug.

The Auto Split Task Object

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "print-split",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/preview.png?Expires=***",
  "part_count": 4,
  "progress": 100,
  "status": "SUCCEEDED",
  "preceding_tasks": 0,
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000082000,
  "task_error": null,
  "consumed_credits": 10
}