Creative Lab Figure API

Proměňte fotografii ve dvou krocích na sběratelskou 3D figurku ve stylu chibi. Úkol prototypu vygeneruje z fotografie koncepční obrázek. Úkol sestavení pak tento obrázek přemění na texturovaný 3D model a jako input_task_id používá ID úkolu prototypu.

POST /openapi/creative-lab/figure/v1/prototype
POST /openapi/creative-lab/figure/v1/build

POST/openapi/creative-lab/figure/v1/prototype

Vytvoření úlohy prototypu figurky

Vygeneruje jeden koncepční obrázek ve stylu chibi z fotografie. Pro sestavení 3D modelu předejte ID této úlohy do build endpointu jako input_task_id. Popis polí úlohy najdete v části Objekt úlohy prototypu figurky.

Request

POST

/openapi/creative-lab/figure/v1/prototype

# Stage 1: generate a chibi-style concept image
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/prototype \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>"
  }'

Response

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

Příklad prototypu

Začněte se zdrojovým portrétem a poté vygenerujte obrázek prototypu použitý ve fázi sestavení.

Zdrojový portrét použitý jako vstup funkce Creative Lab Figure — Vstup prototypu

Obrázek prototypu figurky ve stylu chibi vygenerovaný ze zdrojové fotografie — Výstup prototypu

Parametry

Name
image_url
Type
string
Povinné
Description
Fotografie, která se má přeměnit na figurku chibi, zadaná jako veřejná URL adresa nebo Data URI (data:image/jpeg;base64,<vaše base64 zakódovaná data obrázku>).
Obrázek musí být soubor JPG, JPEG, PNG nebo WebP o velikosti nejvýše 20 MB.
Name
name
Type
string
Description
Název úlohy, maximálně 100 znaků. Vrací se v poli name úlohy. Delší název vrátí 400.
Name
remove_background
Type
boolean
výchozí false
Description
Zda se má z obrázku prototypu odstranit pozadí. true vrátí transparentní RGBA PNG, takže můžete umístit subjekt na libovolné pozadí. Sestavení také začíná z obrázku bez pozadí. Pokud Meshy nedokáže pozadí odstranit, vrátí obrázek s pozadím a úloha přesto skončí úspěchem.

Návratové hodnoty

Pole result obsahuje ID nové úlohy prototypu. Získejte úlohu nebo ji streamujte, dokud status nebude SUCCEEDED. Poté předejte ID do build endpointu jako input_task_id.

Způsoby selhání

Name
400 - Bad Request
Description
Požadavek nelze spustit. Například:
- Chybí image_url.
- Obrázek není soubor JPG, JPEG, PNG ani WebP.
- Obrázek je příliš malý, přesahuje 20 MB nebo přesahuje maximální počet pixelů.
- Meshy nemůže obrázek stáhnout, například protože URL adresa vrací 404 nebo vyprší časový limit.
- Data URI není platné base64.
- Obrázek byl označen jako NSFW.
Chybová zpráva uvádí, jaký problém byl zjištěn. Opravte požadavek a odešlete jej znovu.
Name
401 - Unauthorized
Description
API klíč chybí nebo je neplatný. Zkontrolujte hlavičku Authorization.
Name
402 - Payment Required
Description
Platí jedno z následujícího:
- Účet nemá dostatek kreditů.
- API klíč, pracovní prostor nebo člen dosáhl svého limitu kreditů.
- Účet má bezplatný plán.
Zkontrolujte své kredity a plán a poté to zkuste znovu.
Name
403 - Forbidden
Description
Váš tým má zapnuté filtrování IP adres a Meshy obrázek označilo jako obsahující duševní vlastnictví třetí strany. Odešlete obrázek, ke kterému máte práva k použití.
Name
429 - Too Many Requests
Description
Byl dosažen jeden z těchto limitů:
- Odeslali jste více požadavků, než povoluje váš limit rychlosti. Počkejte několik sekund a zkuste to znovu. Viz Limity rychlosti.
- Příliš mnoho vašich úloh čeká ve frontě nebo probíhá. Počkejte, až se některé dokončí, a zkuste to znovu.
- V neomezeném plánu bez zbývajících kreditů jste dosáhli počtu úloh, které lze spustit bez kreditů. Počkejte na dokončení úlohy nebo přidejte kredity.
Name
500 - Internal Server Error
Description
Meshy narazilo na chybu serveru, například proto, že nemohlo u obrázku provést kontrolu duševního vlastnictví. Meshy úlohu nevytvoří a vrátí veškeré účtované kredity. Zkuste požadavek odeslat znovu.

POST/openapi/creative-lab/figure/v1/build

Vytvoření úlohy sestavení figurky

Vygeneruje texturovanou 3D figurku z úspěšně dokončené úlohy prototypu. Popis jejích polí najdete v objektu úlohy sestavení figurky.

Request

POST

/openapi/creative-lab/figure/v1/build

# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578"
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}

Příklad sestavení

Úloha sestavení převede vybraný obrázek prototypu na stažitelný texturovaný 3D model.

Náhled modelu sestavení figurky Creative Lab — Náhled modelu sestavení

Parametry

Name
input_task_id
Type
string
Povinné
Description
ID úlohy prototypu, která se má sestavit. Musí jít o úlohu vytvořenou vaším účtem pomocí POST /openapi/creative-lab/figure/v1/prototype, se stavem SUCCEEDED.
ID, které neodpovídá žádné z vašich úloh prototypu Figure z API, vrátí 404, včetně prototypu vytvořeného ve webové aplikaci.
Name
name
Type
string
Description
Název úlohy, maximálně 100 znaků. Vrací se v poli name úlohy. Delší název vrátí 400.

Návratové hodnoty

Pole result obsahuje ID nové úlohy sestavení. Získejte úlohu nebo streamujte ji, dokud status nebude SUCCEEDED. Poté stáhněte texturovaný GLB z model_urls.glb. Pro OBJ místo toho stáhněte model_urls.obj spolu se souborem materiálu z model_urls.mtl.

Způsoby selhání

Name
400 - Bad Request
Description
Požadavek nelze spustit. Například:
- input_task_id chybí nebo není platné ID úlohy.
- Stav úlohy prototypu není SUCCEEDED. Pokud stále běží, počkejte a zkuste to znovu. Pokud selhala nebo byla zrušena, vytvořte novou úlohu prototypu.
- Úloha prototypu byla úspěšná, ale neobsahuje žádný obrázek. Vytvořte novou úlohu prototypu.
Chybová zpráva uvádí, jaký problém byl zjištěn.
Name
401 - Unauthorized
Description
API klíč chybí nebo je neplatný. Zkontrolujte hlavičku Authorization.
Name
402 - Payment Required
Description
Platí jedno z následujícího:
- Účet nemá dostatek kreditů.
- API klíč, pracovní prostor nebo člen dosáhl svého limitu kreditů.
- Účet je na bezplatném plánu.
Zkontrolujte své kredity a plán a poté to zkuste znovu.
Name
404 - Not Found
Description
input_task_id neodpovídá žádné úloze prototypu Figure, kterou váš účet vytvořil přes API. Prototyp vytvořený ve webové aplikaci také vrátí 404. Odešlete ID result z odpovědi na vytvoření prototypu.
Name
429 - Too Many Requests
Description
Byl dosažen jeden z těchto limitů:
- Odeslali jste více požadavků, než povoluje váš limit rychlosti. Počkejte několik sekund a zkuste to znovu. Viz Limity rychlosti.
- Příliš mnoho vašich úloh čeká ve frontě nebo běží. Počkejte, až se některé dokončí, a zkuste to znovu.
- Pokud máte neomezený plán bez zbývajících kreditů, dosáhli jste počtu úloh, které mohou běžet bez kreditů. Počkejte na dokončení úlohy nebo přidejte kredity.

GET/openapi/creative-lab/figure/v1/(prototype|build)/:id

Získání úlohy figurky

Vrací úlohu typu prototype nebo build. Cesta musí odpovídat fázi úlohy. Build úloha vyžádaná přes /prototype/:id vrátí 404, stejně tak prototype úloha vyžádaná přes /build/:id.

Popis polí najdete v sekcích Objekt prototype úlohy figurky a Objekt build úlohy figurky.

Request

GET

/openapi/creative-lab/figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578

# Prototype
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-figure-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ],
  "remove_lighting": true
}

Parametry

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

Návratová hodnota

Objekt prototype úlohy nebo objekt build úlohy, podle fáze uvedené v cestě.

Chybové stavy

Name
400 - Bad Request
Description
id není platné ID úlohy. Odešlete ID result z odpovědi na vytvoření.
Name
403 - Forbidden
Description
Váš tým má zapnutou funkci IP Filtering a Meshy označilo obrázek úlohy jako obsah porušující práva duševního vlastnictví třetí strany. Týmy s plánem Enterprise tuto chybu nedostávají. Vytvořte prototype úlohu z obrázku, ke kterému máte práva k užití.
Name
404 - Not Found
Description
Úloha figurky s tímto ID nepatří k vašemu účtu, nebo fáze úlohy neodpovídá cestě. Zkontrolujte ID a použijte /prototype nebo /build podle typu úlohy.
Name
500 - Internal Server Error
Description
Meshy nemohlo provést kontrolu duševního vlastnictví. Zkuste požadavek odeslat znovu.

DELETE/openapi/creative-lab/figure/v1/(prototype|build)/:id

Zrušení úlohy Figure

Zruší úlohu Figure. Zrušení úlohy ve stavu PENDING vrátí její kredity. Úloha ve stavu IN_PROGRESS je zrušena bez refundace, protože ji worker už začal zpracovávat. Úlohu s konečným stavem (SUCCEEDED, FAILED nebo CANCELED) nelze zrušit.

Cesta musí odpovídat fázi úlohy. Například DELETE na /prototype/:id s ID úlohy typu build vrátí 404.

Request

DELETE

/openapi/creative-lab/figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578

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

Response

// Returns 204 No Content on success (empty body).

Parametry cesty

Name
id
Type
path
Description
ID úlohy, kterou chcete zrušit.

Návratová hodnota

204 No Content s prázdným tělem.

Chybové stavy

Name
400 - Bad Request
Description
Platí jedna z následujících podmínek:
- id není platné ID úlohy. Odešlete ID result z odpovědi na vytvoření.
- Úloha už má konečný stav (SUCCEEDED, FAILED nebo CANCELED), takže ji nelze zrušit.
Name
404 - Not Found
Description
Pod tímto ID neexistuje žádná úloha Figure patřící k vašemu účtu, nebo fáze úlohy neodpovídá cestě. Zkontrolujte ID a použijte /prototype nebo /build podle toho, které odpovídá úloze.

GET/openapi/creative-lab/figure/v1/(prototype|build)/:id/stream

Streamování úlohy figurky

Streamuje aktualizace úlohy figurky jako Server-Sent Events (SSE). Cesta musí odpovídat fázi úlohy. Pokud neodpovídá, například ID úlohy sestavení (build) na /prototype/:id/stream, stream odešle jednu událost error se status_code: 404 a uzavře se.

Request

GET

/openapi/creative-lab/figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream

curl -N https://api.meshy.ai/openapi/creative-lab/figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example (wrong stage or task not found)
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// Every frame is the full task object; fields not yet populated are null / empty.
// The following PENDING frame is shortened to the fields that change.
event: message
data: {
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-figure-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ],
  "remove_lighting": true
}

Parametry

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

Návratová hodnota

Stream objektů úlohy prototype nebo build. Každá událost obsahuje celý objekt úlohy, tak jak jej vrací Získání úlohy figurky. Dokud je úloha ve stavu PENDING nebo IN_PROGRESS, jsou její výstupní pole stále prázdná (null, [] nebo {}) a finished_at je null.

Pokud IP Filtering zablokuje výsledek úlohy, stream místo toho odešle jednu událost error s hodnotou status_code, kterou by vrátil požadavek typu get.

GET/openapi/creative-lab/figure/v1/(prototype|build)

Seznam úloh Figure

Vrátí vaše úlohy figurka pro jednu fázi, vždy jednu stránku. Cesta určuje fázi. /prototype vrací pouze úlohy prototypu a /build vrací pouze úlohy sestavení.

Request

GET

/openapi/creative-lab/figure/v1/prototype

# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/prototype?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/build?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-figure-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729123456000,
    "started_at": 1729123460000,
    "finished_at": 1729123486000,
    "expires_at": 1729382686000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "image_urls": [
      "https://assets.meshy.ai/***/concept.png?Expires=***"
    ]
  }
]

Parametry cesty

Name
stage
Type
path
Povinné
Description
Fáze, kterou chcete vypsat, prototype nebo build.

Parametry dotazu

Name
page_num
Type
integer
výchozí 1
Description
Stránka, která se má vrátit, od 1 do 255. 0 vrátí první stránku. Hodnota mimo rozsah 0 až 255 vrátí 400.
Name
page_size
Type
integer
výchozí 10
Description
Počet úloh na stránku, maximálně 100. Hodnota od 101 do 255 vrátí 100 úloh a 0 použije výchozí hodnotu. Hodnota mimo rozsah 0 až 255 vrátí 400.
Name
sort_by
Type
string
výchozí -created_at
Description
Pořadí řazení.
Dostupné hodnoty:
- -created_at: nejnovější první
- +created_at: nejstarší první

Návratová hodnota

Pole objektů úlohy prototypu nebo objektů úlohy sestavení, odpovídající fázi uvedené v cestě.

Objekt úkolu prototypu figurky

Úkol prototypu vygeneruje z fotografie koncepční obrázek ve stylu chibi. Chcete-li obrázek přeměnit na 3D model, předejte ID úkolu koncovému bodu pro sestavení jako input_task_id.

Vlastnosti

Example Figure Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-figure-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123456000,
  "started_at": 1729123460000,
  "finished_at": 1729123486000,
  "expires_at": 1729382686000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Name
id
Type
string
Description
ID úkolu. Nespoléhejte na jeho formát.
Name
type
Type
string
Description
Typ úkolu, vždy creative-lab-figure-prototype.
Name
name
Type
string
Description
name, který jste odeslali při vytvoření úkolu, nebo "", pokud jste žádný neodeslali.
Name
status
Type
string
Description
Stav úkolu.
Dostupné hodnoty:
- PENDING: čeká ve frontě
- IN_PROGRESS: generuje se výsledek
- SUCCEEDED: konečný stav, s výsledkem
- FAILED: konečný stav, s důvodem v task_error
- CANCELED: konečný stav, bez výsledku
Name
progress
Type
integer
Description
Procento hotové práce, od 0 do 100. Je 0, dokud úkol nezačne, a 100, když uspěje.
Name
created_at
Type
timestamp
Description
Čas vytvoření úkolu, v Unix milisekundách.
Name
started_at
Type
timestamp
Description
Čas, kdy pracovní proces úkol zahájil, v Unix milisekundách. Do té doby null.
Name
finished_at
Type
timestamp
Description
Čas, kdy úkol dosáhl konečného stavu, v Unix milisekundách. Do té doby null.
Name
expires_at
Type
timestamp
Description
Čas, kdy vyprší platnost výsledku úkolu, v Unix milisekundách. Je to 3 dny po finished_at, nebo 3 dny po created_at, dokud úkol neskončí. U podnikových (Enterprise) účtů, které uchovávají výsledky API neomezeně dlouho, je to přibližně o 100 let později. Viz Uchování assetů.
Name
preceding_tasks
Type
integer
Description
Pozice úkolu ve frontě, dokud je PENDING. 1 znamená, že začne jako další. 0 poté, co úkol opustí frontu, a vždy 0 ve výsledcích seznamu.
Name
task_error
Type
object
Description
Důvod, proč úkol selhal. null, pokud status není FAILED. Viz Chyby.
Name
consumed_credits
Type
integer
Description
Počet kreditů účtovaných za úkol, po případném vrácení. Požadavek, který vrátí chybu, se neúčtuje. Neúspěšný úkol má hodnotu 0, protože Meshy jej vrátí. Zrušení vrátí kredity za úkol pouze tehdy, je-li ve stavu PENDING. Pokud Meshy nedokáže přečíst účtovanou částku, odpověď typu get nebo stream toto pole vynechá a požadavek na seznam vrátí 500. V takovém případě požadavek zopakujte.
Name
image_urls
Type
array of strings
Description
Odkazy ke stažení koncepčního obrázku. Pole obsahuje jednu URL adresu po úspěšném dokončení úkolu a do té doby je prázdné.

Objekt úlohy sestavení figurky

Úloha sestavení vygeneruje texturovanou 3D figurku z úspěšně dokončené úlohy prototypu. Pole model_urls, thumbnail_url a texture_urls mají stejný formát jako v objektu úlohy Obrázek na 3D.

Vlastnosti

Example Figure Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-figure-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ],
  "remove_lighting": true
}

Name
id
Type
string
Description
ID úlohy. Nespoléhejte na jeho formát.
Name
type
Type
string
Description
Typ úlohy, vždy creative-lab-figure-build.
Name
name
Type
string
Description
Hodnota name, kterou jste odeslali při vytvoření úlohy, nebo "", pokud jste ji neodeslali.
Name
status
Type
string
Description
Stav úlohy.
Dostupné hodnoty:
- PENDING: čeká ve frontě
- IN_PROGRESS: probíhá generování výsledku
- SUCCEEDED: konečný stav, s výsledkem
- FAILED: konečný stav, s důvodem v task_error
- CANCELED: konečný stav, bez výsledku
Name
progress
Type
integer
Description
Procento dokončené práce, od 0 do 100. Je 0, dokud úloha nezačne, a 100, když je úspěšně dokončena.
Name
created_at
Type
timestamp
Description
Čas vytvoření úlohy, v milisekundách unixového času.
Name
started_at
Type
timestamp
Description
Čas, kdy worker úlohu spustil, v milisekundách unixového času. Do té doby null.
Name
finished_at
Type
timestamp
Description
Čas, kdy úloha dosáhla konečného stavu, v milisekundách unixového času. Do té doby null.
Name
expires_at
Type
timestamp
Description
Čas, kdy vyprší platnost výsledku úlohy, v milisekundách unixového času. Je to 3 dny po finished_at, nebo 3 dny po created_at, dokud úloha neskončí. U Enterprise účtů, které uchovávají výsledky API neomezeně dlouho, je to přibližně o 100 let později. Viz Uchování assetů.
Name
preceding_tasks
Type
integer
Description
Pozice úlohy ve frontě, zatímco je PENDING. 1 znamená, že je na řadě jako další. 0 poté, co úloha opustí frontu, a vždy 0 ve výsledcích seznamu.
Name
task_error
Type
object
Description
Důvod selhání úlohy. null, pokud status není FAILED. Viz Chyby.
Name
consumed_credits
Type
integer
Description
Počet kreditů účtovaných za úlohu, po případném vrácení. Požadavek, který vrátí chybu, se neúčtuje. Neúspěšná úloha má hodnotu 0, protože Meshy ji vrátí. Zrušení vrátí kredity za úlohu pouze tehdy, je-li ve stavu PENDING. Pokud Meshy nedokáže zjistit účtovanou částku, odpověď get nebo stream pole vynechá a požadavek na seznam vrátí 500. V takovém případě požadavek zopakujte.
Name
prompt
Type
string
Description
U úlohy sestavení figurky vždy "".
Name
negative_prompt
Type
string
Description
U úlohy sestavení figurky vždy "", stejně jako prompt.
Name
texture_prompt
Type
string
Description
U úlohy sestavení figurky vždy "", stejně jako prompt.
Name
texture_image_url
Type
string
Description
U úlohy sestavení figurky vždy "", stejně jako prompt.
Name
model_urls
Type
object
Description
Adresy URL ke stažení 3D modelu, jako texturovaný GLB a jako soubor OBJ s jeho souborem MTL.
- Name
  glb
  Type
  string
  Description
  Adresa URL ke stažení texturovaného souboru GLB.
- Name
  obj
  Type
  string
  Description
  Adresa URL ke stažení souboru OBJ, s geometrií a UV souřadnicemi.
- Name
  mtl
  Type
  string
  Description
  Adresa URL ke stažení souboru materiálu MTL, který patří k obj. Použijte ji společně s obj a texturou v texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
Adresa URL ke stažení náhledového obrázku modelu.
Name
texture_urls
Type
array
Description
Textury, jako pole s jedním objektem obsahujícím mapu základní barvy.
- Name
  base_color
  Type
  string
  Description
  Adresa URL ke stažení mapy základní barvy.
Name
remove_lighting
Type
boolean
Description
Zda Meshy odstranilo odlesky a stíny z textury základní barvy.