Creative Lab — Keychain API

Zdjęcie źródłowe, które Meshy ma skolorować i przekształcić w obraz koncepcyjny gotowy do stworzenia breloka. 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,<twoje zakodowane w base64 dane obrazu>.

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

Nadaje ona zadaniu etykietę na twoim panelu i na listach zadań. Nie jest ona grawerowana na breloku — do tego celu służy name_text.

Tekst do wygrawerowania na breloku, na przykład imię zwierzaka lub osoby. Maksymalnie 10 znaków, liczonych jako znaki Unicode, a nie bajty, więc 10-znakowe imię w języku chińskim, japońskim lub koreańskim zostanie zaakceptowane. Pomiń ten parametr, aby uzyskać brelok bez grawerunku.

Otaczające białe znaki są usuwane, a niewidoczne znaki formatujące są usuwane przed użyciem tekstu. Wynikowa wartość jest zwracana jako name_text w obiekcie zadania prototypu, dzięki czemu możesz potwierdzić dokładnie to, co zostanie wygrawerowane, zanim zapłacisz za etap budowania.

Grawerunek jest stosowany tutaj, na etapie prototypu. Etap budowania dziedziczy go automatycznie i nie przyjmuje własnego name_text.

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

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

Żądanie było nie do przyjęcia. 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 sformułowany.
• Zbyt długi grawerunek: name_text jest dłuższy niż 10 znaków. Żądanie jest odrzucane, a nie skracane, dzięki czemu nigdy nie zostaniesz obciążony za brelok wygrawerowany skróconą nazwą.
• Treść oznaczona: obraz wejściowy został oznaczony przez moderation NSFW lub moderation praw własności intelektualnej, albo grawerunek name_text został oznaczony przez moderation NSFW. Grawerunek jest sprawdzany wyłącznie pod kątem treści NSFW — sprawdzanie praw własności intelektualnej dotyczy obrazu.

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 (task ID) zadania prototypu utworzonego za pomocą tego samego punktu końcowego OpenAPI. Prototyp musi zostać utworzony za pomocą tego samego klucza API, musi osiągnąć status SUCCEEDED i musi wygenerować dokładnie jeden obraz kandydujący.

Zadania prototypów utworzone za pomocą aplikacji webowej nie są akceptowane — punkt końcowy budowania akceptuje tylko zadania prototypów wygenerowane przez POST /openapi/creative-lab/keychain/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.

Kontur/silhouette medalionu breloka. Dostępne wartości:

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

Długość krawędzi kwadratu ograniczającego brelok, w milimetrach. Zakres: (0, 400].

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

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

Grubość płaskiej płyty podstawy za reliefem, w milimetrach. Zakres: [0, 20].

Określa, czy tył medalionu jest zamknięty jako zamknięta powierzchnia. Ustaw na false dla otwartej powłoki (shell).

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

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

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

Odwraca interpretację mapy głębi, tak aby ciemniejsze obszary stały się wyższym reliefem.

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

Mnożnik skali wertykalnej zastosowany na wartości relief_height_mm. Zakres: (0, 10].

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

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

Odrębny 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żyta do eksportu. Zakres: [64, 2048].

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

• glb (domyślnie) — 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 niedopuszczalne. 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: Wskazywane zadanie prototypu nie osiągnęło jeszcze statusu SUCCEEDED.
• Brak kandydata: Zadanie prototypu zakończyło się powodzeniem, ale nie wygenerowało żadnego obrazu kandydującego.
• Opcje poza zakresem: Jedno z pól options wykroczyło poza dozwolony zakres lub zestaw wartości enum.

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

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

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

Przekroczono limit szybkości.

Unikalny identyfikator zadania keychain do pobrania.

Unikalny identyfikator zadania brelok do anulowania.

Zadanie znajduje się 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 breloka do strumieniowania.

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

Numer strony do stronicowania.

Limit rozmiaru strony. Maksymalna dozwolona 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 rosnąco.
• -created_at: Sortowanie według czasu utworzenia malejąco.

Unikalny identyfikator zadania. Choć jako szczegół implementacyjny używamy identyfikatorów UUID z możliwością sortowania k-sortowalnego dla identyfikatorów zadań, nie należy przyjmować żadnych założeń co do formatu identyfikatora.

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

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

Grawerunek zastosowany na tym breloku, po przycięciu i usunięciu niewidocznych znaków formatujących. Nieobecne, jeśli zadanie zostało utworzone bez name_text. Porównaj tę wartość z tym, co wysłałeś, aby potwierdzić, że tekst przetrwał kodowanie Twojego klienta HTTP.

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

Postęp zadania. Jeśli zadanie nie zostało jeszcze rozpoczęte, ta właściwość będzie równa 0. Po zakończeniu zadania sukcesem stanie się 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 równa 0.

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

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

Liczba zadań poprzedzających.

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

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 do pobrania 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 kompatybilność.

Unikalny identyfikator zadania.

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

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 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 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 wygenerowanego artefaktu, indeksowane nazwą artefaktu. Zawsze zawiera dokładnie jeden wpis — format żądany za pomocą output.format w żądaniu budowy. Klucz odpowiada żądanemu formatowi: