Creative Lab Lamp API

Fotografie, na jejímž základě vznikne stínidlo lampy, zadaná jako veřejná URL adresa 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.

Druh objektu na fotografii, podle kterého Meshy určuje styl ztvárnění.

Dostupné hodnoty:

• character: jedna postava nebo objekt, například figurka, zvíře nebo maskot
• landscape: venkovní scéna nebo panorama, například hora, panorama města nebo les

Název úkolu, maximálně 100 znaků. Vrací se v poli name daného úkolu. Delší název vrátí 400.

Zda odstranit pozadí z koncepčního obrázku. true vrátí průhledný PNG v režimu RGBA, takže objekt lze umístit na libovolné pozadí. Meshy také sestaví 3D model z obrázku bez jeho pozadí. Pokud Meshy nedokáže pozadí odstranit, použije obrázek s jeho pozadím a úkol přesto proběhne úspěšně.

Požadavek nelze spustit. Například:

• Chybí image_url.
• Obrázek není soubor JPG, JPEG, PNG ani WebP.
• Obrázek je příliš malý, větší než 20 MB nebo překračuje maximální počet pixelů.
• Meshy nemůže obrázek stáhnout, například proto, že URL adresa vrací 404 nebo vyprší časový limit.
• Data URI není platné v base64.
• Obrázek byl označen jako NSFW.
• image_subject není character ani landscape.

Chybová zpráva uvádí, jaký problém byl nalezen. Opravte požadavek a odešlete jej znovu.

API klíč chybí nebo je neplatný. Zkontrolujte hlavičku Authorization.

Platí jedna z těchto možností:

• Úč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 poté akci zopakujte.

Váš tým má zapnuté IP Filtering a Meshy obrázek označilo jako obsahující duševní vlastnictví třetí strany. Odešlete obrázek, ke kterému máte práva k použití.

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 poté akci zopakujte. Viz Rate limits.
• Je zařazeno nebo spuštěno příliš mnoho vašich úkolů. Počkejte, až se některé dokončí, a poté akci zopakujte.
• V neomezeném plánu bez zbývajících kreditů jste dosáhli počtu úkolů, které lze spustit bez kreditů. Počkejte, až se nějaký úkol dokončí, nebo přidejte kredity.

V Meshy došlo k chybě serveru, například proto, že se nepodařilo provést kontrolu duševního vlastnictví u obrázku. Meshy úkol nevytvoří a vrátí veškeré účtované kredity. Odešlete požadavek znovu.

ID úlohy prototypu, která se má sestavit. Musí jít o úlohu vytvořenou vaším účtem pomocí POST /openapi/creative-lab/lamp/v1/prototype, se stavem SUCCEEDED.

ID, které neodpovídá žádné z vašich úloh prototypu lampy z API, vrátí 404, včetně prototypu vytvořeného ve webové aplikaci.

Název úlohy, až 100 znaků. Vrátí se v poli úlohy name. Delší název vrátí 400.

Velikost největšího rozměru stínidla lampy, v milimetrech, od 50 do 400. Meshy model rovnoměrně zvětší nebo zmenší, aby se vešel. 0 použije výchozí hodnotu a jakákoli jiná hodnota mimo rozsah vrátí 400.

Tloušťka stěny stínidla lampy, v milimetrech, až 10. 0 použije výchozí hodnotu, záporná hodnota nebo hodnota nad 10 vrátí 400.

Procento výšky modelu, které se má seříznout naplocho ve spodní části, od 1 do 100. Plochá spodní část umožňuje, aby stínidlo stálo na tiskové podložce, a ponechává prostor pro objímku. Hodnota mimo rozsah vrátí 400.

Přednastavení objímky světla, které určuje, jak Meshy sestaví spodní část.

Dostupné hodnoty:

• bambu_mh001_60mm: stínidlo s otevřenou spodní částí a základovou deskou s 60mm otvorem pro objímku, oboje v model_urls.lamp_stl, a držák objímky v model_urls.base_stl
• none: jedno uzavřené stínidlo v model_urls.lamp_stl, bez model_urls.base_stl

O kolik posunout otvor pro objímku podél osy X od středu stínidla, v milimetrech, od -80 do 80. Platí pouze, pokud light_source_preset není none.

O kolik posunout otvor pro objímku podél osy Z (hloubka) od středu stínidla, v milimetrech, od -80 do 80. Platí pouze, pokud light_source_preset není none.

Otočení kolem osy X, které se má na model aplikovat před zpracováním Meshy, ve stupních, od -360 do 360. Meshy aplikuje tři otočení jako Eulerovy úhly XYZ kolem středu modelu.

Otočení kolem osy Y, které se má na model aplikovat před zpracováním Meshy, ve stupních, od -360 do 360.

Otočení kolem osy Z, které se má na model aplikovat před zpracováním Meshy, ve stupních, od -360 do 360.

Zda se má do zip balíčku přidat soubor result.json s názvem spuštěného postupu zpracování, varováními a cestami k souborům. Vyžaduje, aby output.format bylo nastaveno na zip. true se stl vrátí 400.

Soubory, které sestavení vrátí.

Dostupné hodnoty:

• stl: model_urls.lamp_stl, stínidlo se základovou deskou, pokud je použito přednastavení objímky, a model_urls.base_stl, pokud light_source_preset není none
• zip: jeden zip soubor v model_urls.bundle_zip, se soubory lamp.stl a případně base.stl a result.json, pokud se uplatní

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ý 3D model. Vytvořte novou úlohu prototypu.
• Pole v options je mimo svůj rozsah nebo nejde o dostupnou hodnotu.
• output.format není stl ani zip, nebo je include_result_json nastaveno na true bez zip.

Chybová zpráva uvádí, jaký problém byl zjištěn.

API klíč chybí nebo je neplatný. Zkontrolujte hlavičku Authorization.

Platí jedna z těchto možností:

• Účet nemá dostatek kreditů.
• API klíč, pracovní prostor nebo člen dosáhl svého kreditního limitu.
• Účet má bezplatný plán.

Zkontrolujte své kredity a plán a poté to zkuste znovu.

input_task_id neodpovídá žádné úloze prototypu lampy, 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.

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 je ve frontě nebo probíhá. Počkejte, až se některé dokončí, a zkuste to znovu.
• Na 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.

ID úlohy z odpovědi na vytvoření.

id není platné ID úlohy. Odešlete ID result z odpovědi na vytvoření.

Váš tým má zapnuté IP Filtering a Meshy označilo obrázek prototypové úlohy jako obsahující duševní vlastnictví třetí strany. U sestavovacích úloh a týmů v plánu Enterprise se tato chyba nevyskytuje. Vytvořte prototypovou úlohu z obrázku, ke kterému máte práva k užívání.

K vašemu účtu nepatří žádná úloha Lamp s tímto ID, nebo fáze úlohy neodpovídá cestě. Zkontrolujte ID a použijte /prototype nebo /build tak, aby odpovídalo dané úloze.

Meshy nemohlo provést kontrolu duševního vlastnictví. Zkuste požadavek odeslat znovu.

ID úkolu, který se má zrušit.

Platí jedna z těchto možností:

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

K vašemu účtu nepatří žádný úkol Lamp s tímto ID, nebo fáze úkolu neodpovídá cestě. Zkontrolujte ID a použijte /prototype nebo /build tak, aby odpovídalo danému úkolu.

ID úlohy z odpovědi na její vytvoření.

Fáze, kterou chcete vypsat, prototype nebo build.

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.

Počet úloh na stránku, maximálně 100. Hodnota od 101 do 255 vrátí 100 úloh a hodnota 0 použije výchozí hodnotu. Hodnota mimo rozsah 0 až 255 vrátí 400.

Pořadí řazení.

Dostupné hodnoty:

• -created_at: nejnovější první
• +created_at: nejstarší první

ID úkolu. Nespoléhejte na jeho formát.

Typ úkolu, vždy creative-lab-lamp-prototype.

Hodnota name, kterou jste odeslali při vytváření úkolu, nebo "", pokud jste žádnou neodeslali.

Stav úkolu.

Dostupné hodnoty:

• PENDING: čeká ve frontě
• IN_PROGRESS: generuje se výsledek
• SUCCEEDED: finální, s výsledkem
• FAILED: finální, s důvodem v task_error
• CANCELED: finální, bez výsledku

Procento dokončené práce, od 0 do 100. Je 0, dokud úkol nezačne, a 100, když je úspěšný.

Čas vytvoření úkolu, v milisekundách Unix.

Čas, kdy pracovník zahájil úkol, v milisekundách Unix. Do té doby null.

Čas, kdy úkol dosáhl finálního stavu, v milisekundách Unix. Do té doby null.

Čas, kdy vyprší výsledek úkolu, v milisekundách Unix. Je to 3 dny po finished_at, nebo 3 dny po created_at, dokud úkol neskončí. 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ů.

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 výpisu.

Důvod selhání úkolu. null, pokud status není FAILED. Viz Chyby.

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 je ve stavu PENDING. Pokud Meshy nemůže načíst účtování, odpověď na získání nebo stream pole vynechá a požadavek na výpis vrátí 500. V takovém případě požadavek opakujte.

Adresy URL ke stažení pro 3D model vygenerovaný z koncepčního obrázku. {}, dokud úkol není úspěšný.

Adresa URL ke stažení náhledového obrázku 3D modelu. "", dokud úkol není úspěšný.

Adresy URL ke stažení koncepčního obrázku. Pole obsahuje jednu adresu URL poté, co je úkol úspěšný, a do té doby je prázdné.

ID úlohy. Nespoléhejte na jeho formát.

Typ úlohy, vždy creative-lab-lamp-build.

Hodnota name, kterou jste odeslali při vytvoření úlohy, nebo "", pokud jste žádnou neodeslali.

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

Procento dokončené práce, od 0 do 100. Je 0, dokud úloha nezačne, a 100, když uspěje.

Čas vytvoření úlohy, v Unix milisekundách.

Čas, kdy pracovní proces úlohu spustil, v Unix milisekundách. Do té doby null.

Čas, kdy úloha dosáhla konečného stavu, v Unix milisekundách. Do té doby null.

Čas, kdy vyprší platnost výsledku úlohy, v Unix milisekundách. Jsou to 3 dny po finished_at, nebo 3 dny po created_at, dokud úloha neskončí. U Enterprise účtů, které uchovávají výsledky API neomezeně dlouho, je to přibližně o 100 let později. Viz Uchování assetů.

Pozice úlohy ve frontě, dokud je PENDING. 1 znamená, že začne jako další. 0 poté, co úloha frontu opustí, a vždy 0 ve výsledcích výpisu.

Důvod selhání úlohy. null, pokud status není FAILED. Viz Chyby.

Počet kreditů účtovaných za úlohu, po případném vrácení. Za požadavek, který vrátí chybu, se neúčtuje nic. Selhaná úloha má 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 účtovanou částku, odpověď typu get nebo stream pole vynechá a požadavek na výpis vrátí 500. V takovém případě požadavek zopakujte.

URL ke stažení tisknutelných souborů. Které klíče se objeví, závisí na output.format a options.light_source_preset.