Text na 3D API

Generujte 3D modely z textových promptů ve vlastní aplikaci.

Text na 3D funguje ve dvou krocích. Nejprve vytvořte úlohu preview (mode: "preview") pro vygenerování 3D sítě bez textury, abyste si mohli zkontrolovat tvar. Poté odešlete ID úspěšné úlohy preview do úlohy refine (mode: "refine"), která síť otexturuje. Oba kroky používají stejný koncový bod.

POST/openapi/v2/text-to-3d

Vytvoření preview úlohy Text na 3D

Vytvoří preview úlohu Text na 3D, která z textového promptu vygeneruje netexturovanou 3D síť (pouze geometrii). Jedná se o první krok dvoukrokového workflow. Po úspěšném dokončení preview odešlete její ID úlohy v refine úloze pro texturování sítě. Viz Vytvoření refine úlohy Text na 3D. Úplné schéma odpovědi najdete v části Objekt úlohy Text na 3D.

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

Request

POST

/openapi/v2/text-to-3d

# Simple preview with required params only
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a monster mask"
}'

# Preview with Ultra 4K geometry, remesh, and A-pose
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "preview",
  "prompt": "a futuristic robot warrior",
  "ai_model": "meshy-7.1",
  "geometry_resolution": "4k",
  "should_remesh": true,
  "target_polycount": 100000,
  "pose_mode": "a-pose",
  "target_formats": ["glb"]
}'

Response

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

Parametry

Name
mode
Type
string
Povinné
Description
Krok dvoukrokového workflow. Odešlete preview pro vytvoření preview úlohy.
Name
prompt
Type
string
Povinné
Description
Text popisující objekt k vygenerování, maximálně 800 znaků. Delší text vrátí 400.
Name
model_type
Type
string
výchozí standard
Description
Typ 3D sítě, která se má vygenerovat.
Dostupné hodnoty:
- standard: vysoce detailní 3D síť
- smart-topology: síť Smart Topology. Model zvolíte pomocí ai_model (meshy-t2 nebo meshy-t2.5).
U smart-topology Meshy ignoruje should_remesh a decimation_mode a akceptuje pouze topology: triangle.
Name
ai_model
Type
string
výchozí latest
Description
AI model, který generuje 3D model. Dostupné hodnoty závisí na model_type.
Standardní modely (model_type: standard):
- meshy-6-lite
- meshy-6
- meshy-7.1
- latest: Meshy 7.1
- meshy-7 (zastaralé): odešlete místo toho meshy-7.1
Modely Smart Topology (model_type: smart-topology):
- meshy-t2: čistší topology, nativně oddělené části, triangle výstup a počet ploch, který nastavíte pomocí target_polycount
- meshy-t2.5 (výchozí): ostřejší detail pro herní assety, triangle výstup a počet ploch, který nastavíte pomocí target_polycount
Name
geometry_resolution
Type
string
výchozí standard
Description
Průchod generování geometrie. Platí pouze pro preview úlohy. Refine s tímto parametrem vrátí 400.
Dostupné hodnoty:
- standard
- 2k: spustí Ultra průchod při 2048³
- 4k: spustí Ultra průchod při 4096³, pro jemnější detail povrchu
2k vyžaduje meshy-7.1, latest, nebo zastaralý meshy-7. 4k vyžaduje meshy-7.1 nebo latest. Ostatní modely vrátí 400.
Name
ultra_mode
Type
boolean
⚠ zastaralé
výchozí false
Description
Odešlete místo toho geometry_resolution. ultra_mode: true odpovídá geometry_resolution: "2k".
Name
should_remesh
Type
boolean
výchozí true (meshy-6-lite), false (other models)
Description
Zda model po vygenerování znovu vytvořit síť (remesh). Pro nejvyšší kvalitu 3D modelu odešlete false.

Platí pouze když should_remesh = true

Name
topology
Type
string
výchozí triangle
Description
Typ ploch remeshovaného modelu.
Dostupné hodnoty:
- quad: síť s převahou čtyřúhelníků
- triangle: zredukovaná trojúhelníková síť
Výstup Smart Topology je pouze triangle. Odeslání quad s ai_model meshy-t2 nebo meshy-t2.5 vrátí 400.
Name
decimation_mode
Type
integer
Description
Adaptivní počet ploch podle úrovně. Pokud jej nastavíte, Meshy ignoruje target_polycount.
Dostupné hodnoty:
- 1: ultra
- 2: vysoká
- 3: střední
- 4: nízká

Name
target_polycount
Type
integer
Description
Cílový počet ploch. Výsledek se může od cíle lišit v závislosti na geometrii. Platí ve dvou oddělených případech:
- Remesh: s should_remesh: true u modelu standard. Meshy přetvoří síť (decimuje) na přibližně tento počet. Pokud nastavíte decimation_mode, Meshy jej použije a target_polycount ignoruje.
- Smart Topology: s model_type: smart-topology a ai_model meshy-t2 nebo meshy-t2.5. Meshy vygeneruje model přímo s tímto počtem ploch. Žádný remesh neproběhne a should_remesh není potřeba.
Následující tabulka ukazuje rozsah a výchozí hodnotu pro každý případ:
Případ Rozsah Výchozí hodnota
Remesh 100 až 300000 30000
meshy-t2 100 až 15000 4000
meshy-t2.5 100 až 30000 15000
Hodnota mimo rozsah vrátí 400.

Případ	Rozsah	Výchozí hodnota
Remesh	`100` až `300000`	`30000`
`meshy-t2`	`100` až `15000`	`4000`
`meshy-t2.5`	`100` až `30000`	`15000`

Name
symmetry_mode
Type
string
⚠ zastaralé
výchozí auto
Description
Vynechte jej. Tento parametr neovlivňuje výstup.
Dostupné hodnoty:
- off: vypne symetrii
- auto: použije symetrii na základě vstupní geometrie
- on: vynutí symetrii během generování
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): bez konkrétní pózy
Name
is_a_t_pose
Type
boolean
⚠ zastaralé
výchozí false
Description
Odešlete místo toho pose_mode. Zda model vygenerovat v póze A, nebo v póze T.
Name
art_style
Type
string
⚠ zastaralé
výchozí realistic
Description
Vynechte jej. Meshy jej ignoruje.
Name
moderation
Type
boolean
výchozí false
Description
Zda před generováním zkontrolovat prompt na škodlivý obsah. Pokud Meshy zjistí škodlivý obsah, požadavek vrátí 400 a Meshy úlohu nevytvoří.
Name
target_formats
Type
string[]
Description
Formáty souborů, které se mají vygenerovat. Meshy generuje a vrací pouze tyto formáty, což může úlohu zkrátit. Pokud jej vynecháte, Meshy vygeneruje všechny formáty kromě 3mf, který vygeneruje pouze na vyžádání.
Dostupné hodnoty:
- glb
- obj
- fbx
- stl
- usdz
- 3mf
Name
alpha_thumbnail
Type
boolean
výchozí false
Description
Zda 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
auto_size
Type
boolean
výchozí false
Description
Zda odhadnout reálnou výšku objektu pomocí AI vidění a odpovídajícím způsobem model zvětšit/zmenšit. Meshy umístí počátek na spodní stranu, 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.

Návratové hodnoty

Pole result v odpovědi obsahuje ID nové úlohy Text na 3D.

Režimy selhání

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: Chybí povinný parametr, například prompt nebo mode.
- Příliš dlouhý prompt: prompt překračuje limit počtu znaků.
- Nepodporovaný model pro Ultra: geometry_resolution je 2k nebo 4k s ai_model, který to neumí.
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
429 - Too Many Requests
Description
Překročili jste limit rychlosti. Počkejte a zkuste to znovu. Viz Limity rychlosti.

POST/openapi/v2/text-to-3d

Create a Text to 3D refine task

Vytvoří úkol Text na 3D typu refine, který otexturuje síť dokončeného preview úkolu. Odešlete ID úspěšného preview úkolu jako preview_task_id. Viz Vytvoření úkolu Text na 3D preview. Toto je druhý krok dvoukrokového pracovního postupu.

Úkol běží na pozadí. Jak dlouho úkol obvykle trvá, viz Doby zpracování.

Request

POST

/openapi/v2/text-to-3d

# Basic refine task
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "enable_pbr": true
}'

# Refine with auto-size and GLB format
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "target_formats": ["glb"],
  "auto_size": true
}'

# Refine with Meshy N1 from the preview's stored reference image
curl https://api.meshy.ai/openapi/v2/text-to-3d \
  -H 'Authorization: Bearer ${YOUR_API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "mode": "refine",
  "preview_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "ai_model": "meshy-n1"
}'

Response

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

Parametry

Name
mode
Type
string
Povinné
Description
Krok dvoukrokového pracovního postupu. Pro vytvoření refine úkolu odešlete refine.
Name
preview_task_id
Type
string
Povinné
Description
ID preview úkolu, který se má otexturovat. Preview úkol musí mít stav SUCCEEDED.
Name
enable_pbr
Type
boolean
výchozí false
Description
Zda se mají spolu se základní barvou vygenerovat i PBR mapy (metallic, roughness a normal).
S ai_model meshy-6 Meshy také vygeneruje emission mapu, kromě případu texture_resolution: 8k. meshy-6-lite, meshy-7, meshy-7.1 a latest emission mapu negenerují. Nevygeneruje ji ani refine preview meshy-t2 nebo meshy-t2.5, který nenastavuje ai_model. S ai_model: meshy-n1 vrátí true chybu 400.
Name
texture_resolution
Type
string
výchozí 2k
Description
Rozlišení textury základní barvy. Platí pouze pro refine úkoly. Pokud tento parametr odešlete u preview, vrátí se 400.
Dostupné hodnoty:
- 2k: 2048×2048
- 4k: 4096×4096
- 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. S meshy-n1 vrátí 400. Při 8k Meshy negeneruje emission 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 obě, Meshy použije texture_resolution.
Name
texture_prompt
Type
string
Description
Text, který řídí texturování, až 800 znaků. Delší text vrátí 400. Odešlete buď texture_prompt, nebo texture_image_url, ne obojí. Pokud odešlete obojí, Meshy použije texture_prompt. S ai_model: meshy-n1 jeho odeslání vrátí 400.
Name
texture_image_url
Type
string
Description
2D obrázek, který řídí texturování, jako veřejná URL adresa nebo base64 kódovaná data URI, například data:image/jpeg;base64,<vaše base64 kódovaná obrazová data>.
Obrázek musí být soubor .jpg, .jpeg, .png nebo .webp o velikosti nejvýše 20 MB, s nejméně 32 pixely na každé straně a nejvýše 178 956 970 pixely (šířka × výška).
S ai_model: meshy-n1 Meshy otexturuje podle tohoto obrázku jako pohled zepředu.
Texturování z obrázku nemusí fungovat dobře, pokud se tvar na obrázku výrazně liší od modelu.
Name
ai_model
Type
string
výchozí inherited from the preview task
Description
AI model, který otexturuje síť.
Dostupné hodnoty:
- meshy-6-lite
- meshy-6
- meshy-7.1
- latest: Meshy 7.1
- meshy-n1: 2K textura základní barvy pouze z referenčního obrázku. Bez textového promptu, bez PBR map, bez 4K nebo 8K.
- meshy-7 (zastaralé): místo toho odešlete meshy-7.1
Ponechte prázdné, pokud chcete použít model preview úkolu, aby preview a jeho refine běžely od začátku do konce na stejném modelu. Odesláním hodnoty jej přepíšete. Explicitní latest se vyhodnocuje stejně jako u preview úkolu, takže preview latest a jeho refine latest vždy používají stejný texturovací model.
S meshy-n1 Meshy texturuje z texture_image_url. Bez něj Meshy použije referenční obrázek, který uložil preview meshy-7.1 nebo latest. Jakýkoli jiný preview vrátí 400, pokud neodešlete texture_image_url. Preview může mít nejvýše 7 999 999 trojúhelníků. Preview přepočítaný na síť (remesh) na čtyřúhelníky vrátí 400.
Name
moderation
Type
boolean
výchozí false
Description
Zda se má texture_prompt a texture_image_url před generováním prověřit na škodlivý obsah. Pokud Meshy detekuje škodlivý obsah, požadavek vrátí 400 a Meshy úkol nevytvoří.
Name
remove_lighting
Type
boolean
výchozí true
Description
Zda se mají z textury základní barvy odstranit zvýraznění a stíny. Čistší výsledek funguje lépe při vlastním osvětlení.
Má účinek pouze pokud je ai_model nastaven na meshy-6. meshy-7.1 a latest tento parametr akceptují, ale ignorují, stejně jako refine preview meshy-t2 nebo meshy-t2.5, který nenastavuje ai_model. Odeslání s meshy-6-lite vrátí 400. S meshy-n1 vrátí true chybu 400.
Name
target_formats
Type
string[]
Description
Souborové formáty, které se mají vygenerovat. Meshy generuje a vrací pouze tyto formáty, což může zkrátit dobu trvání úkolu. Pokud jej vynecháte, Meshy vygeneruje všechny formáty kromě 3mf, který vygeneruje pouze pokud jej vyžádáte.
Dostupné hodnoty:
- glb
- obj
- fbx
- stl
- usdz
- 3mf
Name
alpha_thumbnail
Type
boolean
výchozí false
Description
Zda se má také vykreslit náhled s průhledným pozadím (RGBA), vrácený v alpha_thumbnail_url při získání úkolu. thumbnail_url se nezmění.
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í změnit velikost. Meshy umístí počátek na spodek, 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.

Návratové hodnoty

Pole result v odpovědi obsahuje ID nového úkolu Text na 3D.

Způsoby selhání

Name
400 - Bad Request
Description
Požadavek nelze spustit. Chybová zpráva uvádí, jaký problém byl zjištěn. Například:
- Neplatné ID úkolu: preview_task_id je neplatné nebo neodpovídá žádnému z vašich preview úkolů.
- Úkol není připraven: Preview úkol ještě neskončil úspěchem.
- Nesoulad modelů: AI model preview úkolu nefunguje s požadovaným refine modelem.
- Nepodporovaný model pro remove_lighting: remove_lighting bylo odesláno s ai_model: "meshy-6-lite".
- Žádný referenční obrázek pro Meshy N1: ai_model: meshy-n1 bylo odesláno bez texture_image_url a preview nemá žádný referenční obrázek, který by Meshy N1 mohl použít. Odešlete texture_image_url.
- Preview se čtyřúhelníkovou sítí pro Meshy N1: ai_model: meshy-n1 bylo odesláno pro preview přepočítaný (remesh) na čtyřúhelníky. Proveďte refine s jiným ai_model.
- Příliš mnoho trojúhelníků pro Meshy N1: S ai_model: meshy-n1 má preview více než 7 999 999 trojúhelníků. Proveďte refine s jiným ai_model.
- Nepodporovaná možnost pro Meshy N1: ai_model: meshy-n1 bylo odesláno s jednou z těchto možností:
  - texture_prompt
  - enable_pbr: true
  - texture_resolution typu 4k nebo 8k
  - hd_texture: true bez texture_resolution
  - remove_lighting: true
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 tento úkol, nebo účet dosáhl limitu kreditů. Zkontrolujte svůj zůstatek kreditů a zkuste to znovu.
- Bezplatný plán: Vytvoření úkolu 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
429 - Too Many Requests
Description
Překročili jste limit rychlosti. Počkejte a zkuste to znovu. Viz Limity rychlosti.

GET/openapi/v2/text-to-3d/:id

Získání úlohy Text na 3D

Vrátí úlohu Text na 3D podle jejího ID. Funguje jak pro úlohy preview, tak pro úlohy refine.

Request

GET

/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

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

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-3d-preview",
  "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=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?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=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "prompt": "a monster mask",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
    }
  ],
  "preceding_tasks": 0,
  "task_error": null,

  "consumed_credits": 20
}

Parametry

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

Návratová hodnota

Objekt úlohy Text na 3D.

Příklady

Následující tabulka zobrazuje ukázkový model pro každý mode.

Mode	Ukázkový model
Preview
Refine

DELETE/openapi/v2/text-to-3d/:id

Smazání úlohy Text na 3D

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

Request

DELETE

/openapi/v2/text-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v2/text-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 dál běží. 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ž dosáhne stavu SUCCEEDED, FAILED nebo CANCELED, a poté ji smažte.

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

Návratové hodnoty

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

GET/openapi/v2/text-to-3d

Seznam úloh Text na 3D

Vrátí seznam vašich úloh Text na 3D.

Request

GET

/openapi/v2/text-to-3d

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

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "text-to-3d-preview",
    "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=***",
      "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "prompt": "a monster mask",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***"
      }
    ],
    "preceding_tasks": 0,
    "task_error": null,

    "consumed_credits": 20
  }
]

Parametry

Name
page_num
Type
integer
výchozí 1
Description
Číslo stránky, kterou chcete vrátit, až do hodnoty 255. Vyšší hodnota vrátí 400.
Name
page_size
Type
integer
výchozí 10
Description
Počet úloh na stránku, až do hodnoty 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ů úlohy Text na 3D.

GET/openapi/v2/text-to-3d/:id/stream

Stream úlohy Text na 3D

Streamuje aktualizace úlohy Text na 3D formou Server-Sent Events (SSE).

Request

GET

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

curl -N https://api.meshy.ai/openapi/v2/text-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",
  "progress": 50,
  "status": "IN_PROGRESS"
}

event: message
data: {
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "text-to-3d-preview",
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1692771650657,
"started_at": 1692771667037,
"finished_at": 1692771669037,
"model_urls": {
  "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***"
},
"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": null,

"consumed_credits": 20
}

Parametry

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

Návratová hodnota

Stream objektů úlohy Text na 3D formou Server-Sent Events.

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

Objekt úlohy Text na 3D

Objekt úlohy Text na 3D popisuje jednu úlohu, která generuje 3D model z textového promptu. Obsahuje stav, progress a soubory modelu, pokud úloha uspěje. Text na 3D má dvě fáze, preview a refine. Úloha preview vygeneruje 3D model obsahující pouze síť a úloha refine vygeneruje texturovaný 3D model z výsledku preview.

Vlastnosti

Example Text to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "text-to-3d-preview",
  "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=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.mtl?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***"
  },
  "prompt": "a monster mask",
  "texture_prompt": "green slimy skin with scales and warts",
  "texture_image_url": "",
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "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": null,

  "consumed_credits": 20
}

Name
id
Type
string
Description
ID úlohy. Považujte ho za neprůhledný řetězec a nespoléhejte na jeho formát.
Name
type
Type
string
Description
Typ úlohy, text-to-3d-preview pro úlohu preview nebo text-to-3d-refine pro úlohu refine.
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
  usdz
  Type
  string
  Description
  Soubor USDZ.
- Name
  obj
  Type
  string
  Description
  Soubor OBJ.
- Name
  mtl
  Type
  string
  Description
  Soubor MTL.
- Name
  stl
  Type
  string
  Description
  Soubor STL.
- Name
  3mf
  Type
  string
  Description
  Soubor 3MF. Přítomný pouze pokud target_formats obsahuje 3mf.
Name
prompt
Type
string
Description
prompt, který jste odeslali při vytvoření úlohy, beze změny.
Name
texture_prompt
Type
string
Description
Textový prompt, který jste odeslali k řízení texturování ve fázi refine.
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 preview běžela, 2k nebo 4k. Pole chybí pro standard.
Name
texture_image_url
Type
string
Description
Odkaz ke stažení obrázku, který jste odeslali k řízení texturování.
Name
thumbnail_url
Type
string
Description
Odkaz ke stažení miniatury 3D modelu.
Name
alpha_thumbnail_url
Type
string
Description
Odkaz ke stažení verze thumbnail_url s průhledným pozadím (RGBA). Přítomné pouze pokud jste úlohu vytvořili s alpha_thumbnail: true a Meshy vykreslilo průhlednou ukázku.
Name
progress
Type
integer
Description
Jak velká část úlohy je hotová, 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 Unix. Je 0, dokud úloha nezačne.
Name
created_at
Type
timestamp
Description
Čas vytvoření úlohy v milisekundách Unix.
Name
finished_at
Type
timestamp
Description
Čas dokončení úlohy v milisekundách Unix. 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í vygenerovaných texturových map, 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 kovovosti. Chybí, pokud jste úlohu vytvořili s enable_pbr: false.
- Name
  normal
  Type
  string
  Description
  Normálová mapa. Chybí, pokud jste úlohu vytvořili s enable_pbr: false.
- Name
  roughness
  Type
  string
  Description
  Mapa drsnosti. Chybí, pokud jste úlohu vytvořili s enable_pbr: false.
- Name
  emission
  Type
  string
  Description
  Mapa emise. Chybí v kterémkoli z těchto případů:
  
  Úlohu jste vytvořili s enable_pbr: false.
  
  ai_model je meshy-6-lite, meshy-7, meshy-7.1 nebo latest.
  
  texture_resolution je 8k.
  
  Úloha refinuje preview meshy-t2 nebo meshy-t2.5 bez nastavení ai_model.
Name
preceding_tasks
Type
integer
Description
Počet úloh před touto úlohou ve frontě. Hodnota má smysl pouze dokud je úloha PENDING.
Name
task_error
Type
object
Description
Podrobnosti chyby, 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řítomné, pokud je stav PENDING, IN_PROGRESS nebo SUCCEEDED. U úlohy FAILED je 0, protože Meshy vrací kredity, pokud úloha selže.