Creative Lab Brick Figure API

Proměňte fotografii ve sběratelskou 3D minifigurku ve stylu z kostiček ve dvou fázích. Úloha prototypu vygeneruje z fotografie koncepční obrázek. Sestavovací úloha pak tento obrázek přemění na texturovaný 3D model a jako input_task_id používá ID úlohy prototypu.

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

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

Vytvoření úkolu prototypu figurky z kostek

Vygeneruje jeden koncepční obrázek ve stylu kostek z fotografie. Pro sestavení 3D modelu předejte ID tohoto úkolu do koncového bodu pro sestavení jako input_task_id. Informace o polích úkolu najdete v části Objekt úkolu prototypu figurky z kostek.

Request

POST

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

# Stage 1: generate a brick-style concept image
curl https://api.meshy.ai/openapi/creative-lab/brick-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"
}

Parametry

Name
image_url
Type
string
Povinné
Description
Fotografie, kterou chcete přeměnit na minifigurku z kostek, jako veřejná URL adresa nebo data URI (data:image/jpeg;base64,<vaše data obrázku zakódovaná v base64>).
Obrázek musí být soubor JPG, JPEG, PNG nebo WebP o velikosti maximálně 20 MB.
Name
name
Type
string
Description
Název úkolu, maximálně 100 znaků. Vrací se v poli name úkolu. Delší název vrátí 400.
Name
remove_background
Type
boolean
výchozí false
Description
Zda odstranit pozadí z prototypového obrázku. true vrátí průhledný RGBA PNG, takže subjekt můžete umístit na jakékoli pozadí. Sestavení také vychází z obrázku bez pozadí. Pokud Meshy nemůže odstranit pozadí, vrátí obrázek s jeho pozadím a úkol přesto uspěje.

Návratová hodnota

Pole result obsahuje ID nového úkolu prototypu. Získejte úkol nebo streamujte jej, dokud status nenabude hodnoty SUCCEEDED. Poté předejte ID do koncového bodu pro sestavení 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 nebo WebP.
- Obrázek je příliš malý, větší než 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é v kódování base64.
- Obrázek byl označen jako nevhodný (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í jedna z následujících možností:
- Úč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, poté akci zopakujte.
Name
403 - Forbidden
Description
Váš tým má zapnuté IP Filtering a Meshy označilo obrázek kvůli duševnímu 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 akci zopakujte. Viz Limity rychlosti.
- Příliš mnoho vašich úkolů čeká ve frontě nebo běží. Počkejte, až se některé dokončí, a akci zopakujte.
- V neomezeném plánu bez zbývajících kreditů jste dosáhli počtu úkolů, které mohou běžet bez kreditů. Počkejte na dokončení úkolu, nebo přidejte kredity.
Name
500 - Internal Server Error
Description
Meshy narazilo na chybu serveru, například proto, že nemohlo spustit kontrolu duševního vlastnictví na obrázku. Meshy úkol nevytvoří a vrátí veškeré účtované kredity. Odešlete požadavek znovu.

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

Vytvoření úlohy sestavení figurky Brick Figure

Vygeneruje texturovanou 3D minifigurku z úspěšně dokončené úlohy prototypu. Popis polí najdete v části Objekt úlohy sestavení Brick Figure.

Request

POST

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

# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/brick-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"
}

Parametry

Name
input_task_id
Type
string
Povinné
Description
ID úlohy prototypu, která se má sestavit. Musí se jednat o úlohu vytvořenou vaším účtem pomocí POST /openapi/creative-lab/brick-figure/v1/prototype se stavem SUCCEEDED.
ID, které neodpovídá žádné z vašich úloh prototypu Brick Figure z API, vrátí 404, včetně prototypu vytvořeného ve webové aplikaci.
Name
name
Type
string
Description
Název úlohy, až 100 znaků. Vrátí 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 soubor z model_urls.glb. Pokud místo toho chcete OBJ, stáhněte model_urls.obj společně s jeho souborem materiálu z model_urls.mtl.

Režimy 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 má bezplatný plán.
Zkontrolujte své kredity a plán a poté akci zopakujte.
Name
404 - Not Found
Description
input_task_id neodpovídá žádné úloze prototypu Brick Figure, kterou váš účet vytvořil pomocí API. Prototyp vytvořený ve webové aplikaci rovněž 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 poté akci zopakujte.
- V neomezeném plánu bez zbývajících kreditů jste dosáhli počtu úloh, které mohou běžet bez kreditů. Počkejte na dokončení úlohy nebo přidejte kredity.

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

Získání úlohy Brick Figure

Vrací úlohu typu prototype nebo build. Cesta musí odpovídat fázi úlohy. Úloha typu build vyžádaná přes /prototype/:id vrátí 404, a totéž platí pro úlohu typu prototype vyžádanou přes /build/:id.

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

Request

GET

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

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

# Build
curl https://api.meshy.ai/openapi/creative-lab/brick-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-brick-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-brick-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=***"
    }
  ]
}

Parametry

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

Návratová hodnota

Objekt úlohy prototype nebo objekt úlohy build, 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á zapnuté IP Filtering a Meshy označilo obrázek úlohy jako obsahující duševní vlastnictví třetí strany. Týmy s plánem Enterprise tuto chybu nedostávají. Vytvořte úlohu prototype z obrázku, ke kterému máte práva k užívání.
Name
404 - Not Found
Description
K vašemu účtu nepatří žádná úloha Brick Figure s tímto ID, nebo fáze úlohy neodpovídá cestě. Zkontrolujte ID a použijte /prototype nebo /build podle fáze ú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/brick-figure/v1/(prototype|build)/:id

Smazání úkolu Brick Figure

Zruší úkol Brick Figure. Zrušení úkolu ve stavu PENDING vrátí jeho kredity. Úkol ve stavu IN_PROGRESS je zrušen bez vrácení kreditů, protože worker jej již zpracovává. Úkol s konečným stavem (SUCCEEDED, FAILED nebo CANCELED) nelze zrušit.

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

Request

DELETE

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

curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/brick-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 úkolu, který se má zrušit.

Návratová hodnota

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

Chybové stavy

Name
400 - Bad Request
Description
Platí jedna z těchto možností:
- id není platné ID úkolu. Odešlete ID result z odpovědi na vytvoření.
- Úkol již má konečný stav (SUCCEEDED, FAILED nebo CANCELED), takže jej nelze zrušit.
Name
404 - Not Found
Description
Žádný úkol Brick Figure s tímto ID nepatří k vašemu účtu, nebo fáze úkolu neodpovídá cestě. Zkontrolujte ID a použijte /prototype nebo /build, aby odpovídaly úkolu.

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

Stream úlohy figurky z kostiček

Streamuje aktualizace úlohy figurky z kostiček 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/brick-figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream

curl -N https://api.meshy.ai/openapi/creative-lab/brick-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-brick-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=***"
    }
  ]
}

Parametry

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

Návratová hodnota

Stream objektů úlohy typu prototype nebo build. Každá událost obsahuje kompletní objekt úlohy, stejně jako jej vrací Získání úlohy figurky z kostiček. Dokud je úloha ve stavu PENDING nebo IN_PROGRESS, její výstupní pole jsou 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/brick-figure/v1/(prototype|build)

Zobrazení seznamu úloh Brick Figure

Vrátí vaše úlohy Brick Figure pro jednu fázi, vždy po jedné stránce. Fázi určuje cesta. /prototype vrací pouze úlohy prototypu a /build vrací pouze úlohy sestavení.

Request

GET

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

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

# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/brick-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-brick-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 zobrazit, 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. Hodnota 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 hodnota 0 použije výchozí nastavení. 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: od nejnovějších
- +created_at: od nejstarších

Návratová hodnota

Pole objektů úlohy prototypu nebo objektů úlohy sestavení, podle fáze uvedené v cestě.

Objekt úkolu prototypu figurky z kostiček

Úkol prototypu vygeneruje z fotografie koncepční obrázek ve stylu kostiček. Chcete-li obrázek převést na 3D model, předejte ID úkolu do koncového bodu build jako input_task_id.

Vlastnosti

Example Brick Figure Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-brick-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-brick-figure-prototype.
Name
name
Type
string
Description
name, který jste odeslali při vytvář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: dokončeno, s výsledkem
- FAILED: dokončeno, s důvodem v task_error
- CANCELED: dokončeno, bez výsledku
Name
progress
Type
integer
Description
Procento dokončené 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 milisekundách Unixového času.
Name
started_at
Type
timestamp
Description
Čas, kdy worker zahájil úkol, v milisekundách Unixového času. Do té doby null.
Name
finished_at
Type
timestamp
Description
Čas, kdy úkol dosáhl 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 úkolu, v milisekundách Unixového času. Je to 3 dny po finished_at, nebo 3 dny po created_at, dokud úkol 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 ú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é refundaci. Požadavek, který vrátí chybu, se neúčtuje. Neúspěšný úkol má hodnotu 0, protože Meshy jej refunduje. Zrušení vrací kredity za úkol pouze tehdy, pokud je 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
Adresy URL ke stažení koncepčního obrázku. Pole obsahuje jednu URL po úspěšném dokončení úkolu, do té doby je prázdné.

Objekt build úlohy figurky

Build úloha generuje texturovanou 3D minifigurku z úspěšně dokončené prototype úlohy. Pole model_urls, thumbnail_url a texture_urls mají stejný formát jako v objektu úlohy Obrázek na 3D.

Vlastnosti

Example Brick Figure Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-brick-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=***"
    }
  ]
}

Name
id
Type
string
Description
ID úlohy. Nespoléhejte se na jeho formát.
Name
type
Type
string
Description
Typ úlohy, vždy creative-lab-brick-figure-build.
Name
name
Type
string
Description
Hodnota name, kterou jste odeslali při vytváření úlohy, nebo "", pokud jste ji neodeslali.
Name
status
Type
string
Description
Stav úlohy.
Dostupné hodnoty:
- PENDING: čeká ve frontě
- IN_PROGRESS: generuje 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 dokončené práce, od 0 do 100. Je 0, dokud úloha nezačne, a 100, když uspěje.
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. Jde o 3 dny po finished_at, nebo 3 dny po created_at, dokud úloha neskončí. U firemní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 úlohy ve frontě, dokud je ve stavu PENDING. 1 znamená, že začne 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, pokud je 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
prompt
Type
string
Description
U build úlohy figurky vždy "".
Name
negative_prompt
Type
string
Description
U build úlohy figurky vždy "", stejně jako prompt.
Name
texture_prompt
Type
string
Description
U build úlohy figurky vždy "", stejně jako prompt.
Name
texture_image_url
Type
string
Description
U build úlohy figurky vždy "", stejně jako prompt.
Name
model_urls
Type
object
Description
URL ke stažení 3D modelu, jako texturovaný GLB a jako soubor OBJ s jeho souborem MTL.
- Name
  glb
  Type
  string
  Description
  URL ke stažení texturovaného souboru GLB.
- Name
  obj
  Type
  string
  Description
  URL ke stažení souboru OBJ, s geometrií a UV souřadnicemi.
- Name
  mtl
  Type
  string
  Description
  URL ke stažení materiálového souboru MTL, který patří k obj. Použijte jej společně s obj a texturou v texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
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 (base color).
- Name
  base_color
  Type
  string
  Description
  URL ke stažení mapy základní barvy (base color).