Obrázek na 3D API

Obrázek na 3D API je funkce, která vám umožňuje integrovat schopnosti Obrázku na 3D od Meshy do vaší vlastní aplikace. V této části najdete veškeré informace potřebné k zahájení práce s tímto API.

POST/openapi/v1/image-to-3d

Vytvořit úkol Obrázek na 3D

Tento koncový bod vám umožňuje vytvořit nový úkol Obrázek na 3D. Odkazujte na Objekt Úkolu Obrázek na 3D pro zobrazení, které vlastnosti jsou zahrnuty v objektu úkolu Obrázek na 3D.

Parametry

Je vyžadován pouze jeden z input_task_id nebo image_url. Pokud jsou poskytnuty oba, prioritu má input_task_id.

Name
input_task_id
Type
string
Povinné
Description
ID dokončeného úkolu pro generování obrázku, jehož výstup by měl být použit jako vstupní obrázek. Tento úkol musí být jedním z následujících úkolů: Text na obrázek nebo Obrázek na obrázek. Navíc musí být spuštěn prostřednictvím API, mít stav SUCCEEDED a produkovat přesně jeden obrázek.

Name
image_url
Type
string
Povinné
Description
Poskytněte obrázek pro použití v modelové tvorbě Meshy. V současné době podporujeme formáty .jpg, .jpeg, a .png.
Existují dva způsoby, jak poskytnout obrázek:
- Veřejně přístupná URL adresa: URL, která je dostupná z veřejného internetu.
- Data URI: Data URI kódovaná jako base64 obrázku. Příklad Data URI: data:image/jpeg;base64,<váš base64-kódovaný obrázkový údaj>.

Name
model_type
Type
string
výchozí standard
Description
Určete typ generování 3D sítě.
Dostupné hodnoty:
- standard: Běžné vysokodetailní generování 3D sítě.
- smart-topology: Vyberte model Smart Topology pomocí ai_model (meshy-t1 nebo meshy-t2).
- lowpoly (zastaralé): Generuje low-poly síť optimalizovanou pro čistší polygony. Doporučujeme používat smart-topology.
Když je zvolena smart-topology, topology, should_remesh, a save_pre_remeshed_model jsou ignorovány.
Když je zvolena lowpoly, ai_model, topology, target_polycount, should_remesh, a save_pre_remeshed_model jsou ignorovány.
Name
ai_model
Type
string
výchozí latest
Description
ID modelu k použití. Dostupné hodnoty závisí na model_type.
Standardní generování (model_type: standard):
- meshy-5, meshy-6, meshy-7, latest (Meshy 7)
Generování Smart Topology (model_type: smart-topology):
- meshy-t2 (výchozí, doporučené): model Smart Topology — čistší topology, nativně oddělené části, výstupní trojúhelníky, a počet ploch může být nastaven s target_polycount.
- meshy-t1: starý low-poly model; nepodporuje nastavení počtu ploch pomocí target_polycount.
Name
ultra_mode
Type
boolean
výchozí false
Description
Umožňuje generování Ultra pro geometrii s vyšší věrností a jemnějšími detaily povrchu.
Podporováno pouze, když ai_model je meshy-7 (nebo latest).
Name
should_texture
Type
boolean
výchozí true
Description
Určuje, zda jsou generovány textury. Nastavení na false přeskočí fázi texturace, poskytuje síť bez textur.

Platí pouze když should_texture = true

Name
enable_pbr
Type
boolean
výchozí false
Description
Generujte PBR mapy (metallic, roughness, normal) navíc k základní barvě. Mapa vyzařování je také zahrnuta, když ai_model je meshy-6, s výjimkou texture_resolution: 8k. meshy-7 a latest mapu vyzařování nevytvářejí.
Name
texture_resolution
Type
string
výchozí 2k
Description
Rozlišení barevné textury. Jedno z 2k (2048×2048), 4k (4096×4096), nebo 8k (8192×8192). Vyšší rozlišení zaznamenávají více detailů povrchu.
4k a 8k nejsou dostupné pro ai_model: meshy-5. Při 8k, není produkována mapa vyzařování.
Name
hd_texture
Type
boolean
⚠ zastaralé
výchozí false
Description
Použijte texture_resolution místo toho — ekvivalentní s texture_resolution: "4k". Když jsou nastaveny obě, texture_resolution má prioritu.
Name
texture_prompt
Type
string
Description
Poskytněte textový prompt pro vedení procesu textování. Maximálně 600 znaků.
Name
texture_image_url
Type
string
Description
Poskytněte 2D obrázek pro vedení procesu texturace. V současné době podporujeme formáty .jpg, .jpeg, a .png.
Existují dva způsoby, jak poskytnout obrázek:
- Veřejně přístupná URL adresa: URL, která je dostupná z veřejného internetu.
- Data URI: Data URI kódovaná jako base64 obrázku. Příklad Data URI: data:image/jpeg;base64,<váš base64-kódovaný obrázkový údaj>.
Texturace obrázku nemusí fungovat optimálně, pokud existují podstatné rozdíly v geometrie mezi originálním assetem a nahraným obrázkem. Může být použita pouze jedna z texture_image_url nebo texture_prompt ke vedení procesu texturace. Pokud jsou poskytnuty oba parametry, bude ve výchozím nastavení použito texture_prompt k texturaci modelu. Texturování prostřednictvím textu nebo obrázku bude stát 10 kreditů na úkol.

Name
should_remesh
Type
boolean
výchozí false (meshy-6, meshy-7), true (others)
Description
Řídí, zda povolit fázi remesh. Pro nejkvalitnější model doporučujeme nastavit should_remesh na false.

Platí pouze když should_remesh = true

Name
topology
Type
string
výchozí triangle
Description
Určete topology generovaného modelu.
Dostupné hodnoty:
- quad: Vygenerujte síť dominantní v kvadratických prvcích.
- triangle: Vygenerujte síť s trojúhelníkovými prvky.
Name
decimation_mode
Type
integer
Description
Povolit adaptivní dekimate nastavením úrovně polycountu. 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
Když je nastaveno na true, Meshy také uloží další GLB soubor před dokončením fáze remesh.

Name
target_polycount
Type
integer
Description
Cílový počet polygonů (ploch) ve výstupu. Skutečný počet se může lišit od cíle v závislosti na geometrii.
target_polycount má účinek ve dvou nezávislých případech:
- Remesh — s should_remesh: true na standard modelu. Síť se přemění (sníží) na přibližně tuto hodnotu. Rozsah 100 až 300,000, výchozí 30,000. Pokud je nastaven decimation_mode, má prioritu a target_polycount je ignorováno.
- Smart Topology — s model_type: smart-topology a ai_model: meshy-t2. Model je generován přímo s tímto počtem ploch; remesh se nespouští a should_remesh není požadováno. Rozsah 100 až 15,000, výchozí 4,000.

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: Deaktivuje 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 režim pózy pro generovaný model.
Dostupné hodnoty:
- a-pose: Vygenerujte model v A póze.
- t-pose: Vygenerujte model v T póze.
- "" (prázdný řetězec): Žádná specifická póza aplikována.
Name
is_a_t_pose
Type
boolean
⚠ zastaralé
výchozí false
Description
Použijte pose_mode místo toho. Zda generovat model v A/T póze.
Name
image_enhancement
Type
boolean
výchozí true
Description
Optimalizuje vstupní obrázek pro lepší výsledky. Nastavte na false, abyste zachovali přesný vzhled vstupního obrázku bez jakéhokoli zpracování stylu.
Podporováno pouze, když ai_model je meshy-6, meshy-7, nebo latest.
Name
remove_lighting
Type
boolean
výchozí true
Description
Odstraní zvýraznění a stíny ze základní barvy textury, čímž poskytne čistší výsledek, který lépe funguje pod vlastními nastaveními osvětlení.
Podporováno pouze, když ai_model je meshy-6.
Name
moderation
Type
boolean
výchozí false
Description
Když je nastaveno na true, vstupní obsah bude automaticky prohledán na potencionálně škodlivý obsah. Pokud je škodlivý obsah detekován, úloha nebude pokračovat k generování.
Obsah ze vstupů image_url, texture_image_url, a texture_prompt bude prohledán.
Name
target_formats
Type
string[]
Description
Určuje, které 3D souborové formáty budou zahrnuty ve výstupu. Budou generovány a vráceny pouze požadované formáty, což může zkrátit čas dokončení úkolu. Když je vynecháno, jsou zahrnuty všechny podporované formáty.
Dostupné hodnoty: glb, obj, fbx, stl, usdz, 3mf
Když je vynecháno, jsou generovány všechny formáty kromě 3mf. 3mf je zahrnut pouze, když je výslovně specifikován.
Name
auto_size
Type
boolean
výchozí false
Description
Když je nastaveno na true, služba používá AI vidění k automatickému odhadu skutečné výšky objektu a odpovídajícímu přizpůsobení modelu. Počátek bude výchozí bottom, pokud není origin_at explicitně nastaveno.
Name
alpha_thumbnail
Type
boolean
výchozí false
Description
Když je nastaveno na true, úkol 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 je nezměněné.
Name
multi_view_thumbnails
Type
boolean
výchozí false
Description
Když je nastaveno na true, úkol navíc vyrenderuje čtyři miniatury pohledu kardinálních úhlů (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ěné a stále ukazuje na přední pohled, takže stávající klienti nejsou ovlivněni.
Přidává přibližně 3 sekundy k latenci úkolu.

Platí pouze když auto_size = true

Name
origin_at
Type
string
výchozí bottom
Description
Poloha počátku, když je auto_size povoleno.
Dostupné hodnoty: bottom, center.

Vrátí

Vlastnost result v odpovědi obsahuje ID úkolu nově vytvořeného úkolu Obrázek na 3D.

Módy selhání

Name
400 - Bad Request
Description
Požadavek byl nepřijatelný. Běžné příčiny:
- Chybějící parametr: Musí být poskytnuto buď image_url nebo input_task_id.
- Neplatný vstupní úkol: input_task_id musí odkazovat na úspěšný Text na obrázek nebo Obrázek na obrázek úkol, který produkuje přesně jeden obrázek.
- Neplatný formát obrázku: Poskytnutý image_url není podporovaný formát (.jpg, .jpeg, .png).
- E-mail nahrání URL: image_url nelze stáhnout (404 nebo timeout).
- Neplatný Data URI: Řetězec base64 je nesprávně vytvořený.
- Neplatná kombinace parametrů: enable_pbr je podporován pouze, když je should_texture pravdivé.
Name
401 - Unauthorized
Description
Autentizace selhala. Prosím zkontrolujte váš API klíč.
Name
402 - Payment Required
Description
Nedostatečné kredity k vykonání tohoto úkolu.
Name
429 - Too Many Requests
Description
Překročili jste limit rychlosti.

Požadavek

POST

/openapi/v1/image-to-3d

# Jednoduchý požadavek s vyžadovanými parametry
curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_url": "<vaše veřejně přístupná URL obrázku nebo base64-kódovaný Data URI>"
  }'

# S remesh, PBR, a A-póze
curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_url": "<vaše veřejně přístupná URL obrázku nebo base64-kódovaný Data URI>",
    "enable_pbr": true,
    "should_remesh": true,
    "target_polycount": 100000,
    "should_texture": true,
    "pose_mode": "a-pose",
    "target_formats": ["glb"]
  }'

Odpověď

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

GET/openapi/v1/image-to-3d/:id

Získat úkol Obrázek na 3D

Tento koncový bod vám umožňuje získat úkol Obrázek na 3D s platným id úkolu. Odkazujte na Objekt Úkolu Obrázek na 3D, abyste zjistili, které vlastnosti jsou zahrnuty v objektu úkolu Obrázek na 3D.

Parametry

Name
id
Type
path
Description
Jedinečný identifikátor pro získaný úkol Obrázek na 3D.

Vrátí

Odpověď obsahuje objekt úlohy Obrázek na 3D. Podívejte se na sekci Objekt Úkolu Obrázek na 3D pro podrobnosti.

Požadavek

GET

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Odpověď

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {
    "message": ""
  },
  "consumed_credits": 30
}

DELETE/openapi/v1/image-to-3d/:id

Smazat úkol Obrázek na 3D

Tento koncový bod trvale smaže úkol Obrázek na 3D, včetně všech souvisejících modelů a dat. Tato akce je nevratná.

Parametry cesty

Name
id
Type
path
Description
ID úkolu Obrázek na 3D ke smazání.

Vrátí

Vrátí 200 OK při úspěchu.

Požadavek

DELETE

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Odpověď

// Vrátí 200 Ok při úspěchu.

GET/openapi/v1/image-to-3d

Seznam úkolů Obrázek na 3D

Tento koncový bod vám umožňuje získat seznam úkolů Obrázek na 3D.

Parametry

Volitelné atributy

Name
page_num
Type
integer
Description
Číslo stránky pro stránkování. Začíná a výchozí na 1.
Name
page_size
Type
integer
Description
Limit velikosti stránky. Výchozí hodnota je 10 položek. Maximální povolený je 50 položek.
Name
sort_by
Type
string
Description
Pole, podle kterého se třídí. Dostupné hodnoty:
- +created_at: Třídění podle času vytvoření ve vzestupném pořadí.
- -created_at: Třídění podle času vytvoření v sestupném pořadí.

Vrátí

Vrátí stránkovaný seznam Objektů Úkolu Obrázek na 3D.

Požadavek

GET

/openapi/v1/image-to-3d

curl https://api.meshy.ai/openapi/v1/image-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Odpověď

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "image-to-3d",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
      "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "thumbnail_urls": {
      "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
      "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
      "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
      "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
    },
    "texture_prompt": "",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "expires_at": 1692771679037,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
        "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
        "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
        "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
        "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {
      "message": ""
    },
    "consumed_credits": 30
  }
]

GET/openapi/v1/image-to-3d/:id/stream

Streamovat úkol Obrázek na 3D

Tento koncový bod streamuje aktualizace v reálném čase pro úkol Obrázek na 3D pomocí Server-Sent Events (SSE).

Parametry

Name
id
Type
path
Description
Jedinečný identifikátor pro streamovaný úkol Obrázek na 3D.

Vrátí

Vrátí stream Objektů Úkolu Obrázek na 3D jako Server-Sent Events.

Pro úkoly PENDING nebo IN_PROGRESS bude streamovaná odpověď obsahovat pouze nezbytná pole progress a status.

Požadavek

GET

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Příklad události Error
event: error
data: {
  "status_code": 404,
  "message": "Úkol nebyl nalezen"
}

// Příklady událostí Message ilustrují pokrok úkolu.
// Pro úkoly PENDING nebo IN_PROGRESS nebude streamovaná odpověď obsahovat všechna pole.
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "model_urls": {
  "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
  "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
  "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
  "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
  "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
  "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {
    "message": ""
  },
  "consumed_credits": 30
}

Objekt Úkolu Obrázek na 3D

Objekt Úkolu Obrázek na 3D je pracovní jednotka, kterou Meshy sleduje, aby vygenerovala 3D model ze vstupu obrázku. Objekt má následující vlastnosti:

Vlastnosti

Name
id
Type
string
Description
Jedinečný identifikátor úkolu. I když používáme kzorovatelné UUID pro id úkolů jako implementační detail, neměli byste dělat žádné předpoklady o formátu id.
Name
type
Type
string
Description
Typ úkolu Obrázek na 3D. Hodnota je image-to-3d.
Name
model_urls
Type
object
Description
Stahovatelná URL adresa texturovaného 3D modelového souboru generovaného Meshy. Vlastnost pro formát bude vynechána, pokud nebude formát vygenerován, místo vrácení prázdného řetězce.
- Name
  glb
  Type
  string
  Description
  Stahovatelná URL adresa souboru GLB.
- Name
  fbx
  Type
  string
  Description
  Stahovatelná URL adresa souboru FBX.
- Name
  obj
  Type
  string
  Description
  Stahovatelná URL adresa souboru OBJ.
- Name
  usdz
  Type
  string
  Description
  Stahovatelná URL adresa souboru USDZ.
- Name
  mtl
  Type
  string
  Description
  Stahovatelná URL adresa souboru MTL, vrácena společně s exporty OBJ, když jsou přítomny textury.
- Name
  stl
  Type
  string
  Description
  Stahovatelná URL adresa souboru STL.
- Name
  3mf
  Type
  string
  Description
  Stahovatelná URL adresa souboru 3MF. Pouze přítomno, když byl 3mf požadován pomocí target_formats.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  Stahovatelná URL adresa originálního GLB výstupu před remeshem.
  Dostupné pouze, když byl úkol vytvořen s oběma should_remesh: true a save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Stahovatelná URL adresa náhledového obrázku modelového souboru. Ekvivalentní s thumbnail_urls.front když přítomno, zachováno pro zpětnou kompatibilitu.
Name
alpha_thumbnail_url
Type
string
Description
Stahovatelná URL adresa verze thumbnail_url s průhledným pozadím (RGBA). Přítomno pouze, když byl úkol vytvořen s alpha_thumbnail: true a průhledný náhled byl úspěšně vyrendrován; jinak je toto pole vynecháno.
Name
thumbnail_urls
Type
object
Description
Stahovatelné URL adresy pro čtyři miniatury pohledu kardinálních úhlů generovaného 3D modelu. Každá hodnota je podepsaná URL adresa 512×512 PNG vyrendrovaná 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 potrubích bez stahování GLB.
Přítomny pouze, když byl úkol vytvořen s multi_view_thumbnails: true a dosáhl SUCCEEDED. Starší úkoly a úkoly vytvořené bez možnosti opt-in nezahrnou toto pole.
- Name
  front
  Type
  string
  Description
  Pohled zepředu, rotace 0° kolem svislé osy (shodná s thumbnail_url).
- Name
  right
  Type
  string
  Description
  Pohled zprava, rotace 90°.
- Name
  back
  Type
  string
  Description
  Pohled zezadu, rotace 180°.
- Name
  left
  Type
  string
  Description
  Pohled zleva, rotace 270°.
Name
texture_prompt
Type
string
Description
Textový prompt, který byl použit k vedení procesu texturace.
Name
texture_image_url
Type
string
Description
Stahovatelná URL adresa textury obrázku, která byla použita k vedení procesu texturace.
Name
ultra_mode
Type
boolean
Description
Odráží hodnotu ultra_mode, se kterou byl úkol vytvořen. Přítomno pouze pro úkoly meshy-7 (nebo latest), které explicitně nastavily ultra_mode; jinak vynecháno.
Name
progress
Type
integer
Description
Postup úkolu. Pokud úkol dosud nezačal, tato vlastnost bude 0. Jakmile úkol uspěje, stane se 100.
Name
started_at
Type
timestamp
Description
Časové razítko, kdy byl úkol spuštěn, v milisekundách. Pokud úkol dosud nezačal, tato vlastnost bude 0.
Časové razítko představuje počet uplynulých milisekund od 1. ledna 1970 UTC, v souladu se standardem RFC 3339. Například pátek 1. září 2023 12:00:00 PM 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, kdy byl úkol vytvořen, v milisekundách.
Name
expires_at
Type
timestamp
Description
Časové razítko, kdy výsledek úkolu vyprší, v milisekundách.
Name
finished_at
Type
timestamp
Description
Časové razítko, kdy byl úkol dokončen, v milisekundách. Pokud úkol není dokončen, bude tato vlastnost 0.
Name
status
Type
string
Description
Stav úkolu. Možné hodnoty jsou jedním z PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Pole objektů URL textur, které jsou generovány z úkolu. Obvykle obsahuje pouze jeden objekt URL textury. Každý objekt URL textury má následující vlastnosti:
- Name
  base_color
  Type
  string
  Description
  Stahovatelná URL adresa obrázku základní barvy mapy.
- Name
  metallic
  Type
  string
  Description
  Stahovatelná URL adresa obrázku metalické mapy.
  Pokud je úkol vytvořen s enable_pbr: false, tato vlastnost bude vynechána.
- Name
  normal
  Type
  string
  Description
  Stahovatelná URL adresa obrázku normálové mapy.
  Pokud je úkol vytvořen s enable_pbr: false, tato vlastnost bude vynechána.
- Name
  roughness
  Type
  string
  Description
  Stahovatelná URL adresa obrázku mapy drsnosti.
  Pokud je úkol vytvořen s enable_pbr: false, tato vlastnost bude vynechána.
- Name
  emission
  Type
  string
  Description
  Stahovatelná URL adresa obrázku vyzařovací mapy.
  Pokud je úkol vytvořen s enable_pbr: false, nebo ai_model je meshy-5, meshy-7, nebo latest, tato vlastnost bude vynechána.
Name
preceding_tasks
Type
integer
Description
Počet předcházejících úkolů.
Hodnota tohoto pole má smysl pouze, pokud je stav úkolu PENDING.
Name
task_error
Type
object
Description
Podrobnosti chyb pro neúspěšné úkoly. Viz Chyby pro úplný referenční objekt task_error.
Name
consumed_credits
Type
integer
Description
Počet kreditů spotřebovaných tímto úkolem. Přítomno, když je stav úkolu PENDING, IN_PROGRESS, nebo SUCCEEDED. Vrací 0 pro úkoly FAILED (kredity jsou při selhání vráceny).

Příklad Objektu Úkolu Obrázek na 3D

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "texture_image_url": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {
    "message": ""
  },
  "consumed_credits": 30
}