API Více obrázků na 3D je funkce, která vám umožňuje integrovat schopnosti Meshy pro Více obrázků na 3D do vaší vlastní aplikace. V této sekci najdete všechny informace, které potřebujete k zahájení práce s tímto API.
Tento koncový bod umožňuje vytvořit novou úlohu typu Více obrázků na 3D. Podrobnosti o vlastnostech, které
objekt úlohy Více obrázků na 3D obsahuje, najdete v části
Objekt úlohy Více obrázků na 3D.
Parametry
Je vyžadován pouze jeden z parametrů input_task_id nebo image_urls. Pokud jsou zadány oba, má přednost input_task_id.
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: 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ů. Kromě toho musí 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 adresa přístupná z veřejného internetu.
Data URI: Obrázek zakódovaný ve formátu base64 jako data URI. Příklad data URI: data:image/jpeg;base64,<vaše obrázková data zakódovaná v base64>.
U meshy-7 (nebo latest) je první obrázek použit jako primární (přední) pohled. Pořadí zbývajících obrázků není důležité.
Name
ai_model
Type
string
výchozí latest
Description
ID modelu, který se má použít. Dostupné hodnoty: meshy-5, meshy-6, meshy-7, latest (Meshy 7).
Name
ultra_mode
Type
boolean
výchozí false
Description
Aktivuje generování v režimu Ultra pro vyšší věrnost geometrie s jemnějším detailem povrchu.
Podporováno pouze pokud je ai_model nastaven na meshy-7 (nebo latest).
Name
should_texture
Type
boolean
výchozí true
Description
Určuje, zda se mají generovat textury. Nastavením na false se přeskočí fáze texturování a získáte síť bez textur.
Platí pouze když should_texture = true
Name
enable_pbr
Type
boolean
výchozí false
Description
Kromě základní barvy vygeneruje i PBR mapy (metalickou, drsnosti, normálovou). Emisní mapa je zahrnuta také v případě, že ai_model je meshy-6, kromě případu texture_resolution: 8k. meshy-7 a latest emisní mapu nevytvářejí.
Name
texture_resolution
Type
string
výchozí 2k
Description
Rozlišení textury základní barvy. Jedna z hodnot 2k (2048×2048), 4k (4096×4096) nebo 8k (8192×8192). Vyšší rozlišení zachytí více povrchových detailů.
4k a 8k vyžadují ai_modelmeshy-6, meshy-7 nebo latest. Při 8k se emisní mapa nevytváří.
Name
hd_texture
Type
boolean
⚠ zastaralé
výchozí false
Description
Místo toho použijte texture_resolution — odpovídá hodnotě texture_resolution: "4k". Pokud jsou nastaveny oba parametry, má přednost texture_resolution.
Name
texture_prompt
Type
string
Description
Zadejte textový prompt, který má nasměrovat proces texturování. Maximálně 800 znaků.
Name
texture_image_url
Type
string
Description
Poskytněte 2D obrázek, který má nasměrovat proces 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 adresa přístupná z veřejného internetu
Data URI: Obrázek zakódovaný ve formátu base64 jako data URI. Příklad data URI: data:image/jpeg;base64,<vaše obrázková data zakódovaná v base64>
Texturování podle obrázku nemusí fungovat optimálně, pokud existují výrazné rozdíly v geometrii mezi původním assetem a nahraným obrázkem. K nasměrování procesu texturování lze použít pouze jeden z parametrů texture_image_url nebo texture_prompt. Pokud jsou zadány oba, model bude standardně texturován pomocí texture_prompt.
Name
texture_image_urls
Type
string[]
Description
Poskytněte 1 až 4 obrázky zobrazující stejný objekt z různých pohledů, které nasměrují texturování. První obrázek je primární (přední) pohled; pořadí zbývajících pohledů (levý, zadní, pravý) není důležité.
Každý prvek přijímá stejné formáty jako texture_image_url (veřejně přístupná URL nebo base64 data URI, .jpg/.jpeg/.png).
Tyto obrázky nasměrují pouze texturu a jsou nezávislé na image_urls — oba seznamy mohou obsahovat odlišné obrázky i odlišný počet obrázků.
Vyžaduje ai_modelmeshy-7 nebo latest. Nelze kombinovat s texture_image_url ani texture_prompt.
Name
should_remesh
Type
boolean
výchozí false (meshy-6), true (others)
Description
Určuje, zda se má aktivovat fáze remesh. Pro model nejvyšší kvality doporučujeme nastavit should_remesh na false.
Platí pouze když should_remesh = true
Name
topology
Type
string
výchozí triangle
Description
Určete topology vygenerovaného modelu.
Dostupné hodnoty:
quad: Vygeneruje síť tvořenou převážně čtyřúhelníky.
Určete cílový počet polygonů ve vygenerované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ší podle úrovně uživatele:
100 až 300 000 (včetně)
Name
decimation_mode
Type
integer
Description
Aktivuje adaptivní decimaci nastavením úrovně počtu polygonů. Pokud je nastaveno, 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
Pokud je nastaveno na true, Meshy navíc 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: Zakáže symetrii.
auto: Automaticky určí a použije symetrii na základě vstupní geometrie.
on: Vynutí symetrii během generování.
Name
pose_mode
Type
string
výchozí ""
Description
Určete režim pózy vygenerovaného modelu.
Dostupné hodnoty:
a-pose: Vygeneruje model v póze A.
t-pose: Vygeneruje model v póze T.
"" (prázdný řetězec): Není použita žádná konkrétní póza.
Name
is_a_t_pose
Type
boolean
⚠ zastaralé
výchozí false
Description
Místo toho použijte pose_mode. Zda se má model vygenerovat v póze A/T.
Name
image_enhancement
Type
boolean
výchozí true
Description
Optimalizuje vstupní obrázky pro lepší výsledky. Nastavením na false zachováte přesný vzhled vstupních obrázků bez jakéhokoli stylového zpracování.
Podporováno pouze pokud je ai_modelmeshy-6, meshy-7 nebo latest.
Name
remove_lighting
Type
boolean
výchozí true
Description
Odstraní zvýraznění a stíny ze základní barevné textury, čímž vznikne čistší výsledek, který lépe funguje s vlastním nastavením osvětlení.
Podporováno pouze pokud je ai_modelmeshy-6, meshy-7 nebo latest.
Name
moderation
Type
boolean
výchozí false
Description
Pokud je nastaveno na true, vstupní obsah bude automaticky prověřen na potenciálně škodlivý obsah. Pokud je škodlivý obsah zjištěn, úloha nepokračuje do fáze generování.
Prověřen bude každý obrázek z image_urls a text z texture_prompt.
Name
target_formats
Type
string[]
Description
Určuje, které formáty 3D souborů mají být zahrnuty ve 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 parametr vynecháte, vygenerují se všechny formáty kromě 3mf. 3mf je zahrnut pouze v případě, že je výslovně zadán.
Name
auto_size
Type
boolean
výchozí false
Description
Pokud je nastaveno na true, služba pomocí AI vision automaticky odhadne skutečnou výšku objektu v reálném světě a odpovídajícím způsobem změní velikost modelu. Počátek bude standardně nastaven na bottom, pokud není výslovně nastaven origin_at.
Name
alpha_thumbnail
Type
boolean
výchozí false
Description
Pokud je nastaveno na true, úloha navíc vykreslí 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
Pokud je nastaveno na true, úloha navíc vykreslí čtyři náhledy hlavních pohledů (přední, pravý, zadní, levý) a vrátí je v poli thumbnail_urls v odpovědi GET. Stávající pole thumbnail_url zůstává beze změny a nadále odkazuje na přední pohled, takže stávající klienty to nijak neovlivní.
Prodlouží latenci úlohy přibližně o 3 sekundy.
Platí pouze když auto_size = true
Name
origin_at
Type
string
výchozí bottom
Description
Poloha počátku, pokud je aktivováno auto_size. Dostupné hodnoty: bottom, center.
Návratová hodnota
Vlastnost result v odpovědi obsahuje id úlohy nově vytvořené úlohy Více obrázků na 3D.
Způsoby selhání
Name
400 - Bad Request
Description
Požadavek byl nepřijatelný. Běžné příčiny:
Chybějící parametr: Musí být zadán buď image_urls, nebo input_task_id.
Neplatná vstupní úloha: input_task_id musí odkazovat na úlohu se stavem SUCCEEDED typu Text na obrázek, Obrázek na obrázek nebo variantu Více pohledů.
Neplatný počet obrázků: image_urls musí obsahovat 1 až 4 obrázky a texture_image_urls 1 až 4 obrázky.
Neplatný formát obrázku: Jeden nebo více obrázků v image_urls má nepodporovaný formát.
Konfliktní texturové vstupy: texture_image_urls nelze kombinovat s texture_image_url ani texture_prompt a vyžaduje should_texture: true.
Nepodporovaný model pro texturu z více pohledů: texture_image_urls vyžaduje ai_modelmeshy-7 nebo latest.
Nedostupná URL: Jeden nebo více prvků image_urls nebo texture_image_urls nebylo možné stáhnout.
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
429 - Too Many Requests
Description
Překročili jste svůj limit rychlosti.
Request
POST
/openapi/v1/multi-image-to-3d
# Simple requestcurlhttps://api.meshy.ai/openapi/v1/multi-image-to-3d \-XPOST \-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 formatcurlhttps://api.meshy.ai/openapi/v1/multi-image-to-3d \-XPOST \-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 s platným id úlohy.
Podívejte se na Objekt úlohy Více obrázků na 3D, abyste zjistili, které
vlastnosti jsou zahrnuty v objektu úlohy Více obrázků na 3D.
Parametry
Name
id
Type
path
Description
Jedinečný identifikátor pro úlohu 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 vygenerování 3D modelu z více obrázků (v rozmezí 1 až 4 včetně). Obrázky by měly zobrazovat stejný objekt, 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. Ačkoli jako implementační detail používáme pro id úloh k-sortovatelné UUID, neměli byste dělat žá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
Stažitelná URL adresa na soubor s texturovaným 3D modelem vygenerovaným Meshy. Vlastnost pro daný formát bude vynechána, pokud daný formát nebyl vygenerován, namísto vrácení prázdného řetězce.
Name
glb
Type
string
Description
Stažitelná URL adresa na soubor GLB.
Name
fbx
Type
string
Description
Stažitelná URL adresa na soubor FBX.
Name
obj
Type
string
Description
Stažitelná URL adresa na soubor OBJ.
Name
usdz
Type
string
Description
Stažitelná URL adresa na soubor USDZ.
Name
mtl
Type
string
Description
Stažitelná URL adresa na soubor MTL, vrácená spolu s exporty OBJ, pokud jsou přítomny textury.
Name
stl
Type
string
Description
Stažitelná URL adresa na soubor STL.
Name
3mf
Type
string
Description
Stažitelná URL adresa na soubor 3MF. Přítomna pouze tehdy, když byl formát 3mf vyžádán prostřednictvím target_formats.
Name
pre_remeshed_glb
Type
string
Description
Stažitelná URL adresa na původní výstup GLB před reměšováním.
K dispozici pouze v případě, že byla úloha vytvořena s parametry should_remesh: true i save_pre_remeshed_model: true zároveň.
Name
thumbnail_url
Type
string
Description
Stažitelná URL adresa na miniaturu souboru modelu. Odpovídá hodnotě thumbnail_urls.front, pokud je přítomna; zachováno kvůli zpětné kompatibilitě.
Name
alpha_thumbnail_url
Type
string
Description
Stažitelná URL adresa na verzi thumbnail_url s průhledným pozadím (RGBA). Přítomna pouze tehdy, když byla úloha vytvořena s alpha_thumbnail: true a průhledný náhled se podařilo úspěšně vykreslit; jinak je toto pole vynecháno.
Name
thumbnail_urls
Type
object
Description
Stažitelné URL adresy pro čtyři miniatury generovaného 3D modelu ze základních světových stran. Každá hodnota je podepsaná URL adresa 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 zpracováních bez nutnosti stahovat GLB.
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 tohoto volitelného nastavení toto pole obsahovat nebudou.
Name
front
Type
string
Description
Pohled zepředu, rotace o 0° kolem svislé osy (odpovídá thumbnail_url).
Name
right
Type
string
Description
Pohled zprava, rotace o 90°.
Name
back
Type
string
Description
Pohled zezadu, rotace o 180°.
Name
left
Type
string
Description
Pohled zleva, rotace o 270°.
Name
texture_prompt
Type
string
Description
Textový prompt, který byl použit k řízení procesu texturování.
Name
texture_image_urls
Type
string[]
Description
Stažitelné URL adresy na referenční obrázky textur, které byly použity k vytvoření úlohy, v pořadí, v jakém byly poskytnuty. Přítomny pouze tehdy, když byla úloha vytvořena s texture_image_urls.
Name
ultra_mode
Type
boolean
Description
Odráží hodnotu ultra_mode, se kterou byla úloha vytvořena. Přítomno pouze u úloh meshy-7 (nebo latest), které explicitně nastavily ultra_mode; jinak vynecháno.
Name
progress
Type
integer
Description
Průběh úlohy. Pokud úloha ještě nebyla zahájena, tato vlastnost bude mít hodnotu 0. Jakmile úloha uspěje, hodnota se změní na 100.
Name
started_at
Type
timestamp
Description
Časové razítko okamžiku, kdy byla úloha zahájena, v milisekundách. Pokud úloha ještě nebyla zahájena, tato vlastnost bude mít hodnotu 0.
Časové razítko představuje počet milisekund, které uplynuly 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 mít hodnotu 0.
Name
status
Type
string
Description
Stav úlohy. Možné hodnoty jsou PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Pole objektů URL adres textur vygenerovaných z úlohy. Běžně obsahuje pouze jeden objekt URL adresy textury. Každá URL adresa textury má následující vlastnosti:
Name
base_color
Type
string
Description
Stažitelná URL adresa na obrázek mapy základní barvy.
Name
metallic
Type
string
Description
Stažitelná URL adresa na obrázek metalické mapy.
Pokud je úloha vytvořena s enable_pbr: false, tato vlastnost bude vynechána.
Name
normal
Type
string
Description
Stažitelná URL adresa na obrázek normálové mapy.
Pokud je úloha vytvořena s enable_pbr: false, tato vlastnost bude vynechána.
Name
roughness
Type
string
Description
Stažitelná URL adresa na obrázek mapy drsnosti.
Pokud je úloha vytvořena s enable_pbr: false, tato vlastnost bude vynechána.
Name
emission
Type
string
Description
Stažitelná URL adresa na obrázek emisní mapy.
Pokud je úloha vytvořena s enable_pbr: false, nebo pokud je ai_model roven meshy-5, tato vlastnost bude vynechána.
Name
preceding_tasks
Type
integer
Description
Počet předcházejících úloh.
Hodnota tohoto pole má smysl pouze tehdy, pokud je stav úlohy PENDING.
Name
task_error
Type
object
Description
Podrobnosti o chybě u neúspěšných úloh. Úplný popis objektu task_error naleznete v části Chyby.
Name
consumed_credits
Type
integer
Description
Počet kreditů spotřebovaných touto úlohou. Přítomno, pokud je stav úlohy PENDING, IN_PROGRESS nebo SUCCEEDED. U úloh se stavem FAILED vrací 0 (kredity jsou při selhání vráceny).