Creative Lab Figurka API
Zamień zdjęcie w kolekcjonerską figurkę 3D w stylu chibi w dwóch etapach. Zadanie prototypu generuje obraz koncepcyjny na podstawie zdjęcia. Zadanie budowania przekształca ten obraz w teksturowany model 3D i przyjmuje identyfikator zadania prototypu jako input_task_id.
POST /openapi/creative-lab/figure/v1/prototypePOST /openapi/creative-lab/figure/v1/build
Utwórz zadanie prototypu figurki
Generuje jeden obraz koncepcyjny w stylu chibi na podstawie zdjęcia. Aby zbudować model 3D, przekaż identyfikator tego zadania do punktu końcowego budowania jako input_task_id. Informacje o polach zadania znajdziesz w sekcji Obiekt zadania prototypu figurki.
Request
# Stage 1: generate a chibi-style concept image
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/prototype \
-X POST \
-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"
}


Parametry
- Name
- image_url
- Type
- string
- Wymagane
- Description
Zdjęcie, które ma zostać przekształcone w figurkę chibi, podane jako publiczny adres URL lub Data URI (
data:image/jpeg;base64,<your base64-encoded image data>).Obraz musi być plikiem JPG, JPEG, PNG lub WebP o rozmiarze maksymalnie 20 MB.
- Name
- name
- Type
- string
- Description
Nazwa zadania, maksymalnie 100 znaków. Jest zwracana w polu
namezadania. Dłuższa nazwa zwraca błąd400.
- Name
- remove_background
- Type
- boolean
- domyślne false
- Description
Określa, czy usunąć tło z obrazu prototypu.
truezwraca przezroczysty plik PNG RGBA, dzięki czemu możesz umieścić obiekt na dowolnym tle. Budowanie również rozpoczyna się od obrazu bez tła. Jeśli Meshy nie może usunąć tła, zwraca obraz z tłem, a zadanie mimo to kończy się powodzeniem.
Zwracane wartości
Pole result zawiera identyfikator nowego zadania prototypu. Pobierz zadanie lub strumieniuj je, aż status przyjmie wartość SUCCEEDED. Następnie przekaż identyfikator do punktu końcowego budowania jako input_task_id.
Tryby niepowodzeń
- Name
400 - Bad Request- Description
Żą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 dlatego, że adres URL zwraca
404lub przekracza limit czasu. - Data URI nie jest prawidłowym ciągiem base64.
- Obraz został oznaczony jako NSFW.
Komunikat o błędzie wskazuje, jaki problem został znaleziony. Popraw żądanie i wyślij je ponownie.
- Brakuje
- Name
401 - Unauthorized- Description
Brakuje klucza API lub jest on nieprawidłowy. Sprawdź nagłówek
Authorization.
- Name
402 - Payment Required- Description
Zastosowanie ma jedna z poniższych sytuacji:
- Konto nie ma wystarczającej liczby kredytów.
- Klucz API, obszar roboczy lub członek zespołu osiągnął swój limit kredytów.
- Konto korzysta z darmowego planu.
Sprawdź swoje kredyty i plan, a następnie spróbuj ponownie.
- Name
403 - Forbidden- Description
Twój zespół ma włączone filtrowanie IP, a Meshy oznaczyło obraz jako naruszający własność intelektualną osób trzecich. Wyślij obraz, do którego masz prawa użytkowania.
- Name
429 - Too Many Requests- Description
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ń oczekuje w kolejce lub jest w trakcie wykonywania. Poczekaj, aż część z nich się zakończy, a następnie spróbuj ponownie.
- W przypadku planu bez limitu zadań, ale bez pozostałych kredytów, osiągnięto liczbę zadań, które mogą zostać uruchomione bez kredytów. Poczekaj na zakończenie zadania lub doładuj kredyty.
- Name
500 - Internal Server Error- Description
Meshy napotkało błąd serwera, na przykład dlatego, że nie mogło przeprowadzić kontroli własności intelektualnej obrazu. Meshy nie tworzy zadania i zwraca wszelkie pobrane kredyty. Spróbuj wysłać żądanie ponownie.
Utwórz zadanie budowy figurki
Generuje teksturowaną figurkę 3D na podstawie zakończonego sukcesem zadania prototypu. Opis jego pól znajdziesz w sekcji Obiekt zadania budowy figurki.
Request
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/build \
-X POST \
-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"
}

Parametry
- Name
- input_task_id
- Type
- string
- Wymagane
- Description
ID zadania prototypu, które ma zostać zbudowane. Musi to być zadanie utworzone przez Twoje konto za pomocą
POST /openapi/creative-lab/figure/v1/prototype, ze statusemSUCCEEDED.ID, które nie odpowiada żadnemu z Twoich zadań prototypu figurki utworzonych przez API, zwraca
404, w tym również prototyp utworzony w aplikacji webowej.
- Name
- name
- Type
- string
- Description
Nazwa zadania, maksymalnie 100 znaków. Zostaje zwrócona w polu
namezadania. Dłuższa nazwa zwraca400.
Zwracane dane
Pole result zawiera ID nowego zadania budowy. Pobierz zadanie lub strumieniuj je, aż status przyjmie wartość SUCCEEDED. Następnie pobierz teksturowany plik GLB z model_urls.glb. Aby zamiast tego pobrać OBJ, użyj model_urls.obj wraz z plikiem materiału z model_urls.mtl.
Tryby błędów
- Name
400 - Bad Request- Description
Żądanie nie może zostać wykonane. Na przykład:
input_task_idjest brakujący lub nie jest prawidłowym ID zadania.- Status zadania prototypu nie jest
SUCCEEDED. Jeśli wciąż trwa, odczekaj 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ę sukcesem, ale nie ma obrazu. Utwórz nowe zadanie prototypu.
Komunikat o błędzie wskazuje, jaki problem wystąpił.
- Name
401 - Unauthorized- Description
Brak klucza API lub jest on nieprawidłowy. Sprawdź nagłówek
Authorization.
- Name
402 - Payment Required- Description
Zastosowanie ma jedno z poniższych:
- 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 darmowego planu.
Sprawdź swoje kredyty i plan, a następnie spróbuj ponownie.
- Name
404 - Not Found- Description
input_task_idnie odpowiada żadnemu zadaniu prototypu figurki utworzonemu przez Twoje konto za pomocą API. Prototyp utworzony w aplikacji webowej również zwraca404. Wyślij IDresultz odpowiedzi tworzenia prototypu.
- Name
429 - Too Many Requests- Description
Osiągnięto jeden z poniższych limitów:
- Wysłano więcej żądań, niż pozwala na to 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 uruchomionych. Poczekaj, aż niektóre się zakończą, a następnie spróbuj ponownie.
- W przypadku planu nieograniczonego bez pozostałych kredytów osiągnięto liczbę zadań, które mogą być uruchomione bez kredytów. Poczekaj, aż zadanie się zakończy, lub dodaj kredyty.
Pobierz zadanie Figure
Zwraca zadanie prototypu lub builda. Ścieżka musi odpowiadać etapowi zadania. Zadanie builda zażądane przez /prototype/:id zwraca 404, podobnie jak zadanie prototypu zażądane przez /build/:id.
Informacje o polach znajdziesz w Obiekcie zadania prototypu Figure oraz Obiekcie zadania builda Figure.
Request
# Prototype
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
# Build
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Prototype Response
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "creative-lab-figure-prototype",
"name": "",
"status": "SUCCEEDED",
"progress": 100,
"created_at": 1729123456000,
"started_at": 1729123460000,
"finished_at": 1729123486000,
"expires_at": 1729382686000,
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 6,
"image_urls": [
"https://assets.meshy.ai/***/concept.png?Expires=***"
]
}
Build Response
{
"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
"type": "creative-lab-figure-build",
"name": "",
"status": "SUCCEEDED",
"progress": 100,
"created_at": 1729123500000,
"started_at": 1729123510000,
"finished_at": 1729123535000,
"expires_at": 1729382735000,
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 30,
"prompt": "",
"negative_prompt": "",
"texture_prompt": "",
"texture_image_url": "",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
"mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
"texture_urls": [
{
"base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
}
],
"remove_lighting": true
}
Parametry
- Name
- id
- Type
- path
- Description
ID zadania ze odpowiedzi utworzenia.
Zwraca
Obiekt zadania prototypu lub obiekt zadania builda, zgodnie z etapem wskazanym w ścieżce.
Tryby niepowodzenia
- Name
400 - Bad Request- Description
idnie jest prawidłowym ID zadania. Wyślij IDresultz odpowiedzi utworzenia.
- Name
403 - Forbidden- Description
Twój zespół ma włączone IP Filtering, a Meshy oznaczyło obraz zadania jako naruszający prawa własności intelektualnej osób trzecich. Zespoły w planie Enterprise nie otrzymują tego błędu. Utwórz zadanie prototypu z obrazu, do którego masz prawa.
- Name
404 - Not Found- Description
Żadne zadanie Figure o tym ID nie należy do Twojego konta, lub etap zadania nie odpowiada ścieżce. Sprawdź ID i użyj
/prototypelub/build, aby dopasować zadanie.
- Name
500 - Internal Server Error- Description
Meshy nie mogło przeprowadzić kontroli własności intelektualnej. Spróbuj ponownie.
Usuń zadanie Figure
Anuluje zadanie Figure. Anulowanie zadania w stanie PENDING powoduje zwrot kredytów. Zadanie w stanie IN_PROGRESS jest anulowane bez zwrotu, ponieważ worker już je rozpoczął. Zadania ze statusem końcowym (SUCCEEDED, FAILED lub CANCELED) nie można anulować.
Ścieżka musi odpowiadać etapowi zadania. Na przykład DELETE na /prototype/:id z identyfikatorem zadania build zwraca 404.
Request
curl --request DELETE \
--url https://api.meshy.ai/openapi/creative-lab/figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
// Returns 204 No Content on success (empty body).
Parametry ścieżki
- Name
- id
- Type
- path
- Description
Identyfikator zadania do anulowania.
Zwracane dane
204 No Content z pustym ciałem odpowiedzi.
Scenariusze błędów
- Name
400 - Bad Request- Description
Zastosowanie ma jedna z poniższych sytuacji:
idnie jest prawidłowym identyfikatorem zadania. Wyślij identyfikatorresultz odpowiedzi tworzenia.- Zadanie ma już status końcowy (
SUCCEEDED,FAILEDlubCANCELED), więc nie można go anulować.
- Name
404 - Not Found- Description
Żadne zadanie Figure o tym identyfikatorze nie należy do Twojego konta, lub etap zadania nie odpowiada ścieżce. Sprawdź identyfikator i użyj
/prototypelub/build, aby dopasować zadanie.
Strumieniowanie zadania Figure
Strumieniuje aktualizacje zadania Figure jako zdarzenia Server-Sent Events (SSE). Ścieżka musi odpowiadać etapowi zadania. Jeśli tak nie jest, na przykład gdy ID zadania typu build zostanie użyte pod /prototype/:id/stream, strumień wysyła jedno zdarzenie error ze statusem status_code: 404 i zamyka się.
Request
curl -N https://api.meshy.ai/openapi/creative-lab/figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response Stream
// Error event example (wrong stage or task not found)
event: error
data: {
"status_code": 404,
"message": "Task not found"
}
// Message event examples illustrate task progress.
// Every frame is the full task object; fields not yet populated are null / empty.
// The following PENDING frame is shortened to the fields that change.
event: message
data: {
"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
"progress": 0,
"status": "PENDING"
}
event: message
data: {
"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
"type": "creative-lab-figure-build",
"status": "SUCCEEDED",
"progress": 100,
"created_at": 1729123500000,
"started_at": 1729123510000,
"finished_at": 1729123535000,
"expires_at": 1729382735000,
"task_error": null,
"consumed_credits": 30,
"prompt": "",
"negative_prompt": "",
"texture_prompt": "",
"texture_image_url": "",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
"mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
"texture_urls": [
{
"base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
}
],
"remove_lighting": true
}
Parametry
- Name
- id
- Type
- path
- Description
ID zadania z odpowiedzi na żądanie utworzenia.
Zwraca
Strumień obiektów zadań prototype lub build. Każde zdarzenie zawiera pełny obiekt zadania, dokładnie taki, jaki zwraca Pobieranie zadania Figure. Gdy zadanie ma status PENDING lub IN_PROGRESS, jego pola wyjściowe są wciąż puste (null, [] lub {}), a finished_at ma wartość null.
Jeśli filtrowanie IP blokuje wynik zadania, strumień wysyła w jego miejsce jedno zdarzenie error z wartością status_code, którą zwróciłoby żądanie typu get.
Pobierz listę zadań Figure
Zwraca Twoje zadania Figure z jednego etapu, po jednej stronie na raz. Ścieżka wskazuje etap. /prototype zwraca tylko zadania prototypowe, a /build zwraca tylko zadania budowy.
Request
# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/prototype?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/figure/v1/build?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response (List Prototype Tasks)
[
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "creative-lab-figure-prototype",
"name": "",
"status": "SUCCEEDED",
"progress": 100,
"created_at": 1729123456000,
"started_at": 1729123460000,
"finished_at": 1729123486000,
"expires_at": 1729382686000,
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 6,
"image_urls": [
"https://assets.meshy.ai/***/concept.png?Expires=***"
]
}
]
Parametry ścieżki
- Name
- stage
- Type
- path
- Wymagane
- Description
Etap do wylistowania,
prototypelubbuild.
Parametry zapytania
- Name
- page_num
- Type
- integer
- domyślne 1
- Description
Strona do zwrócenia, od
1do255. Wartość0zwraca pierwszą stronę. Wartość spoza zakresu0do255zwraca400.
- Name
- page_size
- Type
- integer
- domyślne 10
- Description
Liczba zadań na stronę, maksymalnie
100. Wartość od101do255zwraca 100 zadań, a0używa wartości domyślnej. Wartość spoza zakresu0do255zwraca400.
- Name
- sort_by
- Type
- string
- domyślne -created_at
- Description
Kolejność sortowania.
Dostępne wartości:
-created_at: od najnowszych+created_at: od najstarszych
Zwraca
Tablicę obiektów zadań prototypu lub obiektów zadań budowy, odpowiadającą etapowi podanemu w ścieżce.
Obiekt zadania prototypu figurki
Zadanie prototypu generuje obraz koncepcyjny w stylu chibi na podstawie zdjęcia. Aby przekształcić obraz w model 3D, przekaż ID zadania do punktu końcowego budowy jako input_task_id.
Właściwości
Example Figure Prototype Task Object
{
"id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"type": "creative-lab-figure-prototype",
"name": "",
"status": "SUCCEEDED",
"progress": 100,
"created_at": 1729123456000,
"started_at": 1729123460000,
"finished_at": 1729123486000,
"expires_at": 1729382686000,
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 6,
"image_urls": [
"https://assets.meshy.ai/***/concept.png?Expires=***"
]
}
- Name
- id
- Type
- string
- Description
ID zadania. Nie polegaj na jego formacie.
- Name
- type
- Type
- string
- Description
Typ zadania, zawsze
creative-lab-figure-prototype.
- Name
- name
- Type
- string
- Description
name, który wysłałeś podczas tworzenia zadania, lub"", jeśli go nie wysłałeś.
- Name
- status
- Type
- string
- Description
Status zadania.
Dostępne wartości:
PENDING: oczekuje w kolejceIN_PROGRESS: generowanie wynikuSUCCEEDED: zakończone, z wynikiemFAILED: zakończone, z przyczyną wtask_errorCANCELED: zakończone, bez wyniku
- Name
- progress
- Type
- integer
- Description
Procent wykonanej pracy, od
0do100. Wynosi0do czasu rozpoczęcia zadania i100, gdy zakończy się sukcesem.
- Name
- created_at
- Type
- timestamp
- Description
Czas utworzenia zadania, w milisekundach Unix.
- Name
- started_at
- Type
- timestamp
- Description
Czas, w którym pracownik rozpoczął zadanie, w milisekundach Unix. Do tego czasu
null.
- Name
- finished_at
- Type
- timestamp
- Description
Czas, w którym zadanie osiągnęło status końcowy, w milisekundach Unix. Do tego czasu
null.
- Name
- expires_at
- Type
- timestamp
- Description
Czas wygaśnięcia wyniku zadania, w milisekundach Unix. To 3 dni po
finished_at, lub 3 dni pocreated_at, dopóki zadanie się nie zakończy. W przypadku kont Enterprise, które przechowują wyniki API bezterminowo, to około 100 lat później. Zobacz Przechowywanie zasobów.
- Name
- preceding_tasks
- Type
- integer
- Description
Pozycja zadania w kolejce, gdy ma status
PENDING.1oznacza, że zostanie uruchomione jako następne.0po opuszczeniu kolejki przez zadanie, i zawsze0w wynikach listy.
- Name
- task_error
- Type
- object
- Description
Powód niepowodzenia zadania.
null, chyba żestatustoFAILED. Zobacz Błędy.
- Name
- consumed_credits
- Type
- integer
- Description
Liczba kredytów naliczonych za zadanie, po uwzględnieniu ewentualnego zwrotu. Żądanie, które zwraca błąd, nie jest obciążane. Nieudane zadanie ma wartość
0, ponieważ Meshy zwraca za nie kredyty. Anulowanie powoduje zwrot kredytów tylko wtedy, gdy zadanie ma statusPENDING. Jeśli Meshy nie może odczytać opłaty, odpowiedź typu get lub stream pomija to pole, a żądanie listy zwraca500. W takim przypadku ponów żądanie.
- Name
- image_urls
- Type
- array of strings
- Description
Adresy URL do pobrania obrazu koncepcyjnego. Tablica zawiera jeden adres URL po pomyślnym zakończeniu zadania, a do tego czasu jest pusta.
Obiekt zadania budowy Figure
Zadanie budowy generuje teksturowaną figurkę 3D na podstawie pomyślnie zakończonego zadania prototypu. Pola model_urls, thumbnail_url i texture_urls mają taki sam format jak w obiekcie zadania Obraz na 3D.
Właściwości
Example Figure Build Task Object
{
"id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
"type": "creative-lab-figure-build",
"name": "",
"status": "SUCCEEDED",
"progress": 100,
"created_at": 1729123500000,
"started_at": 1729123510000,
"finished_at": 1729123535000,
"expires_at": 1729382735000,
"preceding_tasks": 0,
"task_error": null,
"consumed_credits": 30,
"prompt": "",
"negative_prompt": "",
"texture_prompt": "",
"texture_image_url": "",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
"mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
},
"thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
"texture_urls": [
{
"base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
}
],
"remove_lighting": true
}
- Name
- id
- Type
- string
- Description
Identyfikator zadania. Nie polegaj na jego formacie.
- Name
- type
- Type
- string
- Description
Typ zadania, zawsze
creative-lab-figure-build.
- Name
- name
- Type
- string
- Description
Wartość
namewysłana podczas tworzenia zadania, lub"", jeśli jej nie wysłano.
- Name
- status
- Type
- string
- Description
Status zadania.
Dostępne wartości:
PENDING: oczekuje w kolejceIN_PROGRESS: generowanie wynikuSUCCEEDED: zakończone, z wynikiemFAILED: zakończone, z powodem wtask_errorCANCELED: zakończone, bez wyniku
- Name
- progress
- Type
- integer
- Description
Procent wykonanej pracy, od
0do100. Wynosi0do momentu rozpoczęcia zadania i100, gdy zakończy się powodzeniem.
- Name
- created_at
- Type
- timestamp
- Description
Czas utworzenia zadania, w milisekundach Unix.
- Name
- started_at
- Type
- timestamp
- Description
Czas, w którym pracownik rozpoczął zadanie, w milisekundach Unix. Do tego momentu
null.
- Name
- finished_at
- Type
- timestamp
- Description
Czas, w którym zadanie osiągnęło status końcowy, w milisekundach Unix. Do tego momentu
null.
- Name
- expires_at
- Type
- timestamp
- Description
Czas wygaśnięcia wyniku zadania, w milisekundach Unix. Jest to 3 dni po
finished_at, lub 3 dni pocreated_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.
- Name
- preceding_tasks
- Type
- integer
- Description
Pozycja zadania w kolejce, gdy ma status
PENDING.1oznacza, że zostanie uruchomione jako następne.0po opuszczeniu kolejki przez zadanie i zawsze0w wynikach listy.
- Name
- task_error
- Type
- object
- Description
Powód niepowodzenia zadania.
null, chyba żestatustoFAILED. Zobacz Błędy.
- Name
- consumed_credits
- Type
- integer
- Description
Liczba kredytów naliczonych za zadanie, po uwzględnieniu ewentualnego zwrotu. Żądanie, które zwraca błąd, nie jest obciążane. Nieudane zadanie ma wartość
0, ponieważ Meshy zwraca za nie kredyty. Anulowanie powoduje zwrot kredytów za zadanie tylko wtedy, gdy ma ono statusPENDING. Jeśli Meshy nie może odczytać naliczonej opłaty, odpowiedź typu get lub stream pomija to pole, a żądanie listy zwraca500. W takim przypadku ponów żądanie.
- Name
- prompt
- Type
- string
- Description
Zawsze
""dla zadania budowy Figure.
- Name
- negative_prompt
- Type
- string
- Description
Zawsze
""dla zadania budowy Figure, podobnie jakprompt.
- Name
- texture_prompt
- Type
- string
- Description
Zawsze
""dla zadania budowy Figure, podobnie jakprompt.
- Name
- texture_image_url
- Type
- string
- Description
Zawsze
""dla zadania budowy Figure, podobnie jakprompt.
- Name
- model_urls
- Type
- object
- Description
Adresy URL do pobrania modelu 3D, jako teksturowany plik GLB oraz jako plik OBJ wraz z plikiem MTL.
- Name
glb- Type
- string
- Description
Adres URL do pobrania teksturowanego pliku GLB.
- Name
obj- Type
- string
- Description
Adres URL do pobrania pliku OBJ, z geometrią i UV.
- Name
mtl- Type
- string
- Description
Adres URL do pobrania pliku materiału MTL powiązanego z
obj. Używaj go razem zobjoraz teksturą wtexture_urls[0].base_color.
- Name
- thumbnail_url
- Type
- string
- Description
Adres URL do pobrania obrazu podglądu modelu.
- Name
- texture_urls
- Type
- array
- Description
Mapy tekstur, jako tablica z jednym obiektem zawierającym mapę koloru bazowego.
- Name
base_color- Type
- string
- Description
Adres URL do pobrania mapy koloru bazowego.
- Name
- remove_lighting
- Type
- boolean
- Description
Czy Meshy usunęło z tekstury koloru bazowego podświetlenia i cienie.