Creative Lab Fidget Pixel API

Zdjęcie do przekształcenia w pixel art, podane jako publicznie dostępny 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. Meshy wykrywa format na podstawie danych obrazu, a nie rozszerzenia pliku w URL-u. URL bez rozszerzenia również zadziała, a Meshy podąża za przekierowaniami.

Co przedstawia zdjęcie — to ustawienie określa styl pixel art. Oba style wyraźnie się od siebie różnią. Każda inna wartość zwraca 400.

Dostępne wartości:

• person: osoba, na portrecie lub zdjęciu całej sylwetki. Meshy rysuje sprite w stylu chibi pixel art.
• other: dowolny inny temat, na przykład zwierzę domowe, obiekt, maskotka, logo lub krajobraz. Meshy rysuje ikonę pixelową w stylu koralikowym (bead-art).

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

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

• Brakuje image_url lub type.
• type nie ma wartości person ani other.
• 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 ponieważ URL zwraca 404 lub przekroczono limit czasu.
• Data URI nie zawiera prawidłowego kodowania base64.
• Obraz został oznaczony jako NSFW.

Komunikat błędu wskazuje, jaki problem został wykryty. Popraw żądanie i wyślij je ponownie.

Brakuje klucza API lub jest on 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 planu darmowego.

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

Twój zespół ma włączoną funkcję IP Filtering, a Meshy oznaczyło obraz jako naruszający prawa własności intelektualnej osób trzecich. Wyślij obraz, do którego masz prawa użytkowania.

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

• Wysłano więcej żądań, niż pozwala limit szybkości. Odczekaj kilka sekund, a następnie spróbuj ponownie. Zobacz Limity szybkości.
• Zbyt wiele Twoich zadań znajduje się w kolejce lub jest wykonywanych. Poczekaj, aż niektóre się zakończą, a następnie spróbuj ponownie.
• W 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.

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

Identyfikator zadania prototypu do zbudowania. Musi to być zadanie utworzone przez Twoje konto za pomocą POST /openapi/creative-lab/fidget-pixel/v1/prototype, o statusie SUCCEEDED.

Identyfikator, który nie odpowiada żadnemu z Twoich zadań prototypu Fidget Pixel z API, zwraca 404, w tym również prototyp utworzony w aplikacji webowej.

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

Zarys każdego elementu. Jakakolwiek inna wartość zwraca 400.

Dostępne wartości:

• square: kwadratowe elementy na kwadratowej siatce
• hex: sześciokątne elementy na sześciokątnej siatce, z piece_size_mm ustawionym na 6 lub 8

Liczba komórek siatki wzdłuż każdego boku planszy, 16 lub 32. Jakakolwiek inna wartość zwraca 400. Siatka 32 zachowuje więcej szczegółów. Siatka 16 daje mniej elementów o tym samym rozmiarze, więc plansza jest około dwa razy węższa.

Długość krawędzi każdego elementu w milimetrach, 6, 8 lub 10. Jakakolwiek inna wartość zwraca 400. W połączeniu z grid_size ustala rozmiar wydrukowanej planszy. Na przykład siatka 32 złożona z elementów 8 mm ma około 26,5 cm na bok.

Wartość 10 nie działa z hex i zwraca 400, ponieważ pochylona ścianka sześciokąta zwisa na większości konsumenckich drukarek FDM.

Maksymalna liczba kolorów w palecie pixel-art, od 1 do 8. Wartość spoza zakresu zwraca 400. Aby wydrukować, potrzebujesz do color_count plus jeden filamentów, po jednym na kolor i jednym na szare korpusy.

Wysokość każdego elementu w milimetrach, od 10 do 80. Wartość spoza zakresu zwraca 400.

Format pliku wynikowego. Jakakolwiek inna wartość zwraca 400.

Dostępne wartości:

• 3mf: jeden wielokolorowy plik model.3mf, zwracany w model_urls.3mf

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

• input_task_id jest brakujące lub nie jest poprawnym identyfikatorem zadania.
• Status zadania prototypu nie jest SUCCEEDED. Jeśli nadal 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 wykracza poza dozwolone wartości, na przykład grid_size inny niż 16 lub 32.
• piece_size_mm wynosi 10, a shape to hex. Elementy sześciokątne występują tylko w rozmiarach 6 i 8 mm.
• output.format nie jest równy 3mf.

Komunikat błędu wskazuje, jaki problem wykryto.

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

Zastosowanie ma jedna z poniższych sytuacji:

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

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

Twój zespół ma włączone IP Filtering, a Meshy oznaczyło obraz zadania prototypu jako naruszający prawa własności intelektualnej osób trzecich. Utwórz zadanie prototypu na podstawie obrazu, do którego masz prawa użycia.

input_task_id nie odpowiada żadnemu zadaniu prototypu Fidget Pixel utworzonemu przez Twoje konto za pomocą API. Prototyp utworzony w aplikacji webowej również zwraca 404. Wyślij identyfikator result z odpowiedzi tworzenia prototypu.

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

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

Meshy napotkało błąd serwera, na przykład z powodu niemożności przeprowadzenia kontroli własności intelektualnej obrazu zadania prototypu. Meshy nie tworzy zadania i zwraca wszelkie pobrane kredyty. Spróbuj ponownie wysłać żądanie.

ID zadania z odpowiedzi tworzenia.

id nie jest prawidłowym ID zadania. Wyślij ID 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 budowy oraz zespoły w planie Enterprise nie otrzymują tego błędu. Utwórz zadanie prototypu na podstawie obrazu, do którego masz prawa użytkowania.

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

Meshy nie mogło przeprowadzić kontroli własności intelektualnej. Ponów żądanie.

ID zadania do anulowania.

Zastosowanie ma jedno z poniższych:

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

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

Identyfikator 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ę, maksymalnie 100. Wartość od 101 do 255 zwraca 100 zadań, a 0 oznacza użycie 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-fidget-pixel-prototype.

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

Status zadania.

Dostępne wartości:

• PENDING: oczekiwanie 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, dopóki zadanie się nie rozpocznie, i 100, gdy zakończy się sukcesem.

Czas utworzenia zadania, w milisekundach Unix.

Czas, w którym worker rozpoczął zadanie, w milisekundach Unix. null do tego momentu.

Czas, w którym zadanie osiągnęło status końcowy, 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, a w wynikach list zawsze 0.

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, które zwraca błąd, nie jest obciążane. Nieudane zadanie ma wartość 0, ponieważ Meshy zwraca za nie kredyty. Anulowanie powoduje zwrot kredytów za zadanie tylko wtedy, gdy ma ono 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 pixel-art. Tablica zawiera jeden adres URL po pomyślnym zakończeniu zadania, a do tego czasu jest pusta.

Adresy URL są podpisane, więc pobieraj je bez nagłówka Authorization. Pozostają ważne do expires_at. Ponowne pobranie zadania przed tym czasem zwraca te same adresy URL, a nie nowo podpisane. Wygasłego adresu URL nie można odświeżyć, więc pobierz i zapisz pliki przed tym terminem.

ID zadania. Nie polegaj na jego formacie.

Typ zadania, zawsze creative-lab-fidget-pixel-build.

Wartość name, którą wysłano 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: 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, dopóki zadanie się nie rozpocznie, i 100, gdy zakończy się sukcesem.

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. Nieudane zadanie 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ź typu get lub stream pomija to pole, a żądanie listy zwraca 500. W takim przypadku ponów żądanie.

Adresy URL do pobrania wyniku, z kluczem w postaci formatu pliku. Obiekt zawiera jeden wpis, dla formatu output.format, który został wysłany, i jest pusty, dopóki zadanie nie zakończy się sukcesem.

Adresy URL są podpisane, więc pobieraj je bez nagłówka Authorization. Pozostają ważne do expires_at. Ponowne pobranie zadania przed tym czasem zwraca te same adresy URL, a nie nowo podpisane. Wygasłego adresu URL nie można odświeżyć, więc pobierz i zapisz pliki przed tym terminem.