Creative Lab — API breloków

Przekształć zdjęcie źródłowe w brelok do kluczy gotowy do druku 3D — odznakę w kształcie medalu z kolorowym reliefem głębokości — w dwóch etapach: prototyp generuje kolorowy obraz koncepcyjny z Twojego zdjęcia wejściowego, a następnie budowa przekształca ten obraz koncepcyjny w reliefowy model 3D. Oba etapy są połączone za pomocą input_task_id.

  • POST /openapi/creative-lab/keychain/v1/prototype
  • POST /openapi/creative-lab/keychain/v1/build
POST/openapi/creative-lab/keychain/v1/prototype

Utwórz zadanie prototypu breloka

Wygeneruj pojedynczy kolorowy obraz koncepcyjny z oryginalnego zdjęcia. Zwrócone ID zadania to to, które przekazujesz jako input_task_id do punktu końcowego budowy. Odnieś się do Obiektu zadania prototypu breloka dla kształtu odpowiedzi.

Parametry

  • Name
    image_url
    Type
    string
    Wymagane
    Description

    Oryginalne zdjęcie dla Meshy do pokolorowania na obraz koncepcyjny gotowy do breloka. 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,<your base64-encoded image data>.
  • 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 RGBA PNG z usuniętym tłem, dzięki czemu można skomponować temat na dowolnym tle.

    To kontroluje tylko obraz zwracany przez ten punkt końcowy. Jest to oddzielne od opcji budowy o tej samej nazwie (domyślnie true), która kontroluje usuwanie tła przed reliefem.

Zwraca

Właściwość result odpowiedzi zawiera ID zadania nowo utworzonego zadania prototypu breloka. Sprawdź punkt końcowy Pobierz zadanie lub subskrybuj strumień aż zadanie osiągnie SUCCEEDED, a następnie przekaż to ID do punktu końcowego budowy jako input_task_id.

Tryby awarii

  • Name
    400 - Bad Request
    Description

    Żądanie było nieakceptowalne. 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.
    • Nieosiągalny URL: image_url nie mógł zostać pobrany (404 lub timeout).
    • Nieprawidłowy Data URI: Ciąg base64 jest nieprawidłowy.
    • Zawartość oznaczona: Obraz wejściowy został oznaczony przez moderację NSFW lub własności intelektualnej.
  • Name
    401 - Unauthorized
    Description

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

  • Name
    402 - Payment Required
    Description

    Niewystarczające kredyty do wykonania tego zadania.

  • Name
    429 - Too Many Requests
    Description

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

Request

POST
/openapi/creative-lab/keychain/v1/prototype
# Stage 1: generate a colorized keychain concept image
curl https://api.meshy.ai/openapi/creative-lab/keychain/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"
}
Przykład prototypu
Rozpocznij od oryginalnego zdjęcia, a następnie wygeneruj obraz prototypu używany przez etap budowy breloka.
Oryginalne zdjęcie używane jako wejście Creative Lab Keychain
Wejście prototypu
Wyjście prototypu Creative Lab Keychain wygenerowane z oryginalnego zdjęcia
Wyjście prototypu
POST/openapi/creative-lab/keychain/v1/build

Utwórz zadanie budowy breloka

Wygeneruj ostateczny medalik breloka do druku 3D z zakończonego sukcesem zadania prototypu. Budowa uruchamia pipeline reliefu mapy głębi na pokolorowanym obrazie koncepcyjnym prototypu i dostarcza pojedynczy artefakt siatki w formacie, o który prosisz. Odwołaj się do Obiekt zadania budowy breloka dla kształtu odpowiedzi.

Parametry

  • Name
    input_task_id
    Type
    string
    Wymagane
    Description

    Identyfikator zadania prototypu utworzonego za pośrednictwem tego samego punktu końcowego OpenAPI. Prototyp musi być utworzony z tym samym kluczem API, musi osiągnąć SUCCEEDED i musi wygenerować dokładnie jeden obraz kandydata.

    Zadania prototypu utworzone za pośrednictwem aplikacji webowej nie są akceptowane — punkt końcowy budowy akceptuje tylko zadania prototypu wygenerowane przez POST /openapi/creative-lab/keychain/v1/prototype i odrzuca każde inne źródło z 404.

  • Name
    name
    Type
    string
    Description

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

options

Opcjonalne parametry dostrajania dla geometrii reliefu. Każde pole ma rozsądną wartość domyślną — wyślij tylko te, które chcesz nadpisać.

  • Name
    badge_shape
    Type
    string
    domyślne circle
    Description

    Sylwetka konturu medalika breloka. Dostępne wartości:

    • circle (domyślnie)
    • rounded-rect
    • hexagon
    • shield
    • star
  • Name
    size_mm
    Type
    number
    domyślne 40
    Description

    Długość krawędzi kwadratu ograniczającego brelok, w milimetrach. Zakres: (0, 400].

  • Name
    relief_height_mm
    Type
    number
    domyślne 2.2
    Description

    Maksymalna wysokość reliefu nad podstawą, w milimetrach. Zakres: [0, 20].

  • Name
    relief_offset_mm
    Type
    number
    domyślne 0
    Description

    Pionowe przesunięcie zastosowane do reliefu przed ekstrudowaniem, w milimetrach. Zakres: [0, 20].

  • Name
    base_thickness_mm
    Type
    number
    domyślne 0.1
    Description

    Grubość płaskiej płyty bazowej za reliefem, w milimetrach. Zakres: [0, 20].

  • Name
    has_closed_back
    Type
    boolean
    domyślne true
    Description

    Czy tył medalika jest zamknięty jako zamknięta powierzchnia. Ustaw na false dla otwartej skorupy.

  • Name
    relief_curve
    Type
    string
    domyślne linear
    Description

    Krzywa transferu mapująca wartości mapy głębi na wysokość reliefu. Dostępne wartości:

    • linear (domyślnie)
    • gamma
    • s-curve
  • Name
    curve_param
    Type
    number
    domyślne 1.0
    Description

    Parametr kształtu dla krzywej transferu (ma znaczenie tylko, gdy relief_curve to gamma). Zakres: (0, 10].

  • Name
    invert_depth
    Type
    boolean
    domyślne false
    Description

    Odwróć interpretację mapy głębi, aby ciemniejsze obszary stały się wyższym reliefem.

  • Name
    smoothing
    Type
    number
    domyślne 0.24
    Description

    Siła wygładzania zastosowana do mapy głębi przed ekstrakcją reliefu. Zakres: [0, 10].

  • Name
    relief_scale
    Type
    number
    domyślne 1.0
    Description

    Mnożnik skali pionowej zastosowany na relief_height_mm. Zakres: (0, 10].

  • Name
    depth_threshold
    Type
    number
    domyślne 0.1
    Description

    Próg dolnoprzepustowy dla wartości mapy głębi; wszystko poniżej tego jest ograniczone do zera. Zakres: [0, 1].

  • Name
    remove_background
    Type
    boolean
    domyślne true
    Description

    Automatycznie usuń tło obrazu koncepcyjnego prototypu przed reliefem.

    Oddzielnie od parametru prototypu o tej samej nazwie (domyślnie false), który kontroluje, czy sam obraz prototypu jest zwracany z przezroczystością.

  • Name
    export_resolution
    Type
    integer
    domyślne 512
    Description

    Rozdzielczość siatki używana do eksportu. Zakres: [64, 2048].

output

Opcjonalny selektor formatu przewodowego. Domyślnie glb.

  • Name
    format
    Type
    string
    domyślne glb
    Description

    Pakiet artefaktów zwracany przez budowę. Dostępne wartości:

    • glb (domyślnie) — zwraca pojedynczy model.glb pod model_urls.glb.
    • obj — pakuje model.obj + model.mtl + texture.png i zwraca pakiet pod model_urls.obj.
    • zip — pakuje każdy artefakt wygenerowany przez generator i zwraca pakiet pod model_urls.bundle_zip.

Zwraca

Właściwość result odpowiedzi zawiera identyfikator zadania id nowo utworzonego zadania budowy breloka. Odpytywanie punktu końcowego Pobierz zadanie lub subskrybuj strumień aż zadanie osiągnie SUCCEEDED, a następnie pobierz artefakt z pojedynczego wpisu w model_urls.

Tryby awarii

  • Name
    400 - Bad Request
    Description

    Żą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: Odwołane zadanie prototypu nie osiągnęło jeszcze SUCCEEDED.
    • Brak kandydata: Zadanie prototypu zakończyło się sukcesem, ale nie wygenerowało obrazu kandydata.
    • Opcje poza zakresem: Jedno z pól options znalazło się poza dozwolonym zakresem lub zestawem enum.
  • Name
    401 - Unauthorized
    Description

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

  • Name
    402 - Payment Required
    Description

    Niewystarczające kredyty do wykonania tego zadania.

  • Name
    404 - Not Found
    Description

    Odwołane zadanie prototypu nie istnieje, należy do innego użytkownika lub zostało utworzone za pośrednictwem aplikacji webowej (tylko zadania prototypu w trybie API łączą się w budowę).

  • Name
    429 - Too Many Requests
    Description

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

Request

POST
/openapi/creative-lab/keychain/v1/build
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "options": {
      "badge_shape": "circle",
      "size_mm": 40,
      "relief_height_mm": 2.5
    },
    "output": {
      "format": "glb"
    }
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}
Przykład budowy
Zadanie budowy konwertuje wybrany obraz prototypu na model breloka do druku 3D.
Podgląd modelu budowy breloka Creative Lab
Podgląd modelu budowy
GET/openapi/creative-lab/keychain/v1/(prototype|build)/:id

Pobierz zadanie Brelok

Pobierz zadanie prototypu lub budowy, podając prawidłowy id zadania. Ścieżka URL musi odpowiadać etapowi zadania — zadanie budowy pobrane przez /prototype/:id zwraca 404, i odwrotnie.

Odnieś się do Obiektu Zadania Prototypu Brelok oraz Obiektu Zadania Budowy Brelok dla kształtów odpowiedzi.

Parametry

  • Name
    id
    Type
    path
    Description

    Unikalny identyfikator zadania brelok do pobrania.

Zwraca

Odpowiedź zawiera obiekt zadania brelok. Kształt zależy od tego, który etap został zażądany.

Żądanie

GET
/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578
# Prototype
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Odpowiedź Prototypu

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-keychain-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=***"
  ]
}

Odpowiedź Budowy

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-keychain-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": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}
DELETE/openapi/creative-lab/keychain/v1/(prototype|build)/:id

Usuń zadanie breloka

Anuluj zadanie breloka. Jeśli zadanie jest nadal PENDING, kredyty zużyte podczas tworzenia są zwracane. Zadania, które są już IN_PROGRESS, są anulowane bez zwrotu (pracownik może już zużywać zasoby). Zadania, które osiągnęły już stan końcowy (SUCCEEDED, FAILED, CANCELED) nie mogą być anulowane.

Ścieżka URL musi odpowiadać etapowi zadania — DELETE na /prototype/:buildId zwraca 404.

Parametry ścieżki

  • Name
    id
    Type
    path
    Description

    Unikalny identyfikator zadania breloka do anulowania.

Zwraca

Zwraca 204 No Content w przypadku sukcesu z pustym ciałem.

Tryby błędów

  • Name
    400 - Bad Request
    Description

    Zadanie jest już w stanie końcowym i nie może być anulowane.

  • Name
    404 - Not Found
    Description

    Zadanie nie istnieje, należy do innego użytkownika lub jego etap nie odpowiada ścieżce URL.

Request

DELETE
/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578
curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 204 No Content on success (empty body).
GET/openapi/creative-lab/keychain/v1/(prototype|build)/:id/stream

Transmituj zadanie Brelok

Transmituj aktualizacje w czasie rzeczywistym dla zadania brelok za pomocą Server-Sent Events (SSE). Ścieżka URL musi odpowiadać etapowi zadania — otwarcie transmisji na /prototype/:buildId/stream emituje pojedynczy event: error ładunek z status_code: 404 i zamyka transmisję.

Parametry

  • Name
    id
    Type
    path
    Description

    Unikalny identyfikator dla zadania brelok do transmisji.

Zwraca

Zwraca strumień obiektów zadań Keychain Prototype lub Keychain Build jako Server-Sent Events. Dla zadań PENDING lub IN_PROGRESS, strumień odpowiedzi będzie zawierał tylko niezbędne pola progress i status.

Żądanie

GET
/openapi/creative-lab/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream
curl -N https://api.meshy.ai/openapi/creative-lab/keychain/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Strumień odpowiedzi

// 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.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
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-keychain-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}
GET/openapi/creative-lab/keychain/v1/(prototype|build)

Lista zadań breloka

Pobierz stronicowaną listę swoich zadań breloka dla pojedynczego etapu. Ścieżka URL wybiera etap — /prototype zwraca zadania prototypowe; /build zwraca zadania budowlane. Zadania z innego etapu nie są uwzględniane w żadnej z odpowiedzi.

Parametry ścieżki

  • Name
    stage
    Type
    path
    Wymagane
    Description

    Albo prototype, albo build. Kolekcja zwraca tylko zadania, których etap pasuje do URL — pobieranie /prototype nigdy nie zwraca zadań budowlanych 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. Maksymalnie dozwolone to 50 pozycji.

  • Name
    sort_by
    Type
    string
    domyślne -created_at
    Description

    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.

Zwraca

Zwraca stronicowaną listę obiektów zadań dla danego etapu — albo obiekt zadania prototypu breloka przy wymienianiu /prototype, albo obiekt zadania budowlanego breloka przy wymienianiu /build.

Request

GET
/openapi/creative-lab/keychain/v1/prototype
# List prototype tasks
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/prototype?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# List build tasks
curl https://api.meshy.ai/openapi/creative-lab/keychain/v1/build?page_size=10 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-keychain-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=***"
    ]
  }
]

Obiekt Zadania Prototypu Breloka

Obiekt Zadania Prototypu Breloka to jednostka pracy, którą Meshy śledzi, aby wygenerować pokolorowany obraz koncepcyjny z zdjęcia źródłowego. Wynik tego etapu jest połączony z etapem budowy za pomocą input_task_id.

Właściwości

  • Name
    id
    Type
    string
    Description

    Unikalny identyfikator zadania. Chociaż używamy UUID sortowalnego k jako szczegółu implementacji, nie powinieneś zakładać żadnych założeń dotyczących formatu id.

  • Name
    type
    Type
    string
    Description

    Typ zadania. Wartość to creative-lab-keychain-prototype.

  • Name
    name
    Type
    string
    Description

    Nazwa zadania podana podczas tworzenia zadania. Pusty ciąg, 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ę sukcesem, wartość ta wyniesie 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 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 jeszcze się nie rozpoczęło, ta właściwość będzie miała wartość 0.

  • Name
    finished_at
    Type
    timestamp
    Description

    Znacznik czasu zakończenia zadania, w milisekundach. Jeśli zadanie jeszcze się nie zakończyło, ta właściwość będzie miała 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ń. Zobacz Błędy dla pełnej referencji obiektu task_error.

  • Name
    consumed_credits
    Type
    integer
    Description

    Liczba kredytów zużytych przez to zadanie. Obecne, 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

    Pobieralne URL-e dla kandydatów na obrazy koncepcyjne wygenerowane przez to zadanie prototypowe. Obecnie API zawsze zwraca dokładnie jednego kandydata; pole jest tablicą, aby przyszłe wersje mogły ujawniać wielu kandydatów bez wprowadzania zmian łamiących kompatybilność.

Example Keychain Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-keychain-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=***"
  ]
}

Obiekt Zadania Budowy Breloka

Obiekt Zadania Budowy Breloka to jednostka pracy, którą Meshy śledzi, aby wygenerować końcową siatkę 3D breloka z zakończonego sukcesem zadania prototypowego. Budowa uruchamia potok reliefu mapy głębokości na koncepcyjnym obrazie prototypu i publikuje pojedynczy artefakt siatki w formacie, który został zażądany przez wywołującego.

Właściwości

  • Name
    id
    Type
    string
    Description

    Unikalny identyfikator zadania.

  • Name
    type
    Type
    string
    Description

    Typ zadania. Wartość to creative-lab-keychain-build.

  • Name
    name
    Type
    string
    Description

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

  • Name
    status
    Type
    string
    Description

    Status zadania. Możliwe wartości to 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ę sukcesem, wartość ta wyniesie 100.

  • Name
    created_at
    Type
    timestamp
    Description

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

  • Name
    started_at
    Type
    timestamp
    Description

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

  • Name
    finished_at
    Type
    timestamp
    Description

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

  • Name
    expires_at
    Type
    timestamp
    Description

    Znacznik czasu, kiedy wynik zadania wygasa, 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 dla pełnej referencji 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
    model_urls
    Type
    object
    Description

    Pobieralne URL-e dla wygenerowanego artefaktu, kluczowane nazwą artefaktu. Zawsze zawiera dokładnie jeden wpis — format zażądany przez output.format w żądaniu budowy. Klucz odpowiada zażądanym formatowi:

    • Name
      glb
      Type
      string
      Description

      Pobieralny URL do pliku GLB. Obecny, gdy output.format był glb (domyślnie).

    • Name
      obj
      Type
      string
      Description

      Pobieralny URL do paczki zip zawierającej model.obj, model.mtl i texture.png. Obecny, gdy output.format był obj.

    • Name
      bundle_zip
      Type
      string
      Description

      Pobieralny URL do paczki zip zawierającej każdy artefakt wygenerowany przez generator. Obecny, gdy output.format był zip.

Example Keychain Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-keychain-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": 20,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}