Creative Lab Brick Figure API

Zdjęcie, które ma zostać przekształcone w minifigurkę z klocków, 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.

Określa, czy usunąć tło z obrazu prototypu. true zwraca przezroczysty obraz PNG w formacie RGBA, dzięki czemu można umieścić podmiot na dowolnym tle. Budowanie również rozpoczyna 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.

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

• Brakuje 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 ponieważ URL zwraca 404 lub upłynął limit czasu.
• Data URI nie jest prawidłowym kodem base64.
• Obraz został oznaczony jako NSFW.

Komunikat błędu wskazuje, jaki problem został znaleziony. 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łączone filtrowanie IP, a Meshy oznaczyło obraz jako naruszający własność intelektualną 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 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 w trakcie wykonywania. Poczekaj, aż część z nich się zakończy, 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 dlatego, że 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.

ID zadania prototypu, które ma zostać zbudowane. Musi to być zadanie utworzone przez Twoje konto za pomocą POST /openapi/creative-lab/brick-figure/v1/prototype, o statusie SUCCEEDED.

ID, które nie jest jednym z Twoich zadań prototypu Brick Figure utworzonych przez 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.

Żą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 zawiera obrazu. Utwórz nowe zadanie prototypu.

Komunikat błędu wskazuje, który problem został wykryty.

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.

input_task_id nie odpowiada żadnemu zadaniu prototypu Brick Figure utworzonemu 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ż dopuszcza 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.
• Przy planie bez limitu, bez pozostałych kredytów, osiągnięto liczbę zadań, które mogą być uruchamiane bez kredytów. Poczekaj, aż jakieś zadanie się zakończy, 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 IP Filtering, a Meshy oznaczył obraz zadania jako naruszający prawa własności intelektualnej osób trzecich. Zespoły w planie Enterprise nie otrzymują tego błędu. Utwórz zadanie prototype z obrazu, do którego masz prawa użytkowania.

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

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

Identyfikator zadania do anulowania.

Zastosowanie ma jedno z poniższych:

• id nie jest prawidłowym identyfikatorem zadania. Wyślij identyfikator 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 Brick Figure z tym identyfikatorem nie należy do Twojego konta, lub etap zadania nie odpowiada ścieżce. Sprawdź identyfikator i użyj /prototype lub /build, aby dopasować zadanie.

ID zadania z odpowiedzi tworzącej zadanie.

Etap do wylistowania, prototype lub build.

Strona do zwrócenia, od 1 do 255. 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 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-brick-figure-prototype.

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 przyczyną 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ę powodzeniem.

Czas utworzenia zadania, w milisekundach Unix.

Czas rozpoczęcia zadania przez workera, 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. To 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 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 powoduje zwrot kredytów 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 obrazu koncepcyjnego. Tablica zawiera jeden adres URL po pomyślnym zakończeniu zadania, a do tego czasu jest pusta.

ID zadania. Nie polegaj na jego formacie.

Typ zadania, zawsze creative-lab-brick-figure-build.

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

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 przyczyną 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 rozpoczęcia zadania przez workera, w milisekundach Unix. Do tego momentu null.

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

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.

Przyczyna niepowodzenia zadania. null, chyba że status ma wartość 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. Zadanie zakończone niepowodzeniem 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.

Dla zadania budowy Brick Figure zawsze "".

Dla zadania budowy Brick Figure zawsze "", tak jak prompt.

Dla zadania budowy Brick Figure zawsze "", tak jak prompt.

Dla zadania budowy Brick Figure zawsze "", tak jak prompt.

Adresy URL do pobrania modelu 3D, jako teksturowany GLB oraz jako plik OBJ wraz z plikiem MTL.

Adres URL do pobrania obrazu podglądu modelu.

Mapy tekstur, jako tablica zawierająca jeden obiekt z mapą koloru bazowego.