Creative Lab — Brick Figure API

Zdjęcie źródłowe dla Meshy do stylizowania jako minifigurka z klocków. Obecnie obsługujemy formaty .jpg, .jpeg, .png, i .webp.

Istnieją dwa sposoby dostarczenia obrazu:

• Publicznie dostępny URL: URL dostępny z publicznego internetu.
• Data URI: Zakodowany w base64 Data URI obrazu. Przykład Data URI: data:image/jpeg;base64,<twoje zakodowane w base64 dane obrazu>.

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

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

• Brakujący parametr: image_url jest wymagany.
• Nieprawidłowy format obrazu: Dostarczony image_url nie jest obsługiwanym formatem (.jpg, .jpeg, .png, .webp).
• Wymiary obrazu poza zakresem: Obraz jest za mały, przekracza maksymalny rozmiar pliku lub przekracza maksymalną liczbę pikseli.
• Nieosiągalny URL: Nie można pobrać image_url (404 lub timeout).
• Nieprawidłowy Data URI: Ciąg base64 jest wadliwie utworzony.
• Zawartość oznaczona: Obraz wejściowy został oznaczony przez moderation NSFW lub własność intelektualną.

Uwierzytelnianie nie powiodło się. Proszę sprawdzić swój klucz API.

Niewystarczające kredyty do wykonania tego zadania.

Obraz wejściowy został oznaczony z powodu naruszenia własności intelektualnej.

Przekroczyłeś swój limit szybkości.

ID zadania prototypowego utworzonego za pomocą tego samego punktu końcowego OpenAPI. Prototyp musi być stworzony przy użyciu tego samego klucza API, musi osiągnąć SUCCEEDED i musi wygenerować dokładnie jeden obraz kandydata.

Zadania prototypowe stworzone za pośrednictwem webapp nie są akceptowane — punkt końcowy budowy akceptuje jedynie zadania prototypowe wyprodukowane przez POST /openapi/creative-lab/brick-figure/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.

Żądanie było nieakceptowalne. Typowe przyczyny:

• Brakujący parametr: input_task_id jest wymagany.
• Nieprawidłowy UUID: input_task_id nie jest prawidłowym UUID.
• Rodzic nie zakończony sukcesem: Zadanie prototypowe nie osiągnęło jeszcze SUCCEEDED.
• Brak kandydata: Zadanie prototypowe zakończyło się sukcesem, ale nie wygenerowało żadnego obrazu kandydata.

Uwierzytelnienie nie powiodło się. Proszę sprawdzić swój klucz API.

Niewystarczające kredyty do wykonania tego zadania.

Odwoływane zadanie prototypowe nie istnieje, należy do innego użytkownika lub zostało utworzone przez webapp (tylko zadania prototypowe w trybie API łączą się w budowę).

Przekroczyłeś swój limit szybkości.

Unikalny identyfikator zadania figury bricka do pobrania.

Unikalny identyfikator dla zadania figurki z klocków 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 figurki z klocków do przesyłania strumieniowego.

Albo prototype, albo build. Kolekcja zwraca tylko zadania, których etap odpowiada URL — pobieranie /prototype nigdy nie zwraca zadań budowlanych i odwrotnie.

Numer strony dla stronicowania.

Limit rozmiaru strony. Maksymalnie dozwolone to 100 pozycji.

Pole do sortowania. Dostępne wartości:

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

Unikalny identyfikator zadania. Chociaż używamy k-sortowalnego UUID dla identyfikatorów zadań jako szczegółu implementacji, nie powinieneś zakładać niczego na temat formatu id.

Typ zadania. Wartość to creative-lab-brick-figure-prototype.

Nazwa zadania podana podczas jego tworzenia. Pusta wartość, jeśli nie podano nazwy.

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

Progress zadania. Jeśli zadanie jeszcze się nie rozpoczęło, ta właściwość będzie mieć wartość 0. Po pomyślnym zakończeniu zadania, wartość ta wyniesie 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ść będzie mieć wartość null.

Znacznik czasu zakończenia zadania, w milisekundach. Jeśli zadanie jeszcze się nie zakończyło, ta właściwość będzie mieć wartość null.

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

Liczba poprzedzających zadań.

Szczegóły błędu dotyczące nieudanych zadań. Zobacz Błędy dla pełnej referencji obiektu task_error.

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

URL do pobrania kandydatów na obrazy koncepcji wygenerowane przez to prototypowe zadanie. Obecnie API zawsze zwraca dokładnie jednego kandydata; pole jest tablicą, aby przyszłe wersje mogły pokazać kilku kandydatów bez wprowadzenia zmian rozwijających.

Unikalny identyfikator zadania.

Typ zadania. Wartość to creative-lab-brick-figure-build.

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

Status zadania. Możliwe wartości to jedne 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 miała wartość 0. Po pomyślnym zakończeniu zadania osiągnie wartość 100.

Znacznik czasu, kiedy zadanie zostało utworzone, w milisekundach.

Znacznik czasu, kiedy zadanie zostało rozpoczęte, w milisekundach.

Znacznik czasu, kiedy zadanie zostało zakończone, w milisekundach.

Znacznik czasu, kiedy wynik zadania wygasa, w milisekundach.

Liczba zadań poprzedzających. Znaczące tylko, gdy status to PENDING.

Szczegóły błędu dla nieudanych zadań. Zobacz Błędy dla pełnego odniesienia do obiektu task_error.

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

Zawsze puste dla konstrukcji figurki z klocków. Obecne dla kompatybilności między punktami końcowymi ze wspólnym kształtem V2ImageTo3DTaskResponse używanym przez Obraz na 3D.

Zawsze puste dla konstrukcji figurki z klocków. Obecne dla kompatybilności między punktami końcowymi.

Zawsze puste dla konstrukcji figurki z klocków. Obecne dla kompatybilności między punktami końcowymi.

Zawsze puste dla konstrukcji figurki z klocków. Obecne dla kompatybilności między punktami końcowymi.

Pobieralne URL-e dla wygenerowanego modelu 3D. Konstrukcja figurki z klocków emituje teksturowany GLB oraz parę OBJ + MTL dla ścieżek, które preferują Wavefront OBJ. Kształt pola pasuje do obiektu Obraz na 3D model_urls, więc przyszłe dodatki formatów mieszczą się bez zmiany.

Pobieralny URL do miniatury obrazu pliku modelu.

Tablica teksturowych obiektów URL wygenerowanych przez to zadanie. Obecnie zawiera jeden obiekt z mapą podstawowego koloru.