Creative Lab — Lamp API

Zdjęcie źródłowe, którego Meshy używa jako wizualnego odniesienia dla klosza lampy. Obecnie obsługujemy formaty .jpg, .jpeg, .png i .webp.

Istnieją dwa sposoby dostarczenia obrazu:

• Publicznie dostępny URL: URL, który jest dostępny z publicznego internetu.
• Data URI: Zakodowany w base64 identyfikator URI danych obrazu. Przykład Data URI: data:image/jpeg;base64,<your base64-encoded image data>.

Wskazówka kategorii podmiotu, która wybiera prompt stylizacji. Dostępne wartości:

• character (domyślnie) — pojedyncza postać / podmiot będący obiektem (figurka, zwierzę, maskotka itp.).
• landscape — scena plenerowa / panorama (góra, panorama miasta, las itp.).

Opcjonalna nazwa zadania do celów wyświetlania. Maksymalnie 100 znaków.

Gdy ustawione na true, obraz prototypu jest zwracany jako przezroczysty plik PNG RGBA z usuniętym tłem, dzięki czemu możesz skomponować podmiot z dowolnym tłem.

Żądanie było nieakceptowalne. Typowe przyczyny:

• Brakujący parametr: image_url jest wymagane.
• Nieprawidłowy format obrazu: Podany image_url nie jest w obsługiwanym formacie (.jpg, .jpeg, .png, .webp).
• Wymiary obrazu poza zakresem: Obraz jest zbyt mały, przekracza maksymalny rozmiar pliku lub przekracza maksymalną liczbę pikseli.
• Nieosiągalny URL: Nie udało się pobrać image_url (404 lub timeout).
• Nieprawidłowy Data URI: Ciąg base64 jest nieprawidłowo sformatowany.
• Oznaczona treść: Obraz wejściowy został oznaczony przez moderation NSFW lub własności intelektualnej.
• Nieprawidłowe image_subject: Nie jest jedną z wartości character / landscape.

Uwierzytelnianie nie powiodło się. Sprawdź swój klucz API.

Niewystarczająca liczba kredytów do wykonania tego zadania.

Przekroczono limit szybkości.

Identyfikator zadania prototypu utworzonego za pomocą tego samego punktu końcowego OpenAPI. Prototyp musi zostać utworzony przy użyciu tego samego klucza API, musi osiągnąć status SUCCEEDED i musi wygenerować model 3D.

Zadania prototypów utworzone przez aplikację webową nie są akceptowane — punkt końcowy budowy akceptuje wyłącznie zadania prototypów wygenerowane przez POST /openapi/creative-lab/lamp/v1/prototype i odrzuca każde inne źródło z kodem 404.

Opcjonalna nazwa zadania do celów wyświetlania. Maksymalnie 100 znaków.

Docelowy maksymalny wymiar prostopadłościanu ograniczającego klosza lampy, w milimetrach. Siatka jest skalowana jednorodnie, aby się zmieściła. Zakres: [50, 400].

Grubość ścianki wydrążonego klosza lampy, w milimetrach. Zakres: (0, 10].

Procent wysokości modelu odcinany płasko od dołu, dzięki czemu klosz lampy stoi na stole drukarki i ma otwór na mocowanie. Zakres: [1, 100].

Ustawienie wstępne mocowania źródła światła, które określa sposób budowy dolnej części. Dostępne wartości:

• bambu_mh001_60mm (domyślnie) — klosz lampy z otwartym dołem wraz z płytą podstawy zawierającą 60 mm otwór mocujący, oba dostępne w model_urls.lamp_stl, oraz uchwyt mocowania jako model_urls.base_stl.
• none — pojedynczy, zamknięty klosz lampy w model_urls.lamp_stl; pole model_urls.base_stl jest pomijane.

Przesunięcie w osi X otworu mocującego na płycie podstawy, względem środka klosza lampy, w milimetrach. Ma znaczenie tylko wtedy, gdy light_source_preset ≠ none. Zakres: [-80, 80].

Przesunięcie w osi Z (głębokość) otworu mocującego na płycie podstawy, względem środka klosza lampy, w milimetrach. Ma znaczenie tylko wtedy, gdy light_source_preset ≠ none. Zakres: [-80, 80].

Obrót wokół osi X zastosowany do modelu przed przetwarzaniem, w stopniach. Trzy obroty są stosowane jako kąty Eulera XYZ wokół środka modelu. Zakres: [-360, 360].

Obrót wokół osi Y zastosowany do zaimportowanej siatki przed przetwarzaniem, w stopniach. Zakres: [-360, 360].

Obrót wokół osi Z zastosowany do zaimportowanej siatki przed przetwarzaniem, w stopniach. Zakres: [-360, 360].

Gdy ustawione na true, a output.format ma wartość zip, dołącza plik result.json procesora lampy (nazwa potoku, ostrzeżenia i ścieżki artefaktów) do pakietu. Ignorowane, gdy output.format ma wartość stl.

Pakiet artefaktów zwracany przez budowę. Dostępne wartości:

• stl (domyślnie) — zwraca model_urls.lamp_stl (klosz lampy, wraz z płytą podstawy, gdy ustawiono ustawienie wstępne mocowania), a także model_urls.base_stl, gdy light_source_preset ≠ none.
• zip — pakuje każdy artefakt generowany przez procesor (lamp.stl, opcjonalnie base.stl, opcjonalnie result.json) w jeden plik zip i zwraca go pod model_urls.bundle_zip.

Żądanie było nieprawidłowe. Typowe przyczyny:

• Brakujący parametr: input_task_id jest wymagany.
• Nieprawidłowy UUID: input_task_id nie jest prawidłowym UUID.
• Zadanie nadrzędne nie zakończone powodzeniem: Wskazane zadanie prototypu nie osiągnęło jeszcze statusu SUCCEEDED.
• Brak modelu: Zadanie prototypu zakończyło się powodzeniem, ale nie wygenerowało modelu 3D.
• Opcje poza zakresem: Jedno z pól options znalazło się poza dozwolonym zakresem lub zbiorem wartości enum.

Uwierzytelnianie nie powiodło się. Sprawdź swój klucz API.

Niewystarczająca liczba kredytów do wykonania tego zadania.

Wskazane zadanie prototypu nie istnieje, należy do innego użytkownika lub zostało utworzone przez aplikację webową (tylko zadania prototypów w trybie API mogą być łączone w łańcuch z budową).

Przekroczono limit szybkości.

Unikalny identyfikator zadania Lampa, które chcesz pobrać.

Unikalny identyfikator zadania lampy do anulowania.

Zadanie znajduje się już w stanie końcowym i nie może zostać anulowane.

Zadanie nie istnieje, należy do innego użytkownika lub jego etap nie odpowiada ścieżce URL.

Unikalny identyfikator zadania lampy do strumieniowania.

Wartość prototype lub build. Kolekcja zwraca wyłącznie zadania, których etap odpowiada adresowi URL — pobranie /prototype nigdy nie zwraca zadań budowania i odwrotnie.

Numer strony do stronicowania.

Limit rozmiaru strony. Maksymalna dozwolona wartość to 100 elementów.

Pole do sortowania. Dostępne wartości:

• +created_at: Sortowanie według czasu utworzenia rosnąco.
• -created_at: Sortowanie według czasu utworzenia malejąco.

Unikalny identyfikator zadania. Chociaż jako szczegół implementacyjny używamy identyfikatora UUID możliwego do sortowania k-sortable dla identyfikatorów zadań, nie należy przyjmować żadnych założeń co do formatu tego identyfikatora.

Typ zadania. Wartość to creative-lab-lamp-prototype.

Nazwa zadania podana podczas jego tworzenia. Pusty ciąg znaków, jeśli nie podano nazwy.

Status zadania. Możliwe wartości to jedna z: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Postęp zadania (progress). Jeśli zadanie nie zostało jeszcze rozpoczęte, ta właściwość będzie miała wartość 0. Gdy zadanie zakończy się powodzeniem, wartość ta zmieni się na 100.

Znacznik czasu utworzenia zadania, w milisekundach.

Znacznik czasu rozpoczęcia zadania, w milisekundach. Jeśli zadanie nie zostało jeszcze rozpoczęte, ta właściwość będzie miała wartość 0.

Znacznik czasu zakończenia zadania, w milisekundach. Jeśli zadanie nie zostało jeszcze zakończone, ta właściwość będzie miała wartość 0.

Znacznik czasu wygaśnięcia wyniku zadania, w milisekundach.

Liczba poprzedzających zadań.

Szczegóły błędu dla nieudanych zadań. Pełny opis obiektu task_error znajdziesz w sekcji Błędy.

Liczba kredytów zużytych przez to zadanie. Obecna, gdy status zadania to PENDING, IN_PROGRESS lub SUCCEEDED. Zwraca 0 dla zadań FAILED (w przypadku niepowodzenia kredyty są zwracane).

Adresy URL umożliwiające pobranie modelu 3D wygenerowanego z obrazu koncepcyjnego. Obecne, gdy zadanie zakończy się powodzeniem; przed tym {}.

Adres URL umożliwiający pobranie renderowanego podglądu modelu 3D. Pusty ciąg znaków, dopóki zadanie nie zakończy się powodzeniem.

Adresy URL umożliwiające pobranie kandydatów na obraz koncepcyjny wygenerowanych przez to zadanie prototypowe. Obecnie API zawsze zwraca dokładnie jednego kandydata; pole to jest tablicą, aby przyszłe wersje mogły udostępniać wielu kandydatów bez wprowadzania zmian niekompatybilnych wstecz.

Unikalny identyfikator zadania.

Typ zadania. Wartość to creative-lab-lamp-build.

Nazwa zadania podana podczas jego tworzenia. Pusty ciąg znaków, jeśli nie podano nazwy.

Status zadania. Możliwe wartości to jedna z: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Postęp zadania. Jeśli zadanie jeszcze się nie rozpoczęło, ta właściwość będzie miała wartość 0. Gdy zadanie zakończy się powodzeniem, przyjmie wartość 100.

Znacznik czasu utworzenia zadania, w milisekundach.

Znacznik czasu rozpoczęcia zadania, w milisekundach.

Znacznik czasu zakończenia zadania, w milisekundach.

Znacznik czasu, kiedy wynik zadania wygasa, w milisekundach.

Liczba poprzedzających zadań. Ma znaczenie tylko wtedy, gdy status to PENDING.

Szczegóły błędu dla nieudanych zadań. Zobacz Błędy, aby uzyskać pełny opis obiektu task_error.

Liczba kredytów zużytych przez to zadanie. Zwraca 0 dla zadań FAILED (kredyty są zwracane w przypadku niepowodzenia).

Adresy URL do pobrania wygenerowanych plików wynikowych, indeksowane nazwą pliku. Zestaw kluczy zależy od output.format i options.light_source_preset: