Více obrázků na 3D API

Vygenerujte 3D model z jednoho až čtyř obrázků stejného objektu, pořízených z různých úhlů.

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

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

Vytvoří úlohu Více obrázků na 3D. Úloha běží na pozadí. Jak dlouho úloha obvykle trvá, se dozvíte v části Doby zpracování. Pole, která úloha obsahuje, najdete v části Objekt úlohy Více obrázků na 3D.

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

# Textured with Meshy N1 from the input images, the first as the front view
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 front view image url or base64-encoded data URI>",
      "<your back view image url or base64-encoded data URI>"
    ],
    "ai_model": "meshy-7.1",
    "texture_model": "meshy-n1"
  }'

Response

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

Parametry

Name
input_task_id
Type
string
Povinné
Description
Povinné, pokud neodešlete image_urls. ID úlohy Text na obrázek nebo Obrázek na obrázek, včetně úlohy s více pohledy. Meshy použije jako vstup jeden až čtyři obrázky z této úlohy. Úloha musí být vytvořena vámi přes API a mít stav SUCCEEDED.

Name
image_urls
Type
array
Povinné
Description
Povinné, pokud neodešlete input_task_id. Jeden až čtyři obrázky, každý jako veřejná URL adresa nebo jako Data URI, například data:image/jpeg;base64,<vaše obrazová data zakódovaná v base64>. Pokud odešlete obojí, Meshy použije input_task_id.
Každý obrázek musí být soubor .jpg, .jpeg, .png nebo .webp o velikosti nejvýše 20 MB, s každou stranou dlouhou alespoň 32 pixelů a s rozlišením nejvýše 178 956 970 pixelů (šířka × výška). Více než čtyři obrázky vrátí 400.
Nejlepších výsledků dosáhnete, pokud obrázky zobrazují stejný objekt z různých úhlů. S meshy-7.1 nebo latest použije Meshy první obrázek jako pohled zepředu a pořadí ostatních nehraje roli.

Name
ai_model
Type
string
výchozí latest
Description
AI model, který vygeneruje 3D model.
Dostupné hodnoty:
- latest: Meshy 7.1
- meshy-7.1
- meshy-6
- meshy-6-lite
- meshy-7: zastaralé, místo toho odešlete meshy-7.1
V části Modely najdete, který model se hodí pro váš projekt, například reálný objekt nebo 3D tisk.
Name
geometry_resolution
Type
string
výchozí standard
Description
Kolik detailů geometrie se má vygenerovat.
Dostupné hodnoty:
- standard
- 2k: spustí průchod Ultra při 2048³. Vyžaduje meshy-7.1, latest, nebo zastaralý meshy-7.
Name
ultra_mode
Type
boolean
⚠ zastaralé
výchozí false
Description
Místo toho odešlete geometry_resolution. ultra_mode: true je totéž jako geometry_resolution: "2k".
Name
should_texture
Type
boolean
výchozí true
Description
Zda se mají generovat textury. true vrátí texturovaný model, false přeskočí krok texturování a vrátí síť bez textur.

Platí pouze když should_texture = true

Name
texture_model
Type
string
výchozí depends on ai_model
Description
AI model, který v rámci téže úlohy texturuje 3D model z několika pohledů. Pokud jej vynecháte, použije se výchozí texturovací model pro váš ai_model. Neovlivňuje náklady na kredity.
Dostupné hodnoty:
- meshy-7: Meshy 7, s PBR mapami a texturami až do 8K
- meshy-n1: Meshy N1, základní barevná textura 2K pouze z referenčních obrázků
Každý ai_model přijímá oba. Texturovaný požadavek s meshy-6 nebo meshy-6-lite vrátí 400, stejně jako volba, kterou zvolený texturovací model nepodporuje. Při should_texture: false Meshy ignoruje texture_model, ale neznámá hodnota přesto vrátí 400.
S meshy-n1 Meshy texturuje z texture_image_urls nebo texture_image_url, případně ze vstupních obrázků, pokud neodešlete ani jedno. První obrázek je pohled zepředu. Vygenerovaný model s více než 7 999 999 trojúhelníky úlohu ukončí s chybou a Meshy vrátí kredity.
V části Modely najdete, co každý texturovací model dělá a který vybrat.
Name
enable_pbr
Type
boolean
výchozí false
Description
Zda se mají kromě základní barvy vygenerovat i mapy kovovosti, drsnosti a normálová mapa. Texturovací model Meshy 6 navíc generuje emisní mapu, s výjimkou texture_resolution: 8k. S texture_model: meshy-n1 hodnota true vrátí 400.
Name
texture_resolution
Type
string
výchozí 2k
Description
Velikost základní barevné textury. Větší velikost zachytí více detailů povrchu.
Dostupné hodnoty:
- 2k: 2048×2048
- 4k: 4096×4096
- 8k: 8192×8192
4k a 8k vyžadují texturovací model Meshy 7 nebo Meshy 6 a s ostatními vrátí 400. Při 8k Meshy negeneruje emisní mapu.
Name
hd_texture
Type
boolean
⚠ zastaralé
výchozí false
Description
Místo toho odešlete texture_resolution. hd_texture: true je totéž jako texture_resolution: "4k". Pokud odešlete obojí, Meshy použije texture_resolution.
Name
texture_prompt
Type
string
Description
Text, který řídí texturu, až 800 znaků. Delší text vrátí 400. S texture_model: meshy-n1 jeho odeslání vrátí 400.
Name
texture_image_url
Type
string
Description
Jeden 2D obrázek, který řídí texturu, jako veřejná URL adresa nebo jako Data URI, například data:image/jpeg;base64,<vaše obrazová data zakódovaná v base64>. Obrázek musí být soubor .jpg, .jpeg, .png nebo .webp o velikosti nejvýše 20 MB, s každou stranou dlouhou alespoň 32 pixelů a s rozlišením nejvýše 178 956 970 pixelů (šířka × výška).
Pokud odešlete texture_image_url i texture_prompt, Meshy použije texture_prompt. S texture_model: meshy-n1 Meshy texturuje z tohoto obrázku jako z pohledu zepředu.
Textura se nemusí povést dobře, pokud se tvar na obrázku výrazně liší od 3D modelu.
Name
texture_image_urls
Type
string[]
Description
Jeden až čtyři obrázky objektu z různých pohledů, které řídí texturu. Meshy použije první obrázek jako pohled zepředu. Pořadí ostatních pohledů (zleva, zezadu, zprava) nehraje roli.
Každý obrázek se řídí stejnými pravidly jako texture_image_url. Je to veřejná URL adresa nebo Data URI ve formátu .jpg, .jpeg, .png nebo .webp, o velikosti nejvýše 20 MB, s každou stranou dlouhou alespoň 32 pixelů a s rozlišením nejvýše 178 956 970 pixelů (šířka × výška).
Tyto obrázky řídí pouze texturu a nezávisí na image_urls. Oba seznamy mohou obsahovat odlišné obrázky a odlišný počet obrázků.
texture_image_urls vyžaduje texturovací model Meshy 7 nebo Meshy N1. Odešlete jej s jedním z následujících:
- ai_model nastaveným na meshy-7.1, latest, nebo zastaralý meshy-7
- texture_model nastaveným na meshy-7 nebo meshy-n1
Nelze jej odeslat společně s texture_image_url nebo texture_prompt.

Name
should_remesh
Type
boolean
výchozí true (meshy-6-lite), false (other models)
Description
Zda se má model po vygenerování podrobit remeshi. Pro nejvyšší kvalitu 3D modelu nastavte hodnotu na false.

Platí pouze když should_remesh = true

Name
topology
Type
string
výchozí triangle
Description
Typ plošek remeshovaného modelu.
Dostupné hodnoty:
- quad: síť s převahou čtyřúhelníků
- triangle: zjednodušená trojúhelníková síť
S texture_model: meshy-n1 vrátí quad hodnotu 400, pokud je model remeshován, což meshy-6-lite dělá ve výchozím nastavení.
Name
target_polycount
Type
integer
výchozí 30000
Description
Cílový počet plošek, od 100 do 300000. Výsledek se může od cíle lišit v závislosti na geometrii modelu. Hodnota mimo rozsah vrátí 400.
Name
decimation_mode
Type
integer
Description
Adaptivní počet plošek podle úrovně. Pokud ji nastavíte, Meshy ignoruje target_polycount.
Dostupné hodnoty:
- 1: ultra
- 2: vysoká
- 3: střední
- 4: nízká
Name
save_pre_remeshed_model
Type
boolean
výchozí false
Description
Zda se má uložit i GLB z doby před remeshí, vrácený v model_urls.pre_remeshed_glb.

Name
symmetry_mode
Type
string
⚠ zastaralé
výchozí auto
Description
Vynechte. Nemá vliv na výstup.
Dostupné hodnoty:
- off: žádná symetrie
- auto: symetrie podle vstupní geometrie
- on: vynucená symetrie
Name
pose_mode
Type
string
výchozí ""
Description
Póza vygenerovaného modelu.
Dostupné hodnoty:
- a-pose: póza A
- t-pose: póza T
- "" (prázdný řetězec): žádná konkrétní póza
Name
is_a_t_pose
Type
boolean
⚠ zastaralé
výchozí false
Description
Místo toho odešlete pose_mode. Zda se má model vygenerovat v póze A nebo T.
Name
image_enhancement
Type
boolean
výchozí true
Description
Zda se mají vstupní obrázky před generováním optimalizovat. false zachová přesný vzhled vstupních obrázků bez stylového zpracování. Podporováno pouze s meshy-6, meshy-7.1, nebo latest. Odeslání s meshy-6-lite vrátí 400.
Name
remove_lighting
Type
boolean
výchozí true
Description
Zda se mají ze základní barevné textury odstranit světla a stíny. Čistší výsledek funguje lépe při vlastním osvětlení. Používá ji pouze texturovací model Meshy 6, a při texture_resolution: 8k vždy odstraňuje osvětlení. S texture_model: meshy-n1 hodnota true vrátí 400. S ai_model: meshy-6-lite a jeho výchozím texturovacím modelem odeslání vrátí 400.
Name
moderation
Type
boolean
výchozí false
Description
Zda se mají vstupy prověřit na škodlivý obsah. Meshy prověří každý vstupní obrázek, texture_image_url nebo každý obrázek v texture_image_urls, a text v texture_prompt. Pokud Meshy najde škodlivý obsah, požadavek vrátí 400 a Meshy úlohu nevytvoří.
Name
target_formats
Type
string[]
Description
Formáty 3D souborů, které se mají vygenerovat. Meshy vygeneruje a vrátí pouze formáty, které uvedete, což může úlohu zkrátit.
Dostupné hodnoty:
- glb
- obj
- fbx
- stl
- usdz
- 3mf
Pokud je vynecháte, Meshy vygeneruje všechny formáty kromě 3mf. Formát 3mf Meshy vygeneruje pouze tehdy, pokud jej uvedete.
Name
auto_size
Type
boolean
výchozí false
Description
Zda se má pomocí AI vidění odhadnout skutečná výška objektu v reálném světě a model podle ní upravit velikost. Meshy umístí počátek dole, pokud nenastavíte origin_at.

Platí pouze když auto_size = true

Name
origin_at
Type
string
výchozí bottom
Description
Kam umístit počátek modelu, bottom nebo center.

Name
alpha_thumbnail
Type
boolean
výchozí false
Description
Zda se má vykreslit i náhled s průhledným pozadím (RGBA), vrácený v alpha_thumbnail_url při získání úlohy. thumbnail_url se nezmění.
Name
multi_view_thumbnails
Type
boolean
výchozí false
Description
Zda se mají vykreslit i náhledy zepředu, zprava, zezadu a zleva, vrácené v thumbnail_urls při získání úlohy. thumbnail_url se nezmění a nadále zobrazuje pohled zepředu. Tím se úloha prodlouží přibližně o 5 sekund.

Návratové hodnoty

Pole result v odpovědi obsahuje ID nové úlohy Více obrázků na 3D.

Chybové stavy

Name
400 - Bad Request
Description
Požadavek nelze spustit. Chybová zpráva uvádí, jaký problém byl zjištěn. Například:
- Chybějící parametr: Nebylo odesláno ani image_urls, ani input_task_id.
- Neplatná vstupní úloha: input_task_id není úloha Text na obrázek nebo Obrázek na obrázek se stavem SUCCEEDED, ani úloha s více pohledy.
- Neplatný počet obrázků: image_urls nebo texture_image_urls neobsahuje 1 až 4 obrázky.
- Neplatný formát obrázku: Obrázek v image_urls není v podporovaném formátu.
- Konfliktní vstupy textury: texture_image_urls bylo odesláno spolu s texture_image_url, s texture_prompt, nebo s should_texture: false.
- Nepodporovaný model pro texturu z více pohledů: texture_image_urls bylo odesláno s ai_model nastaveným na meshy-6 nebo meshy-6-lite, pokud texture_model není meshy-7 nebo meshy-n1.
- Nedostupná URL adresa: Meshy nemůže stáhnout obrázek z image_urls nebo texture_image_urls.
- Příliš velký obrázek: Obrázek v image_urls, texture_image_url, nebo texture_image_urls přesahuje 20 MB.
- Neplatná velikost obrázku: Obrázek v image_urls, texture_image_url, nebo texture_image_urls má stranu kratší než 32 pixelů, nebo více než 178 956 970 pixelů (šířka × výška).
- Nepodporované rozlišení pro vstup s více obrázky: geometry_resolution je "4k", což tento koncový bod nepodporuje. Použijte 2k nebo standard.
- Nepodporovaný model pro volby obrázku: image_enhancement bylo odesláno s ai_model: "meshy-6-lite", nebo remove_lighting bylo odesláno s ai_model: "meshy-6-lite" a jeho výchozím texturovacím modelem.
- Neplatný texturovací model: texture_model není platný název texturovacího modelu.
- Texturovací model není dostupný: Texturovaný požadavek odeslal texture_model s hodnotou meshy-6 nebo meshy-6-lite. Více obrázků na 3D přijímá pouze texturovací modely, které texturují z několika pohledů. Odešlete meshy-7 nebo meshy-n1, nebo texture_model vynechte.
- Nepodporovaná volba pro texturovací model: Požadavek žádá texturovací model o volbu, kterou nepodporuje, například enable_pbr: true s meshy-n1, nebo texturu 4k s meshy-6-lite. Viz Modely.
Opravte požadavek a odešlete jej znovu. Viz Chyby.
Name
401 - Unauthorized
Description
API klíč chybí nebo je neplatný. Zkontrolujte hlavičku Authorization.
Name
402 - Payment Required
Description
Například:
- Nedostatek kreditů: Účet nemá dostatek kreditů pro tuto úlohu, nebo účet dosáhl limitu kreditů. Zkontrolujte svůj zůstatek kreditů a zkuste to znovu.
- Bezplatný plán: Vytvoření úlohy vyžaduje placený plán. Upgradujte svůj plán v nastavení předplatného a zkuste to znovu.
Name
403 - Forbidden
Description
Moderace obsahu zablokovala prompt nebo vstupní obrázek. Změňte vstup a zkuste to znovu.
Name
404 - Not Found
Description
input_task_id neodpovídá žádné z vašich úloh. Zkontrolujte ID úlohy a odešlete požadavek znovu.
Name
429 - Too Many Requests
Description
Překročili jste svůj limit rychlosti. Počkejte a zkuste to znovu. Viz Limity rychlosti.

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

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

Vrátí úlohu Více obrázků na 3D podle jejího ID.

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"
    }
  ],
  "preceding_tasks": 0,
  "task_error": null,

  "consumed_credits": 30
}

Parametry

Name
id
Type
path
Description
ID úlohy z odpovědi na její vytvoření.

Návratová hodnota

Objekt úlohy Více obrázků na 3D.

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

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

Trvale smaže úlohu Více obrázků na 3D, včetně jejích modelů a dat. Smazání nelze vrátit zpět.

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

Parametry cesty

Name
id
Type
path
Description
ID úlohy, která má být smazána.

Stav úlohy

Smazání úlohy ve stavu PENDING vrátí kredity, které byly použity při jejím vytvoření.

Úlohu ve stavu IN_PROGRESS nelze smazat. Požadavek vrátí 409 Conflict a úloha pokračuje v běhu. Meshy nevrací kredity za úlohu, která už byla spuštěna, takže její smazání by vás stálo jak kredity, tak výsledek. Počkejte, až úloha dosáhne stavu SUCCEEDED, FAILED nebo CANCELED, a poté ji smažte.

Smazání úlohy v konečném stavu (SUCCEEDED, FAILED nebo CANCELED) kredity nevrací.

Návratové hodnoty

200 OK, pokud byla úloha smazána, nebo 409 Conflict, pokud je úloha ve stavu IN_PROGRESS.

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

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

Vrátí seznam vašich úloh 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"
      }
    ],
    "preceding_tasks": 0,
    "task_error": null,

    "consumed_credits": 30
  }
]

Parametry

Name
page_num
Type
integer
výchozí 1
Description
Číslo stránky, kterou chcete vrátit, až do 255. Vyšší hodnota vrátí 400.
Name
page_size
Type
integer
výchozí 10
Description
Počet úloh na stránku, až do 100.
Name
sort_by
Type
string
Description
Pořadí řazení.
Dostupné hodnoty:
- +created_at: nejstarší první
- -created_at: nejnovější první

Návratová hodnota

Stránkovaný seznam objektů úloh Více obrázků na 3D.

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

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

Streamuje aktualizace úlohy Více obrázků na 3D jako Server-Sent Events (SSE).

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.
// These examples are shortened. Each event holds the full task object.
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"
    }
  ],
  "preceding_tasks": 0,
  "task_error": null,

  "consumed_credits": 30
}

Parametry

Name
id
Type
path
Description
ID úlohy z odpovědi na vytvoření.

Návratová hodnota

Proud objektů úlohy Více obrázků na 3D ve formě Server-Sent Events.

Každá událost obsahuje celý objekt úlohy, ve stejné podobě, jakou vrací koncový bod Get. Dokud je úloha ve stavu PENDING nebo IN_PROGRESS, její výsledková pole ještě nemají hodnoty.

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

Objekt úlohy Více obrázků na 3D popisuje jedno generování 3D modelu z jednoho až čtyř obrázků objektu. Obsahuje stav, progress a soubory modelu, pokud úloha uspěje.

Vlastnosti

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"
    }
  ],
  "preceding_tasks": 0,
  "task_error": null,

  "consumed_credits": 30
}

Name
id
Type
string
Description
ID úlohy. Považujte jej za neprůhledný řetězec a nespoléhejte na jeho formát.
Name
type
Type
string
Description
Typ úlohy, vždy multi-image-to-3d.
Name
model_urls
Type
object
Description
Odkazy ke stažení vygenerovaného 3D modelu, jeden pro každý formát souboru. Formát, který úloha nevygenerovala, nemá klíč, místo prázdného řetězce.
- Name
  glb
  Type
  string
  Description
  Soubor GLB.
- Name
  fbx
  Type
  string
  Description
  Soubor FBX.
- Name
  obj
  Type
  string
  Description
  Soubor OBJ.
- Name
  usdz
  Type
  string
  Description
  Soubor USDZ.
- Name
  mtl
  Type
  string
  Description
  Soubor MTL, vrácený spolu se souborem OBJ, pokud má model textury.
- Name
  stl
  Type
  string
  Description
  Soubor STL.
- Name
  3mf
  Type
  string
  Description
  Soubor 3MF. Přítomen pouze tehdy, pokud target_formats obsahuje 3mf.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  Soubor GLB z doby před remeshem. Přítomen pouze v případě, že jste úlohu vytvořili s should_remesh: true i save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Odkaz ke stažení náhledového obrázku modelu. Je stejný jako thumbnail_urls.front, pokud je toto pole přítomno.
Name
alpha_thumbnail_url
Type
string
Description
Odkaz ke stažení verze thumbnail_url s průhledným pozadím (RGBA). Přítomen pouze v případě, že jste úlohu vytvořili s alpha_thumbnail: true a Meshy vykreslil průhledný náhled.
Name
thumbnail_urls
Type
object
Description
Odkazy ke stažení náhledů 3D modelu ze čtyř stran. Každý z nich je podepsaný odkaz na PNG o rozměru 512×512, vykreslený se stejnými materiály a osvětlením jako thumbnail_url. Můžete je použít k náhledu modelu z více úhlů bez stahování GLB.
Přítomno pouze v případě, že jste úlohu vytvořili s multi_view_thumbnails: true a úloha dosáhla stavu SUCCEEDED. Úloha vytvořená bez multi_view_thumbnails: true toto pole nemá.
- Name
  front
  Type
  string
  Description
  Pohled zepředu, při 0° kolem svislé osy. Odpovídá thumbnail_url.
- Name
  right
  Type
  string
  Description
  Pohled zprava, při 90°.
- Name
  back
  Type
  string
  Description
  Pohled zezadu, při 180°.
- Name
  left
  Type
  string
  Description
  Pohled zleva, při 270°.
Name
texture_prompt
Type
string
Description
Textový prompt, který řídil texturu.
Name
texture_image_urls
Type
string[]
Description
Odkazy ke stažení referenčních obrázků textury, se kterými jste úlohu vytvořili, v pořadí, v jakém jste je odeslali. Přítomno pouze v případě, že jste úlohu vytvořili s texture_image_urls.
Name
ultra_mode
Type
boolean
⚠ zastaralé
Description
Místo toho čtěte geometry_resolution.
Name
geometry_resolution
Type
string
Description
Úroveň Ultra, se kterou úloha běžela, tedy 2k. Úloha standard toto pole nemá.
Name
progress
Type
integer
Description
Kolik z úlohy je hotovo, v procentech. Je 0, dokud úloha nezačne, a 100, když uspěje.
Name
started_at
Type
timestamp
Description
Čas zahájení úlohy, v milisekundách Unixového času. Je 0, dokud úloha nezačne.
Name
created_at
Type
timestamp
Description
Čas vytvoření úlohy, v milisekundách Unixového času.
Name
expires_at
Type
timestamp
Description
Čas, kdy vyprší platnost výsledků úlohy, v milisekundách Unixového času.
Name
finished_at
Type
timestamp
Description
Čas dokončení úlohy, v milisekundách Unixového času. Je 0, dokud úloha neskončí.
Name
status
Type
string
Description
Stav úlohy, jeden z PENDING, IN_PROGRESS, SUCCEEDED, FAILED nebo CANCELED.
Name
texture_urls
Type
array
Description
Odkazy ke stažení textur, které úloha vygenerovala, jako pole objektů. Obvykle obsahuje jeden objekt. Každý objekt má tato pole:
- Name
  base_color
  Type
  string
  Description
  Mapa základní barvy.
- Name
  metallic
  Type
  string
  Description
  Mapa metalnosti. Není zahrnuta, pokud jste úlohu vytvořili s enable_pbr: false.
- Name
  normal
  Type
  string
  Description
  Normálová mapa. Není zahrnuta, pokud jste úlohu vytvořili s enable_pbr: false.
- Name
  roughness
  Type
  string
  Description
  Mapa drsnosti. Není zahrnuta, pokud jste úlohu vytvořili s enable_pbr: false.
- Name
  emission
  Type
  string
  Description
  Mapa emise. Zahrnuta pouze v případě, že jste úlohu vytvořili se všemi těmito nastaveními:
  
  ai_model: meshy-6, s výchozím modelem textury
  
  enable_pbr: true
  
  texture_resolution o hodnotě 2k nebo 4k
Name
preceding_tasks
Type
integer
Description
Počet úloh před touto úlohou ve frontě. Hodnota má smysl pouze během stavu PENDING.
Name
task_error
Type
object
Description
Podrobnosti o chybě, pokud úloha selže. Je null, pokud stav není FAILED. Viz Chyby.
Name
consumed_credits
Type
integer
Description
Počet kreditů, které úloha spotřebovala. Přítomno, pokud je stav PENDING, IN_PROGRESS nebo SUCCEEDED. U úlohy se stavem FAILED je 0, protože Meshy při selhání úlohy kredity vrací.