API breloka Creative Lab

Zdjęcie, które ma zostać przekształcone w obraz koncepcyjny breloka, podane jako publiczny URL lub data URI (data:image/jpeg;base64,<your base64-encoded image data>).

Obraz musi być plikiem JPG, JPEG, PNG lub WebP o rozmiarze maksymalnie 20 MB.

Nazwa zadania, maksymalnie 100 znaków. Jest zwracana w polu name zadania. Dłuższa nazwa zwraca 400.

Oznacza zadanie na pulpicie nawigacyjnym i listach zadań i nie pojawia się na breloku. Aby umieścić nazwę na breloku, użyj name_text.

Nazwa do dodania na breloku, na przykład imię zwierzaka lub osoby, maksymalnie 10 znaków. Meshy liczy znaki, nie bajty, więc 10-znakowa nazwa w języku chińskim, japońskim lub koreańskim się zmieści. Dłuższa nazwa zwraca 400. Pomiń to pole, aby uzyskać brelok bez nazwy.

Nazwa pojawia się na powierzchni breloka jako płaski, kolorowy element, a nie jako wypukły lub wycięty tekst.

Meshy przycina otaczające białe znaki i usuwa niewidoczne znaki formatujące. Obiekt zadania prototypu zwraca wynik jako name_text, dzięki czemu możesz sprawdzić tekst przed opłaceniem budowy.

Meshy dodaje nazwę na etapie prototypu. Budowanie ją zachowuje i ignoruje name_text wysłane do punktu końcowego budowania.

Czy usunąć tło z obrazu prototypu. true zwraca przezroczysty obraz PNG RGBA, który zachowuje cały medalion, dzięki czemu możesz umieścić go na dowolnym tle. Budowanie również zaczyna się od obrazu bez tła. Jeśli Meshy nie może usunąć tła, zwraca obraz wraz z tłem, a zadanie nadal kończy się powodzeniem.

Opcja remove_background dla budowania jest odrębna.

Żądanie nie może zostać wykonane. Na przykład:

• Brak image_url.
• Obraz nie jest plikiem JPG, JPEG, PNG ani WebP.
• Obraz jest zbyt mały, przekracza 20 MB lub przekracza maksymalną liczbę pikseli.
• Meshy nie może pobrać obrazu, na przykład dlatego, że URL zwraca 404 lub przekroczono czas oczekiwania.
• Data URI nie jest prawidłowym base64.
• name_text jest dłuższe niż 10 znaków. Meshy odrzuca je zamiast skracać i nie pobiera opłaty za żądanie.
• Obraz lub name_text zostały oznaczone jako NSFW.

Komunikat błędu wskazuje znaleziony problem. Popraw żądanie i wyślij je ponownie.

Brak klucza API lub klucz API jest nieprawidłowy. Sprawdź nagłówek Authorization.

Zastosowanie ma jedno z poniższych:

• Konto nie ma wystarczającej liczby kredytów.
• Klucz API, obszar roboczy lub członek osiągnął swój limit kredytów.
• Konto korzysta z darmowego planu.

Sprawdź swoje kredyty i plan, a następnie spróbuj ponownie.

Twój zespół ma włączone filtrowanie IP, a Meshy oznaczyło obraz jako naruszający prawa własności intelektualnej osób trzecich. Wyślij obraz, do którego masz prawa. Meshy sprawdza pod kątem własności intelektualnej tylko obraz, nie name_text.

Osiągnięto jeden z poniższych limitów:

• Wysłano więcej żądań, niż pozwala na to Twój limit szybkości. Poczekaj kilka sekund, a następnie spróbuj ponownie. Zobacz Limity szybkości.
• Zbyt wiele Twoich zadań znajduje się w kolejce lub jest uruchomionych. Poczekaj, aż część z nich się zakończy, a następnie spróbuj ponownie.
• W planie bez limitów, bez pozostałych kredytów, osiągnięto liczbę zadań, które mogą działać bez kredytów. Poczekaj na zakończenie zadania lub dodaj kredyty.

Meshy napotkało błąd serwera, na przykład dlatego, że nie mogło przeprowadzić kontroli własności intelektualnej obrazu. Meshy nie tworzy zadania i zwraca wszelkie pobrane kredyty. Spróbuj ponownie wysłać żądanie.

ID zadania prototypu do zbudowania. Musi to być zadanie utworzone przez Twoje konto za pomocą POST /openapi/creative-lab/keychain/v1/prototype, ze statusem SUCCEEDED.

ID, które nie odpowiada żadnemu z Twoich zadań prototypu breloka z API, zwraca 404, w tym prototyp utworzony w aplikacji webowej.

Nazwa zadania, maksymalnie 100 znaków. Jest zwracana w polu name zadania. Dłuższa nazwa zwraca 400.

Zarys breloka, gdy Meshy nie odwzorowuje go z obiektu. Meshy używa go, gdy remove_background ma wartość false, lub gdy nie może znaleźć zarysu obiektu.

Dostępne wartości:

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

Długość boku ograniczającego kwadratu breloka, w milimetrach, do 400. 0 oznacza użycie wartości domyślnej.

Maksymalna wysokość reliefu ponad podstawą, w milimetrach, od 0 do 20.

O ile obniżyć relief, w milimetrach, od 0 do 20. Meshy odejmuje tę wartość od wysokości reliefu wszędzie, aż do podstawy.

Grubość płaskiej płyty podstawy za reliefem, w milimetrach, od 0 do 20.

Czy zamknąć tył breloka. false pozostawia tył otwarty, w formie powłoki.

Krzywa mapująca wartości mapy głębi na wysokość reliefu.

Dostępne wartości:

• linear
• gamma
• s-curve

Siła krzywej, do 10. Krzywe gamma i s-curve jej używają, a linear ją ignoruje. 0 oznacza użycie wartości domyślnej.

Czy odwrócić mapę głębi, tak aby ciemniejsze obszary stawały się wyższym reliefem.

Jak bardzo wygładzić mapę głębi przed zbudowaniem reliefu przez Meshy, od 0 do 10.

O ile powiększyć relief i jego teksturę wewnątrz zarysu, względem środka, do 10. Wartość powyżej 1 powiększa obiekt, a wartość poniżej 1 go pomniejsza. Nie zmienia wysokości reliefu. 0 oznacza użycie wartości domyślnej.

Wartość mapy głębi, poniżej której Meshy ustawia głębię na zero, od 0 do 1.

Czy odwzorować zarys breloka na podstawie obiektu, tak aby brelok podążał za kształtem obiektu. false używa zamiast tego zarysu badge_shape. Meshy używa badge_shape również wtedy, gdy nie może znaleźć zarysu obiektu.

Jest to niezależne od parametru remove_background prototypu, który ustawia, czy obraz prototypu ma przezroczyste tło.

Rozdzielczość siatki eksportowanego modelu, od 64 do 512. Meshy buduje geometrię na podstawie mapy głębi o rozdzielczości 512 pikseli, więc dokładniejsza siatka dodałaby ścianki bez dodawania szczegółów. 0 oznacza użycie wartości domyślnej.

Format pliku zwracanego przez budowę.

Dostępne wartości:

• glb: jeden plik model.glb, w model_urls.glb
• obj: plik zip z model.obj, model.mtl i texture.png, w model_urls.obj
• zip: plik zip ze wszystkimi plikami wygenerowanymi przez Meshy, w model_urls.bundle_zip

Żądanie nie może zostać wykonane. Na przykład:

• input_task_id jest nieobecne lub nie jest prawidłowym ID zadania.
• Status zadania prototypu nie jest SUCCEEDED. Jeśli wciąż trwa, poczekaj i spróbuj ponownie. Jeśli zakończyło się niepowodzeniem lub zostało anulowane, utwórz nowe zadanie prototypu.
• Zadanie prototypu zakończyło się powodzeniem, ale nie ma obrazu. Utwórz nowe zadanie prototypu.
• Pole w options jest poza zakresem lub nie jest dostępną wartością.

Komunikat błędu wskazuje, jaki problem został znaleziony.

Brak klucza API lub klucz jest nieprawidłowy. Sprawdź nagłówek Authorization.

Ma zastosowanie jedna z poniższych sytuacji:

• Konto nie ma wystarczającej liczby kredytów.
• Klucz API, obszar roboczy lub członek osiągnął limit kredytów.
• Konto korzysta z darmowego planu.

Sprawdź swoje kredyty i plan, a następnie spróbuj ponownie.

input_task_id nie pasuje do żadnego zadania prototypu breloka utworzonego przez Twoje konto za pomocą API. Prototyp utworzony w aplikacji webowej również zwraca 404. Wyślij ID result z odpowiedzi na utworzenie prototypu.

Osiągnięto jeden z poniższych limitów:

• Wysłano więcej żądań, niż pozwala na to limit szybkości. Poczekaj kilka sekund, a następnie spróbuj ponownie. Zobacz Limity szybkości.
• Zbyt wiele Twoich zadań oczekuje w kolejce lub jest uruchomionych. Poczekaj, aż część z nich się zakończy, a następnie spróbuj ponownie.
• Na planie nielimitowanym bez pozostałych kredytów osiągnięto liczbę zadań, które mogą być uruchomione bez kredytów. Poczekaj na zakończenie zadania lub dodaj kredyty.

Identyfikator zadania z odpowiedzi tworzenia.

id nie jest prawidłowym identyfikatorem zadania. Wyślij identyfikator result z odpowiedzi tworzenia.

Twój zespół ma włączone filtrowanie IP, a Meshy oznaczyło obraz zadania prototypu jako naruszający prawa własności intelektualnej osób trzecich. Zadania builda oraz zespoły na planie Enterprise nie otrzymują tego błędu. Utwórz zadanie prototypu na podstawie obrazu, do którego masz prawa.

Żadne zadanie Keychain o tym identyfikatorze nie należy do Twojego konta, albo etap zadania nie zgadza się ze ścieżką. Sprawdź identyfikator i użyj /prototype lub /build, aby dopasować zadanie.

Meshy nie mogło przeprowadzić kontroli własności intelektualnej. Spróbuj ponownie.

ID zadania do anulowania.

Zastosowanie ma jedno z poniższych:

• id nie jest prawidłowym ID zadania. Wyślij ID result z odpowiedzi tworzącej zadanie.
• Zadanie ma już status końcowy (SUCCEEDED, FAILED lub CANCELED), więc nie można go anulować.

Żadne zadanie Keychain o tym ID nie należy do Twojego konta, albo etap zadania nie odpowiada ścieżce. Sprawdź ID i użyj /prototype lub /build, aby dopasować zadanie.

ID zadania z odpowiedzi tworzenia.

Etap do wylistowania, prototype lub build.

Strona do zwrócenia, od 1 do 255. Wartość 0 zwraca pierwszą stronę. Wartość spoza zakresu 0 do 255 zwraca 400.

Liczba zadań na stronę, do 100. Wartość od 101 do 255 zwraca 100 zadań, a 0 używa wartości domyślnej. Wartość spoza zakresu 0 do 255 zwraca 400.

Kolejność sortowania.

Dostępne wartości:

• -created_at: od najnowszych
• +created_at: od najstarszych

ID zadania. Nie polegaj na jego formacie.

Typ zadania, zawsze creative-lab-keychain-prototype.

Wartość name, którą wysłano podczas tworzenia zadania, lub "", jeśli jej nie wysłano.

Nazwa dodana przez Meshy do breloka, po przycięciu białych znaków i usunięciu niewidocznych znaków formatujących. Pomijana, gdy nie wysłano name_text. Aby sprawdzić, czy klient HTTP poprawnie zakodował tekst, porównaj go z tym, co zostało wysłane.

Status zadania.

Dostępne wartości:

• PENDING: oczekuje w kolejce
• IN_PROGRESS: generowanie wyniku
• SUCCEEDED: zakończone, z wynikiem
• FAILED: zakończone, z powodem w task_error
• CANCELED: zakończone, bez wyniku

Procent wykonanej pracy, od 0 do 100. Wynosi 0 do momentu rozpoczęcia zadania i 100, gdy zakończy się powodzeniem.

Czas utworzenia zadania, w milisekundach Unix.

Czas rozpoczęcia zadania przez worker, w milisekundach Unix. null do tego momentu.

Czas osiągnięcia przez zadanie statusu końcowego, w milisekundach Unix. null do tego momentu.

Czas wygaśnięcia wyniku zadania, w milisekundach Unix. Przypada 3 dni po finished_at, lub 3 dni po created_at, dopóki zadanie się nie zakończy. W przypadku kont Enterprise, które przechowują wyniki API bezterminowo, jest to około 100 lat później. Zobacz Przechowywanie zasobów.

Pozycja zadania w kolejce, gdy ma status PENDING. 1 oznacza, że zostanie uruchomione jako następne. 0 po opuszczeniu kolejki przez zadanie, i zawsze 0 w wynikach list.

Powód niepowodzenia zadania. null, chyba że status to FAILED. Zobacz Błędy.

Liczba kredytów naliczonych za zadanie, po uwzględnieniu ewentualnego zwrotu. Żądanie zwracające błąd nie jest obciążane. Zadanie zakończone niepowodzeniem ma wartość 0, ponieważ Meshy zwraca za nie kredyty. Anulowanie powoduje zwrot kredytów tylko wtedy, gdy zadanie ma status PENDING. Jeśli Meshy nie może odczytać obciążenia, odpowiedź get lub stream pomija to pole, a żądanie list zwraca 500. W takim przypadku ponów żądanie.

Adresy URL do pobrania obrazu koncepcyjnego. Tablica zawiera jeden URL po pomyślnym zakończeniu zadania, a wcześniej jest pusta.

ID zadania. Nie polegaj na jego formacie.

Typ zadania, zawsze creative-lab-keychain-build.

Wartość name wysłana podczas tworzenia zadania, lub "", jeśli jej nie wysłano.

Status zadania.

Dostępne wartości:

• PENDING: oczekuje w kolejce
• IN_PROGRESS: generowanie wyniku
• SUCCEEDED: stan końcowy, z wynikiem
• FAILED: stan końcowy, z powodem w task_error
• CANCELED: stan końcowy, bez wyniku

Procent wykonanej pracy, od 0 do 100. Wynosi 0 do momentu rozpoczęcia zadania i 100, gdy zakończy się powodzeniem.

Czas utworzenia zadania, w milisekundach Unix.

Czas rozpoczęcia zadania przez pracownika, w milisekundach Unix. null do tego momentu.

Czas osiągnięcia przez zadanie statusu końcowego, w milisekundach Unix. null do tego momentu.

Czas wygaśnięcia wyniku zadania, w milisekundach Unix. Przypada 3 dni po finished_at, lub 3 dni po created_at, dopóki zadanie się nie zakończy. W przypadku kont Enterprise, które przechowują wyniki API bezterminowo, jest to około 100 lat później. Zobacz Przechowywanie zasobów.

Pozycja zadania w kolejce, gdy ma status PENDING. 1 oznacza, że zostanie uruchomione jako następne. 0 po opuszczeniu kolejki przez zadanie, i zawsze 0 w wynikach list.

Powód niepowodzenia zadania. null, chyba że status to FAILED. Zobacz Błędy.

Liczba kredytów pobranych za zadanie, po uwzględnieniu ewentualnego zwrotu. Żądanie, które zwraca błąd, nie jest obciążane. Nieudane zadanie ma wartość 0, ponieważ Meshy zwraca za nie kredyty. Anulowanie zwraca kredyty za zadanie tylko wtedy, gdy ma ono status PENDING. Jeśli Meshy nie może odczytać obciążenia, odpowiedź typu get lub stream pomija to pole, a żądanie listy zwraca 500. W takim przypadku ponów żądanie.

Adresy URL do pobrania pliku modelu, z jednym wpisem dla żądanego output.format. {} do momentu zakończenia zadania powodzeniem.