Creative Lab — Fidget Pixel API

Zdrojová fotografie, kterou má Meshy pixelizovat. Aktuálně podporujeme formáty .jpg, .jpeg, .png a .webp.

Formát se zjišťuje dekódováním obrazových dat, nikoli podle přípony souboru v URL — URL bez přípony nebo URL, která přesměrovává, funguje, pokud se bajty dekódují na podporovaný formát. HTTP přesměrování jsou následována.

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

• Veřejně přístupná URL: URL, která je přístupná z veřejného internetu.
• Data URI: Base64 kódovaná Data URI obrázku. Příklad Data URI: data:image/jpeg;base64,<vaše base64 kódovaná obrazová data>.

Co fotografie zobrazuje. Určuje styl pixelizace, proto volte záměrně — obě hodnoty produkují viditelně odlišné výsledky. Dostupné hodnoty:

• person — subjektem je osoba (portrét nebo celá postava). Vytvoří pixelový sprite subjektu ve stylu chibi.
• other — cokoliv jiného: domácí mazlíčci, předměty, maskoti, loga, krajiny. Vytvoří pixelovou ikonu subjektu ve stylu korálkové mozaiky (bead-art).

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

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

• Chybějící parametr: image_url i type jsou povinné.
• Neplatný typ: type musí být person nebo other.
• Neplatný formát obrázku: Poskytnuté image_url není v podporovaném formátu (.jpg, .jpeg, .png, .webp).
• Rozměry obrázku mimo rozsah: Obrázek je příliš malý, přesahuje maximální velikost souboru nebo přesahuje maximální počet pixelů.
• Nedostupná URL: image_url se nepodařilo stáhnout (404 nebo timeout).
• Neplatná Data URI: Base64 řetězec je poškozený.
• Obsah označen: Vstupní obrázek byl označen NSFW moderací.

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

Nedostatek kreditů k provedení této úlohy, nebo API klíč patří k účtu s bezplatným plánem.

Vstupní obrázek byl označen moderací duševního vlastnictví (Content flagged for intellectual property violation). Blokovány jsou pouze Enterprise účty s povolenou filtrací duševního vlastnictví; nic není účtováno.

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

Samotnou kontrolu duševního vlastnictví se nepodařilo dokončit (Unable to perform intellectual property check, please try again). Enterprise účty s povolenou filtrací duševního vlastnictví při této kontrole selžou uzavřeně; nic není účtováno — požadavek zopakujte.

ID úlohy prototypové úlohy vytvořené prostřednictvím téhož koncového bodu OpenAPI. Prototyp musel být vytvořen stejným účtem Meshy a musel dosáhnout stavu SUCCEEDED.

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

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

Půdorys každého dílu. Dostupné hodnoty:

• square (výchozí) — čtvercové díly na čtvercové mřížce.
• hex — šestiúhelníkové díly na šestiúhelníkové mřížce. Šestiúhelníkové díly jsou dostupné pouze v provedení 6 a 8 mm.

Počet dílů podél každé strany desky. Dostupné hodnoty: 16 nebo 32. Mřížka 32 zachovává více detailů; mřížka 16 znamená méně, ale větší díly pro stejný motiv.

Délka hrany každého dílu v milimetrech. Dostupné hodnoty: 6, 8 nebo 10. Společně s grid_size toto určuje velikost vytištěné desky — například 32 × 8 mm ≈ 26 cm na stranu. Hodnota 10 není dostupná pro shape: "hex" (šikmá plocha šestiúhelníku přesahuje na většině spotřebitelských tiskáren FDM).

Maximální počet barev v paletě, na kterou je obrázek kvantizován. Rozsah: [1, 8]. Každá barva se stane jedním filamentem ve vašem sliceru.

Výška každého dílu v milimetrech. Rozsah: [10, 80].

Artefakt vrácený sestavením. Dostupné hodnoty:

• 3mf (výchozí) — vrátí jediný soubor model.3mf v poli model_urls.3mf, s jedním objektem na díl a barvou dílu přiřazenou ke každému objektu.

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 nedokončena úspěšně: Odkazovaná prototypová úloha ještě nedosáhla stavu SUCCEEDED.
• Žádný kandidát: Prototypová úloha byla úspěšná, ale nevytvořila žádný pixel-artový obrázek; vytvořte nový prototyp.
• Volby mimo rozsah: Jedno z polí options je mimo povolenou množinu nebo rozsah — například options.grid_size must be 16 or 32, nebo options.piece_size_mm=10 is not supported for shape=hex; hex pieces are available in 6 and 8 mm.
• Nepodporovaný formát: output.format musí být 3mf.

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

Nedostatek kreditů pro provedení této úlohy, nebo API klíč patří k účtu s bezplatným plánem.

Obrázek odkazovaného prototypu byl označen moderací duševního vlastnictví. Blokovány jsou pouze podnikové (Enterprise) účty s povolenou filtrací duševního vlastnictví; nic se přitom neúčtuje.

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

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

Verdikt ohledně duševního vlastnictví odkazovaného prototypu se nepodařilo stanovit (Unable to perform intellectual property check, please try again). Podnikové (Enterprise) účty s povolenou filtrací duševního vlastnictví u této kontroly selžou uzavřeně (fail closed); nic se přitom neúčtuje — zopakujte požadavek.

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

id není platné UUID (Invalid ID).

Obrázek úlohy byl označen moderací duševního vlastnictví. Blokovány jsou pouze podnikové účty (Enterprise) s povoleným filtrováním duševního vlastnictví.

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

Kontrolu duševního vlastnictví se nepodařilo dokončit (Unable to perform intellectual property check, please try again); podnikové účty (Enterprise) s povoleným filtrováním duševního vlastnictví v tomto případě selžou uzavřeně (fail closed). Zopakujte požadavek.

Jedinečný identifikátor úlohy fidget pixel, kterou chcete zrušit.

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

• Neplatné ID: id není platné UUID.
• Konečný stav: Úloha je již ve stavu SUCCEEDED, FAILED nebo CANCELED a nelze ji zrušit.

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

Jedinečný identifikátor úlohy fidget pixel, kterou chcete streamovat.

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

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

Limit velikosti stránky. Maximální povolená hodnota je 100 položek.

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

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

Jedinečný identifikátor úlohy. Ačkoli 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.

Typ úlohy. Hodnota je creative-lab-fidget-pixel-prototype.

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

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

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

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

Časové razítko okamžiku zahájení úlohy, v milisekundách. Pokud úloha ještě nebyla zahájena, tato vlastnost bude null.

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

Časové razítko okamžiku, kdy vyprší platnost výsledku úlohy, v milisekundách — 3 dny po dokončení úlohy. Enterprise účty uchovávají výsledky API bez omezení (viz Uchování assetů); pro ně je toto časové razítko nastaveno přibližně 100 let dopředu.

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

Podrobnosti o chybě pro neúspěšné úlohy. Kompletní referenci objektu task_error naleznete v části Chyby.

Počet kreditů spotřebovaných touto úlohou. Úloze, která dosáhne stavu SUCCEEDED, je účtována plná částka za danou fázi. Úloha, která nikdy nebyla vytvořena (4xx v době požadavku, včetně zamítnutí moderation), se neúčtuje vůbec. Úloha, která dosáhne stavu FAILED, vrací 0 — poplatek je vrácen. Zrušení pomocí DELETE vrátí poplatek pouze v případě, že úloha je stále ve stavu PENDING; úloha, která je již IN_PROGRESS, zůstává zpoplatněna, protože práce již byla vynaložena.

URL adresy ke stažení obrázku v pixel-art stylu vygenerovaného touto prototypovou úlohou. V současnosti API vždy vrací přesně jeden obrázek; pole je typu array, aby budoucí revize mohly nabídnout více kandidátů bez rušivé změny. Prázdné, dokud úloha nedosáhne stavu SUCCEEDED.

Jedná se o podepsané URL adresy: načítejte je bez hlavičky Authorization. Zůstávají platné až do expires_at, což je 3 dny po finished_at, a opětovné načtení úlohy v tomto časovém okně vrátí identickou URL adresu namísto nově podepsané. Soubory si stáhněte a uložte sami ještě před vypršením platnosti — neexistuje způsob, jak obnovit platnost vypršeného odkazu.

Jedinečný identifikátor úkolu.

Typ úkolu. Hodnota je creative-lab-fidget-pixel-build.

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

Stav úkolu. Možné hodnoty jsou PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Postup (progress) úkolu. Pokud úkol ještě nebyl zahájen, tato vlastnost bude 0. Jakmile úkol uspěje, hodnota se změní na 100.

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

Časové razítko zahájení úkolu, v milisekundách. null, dokud úkol nezačne.

Časové razítko dokončení úkolu, v milisekundách. null, dokud úkol neskončí.

Časové razítko vypršení platnosti výsledku úkolu, v milisekundách — 3 dny po dokončení úkolu. Firemní (Enterprise) účty uchovávají výsledky API po neomezenou dobu (viz Uchování assetů); pro ně je toto časové razítko nastaveno přibližně o 100 let dopředu.

Počet předcházejících úkolů. Má smysl pouze v případě, že stav je PENDING.

Podrobnosti o chybě u neúspěšných úkolů. Úplný popis objektu task_error naleznete v části Chyby.

Počet kreditů spotřebovaných tímto úkolem. Úkolu, který dosáhne stavu SUCCEEDED, je účtována plná částka za jeho fázi. Úkol, který nikdy nebyl vytvořen (chyba 4xx v okamžiku požadavku, včetně zamítnutí moderation), není účtován vůbec. Úkol, který skončí ve stavu FAILED, vrací 0 — poplatek je vrácen. Zrušení pomocí DELETE vrátí poplatek pouze tehdy, pokud je úkol stále ve stavu PENDING; úkol, který je již IN_PROGRESS, zůstává zpoplatněn, protože práce již byla vynaložena.

Stažitelné URL adresy pro vygenerovaný výstup, klíčované podle formátu. Obsahuje přesně jednu položku — formát požadovaný pomocí output.format v požadavku na build. Prázdné, dokud úkol nedosáhne stavu SUCCEEDED.

Jedná se o podepsané URL adresy: načítejte je bez hlavičky Authorization. Zůstávají platné až do expires_at, což je 3 dny po finished_at, a opakované načtení úkolu v tomto časovém okně vrátí identickou URL adresu namísto nově podepsané. Soubory si stáhněte a uložte sami před vypršením platnosti — vypršenou adresu není možné obnovit.