API Obrázek na 3D

API Obrázek na 3D je funkce, která vám umožňuje integrovat možnosti Meshy pro Obrázek na 3D do vaší vlastní aplikace. V této části najdete všechny informace, které potřebujete, abyste mohli s tímto API začít.

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

Vytvořit úlohu Obrázek na 3D

Tento koncový bod vám umožňuje vytvořit novou úlohu Obrázek na 3D. Viz Objekt úlohy Obrázek na 3D, kde najdete, které vlastnosti jsou zahrnuty v objektu úlohy Obrázek na 3D.

Parametry

Vyžadován je pouze jeden z input_task_id nebo image_url. Pokud jsou zadány oba, input_task_id má prioritu.

Name
input_task_id
Type
string
Povinné
Description
ID dokončené úlohy generování obrázku, jejíž výstup má být použit jako vstupní obrázek. Tato úloha musí být jednou z následujících úloh: Text na obrázek nebo Obrázek na obrázek. Kromě toho musela být spuštěna přes API, musí mít stav SUCCEEDED a vytvořit přesně jeden obrázek.

Name
image_url
Type
string
Povinné
Description
Poskytněte obrázek, který má Meshy použít při tvorbě modelu. V současnosti podporujeme formáty .jpg, .jpeg a .png.
Obrázek lze poskytnout dvěma způsoby:
- Veřejně přístupná URL: URL, která je dostupná z veřejného internetu.
- Data URI: Data URI obrázku kódované v base64. Příklad Data URI: data:image/jpeg;base64,<your base64-encoded image data>.

Name
model_type
Type
string
výchozí standard
Description
Určete typ Generování sítě 3D.
Dostupné hodnoty:
- standard: Běžné Generování sítě 3D s vysokými detaily.
- lowpoly: Generuje low-poly síť optimalizovanou pro čistší polygony.
Když je vybráno lowpoly, ai_model, topology, target_polycount, should_remesh, save_pre_remeshed_model jsou ignorovány.
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ě. Emission mapa je také zahrnuta, když ai_model je meshy-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ž ai_model je meshy-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í. V současnosti podporujeme formáty .jpg, .jpeg a .png.
Obrázek lze poskytnout dvěma způsoby:
- Veřejně přístupná URL: URL, která je dostupná z veřejného internetu
- Data URI: Data URI obrázku kódované v base64. Příklad Data URI: data:image/jpeg;base64,<your base64-encoded image data>
Texturování obrázkem nemusí fungovat 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 texture_image_url nebo texture_prompt. Pokud jsou zadány oba parametry, bude pro texturování modelu ve výchozím nastavení použit texture_prompt. Texturování pomocí textu nebo obrázku bude stát 10 kreditů za úlohu.

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í.

Platí pouze když should_remesh = true

Name
topology
Type
string
výchozí triangle
Description
Určete topology generovaného modelu.
Dostupné hodnoty:
- quad: Vygeneruje síť s převahou čtyřúhelníků.
- triangle: Vygeneruje decimovanou trojúhelníkovou síť.
Name
target_polycount
Type
integer
výchozí 30,000
Description
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ší podle úrovně uživatele:
- 100 až 300 000 (včetně)
Name
decimation_mode
Type
integer
Description
Povolte adaptivní decimaci nastavením úrovně počtu polygonů. Při nastavení je target_polycount ignorován.
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ží další 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 pose_mode pro generovaný model.
Dostupné hodnoty:
- a-pose: Vygeneruje model v A pose.
- t-pose: Vygeneruje model v T pose.
- "" (prázdný řetězec): Nepoužije se žá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 vygenerovat model v A/T pose.
Name
image_enhancement
Type
boolean
výchozí true
Description
Optimalizuje vstupní obrázek pro lepší výsledky. Nastavte na false, chcete-li zachovat přesný vzhled vstupního obrázku bez jakéhokoli zpracování stylu.
Podporováno pouze, když ai_model je meshy-6 nebo latest.
Name
remove_lighting
Type
boolean
výchozí true
Description
Odstraňuje odlesky a stíny z textury základní barvy a vytváří čistší výsledek, který lépe funguje při vlastním nastavení osvětlení.
Podporováno pouze, když ai_model je meshy-6 nebo latest.
Name
moderation
Type
boolean
výchozí false
Description
Při nastavení na true bude vstupní obsah automaticky kontrolován na potenciálně škodlivý obsah. Pokud je zjištěn škodlivý obsah, úloha nebude pokračovat ke generování.
Obsah ze vstupů image_url, texture_image_url a texture_prompt bude zkontrolován.
Name
target_formats
Type
string[]
Description
Určuje, které formáty 3D souborů se mají zahrnout do výstupu. Budou vygenerovány a vráceny pouze požadované formáty, což může zkrátit dobu dokončení úlohy. Pokud je vynecháno, jsou zahrnuty všechny podporované formáty.
Dostupné hodnoty: glb, obj, fbx, stl, usdz, 3mf
Pokud je vynecháno, vygenerují se všechny formáty kromě 3mf. 3mf je zahrnut pouze při explicitním zadání.
Name
auto_size
Type
boolean
výchozí false
Description
Při nastavení na true služba používá 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ě nastaven origin_at.
Name
alpha_thumbnail
Type
boolean
výchozí false
Description
Při nastavení 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
Při nastavení na true úloha navíc vykreslí čtyři náhledy z hlavních směrů (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 Obrázek 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_url, nebo input_task_id.
- Neplatná vstupní úloha: input_task_id musí odkazovat na úlohu Text na obrázek nebo Obrázek na obrázek se stavem SUCCEEDED, která vytvoří přesně jeden obrázek.
- Neplatný formát obrázku: Zadané image_url není v podporovaném formátu (.jpg, .jpeg, .png).
- Nedostupná URL: image_url se nepodařilo stáhnout (404 nebo timeout).
- Neplatné Data URI: Řetězec base64 je nesprávně vytvořen.
- Neplatná kombinace parametrů: enable_pbr je podporováno pouze tehdy, když should_texture je true.
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/image-to-3d

# Simple request with required params
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": "<your publicly accessible image url or base64-encoded data URI>"
  }'

# With remesh, PBR, and A-pose
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": "<your publicly accessible image url or base64-encoded data URI>",
    "enable_pbr": true,
    "should_remesh": true,
    "target_polycount": 100000,
    "should_texture": true,
    "pose_mode": "a-pose",
    "target_formats": ["glb"]
  }'

Response

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

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

Načtení úlohy Obrázek na 3D

Tento koncový bod vám umožňuje načíst úlohu Obrázek na 3D pomocí platného id úlohy. Podívejte se na Objekt úlohy Obrázek na 3D, abyste zjistili, které vlastnosti jsou součástí objektu úlohy Obrázek na 3D.

Parametry

Name
id
Type
path
Description
Jedinečný identifikátor úlohy Obrázek na 3D, která se má načíst.

Návratová hodnota

Odpověď obsahuje objekt úlohy Obrázek na 3D. Podrobnosti najdete v sekci Objekt úlohy Obrázek na 3D.

Request

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}"

Response

{
  "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

Odstranění úlohy Obrázek na 3D

Tento koncový bod trvale odstraní úlohu 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 úlohy Obrázek na 3D, která má být odstraněna.

Návratová hodnota

Vrací 200 OK při úspěchu.

Request

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}"

Response

// Returns 200 Ok on success.

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

Vypsat úlohy Obrázek na 3D

Tento koncový bod vám umožňuje načíst seznam úloh Obrázek na 3D.

Parametry

Volitelné atributy

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

Návratová hodnota

Vrací stránkovaný seznam Objektů úlohy Obrázek na 3D.

Request

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}"

Response

[
  {
    "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

Streamování úlohy Obrázek na 3D

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

Parametry

Name
id
Type
path
Description
Jedinečný identifikátor úlohy Obrázek na 3D, která se má streamovat.

Vrací

Vrací stream objektů úlohy Obrázek na 3D jako Server-Sent Events.

U úloh PENDING nebo IN_PROGRESS bude stream odpovědi obsahovat pouze nezbytná pole progress a status.

Request

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

// Error event example
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
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 úlohy Obrázek na 3D

Objekt úlohy Obrázek na 3D je pracovní jednotka, kterou Meshy sleduje za účelem vygenerování 3D modelu ze vstupu v podobě obrázku. Objekt má následující vlastnosti:

Vlastnosti

Name
id
Type
string
Description
Jedinečný identifikátor úlohy. I když jako implementační detail pro ID úloh používáme k-sortovatelný UUID, neměli byste dělat žádné předpoklady o formátu ID.
Name
type
Type
string
Description
Typ úlohy Obrázek na 3D. Hodnota je image-to-3d.
Name
model_urls
Type
object
Description
Stažitelná adresa URL k souboru texturovaného 3D modelu vygenerovanému Meshy. Vlastnost pro daný formát bude vynechána, pokud formát není vygenerován, místo aby se vrátil prázdný řetězec.
- Name
  glb
  Type
  string
  Description
  Stažitelná adresa URL k souboru GLB.
- Name
  fbx
  Type
  string
  Description
  Stažitelná adresa URL k souboru FBX.
- Name
  obj
  Type
  string
  Description
  Stažitelná adresa URL k souboru OBJ.
- Name
  usdz
  Type
  string
  Description
  Stažitelná adresa URL k souboru USDZ.
- Name
  mtl
  Type
  string
  Description
  Stažitelná adresa URL k souboru MTL, vracená společně s exporty OBJ, když jsou přítomny textury.
- Name
  stl
  Type
  string
  Description
  Stažitelná adresa URL k souboru STL.
- Name
  3mf
  Type
  string
  Description
  Stažitelná adresa URL k souboru 3MF. Přítomno pouze tehdy, když bylo 3mf vyžádáno prostřednictvím target_formats.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  Stažitelná adresa URL k původnímu výstupu GLB před remeshingem.
  Dostupné pouze tehdy, když byla úloha vytvořena s should_remesh: true i save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Stažitelná adresa URL k obrázku miniatury souboru modelu. Odpovídá thumbnail_urls.front, je-li přítomno, zachováno kvůli zpětné kompatibilitě.
Name
alpha_thumbnail_url
Type
string
Description
Stažitelná adresa URL k verzi thumbnail_url s průhledným pozadím (RGBA). Přítomno 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
Stažitelné adresy URL pro čtyři miniatury vygenerovaného 3D modelu ze základních směrů pohledu. Každá hodnota je podepsaná adresa URL k PNG 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 tehdy, když byla úloha vytvořena s multi_view_thumbnails: true a dosáhla stavu SUCCEEDED. Starší úlohy a úlohy vytvořené bez volitelného zapnutí toto pole obsahovat nebudou.
- Name
  front
  Type
  string
  Description
  Pohled zepředu, otočení o 0° kolem svislé osy (odpovídá thumbnail_url).
- Name
  right
  Type
  string
  Description
  Pohled zprava, otočení o 90°.
- Name
  back
  Type
  string
  Description
  Pohled zezadu, otočení o 180°.
- Name
  left
  Type
  string
  Description
  Pohled zleva, otočení o 270°.
Name
texture_prompt
Type
string
Description
Textový prompt, který byl použit k vedení procesu texturování.
Name
texture_image_url
Type
string
Description
Stažitelná adresa URL k obrázku textury, který byl použit k vedení procesu texturování.
Name
progress
Type
integer
Description
Progress úlohy. Pokud úloha ještě nebyla spuštěna, bude tato vlastnost 0. Jakmile úloha úspěšně skončí, bude mít hodnotu 100.
Name
started_at
Type
timestamp
Description
Časové razítko, kdy byla úloha spuštěna, v milisekundách. Pokud úloha ještě nebyla spuštěna, bude tato vlastnost 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, kdy byla úloha vytvořena, v milisekundách.
Name
expires_at
Type
timestamp
Description
Časové razítko, kdy vyprší platnost výsledku úlohy, v milisekundách.
Name
finished_at
Type
timestamp
Description
Časové razítko, kdy byla úloha dokončena, v milisekundách. Pokud úloha ještě není 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, 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
  Stažitelná adresa URL k obrázku mapy základní barvy.
- Name
  metallic
  Type
  string
  Description
  Stažitelná adresa URL k obrázku metalické mapy.
  Pokud je úloha vytvořena s enable_pbr: false, bude tato vlastnost vynechána.
- Name
  normal
  Type
  string
  Description
  Stažitelná adresa URL k obrázku normálové mapy.
  Pokud je úloha vytvořena s enable_pbr: false, bude tato vlastnost vynechána.
- Name
  roughness
  Type
  string
  Description
  Stažitelná adresa URL k obrázku mapy drsnosti.
  Pokud je úloha vytvořena s enable_pbr: false, bude tato vlastnost vynechána.
- Name
  emission
  Type
  string
  Description
  Stažitelná adresa URL k obrázku emisní mapy.
  Pokud je úloha vytvořena s enable_pbr: false, nebo je ai_model meshy-5, bude tato vlastnost vynechána.
Name
preceding_tasks
Type
integer
Description
Počet předcházejících úloh.
Hodnota tohoto pole má význam pouze v případě, že stav úlohy je PENDING.
Name
task_error
Type
object
Description
Podrobnosti o chybě 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).

Example Image to 3D Task Object

{
  "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
}