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 vlastní aplikace. V této části najdete všechny informace,
které potřebujete k tomu, abyste s tímto API mohli začít.
Tento koncový bod umožňuje vytvořit novou úlohu Více obrázků na 3D. Podrobnosti o
tom, které vlastnosti objekt úlohy Více obrázků na 3D obsahuje, naleznete 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 uvedeny oba, má přednost input_task_id.
Name
input_task_id
Type
string
Povinné
Description
ID dokončené úlohy generování obrázků, jejíž výstup (1–4 obrázky) by měl 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í byla spuštěna přes API a musí mít stav SUCCEEDED.
Name
image_urls
Type
array
Povinné
Description
Poskytněte 1 až 4 obrázky, které má Meshy použít při vytváření 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ě dostupná URL adresa: URL adresa dostupná z veřejného internetu.
Data URI: obrázek kódovaný ve formátu base64 jako Data URI. Příklad Data URI: data:image/jpeg;base64,<vaše data obrázku kódovaná v base64>.
U modelu meshy-7.1 (nebo latest) je první obrázek použit jako primární (přední) pohled. Pořadí zbývajících obrázků nehraje roli.
meshy-7 (zastaralé): použijte místo něj meshy-7.1.
Name
geometry_resolution
Type
string
výchozí standard
Description
Průchod generování geometrie. 2k spustí Ultra průchod v rozlišení 2048³. Vyžaduje meshy-7.1 nebo latest.
Dostupné hodnoty: standard, 2k
Name
ultra_mode
Type
boolean
⚠ zastaralé
výchozí false
Description
Použijte místo toho geometry_resolution. ultra_mode: true je ekvivalentem geometry_resolution: "2k".
Name
should_texture
Type
boolean
výchozí true
Description
Určuje, zda se generují textury. Pokud je nastaveno na false, fáze texturování se vynechá a výsledkem je 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 zahrnuta také v případě, že ai_model je meshy-6, s výjimkou texture_resolution: 8k. Modely meshy-6-lite, meshy-7.1 a latest emisní mapu nevytváří.
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.1 nebo latest. Při 8k se emisní mapa nevytváří.
Name
hd_texture
Type
boolean
⚠ zastaralé
výchozí false
Description
Použijte místo toho texture_resolution — ekvivalent texture_resolution: "4k". Pokud jsou nastaveny oba parametry, má přednost texture_resolution.
Name
texture_prompt
Type
string
Description
Zadejte textový prompt, který má vést proces texturování. Maximálně 800 znaků.
Name
texture_image_url
Type
string
Description
Poskytněte 2D obrázek, který má vést proces texturování. Aktuálně podporujeme formáty .jpg, .jpeg a .png.
Obrázek lze poskytnout dvěma způsoby:
Veřejně dostupná URL adresa: URL adresa dostupná z veřejného internetu
Data URI: obrázek kódovaný ve formátu base64 jako Data URI. Příklad Data URI: data:image/jpeg;base64,<vaše data obrázku kódovaná v base64>
Texturování podle obrázku nemusí funguje optimálně, pokud existují výrazné 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 zadány oba parametry, model se ve výchozím nastavení textovuje 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é povedou texturování. První obrázek je primární (přední) pohled; pořadí zbývajících pohledů (levý, zadní, pravý) nehraje roli.
Každý prvek přijímá stejné formáty jako texture_image_url (veřejně dostupnou URL adresu nebo base64 Data URI, .jpg/.jpeg/.png).
Tyto obrázky vedou pouze texturu a jsou nezávislé na image_urls — oba seznamy mohou obsahovat odlišné obrázky a odlišný počet obrázků.
Vyžaduje ai_modelmeshy-7.1 nebo latest. Nelze kombinovat s texture_image_url nebo texture_prompt.
Name
should_remesh
Type
boolean
výchozí false (Meshy 6 and Meshy 7 models), true (others)
Description
Určuje, zda se má aktivovat fáze remesh. Pro nejvyšší kvalitu modelu doporučujeme nastavit should_remesh na false.
Určuje cílový počet polygonů ve vygenerovaném modelu. Skutečný počet polygonů se může od cílové hodnoty 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í redukci nastavením úrovně počtu polygonů. Pokud je tento parametr nastaven, target_polycount se ignoruje.
Dostupné hodnoty:
1: Adaptivní — ultra vysoký 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ží extra 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 použije symetrii na základě vstupní geometrie.
on: vynutí symetrii během generování.
Name
pose_mode
Type
string
výchozí ""
Description
Určuje pose mode pro vygenerovaný model.
Dostupné hodnoty:
a-pose: vygeneruje model v póze A.
t-pose: vygeneruje model v póze T.
"" (prázdný řetězec): nebude použita žádná konkrétní póza.
Name
is_a_t_pose
Type
boolean
⚠ zastaralé
výchozí false
Description
Použijte místo toho pose_mode. Zda vygenerovat model v póze A/T.
Name
image_enhancement
Type
boolean
výchozí true
Description
Optimalizuje vstupní obrázky pro lepší výsledky. Nastavte na false, pokud chcete zachovat přesný vzhled vstupních obrázků bez jakéhokoli stylového zpracování.
Podporováno pouze v případě, že ai_model je meshy-6, meshy-7.1 nebo latest.
Name
remove_lighting
Type
boolean
výchozí true
Description
Odstraní odlesky a stíny ze základní barevné textury, čímž vznikne čistší výsledek, který lépe funguje při vlastním nastavení osvětlení.
Podporováno pouze v případě, že ai_model je meshy-6, meshy-7.1 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 zjištěn škodlivý obsah, úloha nebude pokračovat 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ů se mají 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 tento parametr není uveden, vygenerují se všechny formáty kromě 3mf. Formát 3mf je zahrnut pouze tehdy, je-li explicitně zadán.
Name
auto_size
Type
boolean
výchozí false
Description
Pokud je nastaveno na true, služba použije AI vidění k automatickému odhadu reálné výšky objektu a odpovídajícím způsobem změní velikost modelu. Počátek bude standardně bottom, pokud není explicitně nastaven parametr origin_at.
Name
alpha_thumbnail
Type
boolean
výchozí false
Description
Pokud je nastaveno na true, úloha navíc vykreslí verzi náhledu s transparentním pozadím (RGBA) a vrátí ji jako alpha_thumbnail_url v odpovědi GET. Stávající pole thumbnail_url se nezmění.
Name
multi_view_thumbnails
Type
boolean
výchozí false
Description
Pokud je nastaveno na true, úloha navíc vykreslí čtyři kardinální náhledy (přední, pravý, zadní, levý) a vrátí je v poli thumbnail_urls v odpovědi GET. Stávající pole thumbnail_url se nezmění a nadále odkazuje na přední pohled, takže stávající klienty to 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
Pozice počátku, pokud je aktivováno auto_size. Dostupné hodnoty: bottom, center.
Návratové hodnoty
Vlastnost result v 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 uveden 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 Více pohledů se stavem SUCCEEDED.
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í vstupy textury: texture_image_urls nelze kombinovat s texture_image_url nebo texture_prompt a vyžaduje should_texture: true.
Nepodporovaný model pro texturu s více pohledy: texture_image_urls vyžaduje ai_modelmeshy-7.1 nebo latest.
Nedostupná URL adresa: jeden nebo více prvků image_urls nebo texture_image_urls se nepodařilo stáhnout.
Nepodporované rozlišení pro vstup s více obrázky: geometry_resolution: "4k" není na tomto koncovém bodu k dispozici; použijte 2k nebo standard.
Name
401 - Unauthorized
Description
Autentizace se nezdařila. Zkontrolujte 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 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 Ultra 2K geometry, 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>" ], "ai_model": "meshy-7.1", "geometry_resolution": "2k", "should_texture": true, "enable_pbr": true, "target_formats": ["glb"] }'
Tento koncový bod umožňuje získat úlohu Více obrázků na 3D podle platného id úlohy.
Podrobnosti o tom, jaké vlastnosti jsou součástí objektu úlohy Více obrázků na 3D, naleznete
v části Objekt ú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 získat.
Tento koncový bod trvale smaže úlohu Více obrázků na 3D, včetně všech souvisejících modelů a dat. Tato akce je nevratná.
Parametry cesty
Name
id
Type
path
Description
ID úlohy Více obrázků na 3D, 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ž ve stavu IN_PROGRESS, nelze smazat: požadavek je
odmítnut s chybou 409 Conflict a úloha pokračuje v běhu. Kredity za úlohu,
kterou už worker začal zpracovávat, nejsou vratné, takže by vás smazání
uprostřed běhu stálo jak kredity, tak výsledek. Počkejte, až úloha dosáhne
stavu SUCCEEDED, FAILED nebo CANCELED, a teprve poté ji smažte.
Úloha ve finálním stavu (SUCCEEDED, FAILED nebo CANCELED) je smazána
bez vrácení kreditů.
Návratová hodnota
Vrací 200 OK při úspěchu, nebo 409 Conflict, pokud je úloha ve stavu
IN_PROGRESS.
// 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."}
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 počtu od 1 do 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. I když pro id úlohy jako implementační detail používáme k-sortable 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
Stahovatelná URL adresa na texturovaný soubor 3D modelu vygenerovaný Meshy. Vlastnost pro daný formát bude vynechána, pokud tento formát nebyl vygenerován, místo vrácení prázdného řetězce.
Name
glb
Type
string
Description
Stahovatelná URL adresa na soubor GLB.
Name
fbx
Type
string
Description
Stahovatelná URL adresa na soubor FBX.
Name
obj
Type
string
Description
Stahovatelná URL adresa na soubor OBJ.
Name
usdz
Type
string
Description
Stahovatelná URL adresa na soubor USDZ.
Name
mtl
Type
string
Description
Stahovatelná URL adresa na soubor MTL, vracená spolu s exporty OBJ, pokud jsou přítomny textury.
Name
stl
Type
string
Description
Stahovatelná URL adresa na soubor STL.
Name
3mf
Type
string
Description
Stahovatelná URL adresa na soubor 3MF. Přítomna pouze tehdy, když byl formát 3mf požadován prostřednictvím target_formats.
Name
pre_remeshed_glb
Type
string
Description
Stahovatelná URL adresa na původní výstup GLB před remeshováním.
Dostupné pouze tehdy, když byla úloha vytvořena s parametry should_remesh: true i save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Stahovatelná URL adresa na miniaturu souboru modelu. Ekvivalent thumbnail_urls.front, pokud je přítomna, ponecháno pro zpětnou kompatibilitu.
Name
alpha_thumbnail_url
Type
string
Description
Stahovatelná 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 byl úspěšně vykreslen; jinak je toto pole vynecháno.
Name
thumbnail_urls
Type
object
Description
Stahovatelné URL adresy pro čtyři miniatury vygenerovaného 3D modelu ze čtyř základních úhlů pohledu. Každá hodnota je podepsaná URL adresa na obrázek PNG o rozměrech 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 pipeline 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 zapnutí toto pole nebudou obsahovat.
Name
front
Type
string
Description
Pohled zepředu, natočení o 0° kolem svislé osy (shoduje se s thumbnail_url).
Name
right
Type
string
Description
Pohled z pravé strany, natočení o 90°.
Name
back
Type
string
Description
Pohled ze zadu, natočení o 180°.
Name
left
Type
string
Description
Pohled z levé strany, natočení o 270°.
Name
texture_prompt
Type
string
Description
Textový prompt, který byl použit k vedení procesu texturování.
Name
texture_image_urls
Type
string[]
Description
Stahovatelné URL adresy na referenční obrázky textur, které byly použity k vytvoření úlohy, v pořadí, ve kterém byly poskytnuty. Přítomno pouze tehdy, když byla úloha vytvořena s texture_image_urls.
Name
ultra_mode
Type
boolean
⚠ zastaralé
Description
Zastaralé; namísto toho čtěte geometry_resolution.
Name
geometry_resolution
Type
string
Description
Úroveň Ultra, ve které úloha běžela (2k); u standard je vynechána.
Name
progress
Type
integer
Description
Průběh úlohy. Pokud úloha ještě nebyla zahájena, bude tato vlastnost 0. Jakmile úloha uspěje, tato 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, bude tato vlastnost 0.
Časové razítko představuje počet milisekund, které uplynuly od 1. ledna 1970 UTC, v souladu se
standardem RFC 3339.
Například pátek 1. září 2023 12:00:00 GMT je vyjádřen 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ší výsledek ú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ě nebyla dokončena, bude tato vlastnost 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 vygenerovaných z úlohy. Obvykle obsahuje pouze jeden objekt URL textury. Každá URL textury má následující vlastnosti:
Name
base_color
Type
string
Description
Stahovatelná URL adresa na obrázek mapy základní barvy.
Name
metallic
Type
string
Description
Stahovatelná URL adresa na obrázek mapy metalických vlastností.
Pokud je úloha vytvořena s enable_pbr: false, bude tato vlastnost vynechána.
Name
normal
Type
string
Description
Stahovatelná URL adresa na obrázek normálové mapy.
Pokud je úloha vytvořena s enable_pbr: false, bude tato vlastnost vynechána.
Name
roughness
Type
string
Description
Stahovatelná URL adresa na obrázek mapy drsnosti.
Pokud je úloha vytvořena s enable_pbr: false, bude tato vlastnost vynechána.
Name
emission
Type
string
Description
Stahovatelná URL adresa na obrázek mapy emisí.
Pokud je úloha vytvořena s enable_pbr: false, nebo pokud je ai_model roven meshy-6-lite, bude tato vlastnost vynechána.
Name
preceding_tasks
Type
integer
Description
Počet předcházejících úloh.
Hodnota tohoto pole má smysl pouze tehdy, když je stav úlohy PENDING.
Name
task_error
Type
object
Description
Podrobnosti o chybě pro neúspěšné úlohy. Úplnou referenci 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 v případě neúspěchu vráceny).