Zamień zdjęcie źródłowe w kolekcjonerską figurkę 3D w stylu chibi w dwóch etapach:
prototype generuje stylizowany obraz koncepcyjny na podstawie Twojego zdjęcia wejściowego, a następnie
build przekształca ten obraz koncepcyjny w teksturowany model 3D. Oba etapy
są połączone za pomocą input_task_id.
Wygeneruj pojedynczy obraz koncepcyjny w stylu chibi na podstawie zdjęcia źródłowego. Zwrócony identyfikator zadania jest tym, co przekazujesz jako input_task_id do punktu końcowego budowania. Zapoznaj się z
Obiektem zadania prototypu figurki,
aby poznać kształt odpowiedzi.
Parametry
Name
image_url
Type
string
Wymagane
Description
Zdjęcie źródłowe, które Meshy ma stylizować jako figurkę chibi. 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 nałożyć obiekt na dowolne tło.
Zwracane wartości
Właściwość result odpowiedzi zawiera id zadania nowo utworzonego zadania prototypu figurki. Odpytuj punkt końcowy Pobierz zadanie lub subskrybuj 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:
Brakujący parametr: image_url jest wymagany.
Nieprawidłowy format obrazu: Podany image_url nie jest obsługiwanym formatem (.jpg, .jpeg, .png, .webp).
Wymiary obrazu poza zakresem: Obraz jest zbyt mały, przekracza maksymalny rozmiar pliku lub przekracza maksymalną liczbę pikseli.
Niedostępny URL: Nie udało się pobrać image_url (błąd 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 własności intelektualnej.
Name
401 - Unauthorized
Description
Uwierzytelnianie nie powiodło się. Sprawdź swój klucz API.
Name
402 - Payment Required
Description
Niewystarczające kredyty do wykonania tego zadania.
Name
429 - Too Many Requests
Description
Przekroczono limit szybkości.
Request
POST
/openapi/creative-lab/figure/v1/prototype
# Stage 1: generate a chibi-style concept imagecurlhttps://api.meshy.ai/openapi/creative-lab/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>" }'
Response
{"result":"018a210d-8ba4-705c-b111-1f1776f7f578"}
Prototype example
Start with a source portrait, then generate the prototype image used by the build stage.
Wygeneruj finalną teksturowaną figurkę 3D na podstawie zakończonego powodzeniem zadania prototypu.
Budowa wykorzystuje ten sam potok image-to-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, aby poznać
kształt odpowiedzi.
Parametry
Name
input_task_id
Type
string
Wymagane
Description
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ąć status SUCCEEDED i musi wygenerować dokładnie jeden obraz kandydacki.
Zadania prototypu utworzone przez aplikację webową nie są akceptowane — punkt końcowy budowy akceptuje wyłącznie zadania prototypu utworzone przez POST /openapi/creative-lab/figure/v1/prototype i odrzuca każde inne źródło z kodem 404.
Name
name
Type
string
Description
Opcjonalna nazwa zadania do celów wyświetlania. Maksymalnie 100 znaków.
Zwracane wartości
Właściwość result odpowiedzi zawiera id zadania nowo utworzonego zadania budowy figurki. Odpytuj punkt końcowy Pobierz zadanie lub subskrybuj strumień aż zadanie osiągnie status SUCCEEDED, a następnie pobierz teksturowany plik GLB z model_urls.glb (lub parę OBJ + MTL z model_urls.obj oraz model_urls.mtl, jeśli Twój dalszy potok przetwarzania preferuje OBJ).
Tryby awarii
Name
400 - Bad Request
Description
Żądanie było nieprawidłowe. 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 nie zakończyło się powodzeniem: Wskazane zadanie prototypu nie osiągnęło jeszcze statusu SUCCEEDED.
Brak kandydata: Zadanie prototypu zakończyło się powodzeniem, ale nie wygenerowało obrazu kandydackiego.
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 przez aplikację webową (tylko zadania prototypu w trybie API mogą być łączone z zadaniem budowy).
Name
429 - Too Many Requests
Description
Przekroczono limit szybkości.
Request
POST
/openapi/creative-lab/figure/v1/build
# Stage 2: chain build off a succeeded prototype taskcurlhttps://api.meshy.ai/openapi/creative-lab/figure/v1/build \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578" }'
Response
{"result":"019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"}
Przykład budowy
Zadanie budowy przekształca wybrany obraz prototypu w gotowy do pobrania teksturowany model 3D.
Pobierz zadanie prototypu lub buildu na podstawie prawidłowego id zadania. Ścieżka URL
musi odpowiadać etapowi zadania — zadanie buildu pobrane przez
/prototype/:id zwróci 404, i odwrotnie.
Anuluj zadanie figurki. Jeśli zadanie nadal ma status PENDING, kredyty
zużyte przy tworzeniu są zwracane. Zadania, które są już w stanie
IN_PROGRESS, są anulowane bez zwrotu (worker 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 do anulowania.
Zwraca
Zwraca 204 No Content w przypadku sukcesu, z pustą treścią.
Tryby błędów
Name
400 - Bad Request
Description
Zadanie jest 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.
Strumieniuj aktualizacje w czasie rzeczywistym dla zadania figurki za pomocą Server-Sent Events (SSE).
Ścieżka URL musi odpowiadać etapowi zadania — otwarcie strumienia pod
/prototype/:buildId/stream emituje pojedynczy ładunek event: error z
status_code: 404 i zamyka strumień.
Parametry
Name
id
Type
path
Description
Unikalny identyfikator zadania figurki do strumieniowania.
Zwraca
Zwraca strumień obiektów zadania Figure Prototype
lub Figure Build w postaci
Server-Sent Events. Każda klatka zawiera pełny obiekt zadania dla danego etapu — o takim samym kształcie, jaki zwraca
punkt końcowy Get — więc gdy 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ń figurek dla pojedynczego etapu. Ścieżka URL
wybiera etap — /prototype zwraca zadania prototypowe; /build
zwraca zadania budowania. Zadania z drugiego etapu nie są uwzględniane w
żadnej z odpowiedzi.
Parametry ścieżki
Name
stage
Type
path
Wymagane
Description
Wartość prototype lub build. Kolekcja zwraca wyłącznie zadania,
których etap odpowiada adresowi URL — pobranie /prototype nigdy
nie zwróci zadań budowania i odwrotnie.
Parametry zapytania
Name
page_num
Type
integer
domyślne 1
Description
Numer strony dla 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 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.
Obiekt zadania prototypu figurki (Figure Prototype Task) to jednostka pracy śledzona przez Meshy w celu wygenerowania obrazu koncepcyjnego w stylu chibi 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. Chociaż jako szczegół implementacyjny używamy dla identyfikatorów zadań UUID możliwego do sortowania k-sortowego (k-sortable), nie należy przyjmować żadnych założeń dotyczących formatu id.
Name
type
Type
string
Description
Typ zadania. Wartość to creative-lab-figure-prototype.
Name
name
Type
string
Description
Nazwa zadania podana podczas jego tworzenia. Jeśli nie podano nazwy, wartością jest ciąg pusty.
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ść ma wartość 0. Gdy zadanie zakończy się sukcesem, wartość ta wynosi 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, 12:00:00 PM 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ść ma wartość 0.
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ść ma wartość 0.
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 znajdziesz w sekcji Błędy.
Name
consumed_credits
Type
integer
Description
Liczba kredytów zużytych przez to zadanie. Obecne, gdy status zadania to PENDING, IN_PROGRESS lub SUCCEEDED. Dla zadań FAILED zwraca 0 (kredyty są zwracane w przypadku niepowodzenia).
Name
image_urls
Type
array of strings
Description
Adresy URL do pobrania kandydatów na obraz koncepcyjny wygenerowanych przez to zadanie prototypu. 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 niezgodnych wstecz.
Obiekt zadania Figure Build to jednostka pracy, którą Meshy śledzi w celu
wygenerowania teksturowanej figurki 3D na podstawie zakończonego powodzeniem zadania prototypu. Wykorzystuje ten sam
proces obraz-na-3D, którego używa 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-figure-build.
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. Jeśli zadanie jeszcze się nie rozpoczęło, ta właściwość będzie miała wartość 0. Gdy zadanie zakończy się powodzeniem, 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 zapoznać się z pełnym opisem 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 figure build. Obecne ze względu na zgodność 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 figure build. Obecne ze względu na zgodność między punktami końcowymi.
Name
texture_prompt
Type
string
Description
Zawsze puste w przypadku figure build. Obecne ze względu na zgodność między punktami końcowymi.
Name
texture_image_url
Type
string
Description
Zawsze puste w przypadku figure build. Obecne ze względu na zgodność między punktami końcowymi.
Name
model_urls
Type
object
Description
Adresy URL do pobrania wygenerowanego modelu 3D. Figure build zwraca teksturowany plik GLB oraz parę OBJ + MTL dla procesów, które preferują format Wavefront OBJ. Kształt pola odpowiada obiektowi model_urls z Obraz na 3D, dzięki czemu przyszłe dodatki formatów zostaną wprowadzone 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. Należy go łączyć 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.