Více obrázků na 3D API

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

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

Vytvoření úlohy Více obrázků na 3D

Tento koncový bod umožňuje vytvořit novou úlohu Více obrázků na 3D. Podrobnosti o vlastnostech obsažených v objektu úlohy Více obrázků na 3D naleznete v části Objekt úlohy Více obrázků na 3D.

Úloha běží na pozadí. Informace o tom, jak dlouho to obvykle trvá, naleznete v části Doby zpracování.

Parametry

Povinný je 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ů. Navíc 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 k vytvoření modelu. V současné době podporujeme formáty .jpg, .jpeg, .png a .webp. Pro nejlepší výsledky by všechny obrázky měly zobrazovat stejný objekt z různých úhlů.
Maximální velikost souboru: 20 MB na obrázek.
Každý obrázek lze poskytnout dvěma způsoby:
- Veřejně přístupná URL adresa: URL adresa přístupná z veřejného internetu.
- Data URI: Obrázek zakódovaný do base64 jako data URI. Příklad data URI: data:image/jpeg;base64,<vaše obrázková data zakódovaná v base64>.
U meshy-7.1 (nebo latest) se první obrázek použije jako primární (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, který se má použít.
Dostupné hodnoty:
- meshy-6-lite, meshy-6, meshy-7.1, latest (Meshy 7.1)
- meshy-7 (zastaralé): místo toho použijte meshy-7.1.
Name
geometry_resolution
Type
string
výchozí standard
Description
Průchod generování geometrie. 2k spustí průchod Ultra při rozlišení 2048³. Vyžaduje meshy-7.1 nebo latest.
Dostupné hodnoty: standard, 2k
Name
ultra_mode
Type
boolean
⚠ zastaralé
výchozí false
Description
Místo toho použijte geometry_resolution. ultra_mode: true odpovídá hodnotě geometry_resolution: "2k".
Name
should_texture
Type
boolean
výchozí true
Description
Určuje, zda se mají generovat textury. Nastavením na false přeskočíte fázi textury 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 (metalíza, drsnost, normálová mapa). Emisní mapa je také zahrnuta, pokud je ai_model nastaven na meshy-6, kromě případu texture_resolution: 8k. meshy-6-lite, meshy-7.1 a latest emisní mapu nevytvářejí.
Name
texture_resolution
Type
string
výchozí 2k
Description
Rozlišení textury základní barvy. Jedno z: 2k (2048×2048), 4k (4096×4096) nebo 8k (8192×8192). Vyšší rozlišení zachycují více detailů povrchu.
4k a 8k vyžadují ai_model meshy-6, meshy-7.1 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, má přednost texture_resolution.
Name
texture_prompt
Type
string
Description
Zadejte textový prompt, který bude řídit proces texturování. Maximálně 800 znaků.
Name
texture_image_url
Type
string
Description
Poskytněte 2D obrázek, který bude řídit proces texturování. V současné době podporujeme formáty .jpg, .jpeg, .png a .webp.
Maximální velikost souboru: 20 MB.
Obrázek lze poskytnout dvěma způsoby:
- Veřejně přístupná URL adresa: URL adresa přístupná z veřejného internetu
- Data URI: Obrázek zakódovaný do base64 jako data URI. Příklad data URI: data:image/jpeg;base64,<vaše obrázková data zakódovaná v base64>
Texturování obrázku nemusí fungovat optimálně, pokud mezi původním assetem a nahraným obrázkem existují výrazné geometrické rozdíly. Proces texturování může řídit pouze jeden z parametrů texture_image_url nebo texture_prompt. Pokud jsou zadány oba, bude se model standardně texturovat podle 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é budou řídit texturování. První obrázek je primární (přední) pohled; na pořadí zbývajících pohledů (vlevo, vzadu, vpravo) nezáleží.
Každý prvek přijímá stejné formáty jako texture_image_url (veřejně přístupná URL adresa nebo base64 data URI, .jpg/.jpeg/.png/.webp).
Maximální velikost souboru: 20 MB na obrázek.
Tyto obrázky řídí 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_model meshy-7.1 nebo latest. Nelze kombinovat s texture_image_url ani texture_prompt.

Name
should_remesh
Type
boolean
výchozí false (Meshy 6 and Meshy 7 models), true (others)
Description
Určuje, zda se má povolit fáze remeshe. 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.
- triangle: Vygeneruje zjednodušenou trojúhelníkovou síť.
Name
target_polycount
Type
integer
výchozí 30,000
Description
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 je 100 až 300 000 (včetně).
Name
decimation_mode
Type
integer
Description
Povolte adaptivní decimaci nastavením úrovně počtu polygonů. Pokud je nastaveno, parametr 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ží další soubor GLB před dokončením fáze remeshe.

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 mode pozy vygenerovaného modelu.
Dostupné hodnoty:
- a-pose: Vygeneruje model v pozici A-pose.
- t-pose: Vygeneruje model v pozici T-pose.
- "" (prázdný řetězec): Nepoužije se žádná konkrétní poza.
Name
is_a_t_pose
Type
boolean
⚠ zastaralé
výchozí false
Description
Místo toho použijte pose_mode. Určuje, zda se má model vygenerovat v pozici A/T.
Name
image_enhancement
Type
boolean
výchozí true
Description
Optimalizuje vstupní obrázky pro lepší výsledky. Nastavte na false, chcete-li zachovat přesný vzhled vstupních obrázků bez jakéhokoli stylového zpracování.
Podporováno pouze tehdy, když je ai_model nastaven na meshy-6, meshy-7.1 nebo latest. Nastavení s meshy-6-lite vrátí chybu.
Name
remove_lighting
Type
boolean
výchozí true
Description
Odstraní z textury základní barvy odlesky a stíny, čímž vznikne čistší výsledek, který lépe funguje při vlastním nastavení osvětlení.
Podporováno pouze tehdy, když je ai_model nastaven na meshy-6, meshy-7.1 nebo latest. Nastavení s meshy-6-lite vrátí chybu.
Name
moderation
Type
boolean
výchozí false
Description
Pokud je nastaveno na true, bude vstupní obsah automaticky zkontrolován na potenciálně škodlivý obsah. Pokud je škodlivý obsah detekován, úloha nebude pokračovat ke generování.
Zkontrolován 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 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 není uvedeno, vygenerují se všechny formáty kromě 3mf. Formát 3mf je zahrnut pouze tehdy, pokud je výslovně uveden.
Name
auto_size
Type
boolean
výchozí false
Description
Pokud je nastaveno na true, služba pomocí AI vidění 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 ve výchozím nastavení 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 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 hlavní pohledy (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 to neovlivní existující klienty.
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
Pozice počátku, pokud je povoleno auto_size. Dostupné hodnoty: bottom, center.

Návratové hodnoty

Vlastnost result 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ý. Časté 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 dokončenou (SUCCEEDED) úlohu 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í vstupy textury: 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_model meshy-7.1 nebo latest.
- Nedostupná URL adresa: Jeden nebo více prvků image_urls nebo texture_image_urls se nepodařilo stáhnout.
- Příliš velký obrázek: Jeden nebo více obrázků v image_urls, texture_image_url nebo texture_image_urls přesahuje 20 MB.
- Nepodporované rozlišení pro vstup s více obrázky: geometry_resolution: "4k" není u tohoto koncového bodu dostupné; použijte 2k nebo standard.
- Nepodporovaný model pro volby obrázku: image_enhancement nebo remove_lighting je nastaveno společně s ai_model: "meshy-6-lite".
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 limit rychlosti.

Request

POST

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

# Simple request
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d \
  -X POST \
  -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 format
curl https://api.meshy.ai/openapi/v1/multi-image-to-3d \
  -X POST \
  -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"]
  }'

Response

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

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

Načtení úlohy Více obrázků na 3D

Tento koncový bod umožňuje načíst úlohu Více obrázků na 3D podle platného id úlohy. Podívejte se na Objekt úlohy Více obrázků na 3D, kde zjistíte, jaké vlastnosti objekt úlohy Více obrázků na 3D obsahuje.

Parametry

Name
id
Type
path
Description
Jedinečný identifikátor úlohy Více obrázků na 3D, kterou chcete načíst.

Návratová hodnota

Odpověď obsahuje objekt úlohy Více obrázků na 3D. Podrobnosti najdete v sekci Objekt úlohy Více obrázků na 3D.

Request

GET

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

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "multi-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/multi-image-to-3d/:id

Smazání úlohy Více obrázků na 3D

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, kterou chcete smazat.

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 dále běží. Kredity za úlohu, kterou worker již spustil, nelze vrátit, takže její smazání během běhu by vás stálo kredity i výsledek zároveň. Počkejte, až dosáhne stavu SUCCEEDED, FAILED nebo CANCELED, a poté ji smažte.

Úloha v koncovém stavu (SUCCEEDED, FAILED nebo CANCELED) je smazána bez vrácení kreditů.

Návratové hodnoty

Vrací 200 OK při úspěchu nebo 409 Conflict, pokud je úloha ve stavu IN_PROGRESS.

Request

DELETE

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

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

Response

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

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

Výpis úloh Více obrázků na 3D

Tento koncový bod umožňuje načíst seznam úloh Více obrázků na 3D.

Parametry

Volitelné atributy

Name
page_num
Type
integer
Description
Číslo stránky pro stránkování. Začíná 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á hodnota je 100 položek.
Name
sort_by
Type
string
Description
Pole, podle kterého se má řadit. Dostupné hodnoty:
- +created_at: Řazení podle času vytvoření vzestupně.
- -created_at: Řazení podle času vytvoření sestupně.

Návratová hodnota

Vrací stránkovaný seznam objektů úlohy Více obrázků na 3D.

Request

GET

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

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

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "multi-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/multi-image-to-3d/:id/stream

Streamování úlohy Více obrázků na 3D

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

Parametry

Name
id
Type
path
Description
Jedinečný identifikátor úlohy Více obrázků na 3D, kterou chcete streamovat.

Návratové hodnoty

Vrací stream objektů úlohy Více obrázků na 3D jako Server-Sent Events.

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

Request

GET

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

curl -N https://api.meshy.ai/openapi/v1/multi-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": "multi-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 Více obrázků na 3D

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ů (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. Ačkoli jako implementační detail používáme pro identifikátory úloh 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
Stažitelná URL adresa na soubor texturovaného 3D modelu vygenerovaného nástrojem Meshy. Vlastnost pro daný formát bude vynechána, pokud daný formát nebyl vygenerován, místo vracení 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řítomno pouze pokud 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 remeshem.
  Dostupné pouze v případě, že úloha byla vytvořena jak s should_remesh: true, tak s save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Stažitelná URL adresa na miniaturu obrázku souboru modelu. Odpovídá 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řítomno pouze pokud 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é URL adresy pro čtyři miniatury vygenerovaného 3D modelu ze základních pohledů (předního, zadního, levého, pravého). Každá hodnota je podepsaná URL adresa na 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 zpracováních bez nutnosti stahovat soubor GLB.
Přítomno pouze pokud 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 0° kolem svislé osy (odpovídá 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 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řítomno pouze pokud byla úloha vytvořena s texture_image_urls.
Name
ultra_mode
Type
boolean
⚠ zastaralé
Description
Zastaralé; místo toho použijte geometry_resolution.
Name
geometry_resolution
Type
string
Description
Úroveň Ultra, se kterou úloha běžela (2k); vynecháno pro standard.
Name
progress
Type
integer
Description
Postup úlohy. Pokud úloha ještě nebyla spuštěna, tato vlastnost bude 0. Jakmile úloha uspěje, stane se 100.
Name
started_at
Type
timestamp
Description
Časové razítko okamžiku, kdy byla úloha spuštěna, v milisekundách. Pokud úloha ještě nebyla spuštěna, tato vlastnost bude 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 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 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ě nebyla dokončena, tato vlastnost bude 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. Běžně obsahuje pouze jeden objekt URL textury. Každá URL 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 kovové 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 mapy emise.
  Pokud je úloha vytvořena s enable_pbr: false, nebo pokud je ai_model nastaveno na meshy-6-lite, meshy-7.1, nebo latest, 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ě pro neúspěšné úlohy. Úplný referenční popis objektu task_error najdete 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. Pro úlohy se stavem FAILED vrací 0 (kredity jsou při neúspěchu vráceny).

Example Multi-Image to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "multi-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,
}