Více obrázků na 3D API je funkce, která umožňuje integrovat schopnosti Více obrázků na 3D od Meshy do vaší vlastní aplikace. V této sekci najdete všechny informace,
které potřebujete pro začátek s tímto API.
Tento koncový bod umožňuje vytvořit novou úlohu Více obrázků na 3D. Odkazujte se na
Objekt úlohy Více obrázků na 3D, abyste viděli, které
vlastnosti jsou zahrnuty v objektu úlohy Více obrázků na 3D.
Parametry
Pouze jedno z input_task_id nebo image_urls je povinné. Pokud jsou poskytnuta obě, input_task_id má přednost.
Name
input_task_id
Type
string
Povinné
Description
ID dokončené úlohy generování obrázků, 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 s více pohledy nebo Obrázek na obrázek s více pohledy. 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 vytváření modelu. V současnosti podporujeme formáty .jpg, .jpeg a .png. Pro co nejlepší výsledky by všechny obrázky měly zobrazovat stejný objekt z různých úhlů.
Existují dva způsoby, jak poskytnout každý obrázek:
Veřejně dostupná URL: URL, která je přístupná z veřejného internetu.
Data URI: Data URI obrázku zakódovaná pomocí base64. Příklad data URI: data:image/jpeg;base64,<your base64-encoded image data>.
U meshy-7 (nebo latest) se první obrázek použije jako hlavní (přední) pohled. Na pořadí zbývajících obrázků nezáleží.
Name
ai_model
Type
string
výchozí latest
Description
ID modelu k použití. Dostupné hodnoty: meshy-5, meshy-6, meshy-7, latest (Meshy 7).
Name
should_texture
Type
boolean
výchozí true
Description
Určuje, zda jsou generovány textury. Nastavení na false přeskočí fázi texturování a poskytne síť bez textur.
Platí pouze když should_texture = true
Name
enable_pbr
Type
boolean
výchozí false
Description
Generuje PBR mapy (metalická, drsnost, normála) navíc k základní barvě. Emisní mapa je zahrnuta také tehdy, když je ai_modelmeshy-6, s výjimkou texture_resolution: 8k. meshy-7 a latest emisní mapu neprodukují.
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 detailů povrchu.
4k a 8k vyžadují ai_modelmeshy-6, meshy-7 nebo latest. Při 8k není produkována žádná emisní mapa.
Name
hd_texture
Type
boolean
⚠ zastaralé
výchozí false
Description
Použijte místo toho texture_resolution — ekvivalent texture_resolution: "4k". Když jsou nastaveny obě, texture_resolution má přednost.
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í. V současnosti podporujeme formáty .jpg, .jpeg a .png.
Existují dva způsoby, jak obrázek poskytnout:
Veřejně dostupná URL: URL, která je přístupná z veřejného internetu
Data URI: Data URI obrázku zakódovaná pomocí 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 jeden z parametrů texture_image_url nebo texture_prompt. Pokud jsou poskytnuty oba parametry, bude pro texturování modelu ve výchozím nastavení použit texture_prompt.
Name
should_remesh
Type
boolean
výchozí false (meshy-6), true (others)
Description
Určuje, zda povolit fázi remesh. Pro model nejvyšší kvality doporučujeme nastavit should_remesh na false.
Specifikujte 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ší podle úrovně uživatele:
100 až 300 000 (včetně)
Name
decimation_mode
Type
integer
Description
Povolí adaptivní decimaci nastavením úrovně polycount. Když je nastaveno, target_polycount je ignorováno.
Dostupné hodnoty:
1: Adaptivní — ultra polycount.
2: Adaptivní — vysoký polycount.
3: Adaptivní — střední polycount.
4: Adaptivní — nízký polycount.
Name
save_pre_remeshed_model
Type
boolean
výchozí false
Description
Pokud je nastaveno na true, Meshy rovněž uloží další GLB soubor 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 aplikuje symetrii na základě vstupní geometrie.
on: Vynutí symetrii během generování.
Name
pose_mode
Type
string
výchozí ""
Description
Specifikujte režim pózy pro generovaný model.
Dostupné hodnoty:
a-pose: Generovat model v A póze.
t-pose: Generovat model v T póze.
"" (prázdný řetězec): Není použita žádná specifická póza.
Name
is_a_t_pose
Type
boolean
⚠ zastaralé
výchozí false
Description
Použijte místo toho pose_mode. Zda generovat 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, aby se zachoval přesný vzhled vstupních obrázků bez jakéhokoliv zpracování stylu.
Podporováno pouze, když je ai_modelmeshy-6, meshy-7 nebo latest.
Name
remove_lighting
Type
boolean
výchozí true
Description
Odstraní odlesky a stíny z textury základní barvy, čímž produkuje čistší výsledek, který lépe funguje s vlastním nastavením osvětlení.
Podporováno pouze, když 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 bude škodlivý obsah detekován, úloha nepokročí do generování.
Prověřen bude každý obrázek z image_urls a text z texture_prompt.
Name
target_formats
Type
string[]
Description
Specifikuje, které 3D formáty souborů zahrnout do výstupu. Budou generovány a vráceny pouze vyžádané formáty, což může zkrátit dobu dokončení úlohy.
Dostupné hodnoty: glb, obj, fbx, stl, usdz, 3mf
Když je parametr vynechán, generují se všechny formáty kromě 3mf. 3mf je zahrnut pouze při explicitním specifikování.
Name
auto_size
Type
boolean
výchozí false
Description
Pokud je nastaveno na true, služba použije AI vidění pro automatický odhad skutečné výšky objektu a odpovídající změnu velikosti modelu. Počátek bude ve výchozím nastavení bottom, pokud není origin_at explicitně nastaveno.
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á nezměněno.
Name
multi_view_thumbnails
Type
boolean
výchozí false
Description
Pokud je nastaveno na true, úloha navíc vykreslí čtyři miniatury hlavních pohledů (přední, pravý, zadní, levý) a vrátí je pod thumbnail_urls v odpovědi GET. Stávající pole thumbnail_url je nezměněno a nadále odkazuje na přední pohled, takže stávající klienti nejsou ovlivněni.
Přidává 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 při povoleném auto_size. Dostupné hodnoty: bottom, center.
Návraty
Vlastnost result v odpovědi obsahuje ID id nově vytvořené úlohy Více obrázků na 3D.
Režimy selhání
Name
400 - Bad Request
Description
Žádost byla neakceptovatelná. Běžné příčiny:
Chybějící parametr: Musí být poskytnut 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 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 není v podporovaném formátu.
Nedosažitelná URL: Jednu nebo více image_urls nebylo možné stáhnout.
Name
401 - Unauthorized
Description
Autentizace selhala. Zkontrolujte prosím váš API klíč.
Name
402 - Payment Required
Description
Nedostatečné kredity k provedení této úlohy.
Name
429 - Too Many Requests
Description
Překročili jste svůj limit rychlosti.
Žádost
POST
/openapi/v1/multi-image-to-3d
# Jednoduchá žádostcurlhttps://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>" ] }'# S PBR texturováním a formátem GLBcurlhttps://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 umožňuje získat úlohu Více obrázků na 3D na základě platného ID úlohy id.
Odkazujte se na Objekt úlohy Více obrázků na 3D, abyste viděli, které
vlastnosti jsou zahrnuty v objektu úlohy Více obrázků na 3D.
Parametry
Name
id
Type
path
Description
Unikátní identifikátor úlohy Více obrázků na 3D, kterou chcete získat.
Objekt úlohy Více obrázků na 3D je pracovní jednotka, kterou Meshy sleduje, aby vygeneroval 3D model z více obrázků (od 1 do 4 včetně). Obrázky by měly zachycovat stejný objekt, ideálně z různých pohledů nebo úhlů.
Objekt má následující vlastnosti:
Vlastnosti
Name
id
Type
string
Description
Unikátní identifikátor úlohy. Přestože jako implementační detail používáme pro ID úloh k-seřaditelný UUID,
neměli byste činit žádné předpoklady o formátu tohoto 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
Stáhnutelná URL k texturovanému souboru 3D modelu vygenerovanému Meshy. Vlastnost pro daný formát bude vynechána, pokud formát nebyl vygenerován, místo vrácení prázdného řetězce.
Name
glb
Type
string
Description
Stáhnutelná URL k GLB souboru.
Name
fbx
Type
string
Description
Stáhnutelná URL k FBX souboru.
Name
obj
Type
string
Description
Stáhnutelná URL k OBJ souboru.
Name
usdz
Type
string
Description
Stáhnutelná URL k USDZ souboru.
Name
mtl
Type
string
Description
Stáhnutelná URL k MTL souboru, vrácena spolu s OBJ exporty, když jsou přítomny textury.
Name
stl
Type
string
Description
Stáhnutelná URL k STL souboru.
Name
3mf
Type
string
Description
Stáhnutelná URL k 3MF souboru. Přítomno pouze, když byl 3mf vyžádán prostřednictvím target_formats.
Name
pre_remeshed_glb
Type
string
Description
Stáhnutelná URL k původnímu GLB výstupu před remeshingem.
Dostupné pouze, když byla úloha vytvořena s should_remesh: true i save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Stáhnutelná URL k náhledovému obrázku souboru modelu. Odpovídá thumbnail_urls.front, pokud je přítomno, zachováno pro zpětnou kompatibilitu.
Name
alpha_thumbnail_url
Type
string
Description
Stáhnutelná URL k verzi thumbnail_url s průhledným pozadím (RGBA). Přítomno pouze, 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
Stáhnutelné URL pro čtyři miniatury hlavních pohledů vygenerovaného 3D modelu. Každá hodnota je podepsaná URL k PNG o velikosti 512×512, vykreslenému 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 pipeline bez stahování GLB.
Přítomno pouze, když byla úloha vytvořena s multi_view_thumbnails: true a dosáhla stavu SUCCEEDED. Starší úlohy a úlohy vytvořené bez tohoto přihlášení toto pole neobsahují.
Name
front
Type
string
Description
Přední pohled, rotace 0° kolem vertikální osy (shoduje se s 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 pro vedení procesu texturování.
Name
progress
Type
integer
Description
Průběh úlohy. Pokud úloha ještě nezačala, tato vlastnost bude 0. Jakmile úloha uspěje, změní se na 100.
Name
started_at
Type
timestamp
Description
Časové razítko, kdy úloha začala, v milisekundách. Pokud úloha ještě nezačala, 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. Toto platí
pro všechna časová razítka v Meshy API.
Name
created_at
Type
timestamp
Description
Časové razítko, kdy byla úloha vytvořena, v milisekundách.
Name
expires_at
Type
timestamp
Description
Časové razítko, kdy vyprší výsledek úlohy, v milisekundách.
Name
finished_at
Type
timestamp
Description
Časové razítko, kdy úloha skončila, v milisekundách. Pokud úloha ještě neskončila, tato vlastnost bude 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 textur, které jsou vygenerovány úlohou. Obvykle obsahuje pouze jeden objekt URL textury. Každá URL textury má následující vlastnosti:
Name
base_color
Type
string
Description
Stáhnutelná URL k obrázku mapy základní barvy.
Name
metallic
Type
string
Description
Stáhnutelná URL k obrázku metalické mapy.
Pokud je úloha vytvořena s enable_pbr: false, tato vlastnost bude vynechána.
Name
normal
Type
string
Description
Stáhnutelná URL k obrázku mapy normál.
Pokud je úloha vytvořena s enable_pbr: false, tato vlastnost bude vynechána.
Name
roughness
Type
string
Description
Stáhnutelná URL k obrázku mapy drsnosti.
Pokud je úloha vytvořena s enable_pbr: false, tato vlastnost bude vynechána.
Name
emission
Type
string
Description
Stáhnutelná URL k 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 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 najdete v sekci 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. Vrátí 0 pro úlohy FAILED (kredity jsou při selhání vráceny).