Creative Lab Lamp API

Zdjęcie, na podstawie którego ma zostać utworzony klosz lampy, jako publicznie dostępny URL lub Data URI (data:image/jpeg;base64,<zakodowane w base64 dane obrazu>).

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

Rodzaj obiektu na zdjęciu, który określa sposób stylizacji przez Meshy.

Dostępne wartości:

• character: pojedyncza postać lub obiekt, taki jak figurka, zwierzę lub maskotka
• landscape: scena plenerowa lub panorama, taka jak góra, panorama miasta lub las

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 w formacie RGBA, dzięki czemu możesz umieścić obiekt na dowolnym tle. Meshy buduje również model 3D na podstawie obrazu bez tła. Jeśli Meshy nie może usunąć tła, używa obrazu z tłem, a zadanie nadal kończy się powodzeniem.

Żą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, ma ponad 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 zawiera prawidłowego kodowania base64.
• Obraz został oznaczony jako NSFW.
• image_subject nie ma wartości character ani landscape.

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

Klucz API jest nieobecny lub nieprawidłowy. Sprawdź nagłówek Authorization.

Ma zastosowanie 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 bezpłatnego.

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 posiadasz prawa użytkowania.

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

• Wysłano więcej żądań, niż pozwala na to limit szybkości. Odczekaj kilka sekund i 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 przypadku planu nielimitowanego bez pozostałych kredytów osiągnięto liczbę zadań, które mogą być uruchomione bez kredytów. Poczekaj na zakończenie zadania lub doładuj kredyty.

Meshy napotkało błąd serwera, 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/lamp/v1/prototype, ze statusem SUCCEEDED.

ID, które nie jest jednym z zadań prototypów lampy utworzonych przez API na Twoim koncie, zwraca 404, włącznie z prototypem utworzonym w aplikacji webowej.

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

Rozmiar największego wymiaru klosza lampy, w milimetrach, od 50 do 400. Meshy skaluje model równomiernie, aby pasował. 0 używa wartości domyślnej, a każda inna wartość poza zakresem zwraca 400.

Grubość ścianki klosza lampy, w milimetrach, do 10. 0 używa wartości domyślnej, a wartość ujemna lub wartość powyżej 10 zwraca 400.

Procent wysokości modelu do przycięcia na płasko u dołu, od 1 do 100. Płaski spód pozwala klosza lampy stać na stole druku i zostawia miejsce na mocowanie. Wartość poza zakresem zwraca 400.

Predefiniowane ustawienie oprawy oświetleniowej, które określa, jak Meshy buduje spód.

Dostępne wartości:

• bambu_mh001_60mm: klosz lampy z otwartym spodem z płytą podstawy z 60 mm otworem mocującym, oba w model_urls.lamp_stl, oraz mocowanie oprawy w model_urls.base_stl
• none: pojedynczy, zamknięty klosz lampy w model_urls.lamp_stl, bez model_urls.base_stl

O ile przesunąć otwór mocujący wzdłuż osi X od środka klosza lampy, w milimetrach, od -80 do 80. Ma zastosowanie tylko, gdy light_source_preset nie jest none.

O ile przesunąć otwór mocujący wzdłuż osi Z (głębokość) od środka klosza lampy, w milimetrach, od -80 do 80. Ma zastosowanie tylko, gdy light_source_preset nie jest none.

Obrót wokół osi X do zastosowania na modelu przed przetworzeniem przez Meshy, w stopniach, od -360 do 360. Meshy stosuje trzy obroty jako kąty Eulera XYZ wokół środka modelu.

Obrót wokół osi Y do zastosowania na modelu przed przetworzeniem przez Meshy, w stopniach, od -360 do 360.

Obrót wokół osi Z do zastosowania na modelu przed przetworzeniem przez Meshy, w stopniach, od -360 do 360.

Czy dodać plik result.json do pakietu zip, z nazwą uruchomionego potoku, ostrzeżeniami i ścieżkami plików. Wymaga ustawienia output.format na zip. true z stl zwraca 400.

Pliki zwracane przez budowanie.

Dostępne wartości:

• stl: model_urls.lamp_stl, klosz lampy z płytą podstawy, gdy jest predefiniowane ustawienie mocowania, oraz model_urls.base_stl, gdy light_source_preset nie jest none
• zip: jeden plik zip w model_urls.bundle_zip, z lamp.stl oraz base.stl i result.json, gdy mają zastosowanie

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

• input_task_id jest brakujący 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 modelu 3D. Utwórz nowe zadanie prototypu.
• Pole options jest poza zakresem lub nie jest dostępną wartością.
• output.format nie jest stl ani zip, lub include_result_json jest true bez zip.

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

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

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

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

input_task_id nie pasuje do żadnego zadania prototypu lampy 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 uruchomionych. Poczekaj, aż niektóre się zakończą, a następnie spróbuj ponownie.
• Na planie nieograniczonym 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.

Identyfikator zadania z odpowiedzi tworzenia.

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

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. Ten błąd nie dotyczy zadań builda ani zespołów w planie Enterprise. Utwórz zadanie prototypu na podstawie obrazu, do którego masz prawa.

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

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. Wyś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 Lamp z 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 wyświetlenia, 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-lamp-prototype.

name wysłane podczas tworzenia zadania lub "", jeśli go 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 do czasu rozpoczęcia zadania i 100, gdy zakończy się powodzeniem.

Czas utworzenia zadania, w milisekundach Unix.

Czas, kiedy worker rozpoczął zadanie, w milisekundach Unix. null do tego momentu.

Czas, kiedy 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 i zawsze 0 w wynikach listy.

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

Adresy URL do pobrania modelu 3D wygenerowanego z obrazu koncepcyjnego. {} do czasu powodzenia zadania.

Adres URL do pobrania obrazu podglądu modelu 3D. "" do czasu powodzenia zadania.

Adresy URL do pobrania obrazu koncepcyjnego. Tablica zawiera jeden adres URL po powodzeniu zadania, a do tego czasu jest pusta.

Identyfikator zadania. Nie polegaj na jego formacie.

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

Wartość name, którą wysłałeś podczas tworzenia zadania, lub "", jeśli jej 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. 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, 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ć 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 plików drukowalnych. To, które klucze się pojawią, zależy od output.format i options.light_source_preset.