Auto Split API
Rozdělte 3D model na samostatně tisknutelné části — automaticky, podle vámi pojmenovaných částí, nebo podle barevných oblastí — s volitelnými spojovacími prvky; tenké oblasti, které po řezu zůstanou, jsou vždy zpevněny, aby se každá část vytiskla vcelku.
Výsledek rozdělení nezachovává vstupní texturu. Auto Split přijímá vstupy s texturou, takže není nutné model znovu generovat s should_texture: false. Rozřezané části znovu sestaví a každé z nich přiřadí jednotnou barvu vrcholů; do žádného exportovaného formátu se nepřenáší žádná vstupní textura.
Create an Auto Split Task
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, kde je každý díl vlastní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
SUCCEEDEDa její model musí být vygenerován pomocí Meshy 6 nebo Meshy 7 (ai_modelmeshy-6,meshy-7,meshy-7.1nebolatest). Modely typu low-poly a Smart Topology (meshy-t2) nejsou podporovány. Model s texturou je přijat, ale jeho textura se do výsledku nepřenáší.
- Name
- mode
- Type
- string
- výchozí auto
- Description
Jak se model rozdělí na díly.
Dostupné hodnoty:
auto: Meshy zvolí řezy sám.promptse ignoruje.by_parts: Řeže podél strukturálních částí, které pojmenujete vprompt, například hlava, paže a trup.by_color: Řeže podél barevných oblastí, které pojmenujete vprompt. 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 kódem400. Hranice barevných oblastí pocházejí ze zdrojového obrázku, nikoli z textury vstupního modelu. U funkce Více obrázků na 3D používá Auto Split první zdrojový obrázek.
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 textu přečte 1 až 10 názvů dílů, proto pojmenujte jednotlivé části, nikoli celý model — například
split into the figure and the base, nebohead, torso, left arm, right arm, legs. Pojmenování jediného dílu je v pořádku: vše, co nepojmenujete, se stane jedním zbývajícím dílem, takžethe headrozdělí model na hlavu a zbytek, stejně jako ve webové aplikaci. Maximálně 600 znaků. Existují dva způsoby selhání: popis, který žádá o žádné rozdělení, nebo pojmenovává více než 10 dílů, je odmítnut s kódem400a nic se neúčtuje; popis, který Meshy vůbec nedokáže přečíst, se vrátí kauto, úloha přesto proběhne a je zpoplatněna a její odpověď obsahujeprompt_ignored: true.
- Name
- target_formats
- Type
- array
- výchozí ["glb"]
- Description
Formáty, ve kterých se má rozdělený model exportovat. Formáty podporující objekty scény (
glb,obj,fbx,usdz,blend,3mf) uchovávají každý díl jako samostatný objekt;stlnemá koncept samostatných objektů, takže spojí všechny díly do jednoho pevného tělesa uspořádaného podlelayout(pokud chcete samostatně vybíratelné díly ve slicer, vyžádejte si3mf).glbje vždy vytvořen a vrácen vmodel_urls; ostatní formáty, které chcete navíc, uveďte v seznamu.Dostupné hodnoty:
glb,obj,fbx,stl,usdz,blend,3mf.
- Name
- layout
- Type
- string
- výchozí assembled
- Description
Jak jsou díly uspořádány ve všech výstupních formátech a v miniatuře.
Dostupné hodnoty:
assembled: Díly zůstávají tam, kde je měl zdrojový model.on_plate: Díly jsou rozloženy naplocho a rozprostřeny na tiskové podložce, připravené ke slicování — stejné uspořádání jako v pohledu On Plate ve webové aplikaci.
V obou uspořádáních je před exportem odstraněn zborcený úlomek nebo bodu podobný kousek zbylý po řezu, takže každý získaný díl je tisknutelný. Formáty podporující objekty scény obsahují jeden objekt na díl;
stlje spojí do jednoho pevného tělesa.
- Name
- connectors
- Type
- boolean
- výchozí false
- Description
Přidá na každý řez spoje typu čep a dlab, aby vytištěné díly do sebe zapadaly.
connectors = true- Name
- connector_type
- Type
- string
- výchozí cube
- Description
Tvar spoje na každé řezné ploše.
Dostupné hodnoty:
cube,cylinder.
- Name
- connector_size
- Type
- number
- výchozí 0.5
- Description
Velikost spoje vzhledem k řezné ploše.
Platný rozsah:
0.1až0.8.
- Name
- connector_height
- Type
- number
- výchozí 0.1
- Description
Jak daleko spoj vystupuje z řezné plochy, vzhledem k řezné ploše.
Platný rozsah:
0.1až0.8.
Vrácené hodnoty
Vlastnost result odpovědi obsahuje id nově vytvořené úlohy Auto Split.
Způsoby selhání
- Name
400 - Bad Request- Description
Požadavek byl nepřijatelný. Časté příčiny:
- Chybějící prompt:
promptje vyžadován, pokud jemodenastaven naby_partsneboby_color. - Prompt nepopisuje žádné rozdělení, nebo je dílů příliš mnoho:
by_parts/by_colorpřijímá 1 až 10 pojmenovaných dílů. Popis, který žádá o zachování modelu v jednom kuse, nebo pojmenovává více než 10 dílů, je odmítnut. Nic se neúčtuje. - Nepodporovaná vstupní úloha:
input_task_idmusí odkazovat na úspěšnou úlohu podporovaného typu, vygenerovanou pomocí Meshy 6 nebo Meshy 7. - Chybějící referenční obrázek:
by_colorvyžaduje vstup vygenerovaný z nahraného obrázku. - Spoj mimo rozsah:
connector_sizeneboconnector_heightje mimo rozsah0.1až0.8.
- Chybějící prompt:
- Name
401 - Unauthorized- Description
Autentizace se nezdařila. 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_idneexistuje nebo nepatří k vašemu účtu.
- Name
429 - Too Many Requests- Description
Překročili jste svůj limit rychlosti. Požadavky
by_partsaby_colortaké sdílejí limit zpracování promptů ve výši 12 požadavků za minutu na účet.
- Name
503 - Service Unavailable- Description
Rozdělování na základě promptu (
by_partsaby_color) je dočasně nedostupné. Zkuste to znovu později, nebo použijtemode: "auto", které tím není ovlivněno. Nic se neúčtuje.
Request
# 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"
}
Načtení úlohy Auto Split
Tento koncový bod načte úlohu Auto Split podle jejího ID.
Parametry
- Name
- id
- Type
- path
- Description
ID úlohy Auto Split, kterou chcete načíst.
Návratová hodnota
Objekt úlohy Auto Split.
Request
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
}
Smazat úlohu Auto Split
Tento koncový bod trvale smaže úlohu Auto Split, včetně všech souvisejících modelů a dat. Tato akce je nevratná.
Parametry cesty
- Name
- id
- Type
- path
- Description
ID úlohy Auto Split, která má být smazána.
Stav úlohy
Úloha, která je stále ve stavu PENDING, je smazána a kredity spotřebované
při jejím vytvoření jsou vráceny.
Úlohu, která je již IN_PROGRESS, nelze smazat: požadavek je zamítnut
s chybou 409 Conflict a úloha pokračuje v běhu. Kredity za úlohu, kterou
již pracovní proces začal zpracovávat, nejsou vratné, takže její smazání
uprostřed zpracování by vás stálo kredity i výsledek zároveň. Počkejte,
dokud nedosáhne stavu SUCCEEDED, FAILED nebo CANCELED, a poté ji smažte.
Úloha v koncovém stavu (SUCCEEDED, FAILED nebo CANCELED) je smazána
bez vrácení kreditů.
Návratové hodnoty
Při úspěchu vrací 200 OK, nebo 409 Conflict, pokud je úloha
ve stavu IN_PROGRESS.
Request
curl --request DELETE \
--url https://api.meshy.ai/openapi/v1/print/split/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS — the task is left running:
{
"message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}
List Auto Split Tasks
Tento koncový bod umožňuje načíst seznam úkolů 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
10položek. Maximální povolená hodnota je100položek; vyšší hodnoty jsou omezeny na100.
- Name
- sort_by
- Type
- string
- Description
Pole, podle kterého se má řadit. Dostupné hodnoty:
+created_at: Řazení podle času vytvoření vzestupně.-created_at: Řazení podle času vytvoření sestupně.
Návratová hodnota
Vrací stránkovaný seznam The Auto Split Task Objects.
Request
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
}
]
Streamovat úlohu Auto Split
Tento endpoint streamuje aktuální průběžné aktualizace úlohy 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 jako Server-Sent Events.
Každá událost message obsahuje celý objekt úlohy tak, jak je vrácen metodou Získání úlohy Auto Split, včetně consumed_credits, časových razítek a prompt_ignored; dokud 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 také model_urls, thumbnail_url a part_count. Událost error obsahuje pouze status_code a message, proto se před čtením status rozhodujte podle názvu události.
Request
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
}
Objekt úlohy Auto Split
Úloha Auto Split obsahuje pouze níže uvedené vlastnosti. Pole generačního promptu, která jiné objekty úloh obsahují (name, object_prompt, texture_prompt a další), samotné model_url a texture_urls se u rozdělení nikdy nevyplňují a nejsou vraceny. Vlastnosti, které se vyplňují v průběhu úlohy (thumbnail_url, model_urls, časová razítka), jsou vždy přítomny, prázdné, dokud nemají hodnotu, takže se sada klíčů 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 k rozdělenému modelu, jedno pro každý požadovaný formát. Formáty podporující objekty scény zachovávají každou část jako samostatný objekt;
stlje sloučí do jednoho pevného tělesa. Vlastnost pro daný formát bude vynechána, pokud tento formát nebyl vyžádán.- Name
glb- Type
- string
- Description
Stažitelné URL k rozdělenému modelu ve formátu GLB.
- Name
obj- Type
- string
- Description
Stažitelné URL k rozdělenému modelu ve formátu OBJ.
- Name
fbx- Type
- string
- Description
Stažitelné URL k rozdělenému modelu ve formátu FBX.
- Name
stl- Type
- string
- Description
Stažitelné URL k rozdělenému modelu ve formátu STL. Všechny části jsou sloučeny do jednoho pevného tělesa; pro samostatně vybíratelné části vyžádejte
3mf.
- Name
usdz- Type
- string
- Description
Stažitelné URL k rozdělenému modelu ve formátu USDZ.
- Name
blend- Type
- string
- Description
Stažitelné URL k rozdělenému modelu ve formátu Blender.
- Name
3mf- Type
- string
- Description
Stažitelné URL k rozdělenému modelu ve formátu 3MF.
- Name
- thumbnail_url
- Type
- string
- Description
Stažitelné URL na vykreslený náhled rozděleného modelu, kde má každá část odlišnou barvu, v požadovaném
layout.
- Name
- prompt_ignored
- Type
- boolean
- Description
true, pokudpromptpožadavkuby_partsneboby_colornepojmenoval žádné části, a Meshy proto model rozdělil automaticky — názvy částí ve výsledku pak pocházejí od Meshy, ne od vás. Přítomno odPENDINGdál. Vynecháno u úlohautoa vždy, když byl prompt dodržen.
- Name
- part_count
- Type
- integer
- Description
Počet tisknutelných částí, které rozdělení vytvořilo. Formáty podporující objekty scény obsahují jeden objekt na část;
stlje sloučí do jednoho pevného tělesa, ale počet stále odpovídá počtu částí. Zhroucené útržky, které segmentace nedokázala převést na tisknutelnou část, jsou před exportem ze souborů odstraněny a nejsou počítány.
- Name
- progress
- Type
- integer
- Description
Postup úlohy. Pokud úloha ještě nebyla zahájena, bude tato vlastnost
0. Jakmile úloha úspěšně skončí, změní se na100.
- 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ředchozích úloh.
Hodnota tohoto pole má smysl pouze pokud je stav úlohy
PENDING.
- Name
- created_at
- Type
- timestamp
- Description
Časové razítko vytvoření úlohy, v milisekundách.
- Name
- started_at
- Type
- timestamp
- Description
Časové razítko zahájení úlohy, v milisekundách. Pokud úloha ještě nebyla zahájena, bude tato vlastnost
0.
- Name
- finished_at
- Type
- timestamp
- Description
Časové razítko dokončení úlohy, v milisekundách. Pokud úloha ještě nebyla dokončena, bude tato vlastnost
0.
- Name
- task_error
- Type
- object
- Description
Podrobnosti o chybě u neúspěšných úloh. Úplný popis objektu
task_errornaleznete v Chyby.
- Name
- consumed_credits
- Type
- integer
- Description
Počet kreditů spotřebovaných touto úlohou. Vždy přítomno:
10po přijetí úlohy a0u úlohFAILED, protože poplatek je při neúspěchu vrácen. Odstranění úlohy, dokud je stálePENDING, ji rovněž vrátí.
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
}