Creative Lab — API pro klíčenky

Přeměňte zdrojovou fotografii na 3D-tisknutelný medailon klíčenky — odznak ve tvaru barevného hloubkového reliéfu — ve dvou fázích: prototyp generuje barevný konceptuální obrázek z vaší vstupní fotografie, poté sestavení přemění tento konceptuální obrázek na reliéfní 3D model. Obě fáze jsou propojeny 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í úkolu prototypu klíčenky

Vygenerujte jeden barevný konceptuální obrázek ze zdrojové fotografie. Vrácené ID úkolu je to, co předáte jako input_task_id do koncového bodu sestavení. Podívejte se na Objekt úkolu prototypu klíčenky pro tvar odpovědi.

Parametry

  • Name
    image_url
    Type
    string
    Povinné
    Description

    Zdrojová fotografie pro Meshy k obarvení do konceptuálního obrázku připraveného pro klíčenku. Aktuálně podporujeme formáty .jpg, .jpeg, .png a .webp.

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

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

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

  • Name
    remove_background
    Type
    boolean
    výchozí false
    Description

    Pokud je nastaveno na true, prototypový obrázek je vrácen jako průhledný RGBA PNG s odstraněným pozadím, takže můžete subjekt složit na jakékoli pozadí.

    Toto ovládá pouze obrázek, který tento koncový bod vrací. Je oddělený od možnosti sestavení se stejným názvem (výchozí true), která ovládá odstranění pozadí před reliéfováním.

Návraty

Vlastnost result odpovědi obsahuje ID úkolu nově vytvořeného úkolu prototypu klíčenky. Dotazujte koncový bod Získat úkol nebo se přihlaste k odběru streamu, dokud úkol nedosáhne SUCCEEDED, poté předáte toto ID do koncového bodu 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: 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 nemohla být stažena (404 nebo timeout).
    • Neplatný Data URI: Base64 řetězec je poškozený.
    • Obsah označený: Vstupní obrázek byl označen NSFW nebo moderací duševního vlastnictví.
  • Name
    401 - Unauthorized
    Description

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

  • Name
    402 - Payment Required
    Description

    Nedostatečné kredity pro provedení tohoto úkolu.

  • 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>"
  }'

Odpověď

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
Příklad prototypu
Začněte se zdrojovou fotografií, poté vygenerujte prototypový obrázek použitý ve fázi sestavení klíčenky.
Zdrojová fotografie použitá jako vstup pro Creative Lab Klíčenku
Vstup prototypu
Výstup prototypu Creative Lab Klíčenky generovaný ze zdrojové fotografie
Výstup prototypu
POST/openapi/creative-lab/keychain/v1/build

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

Generování finálního 3D tisknutelného medailonu klíčenky z úspěšné prototypové úlohy. Sestavení spouští pipeline pro reliéfní mapu hloubky na barevný konceptuální obrázek prototypu a dodává jeden artefakt sítě ve formátu, který požadujete. Odkazujte na Objekt úlohy pro sestavení klíčenky pro tvar odpovědi.

Parametry

  • Name
    input_task_id
    Type
    string
    Povinné
    Description

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

    Prototypové úlohy vytvořené prostřednictvím webové aplikace nejsou přijímány — koncový bod pro sestavení přijímá pouze prototypové úlohy produkované POST /openapi/creative-lab/keychain/v1/prototype a odmítá jakýkoli jiný zdroj s 404.

  • Name
    name
    Type
    string
    Description

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

options

Volitelné parametry ladění pro reliéfní geometrie. Každé pole má rozumnou výchozí hodnotu — posílejte pouze ty, 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

    Vertikální posun aplikovaný 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ákladní 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řápku.

  • 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 pro přenosovou křivku (má smysl pouze, když relief_curve je gamma). Rozsah: (0, 10].

  • Name
    invert_depth
    Type
    boolean
    výchozí false
    Description

    Invertovat interpretaci mapy hloubky tak, aby tmavší oblasti byly vyšší reliéf.

  • Name
    smoothing
    Type
    number
    výchozí 0.24
    Description

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

  • Name
    relief_scale
    Type
    number
    výchozí 1.0
    Description

    Vertikální měřítkový násobitel aplikovaný na relief_height_mm. Rozsah: (0, 10].

  • Name
    depth_threshold
    Type
    number
    výchozí 0.1
    Description

    Prahová hodnota dolního průchodu pro hodnoty mapy hloubky; cokoli pod touto hodnotou je oříznuto na nulu. Rozsah: [0, 1].

  • Name
    remove_background
    Type
    boolean
    výchozí true
    Description

    Automaticky odstranit pozadí konceptuálního obrázku prototypu před reliéfováním.

    Odděleno od prototypového parametru stejného jména (výchozí false), který kontroluje, zda je samotný prototypový obrázek vrácen s průhledností.

  • 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 drá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í) — vrací jeden model.glb pod model_urls.glb.
    • obj — zabalí model.obj + model.mtl + texture.png a vrátí balíček pod model_urls.obj.
    • zip — zabalí každý artefakt, který generátor vydá, a vrátí balíček pod model_urls.bundle_zip.

Vrací

Vlastnost result odpovědi obsahuje ID úlohy nově vytvořené úlohy pro sestavení klíčenky. Dotazujte koncový bod Získat úlohu nebo se přihlaste k odběru streamu, dokud úloha nedosáhne SUCCEEDED, poté stáhněte artefakt z jediného záznamu 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.
    • Rodič nedosáhl úspěchu: Odkazovaná prototypová úloha ještě nedosáhla SUCCEEDED.
    • Žádný kandidát: Prototypová úloha uspěla, ale neprodukovala žádný kandidátní obrázek.
    • Možnosti mimo rozsah: Jedno z polí options spadlo mimo povolený rozsah nebo množinu enum.
  • Name
    401 - Unauthorized
    Description

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

  • Name
    402 - Payment Required
    Description

    Nedostatečné kredity pro provedení této úlohy.

  • Name
    404 - Not Found
    Description

    Odkazovaná prototypová úloha neexistuje, patří jinému uživateli nebo byla vytvořena prostřednictvím webové aplikace (pouze prototypové úlohy v režimu API se řetězí do sestavení).

  • 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"
}
Příklad sestavení
Úloha sestavení převádí vybraný prototypový obrázek do 3D tisknutelného modelu klíčenky.
Náhled modelu sestavení klíčenky Creative Lab
Náhled modelu sestavení
GET/openapi/creative-lab/keychain/v1/(prototype|build)/:id

Načtení úkolu klíčenky

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

Podívejte se na Objekt úkolu prototypu klíčenky a Objekt úkolu sestavení klíčenky pro tvary odpovědí.

Parametry

  • Name
    id
    Type
    path
    Description

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

Vrátí

Odpověď obsahuje objekt úkolu klíčenky. Tvar závisí na tom, která fáze byla požadována.

Požadavek

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}"

Odpověď prototypu

{
  "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=***"
  ]
}

Odpověď sestavení

{
  "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

Smazat úkol klíčenky

Zrušit úkol klíčenky. Pokud je úkol stále PENDING, kredity spotřebované při vytvoření jsou vráceny. Úkoly, které jsou již IN_PROGRESS, jsou zrušeny bez vrácení peněz (pracovník již může spotřebovávat zdroje). Úkoly, které již dosáhly konečného stavu (SUCCEEDED, FAILED, CANCELED), nelze zrušit.

Cesta URL musí odpovídat fázi úkolu — DELETE na /prototype/:buildId vrací 404.

Parametry cesty

  • Name
    id
    Type
    path
    Description

    Unikátní identifikátor úkolu klíčenky ke zrušení.

Návratové hodnoty

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

Režimy selhání

  • Name
    400 - Bad Request
    Description

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

  • Name
    404 - Not Found
    Description

    Úkol neexistuje, patří jinému uživateli nebo jeho 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í úkolu klíčenky

Streamujte aktualizace v reálném čase pro úkol klíčenky prostřednictvím Server-Sent Events (SSE). Cesta URL musí odpovídat fázi úkolu — otevření streamu na /prototype/:buildId/stream vyvolá jediný event: error payload s status_code: 404 a uzavře stream.

Parametry

  • Name
    id
    Type
    path
    Description

    Unikátní identifikátor pro úkol klíčenky ke streamování.

Návratové hodnoty

Vrací stream objektů úkolů Keychain Prototype nebo Keychain Build jako Server-Sent Events. Pro úkoly PENDING nebo IN_PROGRESS bude stream odpovědí obsahovat pouze potřebná 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)

Seznam úkolů klíčenky

Získejte stránkovaný seznam svých úkolů klíčenky pro jednu fázi. Cesta URL vybírá fázi — /prototype vrací úkoly prototypu; /build vrací úkoly sestavení. Úkoly z jiné fáze nejsou zahrnuty v žádné z odpovědí.

Parametry cesty

  • Name
    stage
    Type
    path
    Povinné
    Description

    Buď prototype nebo build. Kolekce vrací pouze úkoly, jejichž fáze odpovídá URL — načítání /prototype nikdy nevrátí úkoly 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 pro třídění. Dostupné hodnoty:

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

Vrací

Vrací stránkovaný seznam objektů úkolů pro jednotlivé fáze — buď objekt úkolu prototypu klíčenky při výpisu /prototype nebo objekt úkolu sestavení klíčenky při výpisu /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 pro vytvoření barevného konceptuálního obrázku z výchozí fotografie. Výstup této fáze je propojen do fáze sestavení pomocí input_task_id.

Vlastnosti

  • Name
    id
    Type
    string
    Description

    Unikátní identifikátor úlohy. Používáme k-tříděné UUID pro id úloh jako implementační detail, neměli byste však 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 PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

  • Name
    progress
    Type
    integer
    Description

    Pokrok úlohy. Pokud úloha ještě nezačala, tato vlastnost bude 0. Jakmile úloha uspěje, stane se 100.

  • Name
    created_at
    Type
    timestamp
    Description

    Časové razítko, 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, kdy úloha začala, v milisekundách. Pokud úloha ještě nezačala, tato vlastnost bude 0.

  • Name
    finished_at
    Type
    timestamp
    Description

    Časové razítko, kdy úloha skončila, v milisekundách. Pokud úloha ještě neskončila, tato vlastnost bude 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á smysl pouze pokud je stav úlohy PENDING.

  • Name
    task_error
    Type
    object
    Description

    Podrobnosti o chybě pro neúspěšné úlohy. Viz Chyby pro úplnou referenci objektu task_error.

  • Name
    consumed_credits
    Type
    integer
    Description

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

  • Name
    image_urls
    Type
    array of strings
    Description

    Stahovatelné URL pro kandidáty konceptuálních obrázků generovaných touto prototypovou úlohou. Aktuálně API vždy vrací přesně jednoho kandidáta; pole je polem, aby budoucí revize mohly zobrazit více kandidátů bez narušení kompatibility.

Příklad objektu úlohy prototypu klíčenky

{
  "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 úspěšné prototypové úlohy. Sestavení spouští pipeline pro reliéf hloubkové mapy na konceptuálním obrázku prototypu a publikuje jediný artefakt sítě ve formátu, který volající požadoval.

Vlastnosti

  • Name
    id
    Type
    string
    Description

    Unikátní identifikátor pro úlohu.

  • Name
    type
    Type
    string
    Description

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

  • Name
    name
    Type
    string
    Description

    Název úlohy zadaný při vytvoření úlohy. Prázdný řetězec, pokud nebyl poskytnut žá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

    Postup úlohy. Pokud úloha ještě nezačala, tato vlastnost bude 0. Jakmile úloha uspěje, stane se 100.

  • Name
    created_at
    Type
    timestamp
    Description

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

  • Name
    started_at
    Type
    timestamp
    Description

    Časové razítko, kdy byla úloha spuštěna, v milisekundách.

  • Name
    finished_at
    Type
    timestamp
    Description

    Časové razítko, kdy byla úloha dokončena, v milisekundách.

  • 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. Významné pouze, když je stav PENDING.

  • Name
    task_error
    Type
    object
    Description

    Podrobnosti o chybě pro neúspěšné úlohy. Viz Chyby pro úplnou referenci objektu task_error.

  • Name
    consumed_credits
    Type
    integer
    Description

    Počet kreditů spotřebovaných touto úlohou. Vrací 0 pro úlohy FAILED (kredity jsou v případě selhání vráceny).

  • Name
    model_urls
    Type
    object
    Description

    Stahovatelné URL pro vygenerovaný artefakt, klíčované podle názvu artefaktu. Vždy obsahuje přesně jednu položku — formát požadovaný prostřednictvím output.format požadavku na sestavení. Klíč odpovídá požadovanému formátu:

    • Name
      glb
      Type
      string
      Description

      Stahovatelné URL k souboru GLB. Přítomno, když output.format byl glb (výchozí).

    • Name
      obj
      Type
      string
      Description

      Stahovatelné URL k zip balíčku obsahujícímu model.obj, model.mtl a texture.png. Přítomno, když output.format byl obj.

    • Name
      bundle_zip
      Type
      string
      Description

      Stahovatelné URL k zip balíčku všech artefaktů, které generátor vydává. Přítomno, když output.format byl 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=***"
  }
}