Creative Lab — API magnesu na lodówkę

Zdjęcie źródłowe, które Meshy ma skolorować w gotowy do wykorzystania obraz koncepcyjny magnesu na lodówkę. Obecnie obsługujemy formaty .jpg, .jpeg, .png i .webp.

Istnieją dwa sposoby dostarczenia obrazu:

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

Opcjonalna nazwa zadania służąca celom wyświetlania. Maksymalnie 100 znaków.

Gdy ustawione na true, obraz prototypu jest zwracany jako przezroczysty plik PNG w formacie RGBA z usuniętym tłem, dzięki czemu można nałożyć obiekt na dowolne tło.

Ta opcja kontroluje wyłącznie obraz zwracany przez ten punkt końcowy. Jest niezależna od opcji budowania o tej samej nazwie (domyślnie true), która kontroluje usuwanie tła przed procesem reliefowania.

Żądanie było niepoprawne. Typowe przyczyny:

• Brakujący parametr: image_url jest wymagany.
• Nieprawidłowy format obrazu: podany image_url nie ma obsługiwanego formatu (.jpg, .jpeg, .png, .webp).
• Wymiary obrazu poza dopuszczalnym zakresem: obraz jest zbyt mały, przekracza maksymalny rozmiar pliku lub przekracza maksymalną liczbę pikseli.
• Nieosiągalny adres URL: nie udało się pobrać image_url (404 lub timeout).
• Nieprawidłowy Data URI: ciąg base64 jest nieprawidłowo sformatowany.
• Treść oznaczona: obraz wejściowy został oznaczony przez moderation NSFW lub moderation praw własności intelektualnej.

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

Niewystarczająca liczba kredytów, aby wykonać to zadanie.

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ąć stan SUCCEEDED i musi wygenerować dokładnie jeden obraz kandydujący.

Zadania prototypów utworzone za pośrednictwem aplikacji webowej nie są akceptowane — punkt końcowy budowy akceptuje wyłącznie zadania prototypów wygenerowane przez POST /openapi/creative-lab/fridge-magnet/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.

Sylwetka konturu magnesu na lodówkę. Dostępne wartości:

• circle
• rounded-rect (domyślna)
• hexagon
• shield
• star

Długość krawędzi kwadratu ograniczającego magnes na lodówkę, w milimetrach. Zakres: (0, 400].

Maksymalna wysokość reliefu ponad podstawą, w milimetrach. Zakres: [0, 20].

Przesunięcie pionowe zastosowane do reliefu przed wytłoczeniem, w milimetrach. Zakres: [0, 20].

Grubość płaskiej płyty podstawy za reliefem, w milimetrach. Domyślna wartość dla magnesu na lodówkę to bardziej masywna podstawa 2 mm — zapewnia magnesowi wystarczającą wytrzymałość, by trzymał się lodówki, bez wrażenia kruchości reliefu. Zakres: [0, 20].

Określa, czy tył magnesu na lodówkę jest zamknięty jako zamknięta powierzchnia (strona, do której przykleja się magnes). Ustaw na false, aby uzyskać otwartą powłokę.

Krzywa transferu mapująca wartości mapy głębi na wysokość reliefu. Dostępne wartości:

• linear (domyślna)
• gamma
• s-curve

Parametr kształtu krzywej transferu (ma znaczenie tylko wtedy, gdy relief_curve ma wartość gamma). Zakres: (0, 10].

Odwróć interpretację mapy głębi, tak aby ciemniejsze obszary stawały się wyższym reliefem.

Siła wygładzania zastosowana do mapy głębi przed ekstrakcją reliefu. Zakres: [0, 10].

Mnożnik skali pionowej stosowany na bazie relief_height_mm. Zakres: (0, 10].

Próg dolnoprzepustowy dla wartości mapy głębi; wszystko poniżej tej wartości jest przycinane do zera. Zakres: [0, 1].

Automatycznie usuń tło z obrazu koncepcyjnego prototypu przed nałożeniem reliefu.

Jest to odrębny parametr od parametru prototypu o tej samej nazwie (domyślnie false), który kontroluje, czy sam obraz prototypu jest zwracany z przezroczystością.

Rozdzielczość siatki używana przy eksporcie. Zakres: [64, 2048].

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

• glb (domyślna) — zwraca pojedynczy plik model.glb pod model_urls.glb.
• obj — pakuje model.obj + model.mtl + texture.png i zwraca pakiet pod model_urls.obj.
• zip — pakuje każdy artefakt wygenerowany przez generator i zwraca pakiet 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 poprawnym identyfikatorem UUID.
• Zadanie nadrzędne nie zakończyło się powodzeniem: Wskazane zadanie prototypu nie osiągnęło jeszcze stanu SUCCEEDED.
• Brak kandydata: Zadanie prototypu zakończyło się powodzeniem, ale nie wygenerowało obrazu kandydującego.
• Opcje poza zakresem: Jedno z pól w options znalazło się poza dozwolonym zakresem lub zestawem 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 za pośrednictwem aplikacji webowej (tylko zadania prototypów w trybie API mogą być łączone w łańcuch z budową).

Przekroczono limit szybkości.

Unikalny identyfikator zadania magnesu na lodówkę do pobrania.

Unikalny identyfikator zadania magnesu na lodówkę do anulowania.

Zadanie jest już w stanie końcowym i nie można go anulować.

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

Unikalny identyfikator zadania magnesu na lodówkę do strumieniowania.

prototype lub build. Kolekcja zwraca tylko zadania, których etap odpowiada ścieżce URL — pobranie /prototype nigdy nie zwraca zadań budowy i odwrotnie.

Numer strony do stronicowania.

Limit liczby elementów na stronie. Maksymalna dopuszczalna wartość to 100 elementów.

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

• +created_at: Sortowanie według czasu utworzenia w porządku rosnącym.
• -created_at: Sortowanie według czasu utworzenia w porządku malejącym.

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

Typ zadania. Wartość to creative-lab-fridge-magnet-prototype.

Nazwa zadania podana podczas jego tworzenia. Pusty ciąg znaków, jeśli nazwa nie została podana.

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 zadań poprzedzających.

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. Obecne, gdy status zadania to PENDING, IN_PROGRESS lub SUCCEEDED. Zwraca 0 dla zadań FAILED (kredyty są zwracane w przypadku niepowodzenia).

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 jest tablicą, aby przyszłe wersje mogły udostępniać wielu kandydatów bez wprowadzania zmian łamiących zgodność.

Unikalny identyfikator zadania.

Typ zadania. Wartość to creative-lab-fridge-magnet-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, wartość 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 poprzedzających zadań. Ma znaczenie tylko wtedy, gdy status to PENDING.

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. Zwraca 0 dla zadań FAILED (w przypadku niepowodzenia kredyty są zwracane).

Adresy URL do pobrania wygenerowanego artefaktu, indeksowane nazwą artefaktu. Zawsze zawiera dokładnie jeden wpis — format żądany za pomocą parametru output.format w żądaniu budowy. Klucz odpowiada żądanemu formatowi: