Creative Lab Keychain API

Fotografie, která se má přeměnit na koncepční obrázek klíčenky, jako veřejná URL adresa nebo data URI (data:image/jpeg;base64,<vaše base64 kódovaná data obrázku>).

Obrázek musí být soubor JPG, JPEG, PNG nebo WebP o velikosti maximálně 20 MB.

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

Označuje úlohu ve vašem dashboardu a seznamech úloh a na klíčence se neobjeví. Chcete-li na klíčenku umístit jméno, použijte name_text.

Jméno, které se má přidat na klíčenku, například jméno domácího mazlíčka nebo osoby, až 10 znaků. Meshy počítá znaky, nikoli bajty, takže se vejde i 10znakové čínské, japonské nebo korejské jméno. Delší jméno vrátí 400. Pokud chcete klíčenku bez jména, ponechte prázdné.

Jméno se zobrazí na líci klíčenky jako plochý barevný detail, nikoli jako vyvýšený nebo vyříznutý text.

Meshy ořízne okolní mezery a odstraní neviditelné formátovací znaky. Objekt úlohy prototypu vrací výsledek jako name_text, takže si text můžete zkontrolovat ještě před zaplacením sestavení.

Meshy přidává jméno ve fázi prototypu. Sestavení jej zachová a name_text odeslaný koncovému bodu sestavení ignoruje.

Zda se má z obrázku prototypu odstranit pozadí. true vrátí průhledné RGBA PNG, které zachovává celý medailon, takže jej můžete umístit na libovolné pozadí. Sestavení také vychází z obrázku bez pozadí. Pokud Meshy nedokáže pozadí odstranit, vrátí obrázek s pozadím a úloha přesto uspěje.

Volba remove_background u sestavení je samostatná.

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řesahuje maximální počet pixelů.
• Meshy nemůže obrázek stáhnout, například protože URL vrací 404 nebo vypršel časový limit.
• Data URI není platné base64.
• name_text je delší než 10 znaků. Meshy jej odmítne, místo aby jej zkrátil, a za požadavek neúčtuje poplatek.
• Obrázek nebo name_text byl označen jako nevhodný obsah (NSFW).

Chybová zpráva uvádí, jaký problém byl zjištěn. Opravte požadavek a odešlete jej 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 je na bezplatném plánu.

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

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 užívání. Meshy kontroluje duševní vlastnictví pouze u obrázku, nikoli u name_text.

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 právě běží. 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, až se nějaká úloha dokončí, nebo přidejte kredity.

V Meshy došlo k chybě serveru, například proto, že se nepodařilo spustit kontrolu duševního vlastnictví u obrázku. 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/keychain/v1/prototype, se stavem SUCCEEDED.

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

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

Obrys klíčenky, pokud ho Meshy netrasuje podle subjektu. Meshy jej použije, když je remove_background nastaveno na false, nebo když nedokáže najít obrys subjektu.

Dostupné hodnoty:

• circle
• rounded-rect
• hexagon
• shield
• star

Délka hrany ohraničujícího čtverce klíčenky v milimetrech, maximálně 400. 0 použije výchozí hodnotu.

Maximální výška reliéfu nad základnou v milimetrech, od 0 do 20.

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

Tloušťka ploché základní desky za reliéfem, v milimetrech, od 0 do 20.

Zda uzavřít zadní stranu klíčenky. false ponechá zadní stranu otevřenou, jako skořepinu.

Křivka, která mapuje hodnoty hloubkové mapy na výšku reliéfu.

Dostupné hodnoty:

• linear
• gamma
• s-curve

Síla křivky, maximálně 10. Používají ji křivky gamma a s-curve, zatímco linear ji ignoruje. 0 použije výchozí hodnotu.

Zda invertovat hloubkovou mapu, aby se tmavší oblasti staly vyšším reliéfem.

Jak moc vyhladit hloubkovou mapu předtím, než Meshy sestaví reliéf, od 0 do 10.

Jak moc přiblížit reliéf a jeho texturu uvnitř obrysu, kolem středu, maximálně 10. Hodnota nad 1 subjekt zvětší a hodnota pod 1 jej zmenší. Nemění výšku reliéfu. 0 použije výchozí hodnotu.

Hodnota hloubkové mapy, pod kterou Meshy nastaví hloubku na nulu, od 0 do 1.

Zda trasovat obrys klíčenky podle subjektu, aby klíčenka sledovala tvar subjektu. false místo toho použije obrys badge_shape. Meshy použije badge_shape také v případě, že nedokáže najít obrys subjektu.

Toto je oddělené od parametru remove_background prototypu, který určuje, zda má obrázek prototypu průhledné pozadí.

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 plošky bez přidání detailu. 0 použije výchozí hodnotu.

Formát souboru, který sestavení vrátí.

Dostupné hodnoty:

• glb: jeden soubor model.glb, v model_urls.glb
• obj: zip soubor obsahující model.obj, model.mtl a texture.png, v model_urls.obj
• zip: zip soubor obsahující všechny soubory, které Meshy vygeneruje, v model_urls.bundle_zip

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 uspěla, ale neobsahuje žádný obrázek. Vytvořte novou úlohu prototypu.
• Pole v options je mimo svůj rozsah nebo není dostupnou hodnotou.

Chybová zpráva uvádí, jaký problém byl nalezen.

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, poté to zkuste znovu.

input_task_id neodpovídá žádné úloze prototypu klíčenky, 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.
• Je zařazeno nebo spuštěno příliš mnoho vašich úloh. 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é mohou běžet bez kreditů. Počkejte na dokončení úlohy, nebo přidejte kredity.

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

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

Váš tým má zapnuté Filtrování IP a Meshy označilo obrázek úlohy prototypu kvůli duševnímu vlastnictví třetí strany. U úloh buildu a týmů na plánu Enterprise se tato chyba nevyskytuje. Vytvořte úlohu prototypu z obrázku, ke kterému máte práva k použití.

K vašemu účtu nepatří žádná úloha klíčenky 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 nemohlo provést kontrolu duševního vlastnictví. Opakujte požadavek.

ID úlohy, kterou chcete zrušit.

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

• id není platné ID úlohy. Odeš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 Keychain s tímto ID, nebo fáze úlohy neodpovídá cestě. Zkontrolujte ID a použijte /prototype nebo /build podle typu úlohy.

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. 0 vrátí první stránku. Hodnota mimo rozsah 0 až 255 vrátí 400.

Počet úkolů na stránku, maximálně 100. Hodnota od 101 do 255 vrátí 100 úkolů a 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-keychain-prototype.

name, který jste odeslali při vytvoření úkolu, nebo "", pokud jste žádný neodeslali.

Jméno, které Meshy přidalo ke klíčence, po odstranění bílých znaků a neviditelných formátovacích znaků. Vynecháno, pokud jste neodeslali name_text. Chcete-li ověřit, že váš HTTP klient text zakódoval správně, porovnejte jej s tím, co jste odeslali.

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, jakmile uspěje.

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

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

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

Čas, kdy vyprší výsledek úkolu, v Unix milisekundách. Je to 3 dny po finished_at, nebo 3 dny po created_at, dokud úkol nedokončí. U podnikových (Enterprise) účtů, které uchovávají výsledky API neomezeně dlouho, je to asi o 100 let později. Viz Uchování assetů.

Pozice úkolu ve frontě, zatímco je PENDING. 1 znamená, že začne jako další. 0 poté, co úkol opustí frontu, a vždy 0 ve výsledcích seznamu.

Proč úkol selhal. 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, je-li ve stavu PENDING. Pokud Meshy nedokáže přečíst účtování, odpověď typu get nebo stream toto pole vynechá a požadavek na seznam vrátí 500. V takovém případě požadavek zopakujte.

Odkazy ke stažení koncepčního obrázku. Pole obsahuje jednu URL adresu po úspěšném dokončení úkolu, do té doby je prázdné.

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

Typ úlohy, vždy creative-lab-keychain-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: 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 zahájil, 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. 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ě, dokud je PENDING. 1 znamená, že se spustí jako další. 0 poté, co úloha opustí frontu, a vždy 0 ve výsledcích seznamu.

Proč úloha selhala. 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, není účtován. Neúspěšná úloha má hodnotu 0, protože Meshy ji vrací. Zrušení vrátí kredity za úlohu pouze tehdy, je-li 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.

Odkazy ke stažení souboru modelu, s jednou položkou pro vámi požadovaný output.format. {} dokud úloha neuspěje.