Creative Lab — API breloka

Przekształć zdjęcie źródłowe w medalion do breloka gotowy do druku 3D — relief głębi w kształcie odznaki z naniesionymi kolorami — w dwóch etapach: prototype generuje pokolorowany obraz koncepcyjny ze zdjęcia wejściowego, a następnie build przekształca ten obraz koncepcyjny w reliefowy model 3D. Oba etapy są połączone przez 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 ze zdjęcia źródłowego. Zwrócony identyfikator zadania to wartość, którą przekazujesz jako input_task_id do punktu końcowego build. Zobacz Obiekt zadania prototypu breloka aby poznać kształt odpowiedzi.

Parametry

  • Name
    image_url
    Type
    string
    Wymagane
    Description

    Zdjęcie źródłowe, które Meshy ma pokolorować do postaci obrazu koncepcyjnego gotowego do użycia jako brelok. Obecnie obsługujemy formaty .jpg, .jpeg, .png i .webp.

    Istnieją dwa sposoby podania 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.

Zwraca

Właściwość result odpowiedzi zawiera id zadania nowo utworzonego zadania prototypu breloka. Odpytuj punkt końcowy Pobierz zadanie lub subskrybuj strumień, aż zadanie osiągnie stan SUCCEEDED, a następnie przekaż ten identyfikator do punktu końcowego build jako input_task_id.

Tryby niepowodzenia

  • 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: Nie udało się pobrać image_url (404 lub timeout).
    • Nieprawidłowy Data URI: Ciąg base64 jest nieprawidłowo sformatowany.
    • Oflagowana treść: Obraz wejściowy został oflagowany przez moderation NSFW lub własności intelektualnej.
  • 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
    429 - Too Many Requests
    Description

    Przekroczono 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"
}
Prototype example
Start with a source photo, then generate the prototype image used by the keychain build stage.
Source photo used as the Creative Lab Keychain input
Prototype input
Creative Lab Keychain prototype output generated from the source photo
Prototype output
POST/openapi/creative-lab/keychain/v1/build

Utwórz zadanie budowania breloka

Wygeneruj finalny medalion breloka gotowy do druku 3D z zakończonego powodzeniem zadania prototypu. Budowanie uruchamia potok reliefu mapy głębi na pokolorowanym obrazie koncepcyjnym prototypu i dostarcza pojedynczy artefakt siatki w żądanym formacie. Zapoznaj się z Obiektem zadania budowania breloka, aby poznać kształt odpowiedzi.

Parametry

  • Name
    input_task_id
    Type
    string
    Wymagane
    Description

    ID zadania prototypu utworzonego za pośrednictwem tego samego punktu końcowego OpenAPI. Prototyp musi zostać utworzony przy użyciu tego samego klucza API, musi osiągnąć stan SUCCEEDED i musi wygenerować dokładnie jeden obraz kandydujący.

    Zadania prototypu utworzone przez aplikację webową nie są akceptowane — punkt końcowy budowania akceptuje tylko zadania prototypu utworzone przez POST /openapi/creative-lab/keychain/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.

options

Opcjonalne parametry dostrajania 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

    Kontur sylwetki medalionu 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

    Przesunięcie pionowe zastosowane do reliefu przed ekstruzją, w milimetrach. Zakres: [0, 20].

  • Name
    base_thickness_mm
    Type
    number
    domyślne 0.1
    Description

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

  • Name
    has_closed_back
    Type
    boolean
    domyślne true
    Description

    Określa, czy tył medalionu jest uszczelniony jako zamknięta powierzchnia. Ustaw na false, aby uzyskać otwartą powłokę.

  • 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 wtedy, gdy relief_curve to gamma). Zakres: (0, 10].

  • Name
    invert_depth
    Type
    boolean
    domyślne false
    Description

    Odwraca interpretację mapy głębi, tak aby ciemniejsze obszary stawały się wyższym reliefem.

  • Name
    smoothing
    Type
    number
    domyślne 0.24
    Description

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

  • Name
    relief_scale
    Type
    number
    domyślne 1.0
    Description

    Mnożnik skali pionowej zastosowany ponad 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 tej wartości jest ograniczane do zera. Zakres: [0, 1].

  • Name
    remove_background
    Type
    boolean
    domyślne true
    Description

    Automatycznie usuwa tło obrazu koncepcyjnego prototypu przed tworzeniem reliefu.

  • Name
    export_resolution
    Type
    integer
    domyślne 512
    Description

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

output

Opcjonalny selektor formatu przesyłania. Domyślnie glb.

  • Name
    format
    Type
    string
    domyślne glb
    Description

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

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

Zwraca

Właściwość result odpowiedzi zawiera id zadania nowo utworzonego zadania budowania breloka. Odpytuj punkt końcowy Pobierz zadanie lub subskrybuj strumień, aż zadanie osiągnie stan SUCCEEDED, a następnie pobierz artefakt z pojedynczego wpisu w model_urls.

Tryby awarii

  • Name
    400 - Bad Request
    Description

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

    • Brakujący parametr: input_task_id jest wymagany.
    • Nieprawidłowy UUID: input_task_id nie jest prawidłowym UUID.
    • Zadanie nadrzędne nie zakończone powodzeniem: wskazane zadanie prototypu nie osiągnęło jeszcze stanu SUCCEEDED.
    • Brak kandydata: zadanie prototypu zakończyło się powodzeniem, ale nie wygenerowało obrazu kandydującego.
    • Opcje poza zakresem: jedno z pól options wykraczało poza dozwolony zakres lub zestaw enum.
  • 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
    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 API-mode mogą być łączone z budowaniem).

  • Name
    429 - Too Many Requests
    Description

    Przekroczono 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"
}
Build example
The build task converts the selected prototype image into a 3D-printable keychain model.
Creative Lab Keychain build model preview
Build model preview
GET/openapi/creative-lab/keychain/v1/(prototype|build)/:id

Pobierz zadanie breloka

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

Zobacz Obiekt zadania prototypu breloka oraz Obiekt zadania kompilacji breloka, aby poznać struktury odpowiedzi.

Parametry

  • Name
    id
    Type
    path
    Description

    Unikalny identyfikator zadania breloka do pobrania.

Zwraca

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

Request

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}"

Prototype Response

{
  "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=***"
  ]
}

Build Response

{
  "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 nadal ma status PENDING, kredyty zużyte w momencie tworzenia zostaną zwrócone. Zadania, które są już IN_PROGRESS, są anulowane bez zwrotu (worker może już zużywać zasoby). Zadania, które osiągnęły już stan końcowy (SUCCEEDED, FAILED, CANCELED), nie mogą zostać 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 powodzenia z pustą treścią odpowiedzi.

Tryby niepowodzenia

  • Name
    400 - Bad Request
    Description

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

  • Name
    404 - Not Found
    Description

    Zadanie nie istnieje, należy do innego użytkownika lub jego etap nie pasuje do ścieżki 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

Przesyłaj strumieniowo zadanie breloka

Przesyłaj w czasie rzeczywistym aktualizacje zadania breloka za pośrednictwem 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 breloka do przesyłania strumieniowego.

Zwraca

Zwraca strumień obiektów zadań Prototyp breloka lub Build breloka jako Server-Sent Events. W przypadku zadań PENDING lub IN_PROGRESS strumień odpowiedzi będzie zawierać tylko niezbędne pola progress i status.

Request

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}"

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.
// 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 prototypu; /build zwraca zadania kompilacji. Zadania z drugiego etapu nie są uwzględniane w żadnej odpowiedzi.

Parametry ścieżki

  • Name
    stage
    Type
    path
    Wymagane
    Description

    Albo prototype, albo build. Kolekcja zwraca tylko zadania, których etap pasuje do URL — pobranie /prototype nigdy nie zwraca zadań kompilacji 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 liczba to 50 elementów.

  • Name
    sort_by
    Type
    string
    domyślne -created_at
    Description

    Pole, według którego należy sortować. Dostępne wartości:

    • +created_at: Sortuj według czasu utworzenia w kolejności rosnącej.
    • -created_at: Sortuj według czasu utworzenia w kolejności malejącej.

Zwraca

Zwraca stronicowaną listę obiektu zadania dla danego etapu — albo obiekt zadania prototypu breloka podczas listowania /prototype, albo obiekt zadania kompilacji breloka podczas listowania /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ć kolorowany obraz koncepcyjny ze zdjęcia źródłowego. Wynik tego etapu jest łączony z etapem budowania za pomocą input_task_id.

Właściwości

  • Name
    id
    Type
    string
    Description

    Unikalny identyfikator zadania. Chociaż jako szczegół implementacyjny używamy k-sortowalnego UUID dla identyfikatorów zadań, nie należy przyjmować ż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 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

    Progress zadania. Jeśli zadanie nie zostało jeszcze rozpoczęte, ta właściwość będzie mieć wartość 0. Po pomyślnym zakończeniu zadania będzie to 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 r. 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ść będzie mieć 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ść będzie mieć 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, aby uzyskać pełne odniesienie do 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

    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 zmiany niezgodnej wstecz.

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 budowania breloka

Obiekt zadania budowania breloka to jednostka pracy, którą Meshy śledzi, aby wygenerować finalną siatkę 3D breloka z zadania prototypu zakończonego statusem SUCCEEDED. Proces budowania uruchamia potok reliefu z mapy głębi na obrazie koncepcyjnym prototypu i publikuje pojedynczy artefakt siatki w formacie żądanym 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 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 mieć wartość 0. Po pomyślnym ukończeniu zadania wartość ta 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 zadań zakończonych niepowodzeniem. Zobacz Błędy, aby uzyskać pełną dokumentację 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

    Adresy URL do pobrania wygenerowanego artefaktu, indeksowane według nazwy artefaktu. Zawsze zawiera dokładnie jeden wpis — format żądany przez output.format żądania budowania. Klucz odpowiada żądanemu formatowi:

    • Name
      glb
      Type
      string
      Description

      Adres URL do pobrania pliku GLB. Obecny, gdy output.format miał wartość glb (domyślnie).

    • Name
      obj
      Type
      string
      Description

      Adres URL do pobrania pakietu zip zawierającego model.obj, model.mtl i texture.png. Obecny, gdy output.format miał wartość obj.

    • Name
      bundle_zip
      Type
      string
      Description

      Adres URL do pobrania pakietu zip ze wszystkimi artefaktami generowanymi przez generator. Obecny, gdy output.format miał wartość 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=***"
  }
}