Creative Lab API magnesu na lodówkę

Zdjęcie, które ma zostać przekształcone w obraz koncepcyjny magnesu na lodówkę, podane jako publiczny URL lub Data URI (data:image/jpeg;base64,<dane obrazu zakodowane w base64>).

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.

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

Opcja remove_background w zadaniu budowania jest niezależna.

Żą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 dlatego, że URL zwraca 404 lub przekracza limit czasu.
• Data URI nie jest prawidłowym kodowaniem base64.
• Obraz został oznaczony jako NSFW.

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

Brakuje 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 użytkownik osiągnął 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ł 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 przypadku planu bez limitu, ale 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.

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

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

ID, które nie jest jednym z Twoich zadań prototypu magnesu na lodówkę utworzonych przez API, zwraca 404, w tym prototyp utworzony w aplikacji webowej.

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

Kontur magnesu, gdy Meshy nie wyznacza go na podstawie obiektu. Meshy używa go, gdy remove_background ma wartość false lub gdy nie może znaleźć konturu obiektu.

Dostępne wartości:

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

Długość krawędzi kwadratu obwiedni magnesu, w milimetrach, do 400. 0 używa wartości domyślnej.

Maksymalna wysokość reliefu nad 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. Domyślna podstawa o grubości 2 mm nadaje magnesowi wystarczającą masę, by trzymał się lodówki, dzięki czemu relief nie wydaje się kruchy.

Czy zamknąć tył magnesu, czyli stronę, do której przykleja się magnes. false pozostawia tył otwarty, jako powłokę.

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 używa 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, zanim Meshy zbuduje relief, od 0 do 10.

O ile przybliżyć relief i jego teksturę wewnątrz konturu, 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 używa wartości domyślnej.

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

Czy wyznaczyć kontur magnesu na podstawie obiektu, tak aby magnes podążał za kształtem obiektu. false używa zamiast tego konturu badge_shape. Meshy używa badge_shape także wtedy, gdy nie może znaleźć konturu 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 512-pikselowej mapy głębi, więc dokładniejsza siatka dodałaby ścianki bez dodawania szczegółów. 0 używa wartości domyślnej.

Format pliku zwracany 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 brakujące 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 options jest poza zakresem lub nie jest dostępną wartością.

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

Klucz API jest brakujący lub 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 pasuje do żadnego zadania prototypu magnesu na lodówkę utworzonego przez Twoje konto za pomocą API. Prototyp utworzony w aplikacji webowej również zwraca 404. Wyślij ID 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.
• W planie bez limitów, przy braku kredytów, osiągnięto liczbę zadań, które mogą być uruchamiane bez kredytów. Poczekaj, aż zadanie się zakończy, lub dodaj kredyty.

ID zadania z odpowiedzi tworzenia.

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

W Twoim zespole włączone jest Filtrowanie IP, a Meshy oznaczyło obraz zadania prototypu jako naruszający prawa własności intelektualnej osób trzecich. Ten błąd nie dotyczy zadań budowy ani zespołów w planie Enterprise. Utwórz zadanie prototypu na podstawie obrazu, do którego masz prawa użycia.

Żadne zadanie Fridge Magnet 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.

Identyfikator zadania do anulowania.

Zastosowanie ma jedno z poniższych:

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

Żadne zadanie magnesu na lodówkę o tym identyfikatorze 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 tworzenia zadania.

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 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-fridge-magnet-prototype.

name, które wysłałeś podczas tworzenia zadania, lub "", jeśli go nie wysłałeś.

Status zadania.

Dostępne wartości:

• PENDING: oczekiwanie 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 czasu rozpoczęcia zadania i 100, gdy zakończy się powodzeniem.

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. Jest 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 zadanie rozpocznie się 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, 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 koncepcyjnego. Tablica zawiera jeden 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-fridge-magnet-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: 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ę powodzeniem.

Czas utworzenia zadania, w milisekundach Unix.

Czas rozpoczęcia zadania przez worker, 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, a dopóki zadanie się nie zakończy — 3 dni po created_at. 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 opłatą. 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ć naliczonej opłaty, 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. {}, dopóki zadanie nie zakończy się powodzeniem.