Creative Lab API pro magnet na lednici

Proměňte fotografii ve 3D tisknutelný magnet na lednici s barevným reliéfem a plochou zadní stranou, a to ve dvou fázích. Úkol prototypu vygeneruje z fotografie barevný koncepční obrázek. Úkol sestavení poté tento obrázek přemění na reliéfní 3D model a jako input_task_id používá ID úkolu prototypu.

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ření úkolu prototypu magnetu na lednici

Vygeneruje jeden barevný koncepční obrázek z fotografie. Pro sestavení 3D modelu předejte ID tohoto úkolu koncovému bodu pro sestavení jako input_task_id. Popis polí úkolu najdete v Objektu úkolu prototypu magnetu na lednici.

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

Příklad prototypu

Začněte se zdrojovou fotografií a poté vygenerujte prototypový obrázek použitý ve fázi sestavení (build) magnetu na lednici.

Source landscape photo used as the Creative Lab Fridge Magnet input — Vstup prototypu

Creative Lab Fridge Magnet prototype output generated from the source photo — Výstup prototypu

Parametry

Name
image_url
Type
string
Povinné
Description
Fotografie, kterou chcete přeměnit na koncepční obrázek magnetu na lednici, jako veřejnou URL adresu nebo data URI (data:image/jpeg;base64,<vaše data obrázku zakódovaná v base64>).
Obrázek musí být soubor JPG, JPEG, PNG nebo WebP o velikosti nejvýše 20 MB.
Name
name
Type
string
Description
Název úkolu, maximálně 100 znaků. Vrátí se v poli name úkolu. Delší název vrátí 400.
Name
remove_background
Type
boolean
výchozí false
Description
Zda odstranit pozadí z prototypového obrázku. true vrátí průhledný RGBA PNG, který zachová celý magnet, takže jej můžete umístit na jakékoli pozadí. Sestavení (build) také začíná z obrázku bez pozadí. Pokud Meshy nedokáže pozadí odstranit, vrátí obrázek s jeho pozadím a úkol přesto uspěje.
Možnost remove_background u sestavení (build) je samostatná.

Návratové hodnoty

Pole result obsahuje ID nového úkolu prototypu. Získejte úkol nebo sledujte jeho stream, dokud status nebude SUCCEEDED. Poté předejte ID koncovému bodu pro sestavení jako input_task_id.

Způsoby selhání

Name
400 - Bad Request
Description
Požadavek nelze spustit. Například:
- Chybí image_url.
- Obrázek není soubor JPG, JPEG, PNG ani WebP.
- Obrázek je příliš malý, přesahuje 20 MB nebo překračuje maximální počet pixelů.
- Meshy nemůže obrázek stáhnout, například protože URL vrací 404 nebo vyprší časový limit.
- Data URI není platný base64.
- Obrázek byl označen jako nevhodný (NSFW).
Chybová zpráva uvádí, jaký problém byl zjištěn. Opravte požadavek a odešlete jej znovu.
Name
401 - Unauthorized
Description
API klíč chybí nebo je neplatný. Zkontrolujte hlavičku Authorization.
Name
402 - Payment Required
Description
Platí jedna z těchto situací:
- Účet nemá dostatek kreditů.
- API klíč, pracovní prostor nebo člen dosáhl svého limitu kreditů.
- Účet je na bezplatném plánu.
Zkontrolujte své kredity a plán a zkuste to znovu.
Name
403 - Forbidden
Description
Váš tým má zapnutou funkci IP Filtering a Meshy obrázek označilo kvůli duševnímu vlastnictví třetí strany. Odešlete obrázek, ke kterému máte práva na použití.
Name
429 - Too Many Requests
Description
Byl dosažen jeden z těchto limitů:
- Odeslali jste více požadavků, než povoluje váš limit rychlosti. Počkejte několik sekund a zkuste to znovu. Viz Limity rychlosti.
- Příliš mnoho vašich úkolů je ve frontě nebo probíhá. Počkejte, až se některé dokončí, a zkuste to znovu.
- V neomezeném plánu bez zbývajících kreditů jste dosáhli počtu úkolů, které lze spustit bez kreditů. Počkejte na dokončení úkolu nebo přidejte kredity.
Name
500 - Internal Server Error
Description
Meshy narazilo na chybu serveru, například proto, že nemohlo spustit kontrolu duševního vlastnictví na obrázku. Meshy úkol nevytvoří a vrátí všechny účtované kredity. Zkuste požadavek odeslat znovu.

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

Vytvoření úlohy sestavení magnetu na lednici

Vygeneruje 3D tisknutelný magnet na lednici z úspěšně dokončené úlohy prototypu. Meshy přemění koncepční obrázek prototypu na reliéf z hloubkové mapy a vrátí jeden soubor modelu ve vámi zvoleném formátu. Pole úlohy naleznete v části Objekt úlohy sestavení magnetu na lednici.

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.

Creative Lab Fridge Magnet build model preview — Build model preview

Parametry

Name
input_task_id
Type
string
Povinné
Description
ID úlohy prototypu, která se má sestavit. Musí jít o úlohu vytvořenou vaším účtem pomocí POST /openapi/creative-lab/fridge-magnet/v1/prototype, se stavem SUCCEEDED.
ID, které neodpovídá žádné vaší úloze prototypu magnetu na lednici z API, vrátí 404, včetně prototypu vytvořeného ve webové aplikaci.
Name
name
Type
string
Description
Název úlohy, až 100 znaků. Vrátí se v poli name úlohy. Delší název vrátí 400.

`options`

Volitelná nastavení pro tvar reliéfu. Každé pole má výchozí hodnotu, takže odešlete pouze ta, která chcete změnit. Hodnota mimo rozsah pole vrátí 400.

Name
badge_shape
Type
string
výchozí rounded-rect
Description
Obrys magnetu v případě, že jej Meshy nevysleduje podle motivu. Meshy jej použije, pokud je remove_background nastaveno na false, nebo pokud se nepodaří najít obrys motivu.
Dostupné hodnoty:
- circle
- rounded-rect
- hexagon
- shield
- star
Name
size_mm
Type
number
výchozí 60
Description
Délka hrany ohraničujícího čtverce magnetu, v milimetrech, až 400. 0 použije výchozí hodnotu.
Name
relief_height_mm
Type
number
výchozí 3.3
Description
Maximální výška reliéfu nad základnou, v milimetrech, od 0 do 20.
Name
relief_offset_mm
Type
number
výchozí 0
Description
O kolik snížit reliéf, v milimetrech, od 0 do 20. Meshy tuto hodnotu odečte od výšky reliéfu všude, až k základně.
Name
base_thickness_mm
Type
number
výchozí 2.0
Description
Tloušťka ploché základní desky za reliéfem, v milimetrech, od 0 do 20. Výchozí základna o tloušťce 2 mm dává magnetu dostatek objemu, aby se přichytil k lednici, takže reliéf nepůsobí křehce.
Name
has_closed_back
Type
boolean
výchozí true
Description
Zda uzavřít zadní stranu magnetu, tu stranu, kterou magnet lepíte. false ponechá zadní stranu otevřenou, jako skořepinu.
Name
relief_curve
Type
string
výchozí linear
Description
Křivka, která mapuje hodnoty hloubkové mapy na výšku reliéfu.
Dostupné hodnoty:
- linear
- gamma
- s-curve
Name
curve_param
Type
number
výchozí 1.0
Description
Síla křivky, až 10. Používají ji křivky gamma a s-curve, zatímco linear ji ignoruje. 0 použije výchozí hodnotu.
Name
invert_depth
Type
boolean
výchozí false
Description
Zda invertovat hloubkovou mapu, takže tmavší oblasti se stanou vyšším reliéfem.
Name
smoothing
Type
number
výchozí 0.24
Description
Jak moc vyhladit hloubkovou mapu před tím, než Meshy sestaví reliéf, od 0 do 10.
Name
relief_scale
Type
number
výchozí 1.0
Description
Jak moc přiblížit reliéf a jeho texturu uvnitř obrysu, kolem středu, až 10. Hodnota nad 1 zvětší motiv a hodnota pod 1 jej zmenší. Nemění výšku reliéfu. 0 použije výchozí hodnotu.
Name
depth_threshold
Type
number
výchozí 0.1
Description
Hodnota hloubkové mapy, pod kterou Meshy nastaví hloubku na nulu, od 0 do 1.
Name
remove_background
Type
boolean
výchozí true
Description
Zda vysledovat obrys magnetu podle motivu, takže magnet kopíruje tvar motivu. false místo toho použije obrys badge_shape. Meshy použije badge_shape také v případě, že se nepodaří najít obrys motivu.
Toto je oddělené od parametru prototypu remove_background, který určuje, zda má obrázek prototypu průhledné pozadí.
Name
export_resolution
Type
integer
výchozí 512
Description
Rozlišení sítě exportovaného modelu, od 64 do 512. Meshy sestavuje geometrii z 512pixelové hloubkové mapy, takže jemnější síť by přidala plochy bez přidání detailu. 0 použije výchozí hodnotu.

`output`

Volitelné. Nastavuje formát souboru, který sestavení vrátí.

Name
format
Type
string
výchozí glb
Description
Formát souboru, který sestavení vrátí.
Dostupné hodnoty:
- glb: jeden soubor model.glb, v model_urls.glb
- obj: zip soubor s model.obj, model.mtl a texture.png, v model_urls.obj
- zip: zip soubor s každým souborem, který Meshy vygeneruje, v model_urls.bundle_zip

Návratové hodnoty

Pole result obsahuje ID nové úlohy sestavení. Získejte úlohu nebo streamujte ji, dokud status není SUCCEEDED. Poté stáhněte soubor z jediné položky v model_urls.

Režimy selhání

Name
400 - Bad Request
Description
Požadavek nelze spustit. Například:
- input_task_id chybí nebo není platné ID úlohy.
- Stav úlohy prototypu není SUCCEEDED. Pokud stále běží, počkejte a zkuste to znovu. Pokud selhala nebo byla zrušena, vytvořte novou úlohu prototypu.
- Úloha prototypu byla úspěšná, ale neobsahuje žádný obrázek. Vytvořte novou úlohu prototypu.
- Pole options je mimo svůj rozsah nebo není dostupnou hodnotou.
Chybová zpráva uvádí, jaký problém byl nalezen.
Name
401 - Unauthorized
Description
API klíč chybí nebo je neplatný. Zkontrolujte hlavičku Authorization.
Name
402 - Payment Required
Description
Platí jedno z následujícího:
- Účet nemá dostatek kreditů.
- API klíč, pracovní prostor nebo člen dosáhl svého limitu kreditů.
- Účet má bezplatný plán.
Zkontrolujte své kredity a plán a zkuste to znovu.
Name
404 - Not Found
Description
input_task_id neodpovídá žádné úloze prototypu magnetu na lednici, kterou váš účet vytvořil pomocí API. Prototyp vytvořený ve webové aplikaci také vrátí 404. Odešlete ID result z odpovědi na vytvoření prototypu.
Name
429 - Too Many Requests
Description
Byl dosažen jeden z těchto limitů:
- Odeslali jste více požadavků, než povoluje váš limit rychlosti. Počkejte několik sekund a zkuste to znovu. Viz Limity rychlosti.
- Příliš mnoho vašich úloh čeká ve frontě nebo běží. Počkejte, až se některé dokončí, a zkuste to znovu.
- V neomezeném plánu bez zbývajících kreditů jste dosáhli počtu úloh, které mohou běžet bez kreditů. Počkejte na dokončení úlohy nebo přidejte kredity.

GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id

Získání úkolu magnetu na lednici

Vrátí prototypový nebo build úkol. Cesta musí odpovídat fázi úkolu. Build úkol vyžádaný přes /prototype/:id vrátí 404, a stejně tak prototypový úkol vyžádaný přes /build/:id.

Popis polí najdete v objektu prototypového úkolu magnetu na lednici a objektu build úkolu magnetu na lednici.

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": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

Parametry

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

Návratová hodnota

Objekt prototypového úkolu nebo objekt build úkolu, podle fáze uvedené v cestě.

Způsoby selhání

Name
400 - Bad Request
Description
id není platné ID úkolu. Odešlete ID result z odpovědi na vytvoření.
Name
403 - Forbidden
Description
Váš tým má zapnuté IP Filtering a Meshy označilo obrázek prototypového úkolu kvůli duševnímu vlastnictví třetí strany. Build úkoly a týmy na plánu Enterprise tuto chybu nedostávají. Vytvořte prototypový úkol z obrázku, k jehož použití máte práva.
Name
404 - Not Found
Description
Žádný úkol magnetu na lednici s tímto ID nepatří k vašemu účtu, nebo fáze úkolu neodpovídá cestě. Zkontrolujte ID a použijte /prototype nebo /build tak, aby odpovídalo úkolu.
Name
500 - Internal Server Error
Description
Meshy nemohlo spustit kontrolu duševního vlastnictví. Zkuste požadavek znovu.

DELETE/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id

Smazání úkolu magnet na lednici

Zruší úkol magnet na lednici. Zrušení úkolu ve stavu PENDING vrátí jeho kredity. Úkol ve stavu IN_PROGRESS je zrušen bez vrácení kreditů, protože na něm už pracuje worker. Úkol s konečným stavem (SUCCEEDED, FAILED nebo CANCELED) nelze zrušit.

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

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).

Parametry cesty

Name
id
Type
path
Description
ID úkolu, který se má zrušit.

Návratová hodnota

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

Režimy selhání

Name
400 - Bad Request
Description
Platí jedno z následujícího:
- id není platné ID úkolu. Odešlete ID result z odpovědi na vytvoření.
- Úkol už má konečný stav (SUCCEEDED, FAILED nebo CANCELED), takže jej nelze zrušit.
Name
404 - Not Found
Description
K vašemu účtu nepatří žádný úkol magnet na lednici s tímto ID, nebo fáze úkolu neodpovídá cestě. Zkontrolujte ID a použijte /prototype nebo /build podle typu úkolu.

GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id/stream

Streamování úlohy magnetu na lednici

Streamuje aktualizace úlohy magnetu na lednici jako Server-Sent Events (SSE). Cesta musí odpovídat fázi úlohy. Pokud neodpovídá, například pokud je ID buildovací úlohy použito na /prototype/:id/stream, stream odešle jednu error událost se status_code: 404 a uzavře se.

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.
// Every frame is the full task object; fields not yet populated are null / empty.
// The following PENDING frame is shortened to the fields that change.
event: message
data: {
  "id": "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": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

Parametry

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

Návratová hodnota

Stream objektů úlohy typu prototype nebo build. Každá událost obsahuje celý objekt úlohy, přesně tak, jak jej vrací Získání úlohy magnetu na lednici. Dokud je úloha ve stavu PENDING nebo IN_PROGRESS, její výstupní pole jsou stále prázdná (null, [] nebo {}) a finished_at je null.

Pokud IP Filtering zablokuje výsledek úlohy, stream místo něj odešle jednu error událost se status_code, který by vrátil get požadavek.

GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)

Seznam úloh magnetu na lednici

Vrátí vaše úlohy magnetu na lednici pro jednu fázi, vždy jednu stránku. Fázi vybírá cesta. /prototype vrací pouze úlohy prototypu a /build vrací pouze úlohy sestavení.

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

Parametry cesty

Name
stage
Type
path
Povinné
Description
Fáze k výpisu, prototype nebo build.

Parametry dotazu

Name
page_num
Type
integer
výchozí 1
Description
Stránka, která se má vrátit, od 1 do 255. Hodnota 0 vrátí první stránku. Hodnota mimo rozsah 0 až 255 vrátí 400.
Name
page_size
Type
integer
výchozí 10
Description
Počet úloh na stránku, až 100. Hodnota od 101 do 255 vrátí 100 úloh a 0 použije výchozí hodnotu. Hodnota mimo rozsah 0 až 255 vrátí 400.
Name
sort_by
Type
string
výchozí -created_at
Description
Pořadí řazení.
Dostupné hodnoty:
- -created_at: nejnovější první
- +created_at: nejstarší první

Návratová hodnota

Pole objektů úlohy prototypu nebo objektů úlohy sestavení, odpovídající fázi uvedené v cestě.

Objekt úkolu prototypu magnetu na lednici

Úkol typu prototyp vygeneruje z fotografie barevný koncepční obrázek. Pokud chcete obrázek převést na 3D model, předejte ID úkolu do koncového bodu pro sestavení jako input_task_id.

Vlastnosti

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

Name
id
Type
string
Description
ID úkolu. Nespoléhejte na jeho formát.
Name
type
Type
string
Description
Typ úkolu, vždy creative-lab-fridge-magnet-prototype.
Name
name
Type
string
Description
Hodnota name, kterou jste odeslali při vytvoření úkolu, nebo "", pokud jste žádnou neodeslali.
Name
status
Type
string
Description
Stav úkolu.
Dostupné hodnoty:
- PENDING: čeká ve frontě
- IN_PROGRESS: probíhá generování výsledku
- SUCCEEDED: konečný stav, s výsledkem
- FAILED: konečný stav, s důvodem v task_error
- CANCELED: konečný stav, bez výsledku
Name
progress
Type
integer
Description
Procento dokončené práce, od 0 do 100. Je 0, dokud úkol nezačne, a 100, když se úspěšně dokončí.
Name
created_at
Type
timestamp
Description
Čas vytvoření úkolu, v milisekundách Unix.
Name
started_at
Type
timestamp
Description
Čas, kdy worker úkol spustil, v milisekundách Unix. Do té doby null.
Name
finished_at
Type
timestamp
Description
Čas, kdy úkol dosáhl konečného stavu, v milisekundách Unix. Do té doby null.
Name
expires_at
Type
timestamp
Description
Čas, kdy vyprší platnost výsledku úkolu, v milisekundách Unix. Je to 3 dny po finished_at, nebo 3 dny po created_at, dokud úkol není dokončen. U účtů Enterprise, které uchovávají výsledky API neomezeně dlouho, je to přibližně o 100 let později. Viz Uchování assetů.
Name
preceding_tasks
Type
integer
Description
Pozice úkolu ve frontě, dokud má stav PENDING. 1 znamená, že je na řadě jako další. 0 poté, co úkol opustí frontu, a vždy 0 ve výsledcích seznamu.
Name
task_error
Type
object
Description
Důvod, proč úkol selhal. null, pokud status není FAILED. Viz Chyby.
Name
consumed_credits
Type
integer
Description
Počet kreditů účtovaných za úkol, po případném vrácení. Požadavek, který vrátí chybu, se neúčtuje. Neúspěšný úkol má hodnotu 0, protože Meshy jej vrátí. Zrušení vrátí kredity za úkol pouze tehdy, pokud má stav PENDING. Pokud Meshy nedokáže přečíst účtovanou částku, odpověď na dotaz nebo stream toto pole vynechá a požadavek na seznam vrátí 500. V takovém případě požadavek zopakujte.
Name
image_urls
Type
array of strings
Description
URL adresy ke stažení koncepčního obrázku. Pole obsahuje jednu URL adresu poté, co se úkol úspěšně dokončí, do té doby je prázdné.

Objekt build úlohy magnetu na lednici

Build úloha generuje 3D magnet na lednici z úspěšně dokončené prototype úlohy. Vrací jeden soubor modelu ve formátu, který jste požadovali.

Vlastnosti

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": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

Name
id
Type
string
Description
ID úlohy. Nespoléhejte na jeho formát.
Name
type
Type
string
Description
Typ úlohy, vždy creative-lab-fridge-magnet-build.
Name
name
Type
string
Description
Hodnota name, kterou jste odeslali při vytváření úlohy, nebo "", pokud jste žádnou neodeslali.
Name
status
Type
string
Description
Stav úlohy.
Dostupné hodnoty:
- PENDING: čeká ve frontě
- IN_PROGRESS: generuje se výsledek
- SUCCEEDED: konečný stav, s výsledkem
- FAILED: konečný stav, s důvodem v task_error
- CANCELED: konečný stav, bez výsledku
Name
progress
Type
integer
Description
Procento dokončené práce, od 0 do 100. Je 0, dokud úloha nezačne, a 100, když je úspěšná.
Name
created_at
Type
timestamp
Description
Čas vytvoření úlohy, v milisekundách Unix času.
Name
started_at
Type
timestamp
Description
Čas, kdy pracovník úlohu spustil, v milisekundách Unix času. Do té doby null.
Name
finished_at
Type
timestamp
Description
Čas, kdy úloha dosáhla konečného stavu, v milisekundách Unix času. Do té doby null.
Name
expires_at
Type
timestamp
Description
Čas, kdy vyprší platnost výsledku úlohy, v milisekundách Unix času. Je to 3 dny po finished_at, nebo 3 dny po created_at, dokud úloha nedoběhne. U podnikových (Enterprise) účtů, které uchovávají výsledky API neomezeně dlouho, je to přibližně o 100 let později. Viz Uchování assetů.
Name
preceding_tasks
Type
integer
Description
Pozice úlohy ve frontě, dokud je ve stavu PENDING. Hodnota 1 znamená, že bude spuštěna jako další. 0 poté, co úloha opustí frontu, a vždy 0 ve výsledcích výpisu.
Name
task_error
Type
object
Description
Důvod, proč úloha selhala. null, pokud status není FAILED. Viz Chyby.
Name
consumed_credits
Type
integer
Description
Počet kreditů účtovaných za úlohu, po případném vrácení. Požadavek, který vrátí chybu, není zpoplatněn. Neúspěšná úloha má hodnotu 0, protože Meshy ji vrátí. Zrušení vrátí kredity za úlohu pouze tehdy, je-li ve stavu PENDING. Pokud Meshy nedokáže zjistit výši účtované částky, odpověď typu get nebo stream toto pole vynechá a požadavek na výpis vrátí 500. V takovém případě požadavek zopakujte.
Name
model_urls
Type
object
Description
Adresy URL pro stažení souboru modelu, s jednou položkou pro formát output.format, který jste požadovali. {}, dokud úloha neuspěje.
- Name
  glb
  Type
  string
  Description
  Adresa URL pro stažení souboru GLB. Přítomna, pokud je output.format rovno glb.
- Name
  obj
  Type
  string
  Description
  Adresa URL pro stažení zip souboru obsahujícího model.obj, model.mtl a texture.png. Přítomna, pokud je output.format rovno obj.
- Name
  bundle_zip
  Type
  string
  Description
  Adresa URL pro stažení zip souboru se všemi soubory, které Meshy vygeneruje. Přítomna, pokud je output.format rovno zip.