Proměňte své fotografie na vlastní magnety na lednici — zaoblený obdélník s barevným
hloubkovým reliéfem a plochou magnetickou zadní stranou, velikostí vhodnou pro lednici — ve dvou
fázích: prototyp generuje barevný konceptuální obrázek z vaší vstupní
fotografie, poté sestavení promění tento konceptuální obrázek na 3D model reliéfu. Tyto
dvě fáze jsou propojeny prostřednictvím input_task_id.
POST /openapi/creative-lab/fridge-magnet/v1/prototype
Generujte jediný barevný konceptuální obrázek ze zdrojové fotografie. Vrácené ID úkolu je to, co předáte jako input_task_id do koncového bodu pro sestavení. Podívejte se na Objekt úkolu prototypu magnetu na lednici pro tvar odpovědi.
Parametry
Name
image_url
Type
string
Povinné
Description
Zdrojová fotografie pro Meshy k obarvení do konceptuálního obrázku připraveného pro magnet na lednici. V současné době podporujeme formáty .jpg, .jpeg, .png a .webp.
Existují dva způsoby, jak poskytnout obrázek:
Veřejně přístupná URL: URL, která je přístupná z veřejného internetu.
Data URI: Base64-kódovaný Data URI obrázku. Příklad Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
name
Type
string
Description
Volitelný název úkolu pro účely zobrazení. Maximálně 100 znaků.
Name
remove_background
Type
boolean
výchozí false
Description
Když je nastaveno na true, prototypový obrázek je vrácen jako průhledný RGBA PNG s odstraněným pozadím, takže můžete subjekt složit na jakékoliv pozadí.
Toto ovládá pouze obrázek, který tento koncový bod vrací. Je oddělený od možnosti sestavení stejného jména (výchozí true), která ovládá odstranění pozadí před reliéfováním.
Vrací
Vlastnost result odpovědi obsahuje id nově vytvořeného úkolu prototypu magnetu na lednici. Dotazujte Získání úkolu koncový bod nebo se přihlaste k odběru streamu, dokud úkol nedosáhne SUCCEEDED, poté předáte toto ID do koncového bodu pro sestavení jako input_task_id.
Generujte finální 3D-tisknutelný magnet na lednici z úspěšného prototypového úkolu. Sestavení spustí pipeline pro reliéfní mapu hloubky na barevný konceptuální obrázek prototypu a dodá jediný síťový artefakt ve formátu, který požadujete. Odkazujte na Objekt úkolu pro sestavení magnetu na lednici pro tvar odpovědi.
Parametry
Name
input_task_id
Type
string
Povinné
Description
ID úkolu prototypu vytvořeného prostřednictvím tohoto stejného OpenAPI koncového bodu. Prototyp musí být vytvořen se stejným API klíčem, musí dosáhnout SUCCEEDED a musí produkovat přesně jeden kandidátní obrázek.
Prototypové úkoly vytvořené prostřednictvím webové aplikace nejsou přijímány — koncový bod pro sestavení přijímá pouze prototypové úkoly produkované POST /openapi/creative-lab/fridge-magnet/v1/prototype a odmítá jakýkoli jiný zdroj s 404.
Name
name
Type
string
Description
Volitelný název úkolu pro zobrazovací účely. Maximálně 100 znaků.
options
Volitelné ladicí parametry pro reliéfní geometrie. Každé pole má rozumnou výchozí hodnotu — posílejte pouze ty, které chcete přepsat.
Name
badge_shape
Type
string
výchozí rounded-rect
Description
Obrysová silueta magnetu na lednici. Dostupné hodnoty:
circle
rounded-rect (výchozí)
hexagon
shield
star
Name
size_mm
Type
number
výchozí 60
Description
Délka hrany ohraničujícího čtverce magnetu na lednici, v milimetrech. Rozsah: (0, 400].
Name
relief_height_mm
Type
number
výchozí 3.3
Description
Maximální výška reliéfu nad základnou, v milimetrech. Rozsah: [0, 20].
Name
relief_offset_mm
Type
number
výchozí 0
Description
Vertikální posun aplikovaný na reliéf před extruzí, v milimetrech. Rozsah: [0, 20].
Name
base_thickness_mm
Type
number
výchozí 2.0
Description
Tloušťka ploché základní desky za reliéfem, v milimetrech. Výchozí hodnota magnetu na lednici je robustnější základna 2 mm — dává magnetu dostatečnou tělesnost, aby se přichytil na lednici, aniž by reliéf působil křehce. Rozsah: [0, 20].
Name
has_closed_back
Type
boolean
výchozí true
Description
Zda je zadní strana magnetu na lednici uzavřena jako uzavřený povrch (strana, na kterou lepíte magnet). Nastavte na false pro otevřenou skořepinu.
Name
relief_curve
Type
string
výchozí linear
Description
Přenosová křivka mapující hodnoty mapy hloubky na výšku reliéfu. Dostupné hodnoty:
linear (výchozí)
gamma
s-curve
Name
curve_param
Type
number
výchozí 1.0
Description
Tvarový parametr pro přenosovou křivku (má smysl pouze, když relief_curve je gamma). Rozsah: (0, 10].
Name
invert_depth
Type
boolean
výchozí false
Description
Inverze interpretace mapy hloubky tak, aby tmavší oblasti byly vyšší reliéf.
Name
smoothing
Type
number
výchozí 0.24
Description
Síla vyhlazení aplikovaná na mapu hloubky před extrakcí reliéfu. Rozsah: [0, 10].
Name
relief_scale
Type
number
výchozí 1.0
Description
Vertikální měřítkový násobitel aplikovaný na relief_height_mm. Rozsah: (0, 10].
Name
depth_threshold
Type
number
výchozí 0.1
Description
Dolní prahová hodnota pro hodnoty mapy hloubky; cokoli pod touto hodnotou je oříznuto na nulu. Rozsah: [0, 1].
Name
remove_background
Type
boolean
výchozí true
Description
Automaticky odstranit pozadí konceptuálního obrázku prototypu před reliéfováním.
Odděleno od parametru prototypu stejného jména (výchozí false), který ovládá, zda je prototypový obrázek sám vrácen s průhledností.
Name
export_resolution
Type
integer
výchozí 512
Description
Rozlišení sítě použité pro export. Rozsah: [64, 2048].
output
Volitelný selektor formátu drátového modelu. Výchozí hodnota je glb.
glb (výchozí) — vrací jediný model.glb pod model_urls.glb.
obj — zabalí model.obj + model.mtl + texture.png a vrátí balíček pod model_urls.obj.
zip — zabalí každý artefakt, který generátor vydá, a vrátí balíček pod model_urls.bundle_zip.
Vrátí
Vlastnost result odpovědi obsahuje ID úkolu nově vytvořeného úkolu pro sestavení magnetu na lednici. Dotazujte koncový bod Získat úkol nebo se přihlaste k odběru streamu, dokud úkol nedosáhne SUCCEEDED, poté stáhněte artefakt z jediného záznamu v model_urls.
Režimy selhání
Name
400 - Bad Request
Description
Požadavek byl nepřijatelný. Běžné příčiny:
Chybějící parametr: input_task_id je povinný.
Neplatný UUID: input_task_id není platný UUID.
Rodič neuspěl: Odkazovaný prototypový úkol ještě nedosáhl SUCCEEDED.
Žádný kandidát: Prototypový úkol uspěl, ale neprodukoval žádný kandidátní obrázek.
Možnosti mimo rozsah: Jedno z polí options spadlo mimo povolený rozsah nebo množinu hodnot.
Name
401 - Unauthorized
Description
Autentizace selhala. Zkontrolujte prosím svůj API klíč.
Name
402 - Payment Required
Description
Nedostatečné kredity pro provedení tohoto úkolu.
Name
404 - Not Found
Description
Odkazovaný prototypový úkol neexistuje, patří jinému uživateli nebo byl vytvořen prostřednictvím webové aplikace (pouze prototypové úkoly v režimu API se řetězí do sestavení).
Získejte prototyp nebo úkol sestavení pomocí platného id úkolu. Cesta URL
musí odpovídat fázi úkolu — úkol sestavení načtený přes
/prototype/:id vrátí 404, a naopak.
Zrušit úkol magnetu na lednici. Pokud je úkol stále PENDING, kredity
spotřebované při vytvoření jsou vráceny. Úkoly, které jsou již
IN_PROGRESS, jsou zrušeny bez náhrady (pracovník již může spotřebovávat zdroje). Úkoly, které již dosáhly konečného stavu
(SUCCEEDED, FAILED, CANCELED), nelze zrušit.
Cesta URL musí odpovídat fázi úkolu — DELETE na
/prototype/:buildId vrací 404.
Parametry cesty
Name
id
Type
path
Description
Jedinečný identifikátor úkolu magnetu na lednici ke zrušení.
Vrací
Vrací 204 No Content při úspěchu s prázdným tělem.
Režimy selhání
Name
400 - Bad Request
Description
Úkol je již v konečném stavu a nelze jej zrušit.
Name
404 - Not Found
Description
Úkol neexistuje, patří jinému uživateli nebo jeho fáze neodpovídá cestě URL.
Streamování aktualizací v reálném čase pro úkol magnet na lednici prostřednictvím Server-Sent Events (SSE).
Cesta URL musí odpovídat fázi úkolu — otevření streamu na
/prototype/:buildId/stream vyvolá jediný event: error payload s
status_code: 404 a uzavře stream.
Parametry
Name
id
Type
path
Description
Unikátní identifikátor pro úkol magnet na lednici ke streamování.
Návratové hodnoty
Vrací stream objektů úkolu Fridge Magnet Prototype
nebo Fridge Magnet Build jako
Server-Sent Events. Pro úkoly PENDING nebo IN_PROGRESS bude stream
odpovědí obsahovat pouze nezbytná pole progress a status.
// Error event example (wrong stage or task not found)event: errordata: {"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: messagedata: {"id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0","progress": 0,"status": "PENDING"}event: messagedata: {"id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0","type": "creative-lab-fridge-magnet-build","status": "SUCCEEDED","progress": 100,"created_at": 1729543250000,"started_at": 1729543258000,"finished_at": 1729543285000,"expires_at": 1729802485000,"task_error": null,"consumed_credits": 20,"model_urls": {"glb":"https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***" }}
Získejte stránkovaný seznam svých úkolů magnetu na lednici pro jednu fázi. Cesta URL
vybírá fázi — /prototype vrací úkoly prototypu; /build
vrací úkoly sestavení. Úkoly z jiné fáze nejsou zahrnuty v žádné
odpovědi.
Parametry cesty
Name
stage
Type
path
Povinné
Description
Buď prototype nebo build. Kolekce vrací pouze úkoly,
jejichž fáze odpovídá URL — načítání /prototype nikdy nevrací
úkoly sestavení a naopak.
Parametry dotazu
Name
page_num
Type
integer
výchozí 1
Description
Číslo stránky pro stránkování.
Name
page_size
Type
integer
výchozí 10
Description
Limit velikosti stránky. Maximálně povoleno je 50 položek.
Name
sort_by
Type
string
výchozí -created_at
Description
Pole pro řazení. Dostupné hodnoty:
+created_at: Řadit podle času vytvoření vzestupně.
Objekt úlohy prototypu magnetu na lednici je pracovní jednotka, kterou Meshy sleduje pro generování kolorovaného konceptuálního obrázku ze zdrojové fotografie. Výstup této fáze je propojen do fáze sestavení prostřednictvím input_task_id.
Vlastnosti
Name
id
Type
string
Description
Unikátní identifikátor úlohy. I když používáme k-tříděné UUID pro id úloh jako implementační detail, neměli byste dělat žádné předpoklady o formátu id.
Name
type
Type
string
Description
Typ úlohy. Hodnota je creative-lab-fridge-magnet-prototype.
Name
name
Type
string
Description
Název úlohy zadaný při vytvoření úlohy. Prázdný řetězec, pokud nebyl poskytnut žádný název.
Name
status
Type
string
Description
Stav úlohy. Možné hodnoty jsou PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Pokrok úlohy. Pokud úloha ještě nezačala, tato vlastnost bude 0. Jakmile úloha uspěje, stane se 100.
Name
created_at
Type
timestamp
Description
Časové razítko, kdy byla úloha vytvořena, v milisekundách.
Časové razítko představuje počet milisekund uplynulých od 1. ledna 1970 UTC, podle standardu RFC 3339. Například pátek, 1. září 2023 12:00:00 GMT je reprezentován jako 1693569600000. To platí pro všechna časová razítka v Meshy API.
Name
started_at
Type
timestamp
Description
Časové razítko, kdy byla úloha zahájena, v milisekundách. Pokud úloha ještě nezačala, tato vlastnost bude 0.
Name
finished_at
Type
timestamp
Description
Časové razítko, kdy byla úloha dokončena, v milisekundách. Pokud úloha ještě není dokončena, tato vlastnost bude 0.
Name
expires_at
Type
timestamp
Description
Časové razítko, kdy výsledek úlohy vyprší, v milisekundách.
Name
preceding_tasks
Type
integer
Description
Počet předcházejících úloh.
Hodnota tohoto pole má smysl pouze pokud je stav úlohy PENDING.
Name
task_error
Type
object
Description
Podrobnosti o chybách pro neúspěšné úlohy. Viz Chyby pro úplnou referenci objektu task_error.
Name
consumed_credits
Type
integer
Description
Počet kreditů spotřebovaných touto úlohou. Přítomno, když je stav úlohy PENDING, IN_PROGRESS nebo SUCCEEDED. Vrací 0 pro úlohy FAILED (kredity jsou při selhání vráceny).
Name
image_urls
Type
array of strings
Description
Stahovatelné URL pro kandidáty konceptuálních obrázků generovaných touto prototypovou úlohou. Aktuálně API vždy vrací přesně jednoho kandidáta; pole je polem, takže budoucí revize mohou zobrazit více kandidátů bez narušení kompatibility.
Příklad objektu úlohy prototypu magnetu na lednici
Objekt úkolu pro stavbu magnetu na lednici je pracovní jednotka, kterou Meshy sleduje, aby vygeneroval konečnou 3D síť magnetu na lednici z úspěšného prototypového úkolu. Stavba provádí pipeline pro reliéf hloubkové mapy na konceptuálním obrázku prototypu a publikuje jediný artefakt sítě ve formátu, který volající požadoval.
Vlastnosti
Name
id
Type
string
Description
Unikátní identifikátor pro úkol.
Name
type
Type
string
Description
Typ úkolu. Hodnota je creative-lab-fridge-magnet-build.
Name
name
Type
string
Description
Název úkolu zadaný při jeho vytvoření. Prázdný řetězec, pokud nebyl zadán žádný název.
Name
status
Type
string
Description
Stav úkolu. Možné hodnoty jsou PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Postup úkolu. Pokud úkol ještě nezačal, tato vlastnost bude 0. Jakmile úkol uspěje, stane se 100.
Name
created_at
Type
timestamp
Description
Časové razítko, kdy byl úkol vytvořen, v milisekundách.
Name
started_at
Type
timestamp
Description
Časové razítko, kdy byl úkol zahájen, v milisekundách.
Name
finished_at
Type
timestamp
Description
Časové razítko, kdy byl úkol dokončen, v milisekundách.
Name
expires_at
Type
timestamp
Description
Časové razítko, kdy výsledek úkolu vyprší, v milisekundách.
Name
preceding_tasks
Type
integer
Description
Počet předcházejících úkolů. Má smysl pouze, když je stav PENDING.
Name
task_error
Type
object
Description
Podrobnosti o chybě pro neúspěšné úkoly. Viz Chyby pro úplnou referenci objektu task_error.
Name
consumed_credits
Type
integer
Description
Počet kreditů spotřebovaných tímto úkolem. Vrací 0 pro úkoly FAILED (kredity jsou při selhání vráceny).
Name
model_urls
Type
object
Description
Stahovatelné URL pro vygenerovaný artefakt, klíčované podle názvu artefaktu. Vždy obsahuje přesně jednu položku — formát požadovaný prostřednictvím output.format žádosti o stavbu. Klíč odpovídá požadovanému formátu:
Name
glb
Type
string
Description
Stahovatelná URL na GLB soubor. Přítomno, když output.format byl glb (výchozí).
Name
obj
Type
string
Description
Stahovatelná URL na zip balíček obsahující model.obj, model.mtl a texture.png. Přítomno, když output.format byl obj.
Name
bundle_zip
Type
string
Description
Stahovatelná URL na zip balíček všech artefaktů, které generátor vydává. Přítomno, když output.format byl zip.
Příklad objektu úkolu pro stavbu magnetu na lednici