Auto Split API

Rozdělte 3D model na samostatně tisknutelné části — automaticky, podle vámi zadaných částí nebo podle barevné oblasti — s volitelnými spojovacími prvky; tenké oblasti zanechané řezem jsou vždy zpevněny, aby se každá část vytiskla pevná.


POST/openapi/v1/print/split

Vytvoření úlohy Auto Split

Tento koncový bod vytvoří novou úlohu Auto Split. Úloha rozřeže model z předchozí úlohy na samostatně tisknutelné díly a vrátí segmentovaný model, přičemž každý díl je samostatným objektem v souboru.

Parametry

  • Name
    input_task_id
    Type
    string
    Povinné
    Description

    ID úspěšné úlohy, jejíž model se má rozdělit. Podporované typy úloh: Obrázek na 3D, Více obrázků na 3D, Text na 3D (náhled), Remesh, Převést a Změnit velikost. Úloha musí mít stav SUCCEEDED a její model musí být vygenerován pomocí Meshy 6 nebo Meshy 7 (ai_model meshy-6, meshy-7 nebo latest). Modely typu low-poly a Smart Topology (meshy-t2) nejsou podporovány.

  • Name
    mode
    Type
    string
    výchozí auto
    Description

    Způsob, jakým je model rozdělen na díly.

    Dostupné hodnoty:

    • auto: Meshy zvolí řezy sám. prompt se ignoruje.
    • by_parts: Rozřeže model podle strukturálních částí, které pojmenujete v prompt, například hlava, ruce a trup.
    • by_color: Rozřeže model podle barevných oblastí, které pojmenujete v prompt. Vyžaduje vstup vygenerovaný z nahraného obrázku (Obrázek na 3D nebo Více obrázků na 3D); jiné vstupy jsou odmítnuty s chybou 400.
Platí pouze když mode = by_parts or by_color
  • Name
    prompt
    Type
    string
    Povinné
    Description

    Popisuje díly, na které se má model rozdělit, v libovolném jazyce. Meshy z něj přečte 1 až 10 názvů dílů, proto díly spíše pojmenujte, než abyste popisovali model – například split into the figure and the base, nebo head, torso, left arm, right arm, legs. Maximálně 600 znaků. Existují dva režimy selhání: popis, který zní jako rozdělení, ale pojmenovává méně než dva díly (například split into individual parts), je odmítnut s chybou 400 a nic se neúčtuje; popis, který Meshy vůbec nedokáže přečíst, se vrátí k režimu auto, úloha přesto proběhne a je zpoplatněna a v odpovědi je uvedeno prompt_ignored: true.

  • Name
    target_formats
    Type
    array
    výchozí ["glb"]
    Description

    Formáty, ve kterých se má rozdělený model exportovat. Každý díl je samostatným objektem v každém formátu. glb se generuje vždy a je vrácen v model_urls; uveďte navíc jakékoli další formáty, které chcete.

    Dostupné hodnoty: glb, obj, fbx, usdz, blend, 3mf.

  • Name
    layout
    Type
    string
    výchozí assembled
    Description

    Jak jsou díly uspořádány v každém výstupním formátu a na miniatuře.

    Dostupné hodnoty:

    • assembled: Díly zůstávají tam, kde byly ve zdrojovém modelu.
    • on_plate: Díly jsou položeny naplocho a rozmístěny na tiskové podložce, připravené k plátkování – stejné uspořádání jako zobrazení On Plate ve webové aplikaci.

    V obou uspořádáních exportované soubory obsahují jeden objekt na díl a nic jiného: zborcený tenký zbytek nebo bodový útvar zanechaný po řezu je před exportem odstraněn, takže každý objekt v souboru je tisknutelný.

  • Name
    connectors
    Type
    boolean
    výchozí false
    Description

    Přidá spojovací prvky typu čep a drážka na každém řezu, aby vytištěné díly do sebe zapadaly.

Platí pouze když connectors = true
  • Name
    connector_type
    Type
    string
    výchozí cube
    Description

    Tvar spojovacího prvku na každé řezné ploše.

    Dostupné hodnoty: cube, cylinder.

  • Name
    connector_size
    Type
    number
    výchozí 0.5
    Description

    Velikost spojovacího prvku vzhledem k řezné ploše.

    Platný rozsah: 0.10.8.

  • Name
    connector_height
    Type
    number
    výchozí 0.1
    Description

    Jak daleko spojovací prvek vystupuje z řezné plochy, vzhledem k řezné ploše.

    Platný rozsah: 0.10.8.

Návratová hodnota

Vlastnost result v odpovědi obsahuje id nově vytvořené úlohy Auto Split.

Režimy selhání

  • Name
    400 - Bad Request
    Description

    Požadavek byl nepřijatelný. Časté příčiny:

    • Chybějící prompt: prompt je vyžadován, pokud je mode nastaven na by_parts nebo by_color.
    • Prompt pojmenovává méně než dva díly: by_parts / by_color vyžaduje alespoň dva pojmenované díly (například head, torso, base); obecná instrukce jako split into individual parts je odmítnuta. Nic se neúčtuje.
    • Nepodporovaná vstupní úloha: input_task_id musí odkazovat na úspěšnou úlohu podporovaného typu, vygenerovanou pomocí Meshy 6 nebo Meshy 7.
    • Texturovaný vstup: Vstupní model má textury. Zatím jsou podporovány pouze netexturované modely.
    • Chybí referenční obrázek: by_color vyžaduje vstup vygenerovaný z nahraného obrázku.
    • Nepodporovaný formát: target_formats obsahuje stl.
    • Spojovací prvek mimo rozsah: connector_size nebo connector_height je mimo rozsah 0.10.8.
  • Name
    401 - Unauthorized
    Description

    Autentizace selhala. Zkontrolujte prosím svůj API klíč.

  • Name
    402 - Payment Required
    Description

    Nedostatek kreditů k provedení této úlohy.

  • Name
    404 - Not Found
    Description

    input_task_id neexistuje nebo nepatří k vašemu účtu.

  • Name
    429 - Too Many Requests
    Description

    Překročili jste limit rychlosti. Požadavky by_parts a by_color navíc sdílejí limit zpracování promptu ve výši 12 požadavků za minutu na jeden účet.

  • Name
    503 - Service Unavailable
    Description

    Rozdělování na základě promptu (by_parts a by_color) je dočasně nedostupné. Zkuste to prosím později, nebo použijte mode: "auto", kterého se to netýká. Nic se neúčtuje.

Request

POST
/openapi/v1/print/split
# Simple request: let Meshy choose the cuts
curl https://api.meshy.cn/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.cn/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

Získání úlohy Auto Split

Tento koncový bod získá úlohu Auto Split podle jejího ID.

Parametry

  • Name
    id
    Type
    path
    Description

    ID úlohy Auto Split, kterou chcete získat.

Návratová hodnota

Objekt úlohy Auto Split.

Request

GET
/openapi/v1/print/split/a43b5c6d-7e8f-901a-234b-567c890d1e2f
curl https://api.meshy.cn/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.cn/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.cn/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.cn/***/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

Smazání úlohy Auto Split

Tento koncový bod trvale smaže úlohu Auto Split, včetně všech přidružených modelů a dat. Tuto akci nelze vrátit zpět.

Parametry cesty

  • Name
    id
    Type
    path
    Description

    ID úlohy Auto Split, která má být smazána.

Návratová hodnota

Při úspěchu vrací 200 OK.

Request

DELETE
/openapi/v1/print/split/a43b5c6d-7e8f-901a-234b-567c890d1e2f
curl --request DELETE \
  --url https://api.meshy.cn/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

List Auto Split Tasks

Tento koncový bod umožňuje načíst seznam úloh Auto Split.

Parametry

Volitelné atributy

  • Name
    page_num
    Type
    integer
    Description

    Číslo stránky pro stránkování. Začíná a výchozí hodnota je 1.

  • Name
    page_size
    Type
    integer
    Description

    Limit velikosti stránky. Výchozí hodnota je 10 položek. Maximální povolená hodnota je 100 položek; vyšší hodnoty jsou omezeny na 100.

  • Name
    sort_by
    Type
    string
    Description

    Pole, podle kterého se má řadit. Dostupné hodnoty:

    • +created_at: Seřadit podle času vytvoření vzestupně.
    • -created_at: Seřadit podle času vytvoření sestupně.

Návratová hodnota

Vrací stránkovaný seznam objektů úloh Auto Split.

Request

GET
/openapi/v1/print/split
curl https://api.meshy.cn/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.cn/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.cn/***/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 úlohy Auto Split

Tento koncový bod streamuje aktualizace v reálném čase pro úlohu Auto Split pomocí Server-Sent Events (SSE).

Parametry

  • Name
    id
    Type
    path
    Description

    Jedinečný identifikátor úlohy Auto Split, kterou chcete streamovat.

Návratová hodnota

Vrací stream Objektů úlohy Auto Split ve formě Server-Sent Events.

Každá událost message obsahuje celý objekt úlohy, jak jej vrací Retrieve an Auto Split Task, včetně consumed_credits, časových razítek a prompt_ignored; zatímco je úloha ve stavu PENDING nebo IN_PROGRESS, mezi jednotlivými snímky se mění pole progress, status, started_at a preceding_tasks, a jakmile úloha dosáhne stavu SUCCEEDED, objeví se model_urls, thumbnail_url, part_count a parts. Událost error obsahuje pouze status_code a message, proto před čtením status rozlišujte podle názvu události.

Request

GET
/openapi/v1/print/split/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream
curl -N https://api.meshy.cn/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.cn/***/tasks/a43b5c6d-7e8f-901a-234b-567c890d1e2f/output/model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.cn/***/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
}

Objekt úlohy Auto Split

Úloha Auto Split obsahuje pouze níže uvedené vlastnosti. Pole s generačním promptem, která obsahují ostatní objekty úloh (name, object_prompt, texture_prompt a další), samotné model_url a texture_urls nejsou u rozdělení nikdy naplněny a nejsou vraceny. Vlastnosti, které se doplňují v průběhu úlohy (thumbnail_url, model_urls, časová razítka), jsou přítomny vždy, dokud nemají hodnotu, zůstávají prázdné, takže sada klíčů se mezi PENDING a SUCCEEDED nemění.

  • Name
    id
    Type
    string
    Description

    Unikátní identifikátor úlohy. Ačkoli jako implementační detail používáme pro id úloh k-sortable UUID, neměli byste dělat žádné předpoklady o formátu id.

  • Name
    type
    Type
    string
    Description

    Typ úlohy. Hodnota je print-split.

  • Name
    model_urls
    Type
    object
    Description

    Stažitelné URL adresy rozděleného modelu, jedna pro každý požadovaný formát. Každá část je v souboru samostatným objektem. Vlastnost pro daný formát bude vynechána, pokud daný formát nebyl vyžádán.

    • Name
      glb
      Type
      string
      Description

      Stažitelná URL adresa rozděleného modelu ve formátu GLB.

    • Name
      obj
      Type
      string
      Description

      Stažitelná URL adresa rozděleného modelu ve formátu OBJ.

    • Name
      fbx
      Type
      string
      Description

      Stažitelná URL adresa rozděleného modelu ve formátu FBX.

    • Name
      usdz
      Type
      string
      Description

      Stažitelná URL adresa rozděleného modelu ve formátu USDZ.

    • Name
      blend
      Type
      string
      Description

      Stažitelná URL adresa rozděleného modelu ve formátu Blender.

    • Name
      3mf
      Type
      string
      Description

      Stažitelná URL adresa rozděleného modelu ve formátu 3MF.

  • Name
    thumbnail_url
    Type
    string
    Description

    Stažitelná URL adresa vykresleného náhledu rozděleného modelu, kde má každá část odlišnou barvu, v požadovaném layout.

  • Name
    prompt_ignored
    Type
    boolean
    Description

    true, pokud prompt v požadavku by_parts nebo by_color nepojmenoval žádné části, a Meshy tedy model rozdělil automaticky — názvy částí ve výsledku pak pocházejí od Meshy, nikoli od vás. Přítomno od PENDING výše. Vynecháno u úloh auto a kdykoli byl prompt dodržen.

  • Name
    part_count
    Type
    integer
    Description

    Počet tisknutelných částí v rozděleném modelu — jedna na objekt v exportovaných souborech. Zkolabované úlomky, které segmentace nedokázala převést na tisknutelný díl, jsou před exportem ze souborů odstraněny a nezapočítávají se.

  • Name
    progress
    Type
    integer
    Description

    Postup úlohy. Pokud úloha ještě nebyla spuštěna, bude tato vlastnost 0. Jakmile úloha uspěje, hodnota se stane 100.

  • Name
    status
    Type
    string
    Description

    Stav úlohy. Možné hodnoty jsou jedna z PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Počet předcházejících úloh.

  • Name
    created_at
    Type
    timestamp
    Description

    Časové razítko okamžiku, kdy byla úloha vytvořena, v milisekundách.

  • Name
    started_at
    Type
    timestamp
    Description

    Časové razítko okamžiku, kdy byla úloha spuštěna, v milisekundách. Pokud úloha ještě nebyla spuštěna, bude tato vlastnost 0.

  • Name
    finished_at
    Type
    timestamp
    Description

    Časové razítko okamžiku, kdy byla úloha dokončena, v milisekundách. Pokud úloha ještě není dokončena, bude tato vlastnost 0.

  • Name
    task_error
    Type
    object
    Description

    Podrobnosti chyby u neúspěšných úloh. Úplný popis objektu task_error naleznete v Chyby.

  • Name
    consumed_credits
    Type
    integer
    Description

    Počet kreditů spotřebovaných touto úlohou. Vždy přítomno: 10 jakmile je úloha přijata, a 0 u úloh FAILED, protože poplatek je v případě selhání vrácen. Smazání úlohy, dokud je stále ve stavu PENDING, ji rovněž vrátí.

The Auto Split Task Object

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "print-split",
  "model_urls": {
    "glb": "https://assets.meshy.cn/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.cn/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.cn/***/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
}