Creative Lab Keycap API

Fotografie, která se má přeměnit na návrh klávesy, jako veřejná URL adresa nebo data URI (data:image/jpeg;base64,<vaše base64 kódovaná obrazová data>).

Obrázek musí být soubor JPG, JPEG, PNG nebo WebP o velikosti maximálně 20 MB (20 000 000 bajtů). Každá strana musí mít alespoň 32 pixelů a obrázek může mít celkem maximálně 178 956 970 pixelů. Obrázek mimo tyto limity vrátí 400.

Meshy rozpozná formát z obrazových dat, nikoli z přípony souboru v URL adrese. URL adresa bez přípony funguje a Meshy sleduje HTTP přesměrování. Meshy aplikuje orientaci EXIF, takže otočená fotografie z telefonu vyjde tak, jak vypadá.

Data URI musí být kódováno pomocí base64 s typem obrázku, například data:image/png;base64,..., a dekódovaný obrázek musí být JPEG, PNG nebo WebP. Limit 20 MB se vztahuje na dekódovaný obrázek, takže text base64 může být zhruba o třetinu větší.

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

Zda se má z obrázku prototypu odstranit pozadí. true vrátí průhledné RGBA PNG, takže klávesu můžete umístit na libovolné pozadí. Pokud Meshy nedokáže pozadí odstranit, vrátí obrázek s jeho pozadím a úloha přesto uspěje.

Návrh hlavičky, který se při buildu přemění na 3D, si v obou případech zachová své pozadí. Build vykreslí základnu klávesy z obrázku v image_urls, bez jeho pozadí, pokud jste odeslali true. Build vrátí tento obrázek jako process_image_urls.composite.

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é base64.
• Obrázek byl označen jako NSFW.

Chybová zpráva uvádí, jaký problém byl zjištěn. Opravte požadavek a odešlete ho znovu.

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

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á neomezený plán.

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

Váš tým má zapnuté 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.

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.
• Pokud máte neomezený plán bez zbývajících kreditů, dosáhli jste počtu úloh, které lze spustit bez kreditů. Počkejte na dokončení úlohy nebo přidejte kredity.

Meshy narazilo na chybu serveru, například protože nebylo možné spustit moderation obsahu nebo kontrolu duševního vlastnictví, nebo Meshy nemohlo obrázek uložit. Meshy úlohu nevytvoří a vrátí veškeré účtované kredity. Zkuste požadavek odeslat znovu.

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

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

Kandidát, který se má sestavit, z pole candidate_ids úlohy prototypu. Hodnota, která v tomto poli není obsažena, vrátí 400.

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

Základna klávesy, na které se má sestavení provést. Jedinou hodnotou je cherry-mx-1x1-r1, standardní kláves profilu Cherry MX 1u. Vlastní velikosti nejsou podporovány a jakákoli jiná hodnota vrátí 400.

Velikost hlavy podél její nejdelší dimenze, v milimetrech, od 10 do 40. Meshy hlavu zvětší nebo zmenší tak, aby její nejdelší dimenze odpovídala této hodnotě. Hodnota mimo rozsah vrátí 400.

Pro hodnotu nad přibližně 32.9 může Meshy velikost zmenšit, aby hlava odpovídala limitu ochranné plochy základny. Hlava pak může vyjít menší, než jste požadovali. Objekt úlohy nevrací velikost, kterou Meshy aplikovalo. Pro její zjištění změřte ohraničující kvádr sítě keycap-head v modelu.

Vertikální posun, který se má na hlavu aplikovat před tím, než ji Meshy usadí na základnu, v milimetrech, od -5 do 5. Hodnota mimo rozsah vrátí 400.

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 nemá žádné kandidáty. Vytvořte novou úlohu prototypu.
• candidate_id chybí nebo není obsažen v candidate_ids úlohy prototypu. Odešlete hodnotu z tohoto pole.
• Některé pole v options je mimo rozsah, nebo base_model není dostupná hodnota.

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

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

Platí jedno z následujícího:

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

input_task_id neodpovídá žádné úloze prototypu Keycap, kterou váš účet vytvořil přes API. Prototyp vytvořený ve webové aplikaci rovněž 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 č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.

Meshy nemohlo úlohu vytvořit kvůli chybě serveru. Meshy vrátí všechny kredity, které naúčtovalo. Zopakujte požadavek.

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é Filtrování IP a Meshy označilo obrázek úlohy prototype jako duševní vlastnictví třetí strany. U úloh build a týmů s plánem Enterprise k této chybě nedochází. Vytvořte úlohu prototype z obrázku, k jehož použití máte práva.

Úloha Keycap s tímto ID nepatří k vašemu účtu, nebo fáze úlohy neodpovídá cestě. Zkontrolujte ID a použijte /prototype nebo /build podle typu úlohy.

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

ID úlohy, kterou chcete zrušit.

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

• id není platné ID úlohy. Pošlete ID result z odpovědi na vytvoření.
• Úloha už má konečný stav (SUCCEEDED, FAILED nebo CANCELED), takže ji nelze zrušit.

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

Meshy narazilo na chybu serveru při rušení úlohy, takže úloha může, ale nemusí být zrušena. Před opakováním si úlohu načtěte a zkontrolujte její status.

ID úlohy z odpovědi na 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 v rozsahu 101 až 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ší jako první
• +created_at: nejstarší jako první

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

Typ úlohy, vždy creative-lab-keycap-prototype.

name, kterou jste poslali při vytvoření úlohy, nebo "", pokud jste žádnou neposlali.

Stav úlohy.

Dostupné hodnoty:

• PENDING: čeká ve frontě
• IN_PROGRESS: probíhá generování výsledku
• 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 úloha nezačne, a 100, když uspěje.

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

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

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

Čas, kdy vyprší platnost výsledku úlohy, v milisekundách Unix. 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ě, 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 opustí frontu, a vždy 0 ve výsledcích seznamu.

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í. Požadavek, který vrátí chybu, se neúčtuje. Neúspěšná úloha má hodnotu 0, protože Meshy ji vrátí. Zrušení vrátí kredity za úlohu pouze tehdy, pokud je ve stavu PENDING. Pokud Meshy nedokáže zjistit účtovanou částku, odpověď na get nebo stream požadavek toto pole vynechá, a požadavek na seznam vrátí 500. V takovém případě požadavek opakujte.

URL ke stažení obrázku hotové klávesy. Pole obsahuje jednu URL poté, co úloha uspěje, a do té doby je prázdné. image_urls[i] zobrazuje kandidáta v candidate_ids[i].

Tyto URL jsou určené k zobrazení. Build koncový bod přijímá položku z candidate_ids, nikoli URL. Jde o podepsané URL, takže je stahujte bez hlavičky Authorization. Zůstávají platné až do expires_at, a opětovné získání úlohy vrátí stejné URL.

ID kandidátů, ve stejném pořadí jako image_urls. Pro sestavení kandidáta pošlete jeho ID jako candidate_id v požadavku na sestavení. Nespoléhejte na formát těchto ID.

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

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

name, který jste odeslali při vytvoření úlohy, nebo "", pokud jste žádný 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ž je úspěšně dokončena.

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

Čas, kdy worker úlohu zahájil, v milisekundách Unix. Do té doby null.

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

Čas, kdy vyprší platnost výsledku úlohy, v milisekundách Unix. Je 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ě, zatímco je PENDING. 1 znamená, že začne jako další. 0 poté, co úloha opustí frontu, a vždy 0 ve výsledcích seznamu.

Důvod, proč úloha selhala. 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. Neúspěšná úloha má hodnotu 0, protože Meshy ji vrací zpět. Zrušení vrací kredity za úlohu pouze tehdy, pokud je ve stavu PENDING. Pokud Meshy nedokáže přečíst účtovanou částku, odpověď na get nebo stream toto pole vynechá a požadavek na seznam vrátí 500. V takovém případě požadavek zopakujte.

URL ke stažení 3D modelu. Meshy exportuje soubor GLB a balíček OBJ ve skutečném měřítku v milimetrech, s osou Y nahoru, přičemž přední strana keycapu směřuje k +Z.

Model obsahuje sítě nazvané keycap-head a keycap-base. Když Meshy přejde na záložní výplň vzorem pro základnu, model obsahuje také síť keycap-base-interior pro dutinu dříku. Nepředpokládejte, že model má přesně dvě sítě.

Jedná se o podepsané URL, takže je stahujte bez hlavičky Authorization. Zůstávají platné do expires_at, a opětovné získání úlohy před tímto časem vrátí stejné URL. Platnost expirovaného URL nelze obnovit, proto si soubory stáhněte a uložte před tímto časem.

URL ke stažení obrázků z jednotlivých kroků sestavení, klíčovaných podle druhu. Stejně jako model_urls se jedná o podepsané URL, takže je stahujte bez hlavičky Authorization. Zůstávají platné do expires_at a opětovné získání úlohy vrátí stejné URL.

Může obsahovat tyto klíče:

• head_design: návrhový obrázek vybraného kandidáta, který sestavení převedlo do 3D. Vždy přítomen.
• composite: obrázek hotového keycapu pro vybraného kandidáta, podle kterého sestavení vymalovalo základnu. Může chybět.
• base_canvas: vymalovaná základna keycapu. Může chybět.

Meshy může přidávat další klíče, takže klíč, který nepoznáváte, ignorujte.