Zamień zdjęcie źródłowe w kolekcjonerski minifigurki 3D w stylu klocków w dwóch etapach:
prototyp generuje stylizowany obraz koncepcyjny na podstawie wprowadzonego zdjęcia, a następnie
kompilacja przekształca ten obraz koncepcyjny w teksturowany model 3D. Oba etapy
są powiązane za pomocą input_task_id.
POST /openapi/creative-lab/brick-figure/v1/prototype
Wygeneruj pojedynczy obraz koncepcyjny w stylu klocków na podstawie zdjęcia źródłowego. Zwrócony identyfikator zadania to wartość, którą przekazujesz jako input_task_id do punktu końcowego budowania. Zapoznaj się z sekcją
Obiekt zadania prototypu figurki z klocków
aby poznać kształt odpowiedzi.
Parametry
Name
image_url
Type
string
Wymagane
Description
Zdjęcie źródłowe, które Meshy ma przekształcić w stylu minifigurki z klocków. 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>.
Name
name
Type
string
Description
Opcjonalna nazwa zadania do celów wyświetlania. Maksymalnie 100 znaków.
Name
remove_background
Type
boolean
domyślne false
Description
Gdy ustawione na true, obraz prototypu jest zwracany jako przezroczysty plik PNG RGBA z usuniętym tłem, dzięki czemu możesz umieścić obiekt na dowolnym tle.
Zwracane dane
Właściwość result odpowiedzi zawiera id zadania nowo utworzonego prototypu figurki z klocków. Odpytuj punkt końcowy Pobierz zadanie lub zasubskrybuj strumień, aż zadanie osiągnie status SUCCEEDED, a następnie przekaż ten identyfikator do punktu końcowego budowania jako input_task_id.
Tryby awarii
Name
400 - Bad Request
Description
Żądanie było niepoprawne. Typowe przyczyny:
Brak parametru: image_url jest wymagany.
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 (błąd 404 lub timeout).
Nieprawidłowy Data URI: ciąg base64 jest nieprawidłowo sformatowany.
Oznaczona zawartość: obraz wejściowy został oznaczony przez moderation NSFW.
Name
401 - Unauthorized
Description
Uwierzytelnianie nie powiodło się. Sprawdź swój klucz API.
Name
402 - Payment Required
Description
Niewystarczająca liczba kredytów do wykonania tego zadania.
Name
403 - Forbidden
Description
Obraz wejściowy został oznaczony jako naruszający prawa własności intelektualnej.
Name
429 - Too Many Requests
Description
Przekroczono limit szybkości.
Request
POST
/openapi/creative-lab/brick-figure/v1/prototype
# Stage 1: generate a brick-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/brick-figure/v1/prototype \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_url": "<your publicly accessible image url or base64-encoded data URI>" }'
Wygeneruj finalną, teksturowaną figurkę 3D z klocków na podstawie zakończonego powodzeniem zadania prototypu. Budowa wykorzystuje ten sam potok obraz-na-3D co
Obraz na 3D, dzięki czemu format obiektu odpowiedzi oraz
lista adresów URL wyników są dokładnie takie same. Zapoznaj się z
Obiektem zadania budowy figurki z klocków, aby poznać kształt
odpowiedzi.
Parametry
Name
input_task_id
Type
string
Wymagane
Description
Identyfikator zadania (task ID) zadania prototypu utworzonego za pomocą tego samego punktu końcowego OpenAPI. Prototyp musi zostać utworzony z użyciem tego samego klucza API, musi osiągnąć status SUCCEEDED i musi wygenerować dokładnie jeden obraz kandydujący.
Zadania prototypu utworzone za pośrednictwem aplikacji webowej nie są akceptowane — punkt końcowy budowy akceptuje wyłącznie zadania prototypu wygenerowane przez POST /openapi/creative-lab/brick-figure/v1/prototype i odrzuca każde inne źródło z kodem 404.
Name
name
Type
string
Description
Opcjonalna nazwa zadania używana do celów wyświetlania. Maksymalnie 100 znaków.
Zwraca
Właściwość result odpowiedzi zawiera id zadania nowo utworzonego zadania budowy figurki z klocków. Odpytuj punkt końcowy Pobierz zadanie lub zasubskrybuj strumień, dopóki zadanie nie osiągnie statusu SUCCEEDED, a następnie pobierz teksturowany GLB z model_urls.glb (lub parę OBJ + MTL z model_urls.obj i model_urls.mtl, jeśli Twój dalszy potok przetwarzania preferuje OBJ).
Tryby awarii
Name
400 - Bad Request
Description
Żądanie było niepoprawne. Typowe przyczyny:
Brakujący parametr: input_task_id jest wymagany.
Nieprawidłowy UUID: input_task_id nie jest prawidłowym identyfikatorem UUID.
Zadanie nadrzędne nieukończone powodzeniem: Wskazane zadanie prototypu jeszcze nie osiągnęło statusu SUCCEEDED.
Brak kandydata: Zadanie prototypu zakończyło się powodzeniem, ale nie wygenerowało żadnego obrazu kandydującego.
Name
401 - Unauthorized
Description
Uwierzytelnianie nie powiodło się. Sprawdź swój klucz API.
Name
402 - Payment Required
Description
Niewystarczająca liczba kredytów do wykonania tego zadania.
Name
404 - Not Found
Description
Wskazane zadanie prototypu nie istnieje, należy do innego użytkownika lub zostało utworzone za pośrednictwem aplikacji webowej (tylko zadania prototypu utworzone w trybie API mogą zostać połączone z budową).
Name
429 - Too Many Requests
Description
Przekroczono limit szybkości.
Request
POST
/openapi/creative-lab/brick-figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578" }'
Pobiera zadanie prototypu lub buildu na podstawie prawidłowego id zadania. Ścieżka URL
musi odpowiadać etapowi zadania — pobranie zadania buildu przez
/prototype/:id zwróci 404, i odwrotnie.
Anuluj zadanie figurki z klocków. Jeśli zadanie nadal ma status PENDING,
kredyty zużyte w momencie utworzenia są zwracane. Zadania, które są już w
stanie IN_PROGRESS, są anulowane bez zwrotu środków (proces roboczy mógł
już zużywać zasoby). Zadań, które osiągnęły już stan końcowy (SUCCEEDED,
FAILED, CANCELED), nie można anulować.
Ścieżka URL musi odpowiadać etapowi zadania — DELETE na
/prototype/:buildId zwraca 404.
Parametry ścieżki
Name
id
Type
path
Description
Unikalny identyfikator zadania figurki z klocków do anulowania.
Zwraca
Zwraca 204 No Content w przypadku powodzenia, z pustą treścią odpowiedzi.
Tryby niepowodzenia
Name
400 - Bad Request
Description
Zadanie znajduje się już w stanie końcowym i nie można go anulować.
Name
404 - Not Found
Description
Zadanie nie istnieje, należy do innego użytkownika lub jego etap nie odpowiada ścieżce URL.
Przesyłaj strumieniowo aktualizacje zadania brick figure w czasie rzeczywistym za pomocą Server-Sent Events (SSE).
Ścieżka URL musi odpowiadać etapowi zadania — otwarcie strumienia pod
/prototype/:buildId/stream powoduje wyemitowanie pojedynczego ładunku event: error z
status_code: 404 i zamknięcie strumienia.
Parametry
Name
id
Type
path
Description
Unikalny identyfikator zadania brick figure do przesyłania strumieniowego.
Zwraca
Zwraca strumień obiektów zadań Brick Figure Prototype
lub Brick Figure Build jako
Server-Sent Events. Każda klatka zawiera pełny obiekt zadania dla danego etapu — ten sam kształt, jaki
zwraca punkt końcowy Get — więc dopóki zadanie ma status PENDING lub IN_PROGRESS, pola
wyjściowe po prostu nie są jeszcze wypełnione (null, [] lub {}), a
finished_at ma wartość null.
Pobierz stronicowaną listę zadań dotyczących figurek z klocków dla pojedynczego etapu. Ścieżka URL
określa etap — /prototype zwraca zadania prototypu; /build
zwraca zadania budowy. Zadania z drugiego etapu nie są uwzględniane w żadnej z odpowiedzi.
Parametry ścieżki
Name
stage
Type
path
Wymagane
Description
prototype lub build. Kolekcja zwraca tylko zadania,
których etap odpowiada adresowi URL — pobranie /prototype nigdy nie zwraca
zadań budowy i odwrotnie.
Parametry zapytania
Name
page_num
Type
integer
domyślne 1
Description
Numer strony do stronicowania.
Name
page_size
Type
integer
domyślne 10
Description
Limit rozmiaru strony. Maksymalna dozwolona wartość to 100 elementów.
Name
sort_by
Type
string
domyślne -created_at
Description
Pole, według którego następuje sortowanie. Dostępne wartości:
+created_at: Sortowanie według czasu utworzenia w kolejności rosnącej.
-created_at: Sortowanie według czasu utworzenia w kolejności malejącej.
Obiekt Brick Figure Prototype Task to jednostka pracy, którą Meshy śledzi, aby
wygenerować obraz koncepcyjny w stylu klocków na podstawie zdjęcia źródłowego. Wynik
tego etapu jest przekazywany do etapu budowy
za pomocą input_task_id.
Właściwości
Name
id
Type
string
Description
Unikalny identyfikator zadania. Choć jako szczegół implementacyjny używamy dla identyfikatorów zadań UUID z zachowaniem porządku k-sortowalnego, nie należy przyjmować żadnych założeń co do formatu tego identyfikatora.
Name
type
Type
string
Description
Typ zadania. Wartość to creative-lab-brick-figure-prototype.
Name
name
Type
string
Description
Nazwa zadania podana podczas jego tworzenia. Pusty ciąg znaków, jeśli nie podano nazwy.
Name
status
Type
string
Description
Status zadania. Możliwe wartości to jedna z: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Postęp zadania (progress). Jeśli zadanie nie zostało jeszcze rozpoczęte, ta właściwość będzie mieć wartość 0. Gdy zadanie zakończy się powodzeniem, wartość ta stanie się 100.
Name
created_at
Type
timestamp
Description
Znacznik czasu utworzenia zadania, w milisekundach.
Znacznik czasu reprezentuje liczbę milisekund, które upłynęły od 1 stycznia 1970 UTC, zgodnie
ze standardem RFC 3339.
Na przykład piątek, 1 września 2023, godz. 12:00:00 GMT jest reprezentowany jako 1693569600000. Dotyczy to
wszystkich znaczników czasu w Meshy API.
Name
started_at
Type
timestamp
Description
Znacznik czasu rozpoczęcia zadania, w milisekundach. Jeśli zadanie nie zostało jeszcze rozpoczęte, ta właściwość będzie mieć wartość null.
Name
finished_at
Type
timestamp
Description
Znacznik czasu zakończenia zadania, w milisekundach. Jeśli zadanie nie zostało jeszcze zakończone, ta właściwość będzie mieć wartość null.
Name
expires_at
Type
timestamp
Description
Znacznik czasu wygaśnięcia wyniku zadania, w milisekundach.
Name
preceding_tasks
Type
integer
Description
Liczba poprzedzających zadań.
Wartość tego pola ma znaczenie tylko wtedy, gdy status zadania to PENDING.
Name
task_error
Type
object
Description
Szczegóły błędu dla nieudanych zadań. Pełny opis obiektu task_error znajduje się w sekcji Błędy.
Name
consumed_credits
Type
integer
Description
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).
Name
image_urls
Type
array of strings
Description
Adresy URL do pobrania kandydatów obrazu koncepcyjnego 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 zmian łamiących zgodność.
Obiekt Brick Figure Build Task to jednostka pracy śledzona przez Meshy w celu wygenerowania teksturowanej figurki 3D z klocków na podstawie pomyślnie zakończonego zadania prototypu. Wykorzystuje ten sam potok obraz-na-3D, który jest używany przez Obraz na 3D, dlatego pola wyjściowe odzwierciedlają obiekt zadania tego punktu końcowego.
Właściwości
Name
id
Type
string
Description
Unikalny identyfikator zadania.
Name
type
Type
string
Description
Typ zadania. Wartość to creative-lab-brick-figure-build.
Name
name
Type
string
Description
Nazwa zadania podana podczas jego tworzenia. Pusty ciąg znaków, jeśli nazwa nie została podana.
Name
status
Type
string
Description
Status zadania. Możliwe wartości to jedna z: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress 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 stanie się 100.
Name
created_at
Type
timestamp
Description
Znacznik czasu utworzenia zadania, w milisekundach.
Name
started_at
Type
timestamp
Description
Znacznik czasu rozpoczęcia zadania, w milisekundach.
Name
finished_at
Type
timestamp
Description
Znacznik czasu zakończenia zadania, w milisekundach.
Name
expires_at
Type
timestamp
Description
Znacznik czasu wygaśnięcia wyniku zadania, w milisekundach.
Name
preceding_tasks
Type
integer
Description
Liczba poprzedzających zadań. Ma znaczenie tylko wtedy, gdy status to PENDING.
Name
task_error
Type
object
Description
Szczegóły błędu dla nieudanych zadań. Zobacz Błędy, aby uzyskać pełne odniesienie do obiektu task_error.
Name
consumed_credits
Type
integer
Description
Liczba kredytów zużytych przez to zadanie. Zwraca 0 dla zadań FAILED (kredyty są zwracane w przypadku niepowodzenia).
Name
prompt
Type
string
Description
Zawsze puste w przypadku brick figure build. Obecne dla zapewnienia zgodności między punktami końcowymi ze wspólną strukturą V2ImageTo3DTaskResponse używaną przez Obraz na 3D.
Name
negative_prompt
Type
string
Description
Zawsze puste w przypadku brick figure build. Obecne dla zapewnienia zgodności między punktami końcowymi.
Name
texture_prompt
Type
string
Description
Zawsze puste w przypadku brick figure build. Obecne dla zapewnienia zgodności między punktami końcowymi.
Name
texture_image_url
Type
string
Description
Zawsze puste w przypadku brick figure build. Obecne dla zapewnienia zgodności między punktami końcowymi.
Name
model_urls
Type
object
Description
Adresy URL do pobrania wygenerowanego modelu 3D. Brick figure build generuje teksturowany plik GLB oraz parę OBJ + MTL dla potoków preferujących format Wavefront OBJ. Kształt pola odpowiada obiektowi Image to 3D model_urls, dzięki czemu przyszłe dodatki formatów można wprowadzać bez zmian łamiących kompatybilność.
Name
glb
Type
string
Description
Adres URL do pobrania teksturowanego pliku GLB.
Name
obj
Type
string
Description
Adres URL do pobrania pliku Wavefront OBJ (geometria + UV).
Name
mtl
Type
string
Description
Adres URL do pobrania towarzyszącego pliku materiału MTL dla OBJ. Połącz z obj oraz wpisem z texture_urls[0].base_color.
Name
thumbnail_url
Type
string
Description
Adres URL do pobrania miniatury pliku modelu.
Name
texture_urls
Type
array
Description
Tablica obiektów adresów URL tekstur wygenerowanych przez to zadanie. Obecnie zawiera pojedynczy obiekt z mapą koloru bazowego.
Name
base_color
Type
string
Description
Adres URL do pobrania obrazu mapy koloru bazowego.