Creative Lab — API lampy

Proměňte textový prompt nebo zdrojovou fotografii na stínidlo lampy vytisknutelné na 3D tiskárně ve dvou fázích: prototype vygeneruje stylizovaný matně bílý koncepční obrázek a poté build tento koncepční obrázek promění v duté STL stínidlo lampy (volitelně spárované se základním diskem pro uchycení světelného zdroje). Tyto dvě fáze jsou propojené pomocí input_task_id.

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

Vytvořit úlohu prototypu lampy

Vygenerujte jeden matně bílý konceptový obrázek stínidla lampy — buď z textového promptu (text-to-3D), nebo z referenční fotografie (image-to-3D). Vrácené ID úlohy předáte jako input_task_id do koncového bodu pro sestavení. Viz Objekt úlohy prototypu lampy pro strukturu odpovědi.

Parametry

Je vyžadováno právě jedno z text nebo image_url. Předání obou, nebo ani jednoho, vrátí 400.

  • Name
    text
    Type
    string
    Povinné
    Description

    Textový prompt popisující požadovaný motiv stínidla lampy. Vyžadováno, když je image_url vynecháno. Maximálně 800 znaků.

  • Name
    image_url
    Type
    string
    Povinné
    Description

    Zdrojová fotografie, kterou Meshy používá jako vizuální referenci pro stínidlo lampy. Vyžadováno, když je text vynecháno. Aktuálně podporujeme formáty .jpg, .jpeg, .png a .webp.

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

    • 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
    image_subject
    Type
    string
    výchozí character
    Description

    Nápověda kategorie motivu pro cestu image-to-3D. Dostupné hodnoty:

    • character (výchozí) — jeden motiv postavy / objektu (figurína, zvíře, maskot atd.).
    • landscape — motiv venkovní scény / panoramatu (hora, panoráma města, les atd.).

    Ignoruje se na cestě text-to-3D.

  • 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 lampy. Dotazujte se koncového bodu Získat úlohu nebo se přihlaste k odběru streamu, dokud úloha nedosáhne stavu SUCCEEDED, a poté toto ID předejte do koncového bodu pro sestavení jako input_task_id.

Režimy selhání

  • Name
    400 - Bad Request
    Description

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

    • Chybějící parametr: Je vyžadováno právě jedno z text nebo image_url.
    • Zadáno obojí: Předání obou text a image_url je odmítnuto — vzájemně se vylučují.
    • 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.
    • Označený obsah: Vstupní obrázek byl označen NSFW nebo moderation duševního vlastnictví.
    • Text je příliš dlouhý: text překračuje 800 znaků.
    • Neplatné image_subject: Není jednou z hodnot character / landscape.
  • 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/lamp/v1/prototype
# Stage 1 (image-to-3D): generate a matte-white lampshade concept image
curl https://api.meshy.ai/openapi/creative-lab/lamp/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>",
    "image_subject": "character"
  }'

# Stage 1 (text-to-3D): generate from a text prompt
curl https://api.meshy.ai/openapi/creative-lab/lamp/v1/prototype \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "text": "a stylized owl perched on a tree branch under moonlight"
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}
Prototype example
Start with a source photo, then generate the prototype image used by the lamp build stage.
Zdrojová fotografie kočky použitá jako vstup Creative Lab Lamp
Prototype input
Výstup prototypu Creative Lab Lamp vygenerovaný ze zdrojové fotografie
Prototype output
POST/openapi/creative-lab/lamp/v1/build

Vytvoření úlohy sestavení lampy

Vygenerujte finální stínidlo lampy připravené pro 3D tisk z úspěšně dokončené prototypové úlohy. Sestavení spustí pipeline image-to-3D na koncepčním obrázku prototypu, poté postprocesuje síť prostřednictvím procesoru lampy, aby ji vydutnilo, zploštilo horní část, volitelně vyřízlo základnu a (když je zvolena předvolba uchycení) vygenerovalo samostatný základní disk pro světelný zdroj. Tvar odpovědi najdete v části Objekt úlohy sestavení lampy.

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 musí být vytvořen stejným API klíčem, musí dosáhnout stavu SUCCEEDED a musí vytvořit právě jeden kandidátní obrázek.

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

  • Name
    name
    Type
    string
    Description

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

options

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

  • Name
    diameter_mm
    Type
    number
    výchozí 80
    Description

    Cílový maximální rozměr ohraničujícího kvádru stínidla lampy, v milimetrech. Síť je rovnoměrně škálována tak, aby se vešla. Rozsah: [50, 400].

  • Name
    thickness_mm
    Type
    number
    výchozí 1.5
    Description

    Tloušťka stěny dutého stínidla lampy, v milimetrech. Rozsah: (0, 10].

  • Name
    cut_amount_percent
    Type
    number
    výchozí 35
    Description

    Procento výšky stínidla lampy, které se má nahoře zploštit, aby tisk mohl stát na podložce. Rozsah: [1, 100].

  • Name
    light_source_preset
    Type
    string
    výchozí bambu_mh001_60mm
    Description

    Předvolba uchycení světelného zdroje, která určuje, zda (a jaký) základní disk se má vygenerovat spolu se stínidlem lampy. Dostupné hodnoty:

    • bambu_mh001_60mm (výchozí) — vygeneruje základní disk o velikosti 60 mm určený pro kompatibilní uchycení světelného zdroje. Výsledek zahrnuje model_urls.base_stl.
    • none — žádné uchycení, žádný základní disk. model_urls.base_stl je vynecháno.
  • Name
    fixture_offset_x_mm
    Type
    number
    výchozí 0
    Description

    Vodorovný posun výřezu uchycení na ose X vzhledem ke středu stínidla lampy, v milimetrech. Má význam pouze tehdy, když light_source_preset ≠ none. Rozsah: [-80, 80].

  • Name
    fixture_offset_z_mm
    Type
    number
    výchozí 0
    Description

    Svislý posun výřezu uchycení na ose Z vzhledem ke spodní části stínidla lampy, v milimetrech. Rozsah: [-80, 80].

  • Name
    rotate_x_deg
    Type
    number
    výchozí 0
    Description

    Rotace kolem osy X použitá na importovanou síť před zpracováním, ve stupních. Rozsah: [-360, 360].

  • Name
    rotate_y_deg
    Type
    number
    výchozí 0
    Description

    Rotace kolem osy Y použitá na importovanou síť před zpracováním, ve stupních. Rozsah: [-360, 360].

  • Name
    rotate_z_deg
    Type
    number
    výchozí 0
    Description

    Rotace kolem osy Z použitá na importovanou síť před zpracováním, ve stupních. Rozsah: [-360, 360].

  • Name
    include_result_json
    Type
    boolean
    výchozí false
    Description

    Když je true a output.format je zip, zahrne do balíčku result.json procesoru lampy (obsahující naměřené metriky sítě + vyřešenou sadu voleb). Ignoruje se, když je output.format stl.

output

Volitelný selektor přenosového formátu. Výchozí je stl.

  • Name
    format
    Type
    string
    výchozí stl
    Description

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

    • stl (výchozí) — vrátí stínidlo lampy jako model_urls.lamp_stl a navíc model_urls.base_stl, když light_source_preset ≠ none.
    • zip — zabalí každý artefakt, který procesor vygeneruje (lamp.stl, volitelné base.stl, volitelné result.json), do jednoho zipu a vrátí jej pod model_urls.bundle_zip.

Návratová hodnota

Vlastnost result odpovědi obsahuje id nově vytvořené úlohy sestavení lampy. Dotazujte se koncového bodu Získat úlohu nebo se přihlaste k odběru streamu, dokud úloha nedosáhne stavu SUCCEEDED, poté stáhněte artefakty z model_urls.

Chybové stavy

  • 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 nebyla ú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.
    • Volby mimo rozsah: Jedno z polí options bylo mimo 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á prototypová úloha neexistuje, patří jinému uživateli nebo byla vytvořena prostřednictvím webové aplikace (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/lamp/v1/build
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/lamp/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": {
      "diameter_mm": 120,
      "thickness_mm": 2,
      "light_source_preset": "bambu_mh001_60mm",
      "cut_amount_percent": 30
    },
    "output": {
      "format": "stl"
    }
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}
Build example
The build task turns the selected prototype image into a printable lampshade model.
Náhled modelu sestavení lampy Creative Lab
Build model preview
GET/openapi/creative-lab/lamp/v1/(prototype|build)/:id

Načíst úlohu lampy

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

Struktury odpovědí najdete v části Objekt úlohy prototypu lampy a Objekt úlohy sestavení lampy.

Parametry

  • Name
    id
    Type
    path
    Description

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

Vrací

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

Request

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

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

Prototype Response

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

Odstranění úlohy lampy

Zruší úlohu lampy. Pokud je úloha stále PENDING, kredity spotřebované při vytvoření se vrátí. Úlohy, které jsou již IN_PROGRESS, jsou zrušeny bez vrácení (worker už může spotřebovávat 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 lampy, 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/lamp/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578
curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/lamp/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/lamp/v1/(prototype|build)/:id/stream

Streamovat úlohu lampy

Streamujte aktualizace v reálném čase pro úlohu lampy 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 lampy, která se má streamovat.

Vrací

Vrací stream objektů úloh prototypu lampy nebo sestavení lampy 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/lamp/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream
curl -N https://api.meshy.ai/openapi/creative-lab/lamp/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-lamp-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "lamp_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/lamp.stl?Expires=***",
    "base_stl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/base.stl?Expires=***"
  }
}
GET/openapi/creative-lab/lamp/v1/(prototype|build)

Vypsat úlohy lampy

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

Návratová hodnota

Vrací stránkovaný seznam objektů úloh pro danou fázi — buď objekt úlohy prototypu lampy při výpisu /prototype, nebo objekt úlohy sestavení lampy při výpisu /build.

Request

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

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

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-lamp-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 lampy

Objekt úlohy prototypu lampy je pracovní jednotka, kterou Meshy sleduje za účelem vygenerování stylizovaného matně bílého koncepčního obrázku buď z textového promptu, nebo 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. Přestože jako implementační detail používáme k-sortable UUID pro ID úloh, neměli byste si dělat žádné předpoklady o formátu ID.

  • Name
    type
    Type
    string
    Description

    Typ úlohy. Hodnota je creative-lab-lamp-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, tato vlastnost bude 0. Jakmile bude úloha úspěšně dokončena, hodnota se změní 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, tato vlastnost bude 0.

  • Name
    finished_at
    Type
    timestamp
    Description

    Časové razítko okamžiku, kdy byla úloha dokončena, v milisekundách. Pokud úloha ještě není dokončena, tato vlastnost bude 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 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

    Stažitelné adresy URL kandidátů koncepčních obrázků vygenerovaných touto prototypovou úlohou. API aktuálně vždy vrací přesně jednoho kandidáta; pole je polem, aby budoucí revize mohly zpřístupnit více kandidátů bez zásadní změny.

Example Lamp Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-lamp-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í lampy

Objekt úlohy sestavení lampy je pracovní jednotka, kterou Meshy sleduje za účelem vygenerování finálního stínidla lampy připraveného pro 3D tisk z prototypové úlohy se stavem SUCCEEDED. Sestavení spouští nad konceptovým obrázkem prototypu pipeline image-to-3D draft + textura a poté síť postprocesuje pomocí procesoru lampy, aby ji vydutil, zploštil a (volitelně) vyřízl základnu pro uchycení.

Vlastnosti

  • Name
    id
    Type
    string
    Description

    Jedinečný identifikátor úlohy.

  • Name
    type
    Type
    string
    Description

    Typ úlohy. Hodnota je creative-lab-lamp-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í výsledku úlohy v milisekundách.

  • Name
    preceding_tasks
    Type
    integer
    Description

    Počet předcházejících úloh. Smysl má 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. Pro úlohy FAILED vrací 0 (kredity jsou při selhání vráceny).

  • Name
    model_urls
    Type
    object
    Description

    Stažitelné adresy URL pro vygenerované artefakty, indexované podle názvu artefaktu. Sada klíčů závisí na output.format a options.light_source_preset:

    • Name
      lamp_stl
      Type
      string
      Description

      Stažitelná adresa URL ke stínidlu lampy lamp.stl. Přítomno, když output.format bylo stl (výchozí hodnota).

    • Name
      base_stl
      Type
      string
      Description

      Stažitelná adresa URL k základně svítidla base.stl. Přítomno, když output.format bylo stl a options.light_source_preset nebylo none. Vynecháno, když předvolba svítidla byla none.

    • Name
      bundle_zip
      Type
      string
      Description

      Stažitelná adresa URL k zip balíčku všech artefaktů, které procesor vygeneruje (lamp.stl, volitelně base.stl a — když je options.include_result_json true — result.json). Přítomno, když output.format bylo zip. Když je přítomno bundle_zip, lamp_stl / base_stl jsou vynechány.

Example Lamp Build Task Object

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