Creative Lab — API klíčenky

Proměňte zdrojovou fotografii v medailonek klíčenky vhodný pro 3D tisk — hloubkový reliéf ve tvaru odznaku s kolorováním — ve dvou fázích: prototype vygeneruje kolorovaný koncepční obrázek z vaší vstupní fotografie a poté build tento koncepční obrázek promění v reliéfní 3D model. Obě fáze jsou propojené prostřednictvím input_task_id.

  • POST /openapi/creative-lab/keychain/v1/prototype
  • POST /openapi/creative-lab/keychain/v1/build
POST/openapi/creative-lab/keychain/v1/prototype

Vytvoření úlohy prototypu klíčenky

Vygenerujte jeden kolorovaný koncepční obrázek ze zdrojové fotografie. Vrácené ID úlohy je to, které předáte jako input_task_id koncovému bodu pro sestavení. Tvar odpovědi najdete v části Objekt úlohy prototypu klíčenky.

Parametry

  • Name
    image_url
    Type
    string
    Povinné
    Description

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

    Obrázek lze poskytnout dvěma způsoby:

    • Veřejně dostupná URL: URL dostupná 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 nově vytvořené úlohy prototypu klíčenky. Dotazujte 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 sestavení jako input_task_id.

Režimy selhání

  • Name
    400 - Bad Request
    Description

    Požadavek nebyl přijatelný. Časté příčiny:

    • Chybějící parametr: image_url je povinný.
    • Neplatný formát obrázku: Poskytnuté 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á chybný formát.
    • Označený obsah: Vstupní obrázek byl označen v rámci NSFW moderation nebo moderation duševního vlastnictví.
  • Name
    401 - Unauthorized
    Description

    Autentizace selhala. Zkontrolujte 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.

Požadavek

POST
/openapi/creative-lab/keychain/v1/prototype
# Stage 1: generate a colorized keychain concept image
curl https://api.meshy.ai/openapi/creative-lab/keychain/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 zdrojovou fotografií a poté vygenerujte obrázek prototypu použitý ve fázi sestavení klíčenky.
Zdrojová fotografie použitá jako vstup klíčenky v Creative Lab
Vstup prototypu
Výstup prototypu klíčenky v Creative Lab vygenerovaný ze zdrojové fotografie
Výstup prototypu
POST/openapi/creative-lab/keychain/v1/build

Vytvoření úlohy sestavení klíčenky

Vygenerujte finální medailon klíčenky vhodný pro 3D tisk z úspěšně dokončené prototypové úlohy. Sestavení spustí pipeline reliéfu z mapy hloubky na kolorovaném koncepčním obrázku prototypu a dodá jeden artefakt sítě ve formátu, který požadujete. Tvar odpovědi najdete v Objektu úlohy sestavení klíčenky.

Parametry

  • Name
    input_task_id
    Type
    string
    Povinné
    Description

    ID úlohy prototypové úlohy vytvořené přes tento stejný koncový bod 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.

    Prototypové úlohy vytvořené přes webovou aplikaci nejsou přijímány — koncový bod sestavení přijímá pouze prototypové úlohy vytvořené pomocí POST /openapi/creative-lab/keychain/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í circle
    Description

    Obrysová silueta medailonu klíčenky. Dostupné hodnoty:

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

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

  • Name
    relief_height_mm
    Type
    number
    výchozí 2.2
    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ý posun použitý na reliéf před extruzí, v milimetrech. Rozsah: [0, 20].

  • Name
    base_thickness_mm
    Type
    number
    výchozí 0.1
    Description

    Tloušťka ploché základové desky za reliéfem v milimetrech. Rozsah: [0, 20].

  • Name
    has_closed_back
    Type
    boolean
    výchozí true
    Description

    Zda je zadní strana medailonu uzavřena jako uzavřený povrch. Nastavte na false pro otevřenou skořepinu.

  • Name
    relief_curve
    Type
    string
    výchozí linear
    Description

    Přenosová křivka mapující hodnoty mapy hloubky 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 přenosové křivky (má význam pouze když je relief_curve gamma). Rozsah: (0, 10].

  • Name
    invert_depth
    Type
    boolean
    výchozí false
    Description

    Invertujte interpretaci mapy hloubky, aby se tmavší oblasti staly vyšším reliéfem.

  • Name
    smoothing
    Type
    number
    výchozí 0.24
    Description

    Síla vyhlazení použitá na mapu hloubky před extrakcí reliéfu. Rozsah: [0, 10].

  • Name
    relief_scale
    Type
    number
    výchozí 1.0
    Description

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

  • Name
    depth_threshold
    Type
    number
    výchozí 0.1
    Description

    Dolní práh pro hodnoty mapy hloubky; cokoli pod touto hodnotou se ořízne na nulu. Rozsah: [0, 1].

  • Name
    remove_background
    Type
    boolean
    výchozí true
    Description

    Automaticky odstraňte 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 formátu přenosu. 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.

Návratové hodnoty

Vlastnost result odpovědi obsahuje id úlohy nově vytvořené úlohy sestavení klíčenky. Dotazujte se koncového bodu 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 vyžadován.
    • Neplatné UUID: input_task_id není platné UUID.
    • Nadřazená úloha není úspěšná: Odkazovaná prototypová úloha ještě nedosáhla stavu SUCCEEDED.
    • Žádný kandidát: Prototypová úloha byla úspěšná, ale nevytvořila žádný kandidátní obrázek.
    • Možnosti mimo rozsah: Jedno z polí options bylo mimo povolený rozsah nebo sadu enum.
  • Name
    401 - Unauthorized
    Description

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

  • Name
    402 - Payment Required
    Description

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

  • Name
    404 - Not Found
    Description

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

  • Name
    429 - Too Many Requests
    Description

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

Request

POST
/openapi/creative-lab/keychain/v1/build
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "options": {
      "badge_shape": "circle",
      "size_mm": 40,
      "relief_height_mm": 2.5
    },
    "output": {
      "format": "glb"
    }
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}
Build example
The build task converts the selected prototype image into a 3D-printable keychain model.
Creative Lab Keychain build model preview
Build model preview
GET/openapi/creative-lab/keychain/v1/(prototype|build)/:id

Načtení úlohy klíčenky

Nač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 klíčenky a Objekt úlohy sestavení klíčenky pro tvary odpovědí.

Parametry

  • Name
    id
    Type
    path
    Description

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

Vrací

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

Request

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

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

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-keychain-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-keychain-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": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}
DELETE/openapi/creative-lab/keychain/v1/(prototype|build)/:id

Odstranění úlohy klíčenky

Zruší úlohu klíčenky. Pokud je úloha stále PENDING, kredity spotřebované při vytvoření se vrátí. Úlohy, které jsou již IN_PROGRESS, se zruší bez vrácení kreditů (worker už možná spotřebovává zdroje). Úlohy, které již dosáhly koncové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 klíčenky, kterou chcete zrušit.

Návratová hodnota

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 koncové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/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578
curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

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

Streamování úlohy klíčenky

Streamujte aktualizace úlohy klíčenky 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 odešle jeden payload event: error se status_code: 404 a stream zavře.

Parametry

  • Name
    id
    Type
    path
    Description

    Jedinečný identifikátor úlohy klíčenky ke streamování.

Návratová hodnota

Vrací stream objektů úloh prototypu klíčenky nebo sestavení klíčenky 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/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream
curl -N https://api.meshy.ai/openapi/creative-lab/keychain/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.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
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-keychain-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}
GET/openapi/creative-lab/keychain/v1/(prototype|build)

Vypsat úlohy klíčenky

Načtěte stránkovaný seznam svých úloh klíčenky 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á hodnota 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ě.

Návratová hodnota

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

Request

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

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

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-keychain-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=***"
    ]
  }
]

Objekt úlohy prototypu klíčenky

Objekt úlohy prototypu klíčenky 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 zřetězen 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 dělat žádné předpoklady o formátu ID.

  • Name
    type
    Type
    string
    Description

    Typ úlohy. Hodnota je creative-lab-keychain-prototype.

  • Name
    name
    Type
    string
    Description

    Název úlohy zadaný při vytvoření úlohy. 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 úspěšně skončí, změní se na 100.

  • Name
    created_at
    Type
    timestamp
    Description

    Časové razítko vytvoření úlohy 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 vyjádřen jako 1693569600000. To platí pro všechna časová razítka v Meshy API.

  • Name
    started_at
    Type
    timestamp
    Description

    Časové razítko spuštění úlohy v milisekundách. Pokud úloha ještě nebyla spuštěna, bude tato vlastnost 0.

  • Name
    finished_at
    Type
    timestamp
    Description

    Časové razítko dokončení úlohy v milisekundách. Pokud úloha ještě není dokončena, bude tato vlastnost 0.

  • Name
    expires_at
    Type
    timestamp
    Description

    Časové razítko, kdy výsledek úlohy vyprší, v milisekundách.

  • Name
    preceding_tasks
    Type
    integer
    Description

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

    Hodnota tohoto pole má význam pouze tehdy, když je stav úlohy PENDING.

  • Name
    task_error
    Type
    object
    Description

    Podrobnosti chyby 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. Přítomno, když je stav úlohy PENDING, IN_PROGRESS nebo SUCCEEDED. U úloh FAILED vrací 0 (kredity jsou při selhání vráceny).

  • Name
    image_urls
    Type
    array of strings
    Description

    URL ke stažení pro kandidáty koncepčního obrázku vygenerované touto prototypovou úlohou. API v současnosti vždy vrací přesně jednoho kandidáta; pole je polem proto, aby budoucí revize mohly zpřístupnit více kandidátů bez průlomové změny.

Example Keychain Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-keychain-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=***"
  ]
}

Objekt úlohy sestavení klíčenky

Objekt úlohy sestavení klíčenky je pracovní jednotka, kterou Meshy sleduje, aby vygeneroval finální 3D síť klíčenky z úlohy prototypu se stavem SUCCEEDED. Sestavení spouští pipeline reliéfu z hloubkové mapy nad konceptovým obrázkem prototypu 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-keychain-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 úspěšně skončí, bude hodnota 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. Význam má pouze tehdy, když je stav 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. Pro úlohy FAILED vrací 0 (kredity jsou při selhání vráceny).

  • Name
    model_urls
    Type
    object
    Description

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

    • Name
      glb
      Type
      string
      Description

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

    • Name
      obj
      Type
      string
      Description

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

    • Name
      bundle_zip
      Type
      string
      Description

      URL ke stažení balíčku zip se všemi artefakty, které generátor vytvoří. Přítomno, když output.format bylo zip.

Example Keychain Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-keychain-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": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}