Creative Lab Keycap API

Zdjęcie, które ma zostać przekształcone w projekt nasadki klawisza, jako publicznie dostępny URL lub Data URI (data:image/jpeg;base64,<Twoje dane obrazu zakodowane w base64>).

Obraz musi być plikiem JPG, JPEG, PNG lub WebP o rozmiarze maksymalnie 20 MB (20 000 000 bajtów). Każdy bok musi mieć co najmniej 32 piksele, a obraz może mieć łącznie maksymalnie 178 956 970 pikseli. Obraz przekraczający te limity zwraca 400.

Meshy wykrywa format na podstawie danych obrazu, a nie na podstawie rozszerzenia pliku w adresie URL. Adres URL bez rozszerzenia również działa, a Meshy podąża za przekierowaniami HTTP. Meshy stosuje orientację EXIF, więc obrócone zdjęcie z telefonu wychodzi tak, jak powinno wyglądać.

Data URI musi być zakodowane w base64 z typem obrazu, np. data:image/png;base64,..., a zdekodowany obraz musi być w formacie JPEG, PNG lub WebP. Limit 20 MB dotyczy zdekodowanego obrazu, więc tekst base64 może być o około jedną trzecią większy.

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

Określa, czy usunąć tło z obrazu prototypu. true zwraca przezroczysty obraz PNG w formacie RGBA, dzięki czemu możesz umieścić nasadkę klawisza na dowolnym tle. Jeśli Meshy nie może usunąć tła, zwraca obraz z jego tłem, a zadanie nadal kończy się sukcesem.

Projekt wierzchniej części, który podczas budowania zostaje przekształcony w 3D, zachowuje swoje tło niezależnie od tego ustawienia. Proces budowania maluje podstawę nasadki klawisza na podstawie obrazu w image_urls, bez jego tła, jeśli wysłano true. Proces budowania zwraca ten obraz jako process_image_urls.composite.

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

• Brakuje image_url.
• Obraz nie jest plikiem JPG, JPEG, PNG ani WebP.
• Obraz jest zbyt mały, przekracza 20 MB lub przekracza maksymalną liczbę pikseli.
• Meshy nie może pobrać obrazu, na przykład ponieważ adres URL zwraca 404 lub upłynął limit czasu.
• Data URI nie jest prawidłowo zakodowane w base64.
• Obraz został oznaczony jako NSFW.

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

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

Zastosowanie ma 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 planu darmowego.

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

Twój zespół ma włączone filtrowanie adresów IP, a Meshy oznaczyło obraz jako naruszający prawa własności intelektualnej osób trzecich. Wyślij obraz, do którego masz prawa użytkowania.

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

• Wysłano więcej żądań, niż pozwala na to Twój limit szybkości. Odczekaj kilka sekund, a następnie spróbuj ponownie. Zobacz Limity szybkości.
• Zbyt wiele Twoich zadań znajduje się w kolejce lub jest 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ć uruchamiane bez kredytów. Poczekaj na zakończenie zadania lub dodaj kredyty.

Wystąpił błąd serwera Meshy, na przykład dlatego, że nie udało się przeprowadzić moderacji treści lub sprawdzenia praw własności intelektualnej, albo Meshy nie mogło zapisać obrazu. Meshy nie tworzy zadania i zwraca wszelkie naliczone 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/keycap/v1/prototype, ze statusem SUCCEEDED.

ID, które nie jest zadaniem prototypu Keycap z API utworzonym przez Twoje konto, zwraca 404, w tym również prototyp utworzony w aplikacji webowej.

Kandydat do zbudowania, pochodzący z tablicy candidate_ids zadania prototypu. Wartość spoza tej tablicy zwraca 400.

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

Podstawa keycapa, na której następuje budowa. Jedyną wartością jest cherry-mx-1x1-r1, standardowy keycap o profilu Cherry MX 1u. Niestandardowe rozmiary nie są obsługiwane, a każda inna wartość zwraca 400.

Rozmiar główki wzdłuż jej najdłuższego wymiaru, w milimetrach, od 10 do 40. Meshy skaluje główkę tak, aby jej najdłuższy wymiar odpowiadał tej wartości. Wartość spoza tego zakresu zwraca 400.

Dla wartości powyżej około 32.9 Meshy może zmniejszyć rozmiar, aby główka zmieściła się w granicach ochronnego obszaru podstawy. Główka może wtedy wyjść mniejsza, niż zażądano. Obiekt zadania nie zwraca rozmiaru zastosowanego przez Meshy. Aby go sprawdzić, zmierz prostopadłościan ograniczający siatki keycap-head w modelu.

Przesunięcie pionowe stosowane do główki, zanim Meshy osadzi ją na podstawie, w milimetrach, od -5 do 5. Wartość spoza tego zakresu zwraca 400.

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

• input_task_id jest nieobecne lub nie jest prawidłowym ID zadania.
• Status zadania prototypu nie jest SUCCEEDED. Jeśli nadal 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 kandydatów. Utwórz nowe zadanie prototypu.
• candidate_id jest nieobecne lub nie znajduje się w candidate_ids zadania prototypu. Wyślij wartość z tej tablicy.
• Pole w options jest poza dozwolonym zakresem lub base_model nie jest dostępną wartością.

Komunikat błędu wskazuje, jaki problem wystąpił.

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

Zastosowanie ma jedno z poniższych:

• Konto nie ma wystarczającej liczby kredytów.
• Klucz API, obszar roboczy lub członek osiągnął limit kredytów.
• Konto korzysta z planu darmowego.

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

input_task_id nie pasuje do żadnego zadania prototypu Keycap utworzonego przez Twoje konto za pomocą API. Prototyp utworzony w aplikacji webowej również zwraca 404. Wyślij ID result z odpowiedzi na utworzenie prototypu.

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

• Wysłano więcej żądań, niż pozwala na to limit szybkości. Poczekaj kilka sekund, a następnie spróbuj ponownie. Zobacz Limity szybkości.
• Zbyt wiele Twoich zadań jest w kolejce lub trwa. 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 dodaj kredyty.

Meshy nie mogło utworzyć zadania z powodu błędu serwera. Meshy zwraca wszelkie pobrane kredyty. Spróbuj ponownie wysłać żądanie.

ID zadania z odpowiedzi tworzenia.

id nie jest prawidłowym ID zadania. Wyślij ID result z odpowiedzi tworzenia.

Twój zespół ma włączone Filtrowanie IP, a Meshy oznaczyło obraz zadania prototypu jako naruszający prawa własności intelektualnej osób trzecich. Zadania builda oraz zespoły w planie Enterprise nie otrzymują tego błędu. Utwórz zadanie prototypu na podstawie obrazu, do którego posiadasz prawa.

Żadne zadanie Keycap o tym ID nie należy do Twojego konta, lub etap zadania nie zgadza się ze ścieżką. Sprawdź ID i użyj /prototype lub /build zgodnie z zadaniem.

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 zadania.
• Zadanie ma już status końcowy (SUCCEEDED, FAILED lub CANCELED), więc nie można go anulować.

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

Meshy napotkało błąd serwera podczas anulowania zadania, więc zadanie może, ale nie musi zostać anulowane. Pobierz zadanie, aby sprawdzić jego status przed ponowną próbą.

Identyfikator zadania z odpowiedzi na żądanie utworzenia.

Etap do wylistowania, 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

Identyfikator zadania. Nie polegaj na jego formacie.

Typ zadania, zawsze creative-lab-keycap-prototype.

Wartość name wysłana podczas tworzenia zadania lub "", jeśli jej 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 momentu rozpoczęcia zadania i 100, gdy zakończy się powodzeniem.

Czas utworzenia zadania, w milisekundach Unix.

Czas, w którym pracownik rozpoczął zadanie, w milisekundach Unix. Do tego momentu null.

Czas, w którym zadanie osiągnęło status końcowy, w milisekundach Unix. Do tego momentu null.

Czas wygaśnięcia wyniku zadania, w milisekundach Unix. Wynosi 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 zwracające błąd nie jest obciążane opłatą. 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ć naliczonej 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 obrazu gotowego keycapa. Tablica zawiera jeden adres URL po pomyślnym zakończeniu zadania, a do tego momentu jest pusta. image_urls[i] pokazuje kandydata z candidate_ids[i].

Te adresy URL służą do wyświetlania. Punkt końcowy build przyjmuje wpis z candidate_ids, a nie adres URL. Są to podpisane adresy URL, więc pobieraj je bez nagłówka Authorization. Pozostają ważne do expires_at, a ponowne pobranie zadania zwraca te same adresy URL.

Identyfikatory kandydatów, w tej samej kolejności co image_urls. Aby zbudować kandydata, wyślij jego identyfikator jako candidate_id w żądaniu build. Nie polegaj na formacie tych identyfikatorów.

ID zadania. Nie polegaj na jego formacie.

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

Wartość name wysłana podczas tworzenia zadania lub "", jeśli jej nie wysłano.

Status zadania.

Dostępne wartości:

• PENDING: oczekiwanie w kolejce
• IN_PROGRESS: generowanie wyniku
• SUCCEEDED: wynik końcowy, z rezultatem
• FAILED: wynik końcowy, z powodem w task_error
• CANCELED: wynik końcowy, bez rezultatu

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 rozpoczęcia zadania przez workera, w milisekundach Unix. Do tego czasu wartość to null.

Czas osiągnięcia przez zadanie statusu końcowego, w milisekundach Unix. Do tego czasu wartość to null.

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 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 modelu 3D. Meshy eksportuje plik GLB oraz pakiet OBJ w rzeczywistej skali w milimetrach, z osią Y skierowaną w górę, przy czym przód keycapa jest skierowany w stronę +Z.

Model zawiera siatki o nazwach keycap-head i keycap-base. Gdy Meshy stosuje zastępcze wypełnienie wzorem dla podstawy, model zawiera również siatkę keycap-base-interior dla wnęki trzpienia. Nie zakładaj, że model ma dokładnie dwie siatki.

Są to podpisane adresy URL, więc pobieraj je bez nagłówka Authorization. Pozostają ważne do expires_at, a ponowne pobranie zadania przed tym czasem zwraca te same adresy URL. Wygasłego adresu URL nie można odnowić, więc pobierz i zapisz pliki przed tym terminem.

Adresy URL do pobrania obrazów z poszczególnych etapów budowy, indeksowane według rodzaju. Podobnie jak model_urls, są to podpisane adresy URL, więc pobieraj je bez nagłówka Authorization. Pozostają ważne do expires_at, a ponowne pobranie zadania zwraca te same adresy URL.

Może zawierać następujące klucze:

• head_design: obraz projektu wybranego kandydata, który budowa przekształciła w model 3D. Zawsze obecny.
• composite: obraz gotowego keycapa dla wybranego kandydata, na podstawie którego budowa pomalowała podstawę. Może być nieobecny.
• base_canvas: pomalowana podstawa keycapa. Może być nieobecna.

Meshy może dodawać kolejne klucze, więc ignoruj klucze, których nie rozpoznajesz.