API Více obrázků na 3D je funkce, která vám umožňuje integrovat možnosti Meshy pro Více obrázků na 3D do vaší vlastní aplikace. V této sekci najdete všechny informace,
které potřebujete, abyste mohli s tímto API začít.
Tento koncový bod umožňuje vytvořit novou úlohu Více obrázků na 3D. Viz
Objekt úlohy Více obrázků na 3D, kde najdete,
které vlastnosti jsou zahrnuty v objektu úlohy Více obrázků na 3D.
Parametry
Vyžadováno je pouze jedno z input_task_id nebo image_urls. Pokud jsou zadány obě, input_task_id má prioritu.
Name
input_task_id
Type
string
Povinné
Description
ID dokončené úlohy generování obrázku, jejíž výstup (1–4 obrázky) má být použit jako vstup. Tato úloha musí být jednou z následujících úloh: Text na obrázek, Obrázek na obrázek, Text na obrázek Více pohledů nebo Obrázek na obrázek Více pohledů. Navíc musela být spuštěna přes API a mít stav SUCCEEDED.
Name
image_urls
Type
array
Povinné
Description
Poskytněte 1 až 4 obrázky, které Meshy použije při tvorbě modelu. Aktuálně podporujeme formáty .jpg, .jpeg a .png. Pro nejlepší výsledky by všechny obrázky měly zobrazovat stejný objekt z různých úhlů.
Každý obrázek lze poskytnout dvěma způsoby:
Veřejně přístupná URL: URL, která je přístupná z veřejného internetu.
Data URI: Data URI obrázku zakódované v base64. Příklad Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
ai_model
Type
string
výchozí latest
Description
ID modelu, který se má použít. Dostupné hodnoty: meshy-5, meshy-6, latest (Meshy 6).
Name
should_texture
Type
boolean
výchozí true
Description
Určuje, zda se generují textury. Nastavení na false přeskočí fázi textury a poskytne síť bez textur.
Platí pouze když should_texture = true
Name
enable_pbr
Type
boolean
výchozí false
Description
Vygeneruje PBR mapy (metallic, roughness, normal) navíc k základní barvě. Emisní mapa je také zahrnuta, když je ai_modelmeshy-6 nebo latest.
Name
hd_texture
Type
boolean
výchozí false
Description
Vygeneruje texturu základní barvy v rozlišení 4K (4096×4096) pro vyšší detail.
Podporováno pouze, když je ai_modelmeshy-6 nebo latest. PBR mapy se vždy generují ve 2K.
Name
texture_prompt
Type
string
Description
Poskytněte textový prompt pro vedení procesu texturování. Maximálně 600 znaků.
Name
texture_image_url
Type
string
Description
Poskytněte 2D obrázek pro vedení procesu texturování. Aktuálně podporujeme formáty .jpg, .jpeg a .png.
Obrázek lze poskytnout dvěma způsoby:
Veřejně přístupná URL: URL, která je přístupná z veřejného internetu
Data URI: Data URI obrázku zakódované v base64. Příklad Data URI: data:image/jpeg;base64,<your base64-encoded image data>
Texturování podle obrázku nemusí fungovat optimálně, pokud existují podstatné rozdíly v geometrii mezi původním assetem a nahraným obrázkem. K vedení procesu texturování lze použít pouze jedno z texture_image_url nebo texture_prompt. Pokud jsou zadány oba parametry, k texturování modelu se ve výchozím nastavení použije texture_prompt.
Name
should_remesh
Type
boolean
výchozí false (meshy-6), true (others)
Description
Řídí, zda povolit fázi Remesh. Při nastavení na false API vrátí trojúhelníkovou síť s nejvyšší přesností.
Určete cílový počet polygonů v generovaném modelu. Skutečný počet polygonů se může od cíle lišit v závislosti na složitosti geometrie.
Platný rozsah hodnot se liší v závislosti na úrovni uživatele:
100 až 300 000 (včetně)
Name
decimation_mode
Type
integer
Description
Povolte adaptivní decimaci nastavením úrovně počtu polygonů. Pokud je nastavena, target_polycount se ignoruje.
Dostupné hodnoty:
1: Adaptivní — ultra počet polygonů.
2: Adaptivní — vysoký počet polygonů.
3: Adaptivní — střední počet polygonů.
4: Adaptivní — nízký počet polygonů.
Name
save_pre_remeshed_model
Type
boolean
výchozí false
Description
Při nastavení na true Meshy také uloží dodatečný soubor GLB před dokončením fáze Remesh.
Name
symmetry_mode
Type
string
⚠ zastaralé
výchozí auto
Description
Zastaralé. Tento parametr již neovlivňuje výstup.
Pole symmetry_mode řídí chování symetrie během procesu generování modelu.
Platné hodnoty jsou:
off: Vypne symetrii.
auto: Automaticky určí a aplikuje symetrii na základě vstupní geometrie.
on: Vynutí symetrii během generování.
Name
pose_mode
Type
string
výchozí ""
Description
Určete pose_mode pro generovaný model.
Dostupné hodnoty:
a-pose: Vygeneruje model v A póze.
t-pose: Vygeneruje model v T póze.
"" (prázdný řetězec): Není aplikována žádná konkrétní póza.
Name
is_a_t_pose
Type
boolean
⚠ zastaralé
výchozí false
Description
Použijte místo toho pose_mode. Určuje, zda vygenerovat model v A/T póze.
Name
image_enhancement
Type
boolean
výchozí true
Description
Optimalizuje vstupní obrázky pro lepší výsledky. Nastavte na false, chcete-li zachovat přesný vzhled vstupních obrázků bez jakéhokoli stylového zpracování.
Podporováno pouze, když je ai_modelmeshy-6 nebo latest.
Name
remove_lighting
Type
boolean
výchozí true
Description
Odstraní zvýraznění a stíny z textury základní barvy, čímž vytvoří čistší výsledek, který lépe funguje ve vlastních nastaveních osvětlení.
Podporováno pouze, když je ai_modelmeshy-6 nebo latest.
Name
moderation
Type
boolean
výchozí false
Description
Při nastavení na true bude vstupní obsah automaticky zkontrolován na potenciálně škodlivý obsah. Pokud je zjištěn škodlivý obsah, úloha nebude pokračovat ke generování.
Každý obrázek z image_urls a text z texture_prompt budou zkontrolovány.
Name
target_formats
Type
string[]
Description
Určuje, které formáty 3D souborů zahrnout do výstupu. Vygenerovány a vráceny budou pouze požadované formáty, což může zkrátit dobu dokončení úlohy.
Dostupné hodnoty: glb, obj, fbx, stl, usdz, 3mf
Pokud je vynecháno, vygenerují se všechny formáty kromě 3mf. 3mf je zahrnut pouze tehdy, když je explicitně určen.
Name
auto_size
Type
boolean
výchozí false
Description
Při nastavení na true služba použije AI vidění k automatickému odhadu skutečné výšky objektu a podle toho změní velikost modelu. Počátek bude ve výchozím nastavení bottom, pokud není explicitně nastaveno origin_at.
Name
alpha_thumbnail
Type
boolean
výchozí false
Description
Při nastavení na true úloha navíc vyrenderuje verzi náhledu s průhledným pozadím (RGBA) a vrátí ji jako alpha_thumbnail_url v odpovědi GET. Stávající pole thumbnail_url zůstává beze změny.
Name
multi_view_thumbnails
Type
boolean
výchozí false
Description
Při nastavení na true úloha navíc vyrenderuje čtyři náhledy z hlavních pohledů (zepředu, zprava, zezadu, zleva) a vrátí je pod thumbnail_urls v odpovědi GET. Stávající pole thumbnail_url zůstává beze změny a nadále ukazuje na přední pohled, takže stávající klienti nejsou ovlivněni.
Přidá přibližně 3 sekundy k latenci úlohy.
Platí pouze když auto_size = true
Name
origin_at
Type
string
výchozí bottom
Description
Poloha počátku, když je povoleno auto_size. Dostupné hodnoty: bottom, center.
Vrací
Vlastnost result odpovědi obsahuje id úlohy nově vytvořené úlohy Více obrázků na 3D.
Režimy selhání
Name
400 - Bad Request
Description
Požadavek byl nepřijatelný. Běžné příčiny:
Chybějící parametr: Musí být zadáno buď image_urls, nebo input_task_id.
Neplatná vstupní úloha: input_task_id musí odkazovat na úlohu Text na obrázek, Obrázek na obrázek nebo variantu úlohy s více pohledy se stavem SUCCEEDED.
Neplatný počet obrázků: image_urls musí obsahovat 1 až 4 obrázky.
Neplatný formát obrázku: Jeden nebo více obrázků v image_urls nejsou podporované formáty.
Nedostupná URL: Jednu nebo více image_urls se nepodařilo stáhnout.
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
429 - Too Many Requests
Description
Překročili jste svůj limit rychlosti.
Request
POST
/openapi/v1/multi-image-to-3d
# Simple requestcurl https://api.meshy.ai/openapi/v1/multi-image-to-3d \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "image_urls": [ "<your publicly accessible image url or base64-encoded data URI>", "<your second publicly accessible image url or base64-encoded data URI>" ] }'# With PBR texturing and GLB formatcurl https://api.meshy.ai/openapi/v1/multi-image-to-3d \ -X POST \ -H "Authorization: Bearer ${YOUR_API_KEY}" \ -H 'Content-Type: application/json' \ -d '{ "image_urls": [ "<your publicly accessible image url or base64-encoded data URI>", "<your second publicly accessible image url or base64-encoded data URI>" ], "should_texture": true, "enable_pbr": true, "target_formats": ["glb"] }'
Tento koncový bod vám umožňuje načíst úlohu Více obrázků na 3D podle platného id úlohy.
Podívejte se na Objekt úlohy Více obrázků na 3D, kde zjistíte, které
vlastnosti jsou zahrnuty v objektu úlohy Více obrázků na 3D.
Parametry
Name
id
Type
path
Description
Jedinečný identifikátor úlohy Více obrázků na 3D, kterou chcete načíst.
Objekt úlohy Více obrázků na 3D je pracovní jednotka, kterou Meshy sleduje za účelem generování 3D modelu z více obrázků (včetně 1 až 4). Obrázky by měly být stejného objektu, ideálně z různých pohledů nebo úhlů.
Objekt má následující vlastnosti:
Vlastnosti
Name
id
Type
string
Description
Jedinečný identifikátor úlohy. Přestože jako implementační detail používáme pro ID úloh
k-sortovatelný UUID, neměli byste si vytvářet žádné předpoklady o formátu ID.
Name
type
Type
string
Description
Typ úlohy Více obrázků na 3D. Hodnota je multi-image-to-3d.
Name
model_urls
Type
object
Description
URL ke stažení souboru 3D modelu s texturou vygenerovaného službou Meshy. Vlastnost pro formát bude vynechána, pokud formát není vygenerován, místo aby se vracel prázdný řetězec.
Name
glb
Type
string
Description
URL ke stažení souboru GLB.
Name
fbx
Type
string
Description
URL ke stažení souboru FBX.
Name
obj
Type
string
Description
URL ke stažení souboru OBJ.
Name
usdz
Type
string
Description
URL ke stažení souboru USDZ.
Name
mtl
Type
string
Description
URL ke stažení souboru MTL, vrácená společně s exporty OBJ, když jsou přítomny textury.
Name
stl
Type
string
Description
URL ke stažení souboru STL.
Name
3mf
Type
string
Description
URL ke stažení souboru 3MF. Je přítomna pouze tehdy, když bylo 3mf vyžádáno prostřednictvím target_formats.
Name
pre_remeshed_glb
Type
string
Description
URL ke stažení původního výstupu GLB před remesh.
Dostupné pouze tehdy, když byla úloha vytvořena s should_remesh: true i save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
URL ke stažení obrázku miniatury souboru modelu. Odpovídá thumbnail_urls.front, když je přítomno, zachováno kvůli zpětné kompatibilitě.
Name
alpha_thumbnail_url
Type
string
Description
URL ke stažení verze thumbnail_url s průhledným pozadím (RGBA). Je přítomna pouze tehdy, když byla úloha vytvořena s alpha_thumbnail: true a průhledný náhled byl úspěšně vykreslen; jinak je toto pole vynecháno.
Name
thumbnail_urls
Type
object
Description
URL ke stažení čtyř miniatur v základních pohledech vygenerovaného 3D modelu. Každá hodnota je podepsaná URL na PNG 512×512 vykreslené se stejnými materiály a osvětlením jako thumbnail_url. Užitečné pro náhled modelu z více úhlů v dávkových pipelines bez stahování GLB.
Je přítomno pouze tehdy, když byla úloha vytvořena s multi_view_thumbnails: true a dosáhla stavu SUCCEEDED. Starší úlohy a úlohy vytvořené bez výslovného zapnutí toto pole nebudou obsahovat.
Name
front
Type
string
Description
Přední pohled, rotace 0° kolem svislé osy (odpovídá thumbnail_url).
Name
right
Type
string
Description
Pravý pohled, rotace 90°.
Name
back
Type
string
Description
Zadní pohled, rotace 180°.
Name
left
Type
string
Description
Levý pohled, rotace 270°.
Name
texture_prompt
Type
string
Description
Textový prompt, který byl použit k vedení procesu texturování.
Name
progress
Type
integer
Description
Progress úlohy. Pokud úloha ještě nebyla spuštěna, tato vlastnost bude 0. Jakmile úloha úspěšně skončí, stane se z ní 100.
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, tato vlastnost bude 0.
Č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
created_at
Type
timestamp
Description
Časové razítko okamžiku, kdy byla úloha vytvořena, v milisekundách.
Name
expires_at
Type
timestamp
Description
Časové razítko okamžiku, kdy vyprší platnost výsledku úlohy, v milisekundách.
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, tato vlastnost bude 0.
Name
status
Type
string
Description
Stav úlohy. Možné hodnoty jsou jedna z PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Pole objektů URL textur, které jsou vygenerovány z úlohy. Obvykle obsahuje pouze jeden objekt URL textury. Každá URL textury má následující vlastnosti:
Name
base_color
Type
string
Description
URL ke stažení obrázku mapy základní barvy.
Name
metallic
Type
string
Description
URL ke stažení obrázku mapy kovovosti.
Pokud je úloha vytvořena s enable_pbr: false, tato vlastnost bude vynechána.
Name
normal
Type
string
Description
URL ke stažení obrázku normálové mapy.
Pokud je úloha vytvořena s enable_pbr: false, tato vlastnost bude vynechána.
Name
roughness
Type
string
Description
URL ke stažení obrázku mapy drsnosti.
Pokud je úloha vytvořena s enable_pbr: false, tato vlastnost bude vynechána.
Name
emission
Type
string
Description
URL ke stažení obrázku emisní mapy.
Pokud je úloha vytvořena s enable_pbr: false, nebo je ai_modelmeshy-5, tato vlastnost bude vynechána.
Name
preceding_tasks
Type
integer
Description
Počet předcházejících úloh.
Hodnota tohoto pole je smysluplná pouze tehdy, pokud je stav úlohy PENDING.
Name
task_error
Type
object
Description
Podrobnosti chyby pro neúspěšné úlohy. Úplnou referenci objektu task_error najdete v části Chyby.
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. Pro úlohy FAILED vrací 0 (kredity jsou při selhání vráceny).