Creative Lab — API lampy

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

Istnieją dwa sposoby dostarczenia obrazu:

• Publicznie dostępny URL: adres URL 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>.

Podpowiedź kategorii tematu, która wybiera prompt stylizacji. Dostępne wartości:

• character (domyślnie) — pojedyncza postać / obiekt jako temat (figurka, zwierzę, maskotka itp.).
• landscape — scena plenerowa / panorama jako temat (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 PNG RGBA z usuniętym tłem, dzięki czemu możesz nałożyć temat na dowolne tło.

Żądanie było niepoprawne. 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: wartość inna niż character / landscape.

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

Niewystarczające kredyty do wykonania tego zadania.

Przekroczono limit szybkości.

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

Zadania prototypów utworzone za pomocą aplikacji webowej nie są akceptowane — punkt końcowy build akceptuje wyłącznie zadania prototypów utworzone 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 abażuru, w milimetrach. Siatka jest skalowana jednolicie, aby się zmieściła. Zakres: [50, 400].

Grubość ścianki pustego w środku abażuru, w milimetrach. Zakres: (0, 10].

Procent wysokości modelu ścięty płasko od dołu, tak aby abażur mógł stać na stole druku i miał otwór na osprzęt. Zakres: [1, 100].

Preset osprzętu źródła światła, który określa sposób budowy spodu. Dostępne wartości:

• bambu_mh001_60mm (domyślny) — abażur z otwartym spodem plus płyta podstawy z 60-milimetrowym otworem na osprzęt, oba w model_urls.lamp_stl, oraz uchwyt osprzętu jako model_urls.base_stl.
• none — pojedynczy, w pełni zamknięty abażur w model_urls.lamp_stl; model_urls.base_stl jest pomijane.

Przesunięcie na osi X otworu na osprzęt na płycie podstawy, względem środka abażuru, w milimetrach. Ma znaczenie tylko wtedy, gdy light_source_preset ≠ none. Zakres: [-80, 80].

Przesunięcie na osi Z (głębokość) otworu na osprzęt na płycie podstawy, względem środka abażuru, w milimetrach. Ma znaczenie tylko wtedy, gdy light_source_preset ≠ none. Zakres: [-80, 80].

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

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

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

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

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

• stl (domyślny) — zwraca model_urls.lamp_stl (abażur, wraz z płytą podstawy, gdy ustawiono preset osprzętu), plus 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) do jednego pliku zip i zwraca go pod model_urls.bundle_zip.

Żądanie było niepoprawne. Częste przyczyny:

• Brakujący parametr: input_task_id jest wymagane.
• 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 znajdowało się poza dozwolonym zakresem lub zbiorem wartości enum.

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

Niewystarczające kredyty do wykonania tego zadania.

Wskazane zadanie prototypu nie istnieje, należy do innego użytkownika lub zostało utworzone za pomocą aplikacji webowej (tylko zadania prototypów utworzone w trybie API mogą być łączone w łańcuch z zadaniem budowy).

Przekroczono limit szybkości.

Unikalny identyfikator zadania lampy do pobrania.

Unikalny identyfikator zadania lampy do anulowania.

Zadanie jest już w stanie końcowym i nie może być anulowane.

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

Unikalny identyfikator zadania lampy do strumieniowania.

prototype albo build. Kolekcja zwraca tylko zadania, których etap odpowiada URL — pobranie /prototype nigdy nie zwróci zadań budowy i odwrotnie.

Numer strony do stronicowania.

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

Pole, według którego ma nastąpić sortowanie. Dostępne wartości:

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

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

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 jeszcze się nie rozpoczęło, ta właściwość ma 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 jeszcze się nie rozpoczęło, ta właściwość ma wartość 0.

Znacznik czasu zakończenia zadania, w milisekundach. Jeśli zadanie jeszcze się nie zakończyło, ta właściwość ma 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 znajduje się w sekcji Błędy.

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

Adresy URL do pobrania modelu 3D wygenerowanego z obrazu koncepcyjnego. Obecne po pomyślnym zakończeniu zadania; wcześniej {}.

Adres URL do pobrania renderowanego podglądu modelu 3D. Pusty ciąg znaków do czasu pomyślnego zakończenia zadania.

Adresy URL do pobrania kandydatów obrazów koncepcyjnych 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 zmiany łamiącej kompatybilność.

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 (progress) 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, wartość ta zmieni się na 100.

Znacznik czasu utworzenia zadania, w milisekundach.

Znacznik czasu rozpoczęcia zadania, w milisekundach.

Znacznik czasu zakończenia zadania, w milisekundach.

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

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

Szczegóły błędu dla zadań zakończonych niepowodzeniem. Zobacz Błędy, aby poznać pełny opis obiektu task_error.

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

Adresy URL do pobrania wygenerowanych artefaktów, indeksowane według nazwy artefaktu. Zestaw kluczy zależy od output.format oraz options.light_source_preset: