Creative Lab — API magnetu na lednici

Proměňte své fotografie ve vlastní magnety na lednici — kolorizovaný hloubkový reliéf se zaobleným obdélníkovým tvarem s plochou magnetickou zadní stranou, velikostně vhodný na lednici — ve dvou fázích: prototyp vygeneruje z vaší vstupní fotografie kolorizovaný koncepční obrázek a poté sestavení tento koncepční obrázek převede na reliéfní 3D model. Tyto dvě fáze jsou propojeny pomocí input_task_id.

  • POST /openapi/creative-lab/fridge-magnet/v1/prototype
  • POST /openapi/creative-lab/fridge-magnet/v1/build
POST/openapi/creative-lab/fridge-magnet/v1/prototype

Vytvořit úlohu prototypu magnetu na lednici

Vygenerujte jeden kolorovaný koncepční obrázek ze zdrojové fotografie. Vrácené ID úlohy je hodnota, kterou předáte jako input_task_id do koncového bodu pro sestavení. Viz Objekt úlohy prototypu magnetu na lednici pro strukturu odpovědi.

Parametry

  • Name
    image_url
    Type
    string
    Povinné
    Description

    Zdrojová fotografie, kterou má Meshy kolorovat do koncepčního obrázku připraveného pro magnet na lednici. Aktuálně podporujeme formáty .jpg, .jpeg, .png a .webp.

    Existují dva způsoby, jak obrázek poskytnout:

    • Veřejně přístupná URL: URL, která je přístupná z veřejného internetu.
    • Data URI: Data URI obrázku zakódované v base64. Příklad Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
  • Name
    name
    Type
    string
    Description

    Volitelný název úlohy pro účely zobrazení. Maximálně 100 znaků.

Vrací

Vlastnost result v odpovědi obsahuje id úlohy nově vytvořené úlohy prototypu magnetu na lednici. Dotazujte se na koncový bod Získat úlohu nebo se přihlaste k odběru streamu, dokud úloha nedosáhne stavu SUCCEEDED, a poté toto ID předejte koncovému bodu pro sestavení jako input_task_id.

Režimy selhání

  • Name
    400 - Bad Request
    Description

    Požadavek byl nepřijatelný. Běžné příčiny:

    • Chybějící parametr: image_url je povinný.
    • Neplatný formát obrázku: Zadané image_url není podporovaný formát (.jpg, .jpeg, .png, .webp).
    • Rozměry obrázku mimo rozsah: Obrázek je příliš malý, překračuje maximální velikost souboru nebo překračuje maximální počet pixelů.
    • Nedostupná URL: image_url se nepodařilo stáhnout (404 nebo timeout).
    • Neplatné Data URI: Řetězec base64 má nesprávný formát.
    • Obsah označen: Vstupní obrázek byl označen NSFW nebo moderation duševního vlastnictví.
  • Name
    401 - Unauthorized
    Description

    Autentizace selhala. Zkontrolujte prosím svůj API klíč.

  • Name
    402 - Payment Required
    Description

    Nedostatek kreditů k provedení této úlohy.

  • Name
    429 - Too Many Requests
    Description

    Překročili jste svůj limit rychlosti.

Request

POST
/openapi/creative-lab/fridge-magnet/v1/prototype
# Stage 1: generate a colorized fridge magnet concept image
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/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": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9"
}
Prototype example
Start with a source photo, then generate the prototype image used by the fridge magnet build stage.
Source landscape photo used as the Creative Lab Fridge Magnet input
Prototype input
Creative Lab Fridge Magnet prototype output generated from the source photo
Prototype output
POST/openapi/creative-lab/fridge-magnet/v1/build

Vytvoření úlohy sestavení magnetu na lednici

Vygenerujte finální magnet na lednici připravený pro 3D tisk z úspěšné úlohy prototypu. Sestavení spouští pipeline reliéfu z hloubkové mapy nad kolorovaným koncepčním obrázkem prototypu a dodává jeden artefakt sítě ve formátu, o který požádáte. Tvar odpovědi najdete v části Objekt úlohy sestavení magnetu na lednici.

Parametry

  • Name
    input_task_id
    Type
    string
    Povinné
    Description

    ID úlohy prototypu vytvořené prostřednictvím tohoto stejného koncového bodu OpenAPI. Prototyp musel být vytvořen se stejným API klíčem, musel dosáhnout stavu SUCCEEDED a musel vytvořit přesně jeden kandidátní obrázek.

    Úlohy prototypu vytvořené přes webovou aplikaci nejsou přijímány — koncový bod sestavení přijímá pouze úlohy prototypu vytvořené pomocí POST /openapi/creative-lab/fridge-magnet/v1/prototype a jakýkoli jiný zdroj odmítne s 404.

  • Name
    name
    Type
    string
    Description

    Volitelný název úlohy pro účely zobrazení. Maximálně 100 znaků.

options

Volitelné ladicí parametry pro geometrii reliéfu. Každé pole má rozumnou výchozí hodnotu — odešlete pouze ta, která chcete přepsat.

  • Name
    badge_shape
    Type
    string
    výchozí rounded-rect
    Description

    Obrysová silueta magnetu na lednici. Dostupné hodnoty:

    • circle
    • rounded-rect (výchozí)
    • hexagon
    • shield
    • star
  • Name
    size_mm
    Type
    number
    výchozí 60
    Description

    Délka hrany ohraničujícího čtverce magnetu na lednici v milimetrech. Rozsah: (0, 400].

  • Name
    relief_height_mm
    Type
    number
    výchozí 3.3
    Description

    Maximální výška reliéfu nad základnou v milimetrech. Rozsah: [0, 20].

  • Name
    relief_offset_mm
    Type
    number
    výchozí 0
    Description

    Svislý offset aplikovaný na reliéf před extruzí, v milimetrech. Rozsah: [0, 20].

  • Name
    base_thickness_mm
    Type
    number
    výchozí 2.0
    Description

    Tloušťka ploché základní desky za reliéfem v milimetrech. Výchozí hodnota pro magnet na lednici je robustnější 2mm základna — dává magnetu dostatečné tělo, aby držel na lednici, aniž by reliéf působil křehce. Rozsah: [0, 20].

  • Name
    has_closed_back
    Type
    boolean
    výchozí true
    Description

    Zda je zadní strana magnetu na lednici uzavřena jako uzavřený povrch (strana, na kterou přilepíte magnet). Nastavte na false pro otevřenou skořepinu.

  • Name
    relief_curve
    Type
    string
    výchozí linear
    Description

    Přenosová křivka mapující hodnoty hloubkové mapy na výšku reliéfu. Dostupné hodnoty:

    • linear (výchozí)
    • gamma
    • s-curve
  • Name
    curve_param
    Type
    number
    výchozí 1.0
    Description

    Parametr tvaru pro přenosovou křivku (má význam pouze tehdy, když je relief_curve nastaveno na gamma). Rozsah: (0, 10].

  • Name
    invert_depth
    Type
    boolean
    výchozí false
    Description

    Invertuje interpretaci hloubkové mapy, takže tmavší oblasti se stanou vyšším reliéfem.

  • Name
    smoothing
    Type
    number
    výchozí 0.24
    Description

    Síla vyhlazení aplikovaná na hloubkovou mapu před extrakcí reliéfu. Rozsah: [0, 10].

  • Name
    relief_scale
    Type
    number
    výchozí 1.0
    Description

    Násobitel svislého měřítka aplikovaný nad rámec relief_height_mm. Rozsah: (0, 10].

  • Name
    depth_threshold
    Type
    number
    výchozí 0.1
    Description

    Prahová hodnota dolní propusti pro hodnoty hloubkové mapy; cokoli pod touto hodnotou se ořízne na nulu. Rozsah: [0, 1].

  • Name
    remove_background
    Type
    boolean
    výchozí true
    Description

    Automaticky odstraní pozadí koncepčního obrázku prototypu před vytvořením reliéfu.

  • Name
    export_resolution
    Type
    integer
    výchozí 512
    Description

    Rozlišení sítě použité pro export. Rozsah: [64, 2048].

output

Volitelný selektor drátového formátu. Výchozí hodnota je glb.

  • Name
    format
    Type
    string
    výchozí glb
    Description

    Balíček artefaktů vrácený sestavením. Dostupné hodnoty:

    • glb (výchozí) — vrátí jeden model.glb pod model_urls.glb.
    • obj — zabalí model.obj + model.mtl + texture.png do zipu a vrátí balíček pod model_urls.obj.
    • zip — zabalí do zipu každý artefakt, který generátor vydá, a vrátí balíček pod model_urls.bundle_zip.

Vrací

Vlastnost result v odpovědi obsahuje id úlohy nově vytvořené úlohy sestavení magnetu na lednici. Dotazujte se na koncový bod Získat úlohu nebo se přihlaste k odběru streamu, dokud úloha nedosáhne stavu SUCCEEDED, a poté stáhněte artefakt z jediné položky v model_urls.

Režimy selhání

  • Name
    400 - Bad Request
    Description

    Požadavek byl nepřijatelný. Běžné příčiny:

    • Chybějící parametr: input_task_id je povinné.
    • Neplatné UUID: input_task_id není platné UUID.
    • Nadřazená úloha není úspěšná: Odkazovaná úloha prototypu ještě nedosáhla stavu SUCCEEDED.
    • Žádný kandidát: Úloha prototypu byla úspěšná, ale nevytvořila žádný kandidátní obrázek.
    • Možnosti mimo rozsah: Jedno z polí options bylo mimo svůj povolený rozsah nebo sadu výčtu.
  • Name
    401 - Unauthorized
    Description

    Autentizace selhala. Zkontrolujte prosím svůj API klíč.

  • Name
    402 - Payment Required
    Description

    Nedostatek kreditů k provedení této úlohy.

  • Name
    404 - Not Found
    Description

    Odkazovaná úloha prototypu neexistuje, patří jinému uživateli nebo byla vytvořena přes webovou aplikaci (do sestavení lze řetězit pouze úlohy prototypu v API-mode).

  • Name
    429 - Too Many Requests
    Description

    Překročili jste svůj limit rychlosti.

Request

POST
/openapi/creative-lab/fridge-magnet/v1/build
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
    "options": {
      "badge_shape": "rounded-rect",
      "size_mm": 60,
      "relief_height_mm": 3.3
    },
    "output": {
      "format": "glb"
    }
  }'

Response

{
  "result": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0"
}
Build example
The build task turns the selected prototype image into a 3D-printable fridge magnet model.
Náhled modelu sestavení magnetu na lednici v Creative Lab
Build model preview
GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id

Načíst úlohu magnetu na lednici

Načtěte úlohu prototypu nebo sestavení podle platného id úlohy. Cesta URL musí odpovídat fázi úlohy — úloha sestavení načtená přes /prototype/:id vrátí 404 a naopak.

Viz Objekt úlohy prototypu magnetu na lednici a Objekt úlohy sestavení magnetu na lednici pro tvary odpovědí.

Parametry

  • Name
    id
    Type
    path
    Description

    Jedinečný identifikátor úlohy magnetu na lednici, kterou chcete načíst.

Vrací

Odpověď obsahuje objekt úlohy magnetu na lednici. Tvar závisí na tom, která fáze byla vyžádána.

Request

GET
/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9
# Prototype
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
  "type": "creative-lab-fridge-magnet-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543210000,
  "started_at": 1729543215000,
  "finished_at": 1729543242000,
  "expires_at": 1729802442000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}
DELETE/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id

Odstranění úlohy magnetu na lednici

Zruší úlohu magnetu na lednici. Pokud je úloha stále ve stavu PENDING, kredity spotřebované při vytvoření se vrátí. Úlohy, které jsou již IN_PROGRESS, jsou zrušeny bez vrácení prostředků (pracovní proces už může spotřebovávat zdroje). Úlohy, které již dosáhly konečného stavu (SUCCEEDED, FAILED, CANCELED), nelze zrušit.

Cesta URL musí odpovídat fázi úlohy — DELETE na /prototype/:buildId vrátí 404.

Parametry cesty

  • Name
    id
    Type
    path
    Description

    Jedinečný identifikátor úlohy magnetu na lednici, která se má zrušit.

Vrací

Při úspěchu vrátí 204 No Content s prázdným tělem.

Režimy selhání

  • Name
    400 - Bad Request
    Description

    Úloha je již v konečném stavu a nelze ji zrušit.

  • Name
    404 - Not Found
    Description

    Úloha neexistuje, patří jinému uživateli nebo její fáze neodpovídá cestě URL.

Request

DELETE
/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9
curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 204 No Content on success (empty body).
GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id/stream

Streamování úlohy magnetu na lednici

Streamujte aktualizace úlohy magnetu na lednici v reálném čase prostřednictvím Server-Sent Events (SSE). Cesta URL musí odpovídat fázi úlohy — otevření streamu na /prototype/:buildId/stream vygeneruje jediný payload event: error se status_code: 404 a stream zavře.

Parametry

  • Name
    id
    Type
    path
    Description

    Jedinečný identifikátor úlohy magnetu na lednici, která se má streamovat.

Návratová hodnota

Vrací stream objektů úloh Prototyp magnetu na lednici nebo Sestavení magnetu na lednici jako Server-Sent Events. U úloh PENDING nebo IN_PROGRESS bude stream odpovědi obsahovat pouze nezbytná pole progress a status.

Request

GET
/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/stream
curl -N https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/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.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
event: message
data: {
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "task_error": null,
  "consumed_credits": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}
GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)

Vypsat úlohy magnetu na lednici

Načte stránkovaný seznam vašich úloh magnetu na lednici pro jednu fázi. Cesta URL vybírá fázi — /prototype vrací úlohy prototypu; /build vrací úlohy sestavení. Úlohy z druhé fáze nejsou zahrnuty v žádné odpovědi.

Parametry cesty

  • Name
    stage
    Type
    path
    Povinné
    Description

    Buď prototype, nebo build. Kolekce vrací pouze úlohy, jejichž fáze odpovídá URL — načtení /prototype nikdy nevrátí úlohy sestavení a naopak.

Parametry dotazu

  • Name
    page_num
    Type
    integer
    výchozí 1
    Description

    Číslo stránky pro stránkování.

  • Name
    page_size
    Type
    integer
    výchozí 10
    Description

    Limit velikosti stránky. Maximální povolený počet je 50 položek.

  • Name
    sort_by
    Type
    string
    výchozí -created_at
    Description

    Pole, podle kterého se má řadit. Dostupné hodnoty:

    • +created_at: Řadit podle času vytvoření vzestupně.
    • -created_at: Řadit podle času vytvoření sestupně.

Vrací

Vrací stránkovaný seznam objektů úloh pro danou fázi — buď objekt úlohy prototypu magnetu na lednici při vypisování /prototype, nebo objekt úlohy sestavení magnetu na lednici při vypisování /build.

Request

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

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

Response (List Prototype Tasks)

[
  {
    "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
    "type": "creative-lab-fridge-magnet-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729543210000,
    "started_at": 1729543215000,
    "finished_at": 1729543242000,
    "expires_at": 1729802442000,
    "preceding_tasks": 0,
    "task_error": null,
    "consumed_credits": 6,
    "image_urls": [
      "https://assets.meshy.ai/***/concept.png?Expires=***"
    ]
  }
]

Objekt úlohy prototypu magnetu na lednici

Objekt úlohy prototypu magnetu na lednici je pracovní jednotka, kterou Meshy sleduje za účelem vygenerování kolorovaného koncepčního obrázku ze zdrojové fotografie. Výstup této fáze je propojen do fáze sestavení prostřednictvím input_task_id.

Vlastnosti

  • Name
    id
    Type
    string
    Description

    Jedinečný identifikátor úlohy. I když jako implementační detail používáme pro ID úloh k-sortable UUID, neměli byste si dělat žádné předpoklady o formátu id.

  • Name
    type
    Type
    string
    Description

    Typ úlohy. Hodnota je creative-lab-fridge-magnet-prototype.

  • Name
    name
    Type
    string
    Description

    Název úlohy zadaný při jejím vytvoření. Prázdný řetězec, pokud nebyl zadán žádný název.

  • Name
    status
    Type
    string
    Description

    Stav úlohy. Možné hodnoty jsou jedna z PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    progress
    Type
    integer
    Description

    Progress úlohy. Pokud úloha ještě nebyla spuštěna, bude tato vlastnost 0. Jakmile úloha uspěje, změní se na 100.

  • Name
    created_at
    Type
    timestamp
    Description

    Časové razítko okamžiku, kdy byla úloha vytvořena, v milisekundách.

    Časové razítko představuje počet milisekund uplynulých od 1. ledna 1970 UTC podle standardu RFC 3339. Například pátek 1. září 2023 12:00:00 GMT je reprezentován jako 1693569600000. To platí pro všechna časová razítka v Meshy API.

  • Name
    started_at
    Type
    timestamp
    Description

    Časové razítko okamžiku, kdy byla úloha spuštěna, v milisekundách. Pokud úloha ještě nebyla spuštěna, bude tato vlastnost 0.

  • Name
    finished_at
    Type
    timestamp
    Description

    Časové razítko okamžiku, kdy byla úloha dokončena, v milisekundách. Pokud úloha ještě nebyla dokončena, bude tato vlastnost 0.

  • Name
    expires_at
    Type
    timestamp
    Description

    Časové razítko okamžiku, kdy vyprší platnost výsledku úlohy, v milisekundách.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Počet předcházejících úloh.

    Hodnota tohoto pole má význam pouze v případě, že stav úlohy je PENDING.

  • Name
    task_error
    Type
    object
    Description

    Podrobnosti o chybě u neúspěšných úloh. Úplnou referenci objektu task_error najdete v části Chyby.

  • Name
    consumed_credits
    Type
    integer
    Description

    Počet kreditů spotřebovaných touto úlohou. Přítomno, když je stav úlohy PENDING, IN_PROGRESS nebo SUCCEEDED. Pro úlohy FAILED vrací 0 (kredity jsou při selhání vráceny).

  • Name
    image_urls
    Type
    array of strings
    Description

    Stažitelné adresy URL kandidátů koncepčního obrázku vygenerovaných touto prototypovou úlohou. API v současnosti vždy vrací právě jednoho kandidáta; pole je polem proto, aby budoucí revize mohly zobrazit více kandidátů bez zásadní změny.

Example Fridge Magnet Prototype Task Object

{
  "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
  "type": "creative-lab-fridge-magnet-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543210000,
  "started_at": 1729543215000,
  "finished_at": 1729543242000,
  "expires_at": 1729802442000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Objekt úlohy sestavení magnetu na lednici

Objekt úlohy sestavení magnetu na lednici je pracovní jednotka, kterou Meshy sleduje za účelem vygenerování finální 3D sítě magnetu na lednici z úspěšné prototypové úlohy. Sestavení spouští nad koncepčním obrázkem prototypu pipeline reliéfu z hloubkové mapy a publikuje jeden artefakt sítě ve formátu, který si volající vyžádal.

Vlastnosti

  • Name
    id
    Type
    string
    Description

    Jedinečný identifikátor úlohy.

  • Name
    type
    Type
    string
    Description

    Typ úlohy. Hodnota je creative-lab-fridge-magnet-build.

  • Name
    name
    Type
    string
    Description

    Název úlohy zadaný při jejím vytvoření. Prázdný řetězec, pokud nebyl zadán žádný název.

  • Name
    status
    Type
    string
    Description

    Stav úlohy. Možné hodnoty jsou jedna z PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    progress
    Type
    integer
    Description

    progress úlohy. Pokud úloha ještě nebyla spuštěna, tato vlastnost bude 0. Jakmile úloha uspěje, změní se na 100.

  • Name
    created_at
    Type
    timestamp
    Description

    Časové razítko vytvoření úlohy v milisekundách.

  • Name
    started_at
    Type
    timestamp
    Description

    Časové razítko spuštění úlohy v milisekundách.

  • Name
    finished_at
    Type
    timestamp
    Description

    Časové razítko dokončení úlohy v milisekundách.

  • Name
    expires_at
    Type
    timestamp
    Description

    Časové razítko vypršení platnosti výsledku úlohy v milisekundách.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Počet předcházejících úloh. Má význam pouze tehdy, když je stav PENDING.

  • Name
    task_error
    Type
    object
    Description

    Podrobnosti o chybě pro neúspěšné úlohy. Úplnou referenci objektu task_error najdete v části Chyby.

  • Name
    consumed_credits
    Type
    integer
    Description

    Počet kreditů spotřebovaných touto úlohou. U úloh FAILED vrací 0 (kredity jsou při selhání vráceny).

  • Name
    model_urls
    Type
    object
    Description

    Adresy URL ke stažení pro vygenerovaný artefakt, indexované podle názvu artefaktu. Vždy obsahuje právě jednu položku — formát vyžádaný prostřednictvím požadavku na sestavení output.format. Klíč odpovídá požadovanému formátu:

    • Name
      glb
      Type
      string
      Description

      Adresa URL ke stažení souboru GLB. Přítomna, když output.format byl glb (výchozí).

    • Name
      obj
      Type
      string
      Description

      Adresa URL ke stažení zip balíčku obsahujícího model.obj, model.mtl a texture.png. Přítomna, když output.format byl obj.

    • Name
      bundle_zip
      Type
      string
      Description

      Adresa URL ke stažení zip balíčku každého artefaktu, který generátor vydává. Přítomna, když output.format byl zip.

Example Fridge Magnet Build Task Object

{
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}