API брелоків Creative Lab

Перетворіть фотографію на брелок, придатний для 3D-друку, з кольоровим рельєфом у два етапи. Завдання прототипу генерує кольорове концептуальне зображення з фотографії. Завдання збірки перетворює це зображення на рельєфну 3D-модель і використовує ID завдання прототипу як input_task_id.

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

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

Створення завдання прототипу Keychain

Генерує одне колоризоване концептуальне зображення з фото. Щоб побудувати 3D-модель, передайте ID цього завдання до кінцевої точки побудови як input_task_id. Поля завдання описані в розділі Об'єкт завдання прототипу Keychain.

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; charset=utf-8' \
  -d '{
    "image_url": "<your publicly accessible image url or base64-encoded data URI>",
    "name_text": "Luna"
  }'

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

Параметри

Name
image_url
Type
string
Обов'язковий
Description
Фото для перетворення на концептуальне зображення брелока, у вигляді публічної URL-адреси або Data URI (data:image/jpeg;base64,<ваші base64-закодовані дані зображення>).
Зображення повинно бути файлом JPG, JPEG, PNG або WebP розміром не більше 20 МБ.
Name
name
Type
string
Description
Назва для завдання, до 100 символів. Вона повертається у полі завдання name. Довша назва призведе до помилки 400.
Вона позначає завдання у вашій панелі керування та списках завдань і не з'являється на брелоку. Щоб додати ім'я на брелок, використовуйте name_text.
Name
name_text
Type
string
Description
Ім'я для додавання на брелок, наприклад, ім'я тварини чи людини, до 10 символів. Meshy рахує символи, а не байти, тому 10-символьне ім'я китайською, японською чи корейською мовою поміститься. Довше ім'я призведе до помилки 400. Залиште поле порожнім для брелока без імені.
Ім'я з'являється на лицьовій стороні брелока як плоска кольорова деталь, а не як рельєфний чи вирізаний текст.
Meshy обрізає пробіли з країв і видаляє невидимі символи форматування. Об'єкт завдання прототипу повертає результат у полі name_text, тож ви можете перевірити текст перед оплатою побудови.
Meshy додає ім'я на етапі прототипу. Побудова зберігає його і ігнорує name_text, надіслане до кінцевої точки побудови.
Якщо текст містить не лише символи ASCII, надсилайте тіло запиту в UTF-8 з Content-Type: application/json; charset=utf-8. Деякі HTTP-клієнти, такі як Invoke-RestMethod у Windows PowerShell, за замовчуванням кодують тіло як ISO-8859-1. Це перетворює кожен нелатинський символ на ? до того, як запит досягне Meshy, і Meshy не може відрізнити це від імені, яке ви насправді мали на увазі надіслати.
Name
remove_background
Type
boolean
за замовчуванням false
Description
Чи видаляти фон із зображення прототипу. true повертає прозорий RGBA PNG, що зберігає весь медальйон, тож ви можете розмістити його на будь-якому фоні. Побудова також починається із зображення без фону. Якщо Meshy не може видалити фон, він повертає зображення з фоном, і завдання все одно завершується успішно.
Параметр remove_background для побудови є окремим.

Результати

Поле result містить ID нового завдання прототипу. Отримайте завдання або транслюйте його, доки status не стане SUCCEEDED. Потім передайте ID до кінцевої точки побудови як input_task_id.

Режими помилок

Name
400 - Bad Request
Description
Запит не може бути виконаний. Наприклад:
- Відсутній image_url.
- Зображення не є файлом JPG, JPEG, PNG або WebP.
- Зображення занадто мале, перевищує 20 МБ, або перевищує максимальну кількість пікселів.
- Meshy не може завантажити зображення, наприклад, тому що URL-адреса повертає 404 або час очікування вичерпано.
- Data URI не є дійсним base64.
- name_text довший за 10 символів. Meshy відхиляє його замість скорочення і не стягує плату за запит.
- Зображення або name_text позначено як NSFW.
Повідомлення про помилку вказує, яку проблему виявлено. Виправте запит і надішліть його знову.
Name
401 - Unauthorized
Description
API-ключ відсутній або недійсний. Перевірте заголовок Authorization.
Name
402 - Payment Required
Description
Застосовується одне з таких:
- На рахунку недостатньо кредитів.
- API-ключ, робоча область або учасник досягли ліміту кредитів.
- Обліковий запис використовує безкоштовний план.
Перевірте ваші кредити та план, потім повторіть спробу.
Name
403 - Forbidden
Description
У вашій команді увімкнено фільтрацію IP, і Meshy позначив зображення як таке, що містить права інтелектуальної власності третіх осіб. Надішліть зображення, на використання якого ви маєте права. Meshy перевіряє на інтелектуальну власність лише зображення, а не name_text.
Name
429 - Too Many Requests
Description
Досягнуто одного з таких обмежень:
- Ви надіслали більше запитів, ніж дозволяє ваше обмеження частоти. Зачекайте кілька секунд, потім повторіть спробу. Див. Обмеження частоти.
- Забагато ваших завдань у черзі або виконується одночасно. Зачекайте, доки деякі з них завершаться, потім повторіть спробу.
- На необмеженому плані без кредитів ви досягли кількості завдань, які можуть виконуватися без кредитів. Зачекайте завершення завдання або додайте кредити.
Name
500 - Internal Server Error
Description
Meshy зіткнувся з помилкою сервера, наприклад, через неможливість виконати перевірку зображення на інтелектуальну власність. Meshy не створює завдання і повертає будь-які стягнуті кредити. Повторіть запит.

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

Створення завдання збірки Keychain

Генерує 3D-брелок, придатний для друку, з успішно виконаного завдання прототипу. Meshy перетворює концептуальне зображення прототипу на рельєф із карти глибини та повертає один файл моделі у вибраному вами форматі. Поля цього завдання описано в розділі Об'єкт завдання збірки Keychain.

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

Параметри

Name
input_task_id
Type
string
Обов'язковий
Description
ID завдання прототипу, яке потрібно зібрати. Це має бути завдання, створене вашим акаунтом через POST /openapi/creative-lab/keychain/v1/prototype, зі статусом SUCCEEDED.
ID, який не відповідає жодному з ваших завдань прототипу Keychain, створених через API, повертає 404, включно з прототипом, створеним у веб-застосунку.
Name
name
Type
string
Description
Назва завдання, до 100 символів. Вона повертається в полі name завдання. Довша назва повертає 400.

`options`

Необов'язкові налаштування форми рельєфу. Кожне поле має значення за замовчуванням, тому надсилайте лише ті, які хочете змінити. Значення поза допустимим діапазоном поля повертає 400.

Name
badge_shape
Type
string
за замовчуванням circle
Description
Контур брелока, коли Meshy не обводить його за об'єктом. Meshy використовує це значення, коли remove_background має значення false, або коли не вдається знайти контур об'єкта.
Доступні значення:
- circle
- rounded-rect
- hexagon
- shield
- star
Name
size_mm
Type
number
за замовчуванням 40
Description
Довжина сторони обмежувального квадрата брелока, в міліметрах, до 400. 0 використовує значення за замовчуванням.
Name
relief_height_mm
Type
number
за замовчуванням 2.2
Description
Максимальна висота рельєфу над основою, в міліметрах, від 0 до 20.
Name
relief_offset_mm
Type
number
за замовчуванням 0
Description
Наскільки опустити рельєф, в міліметрах, від 0 до 20. Meshy віднімає це значення від висоти рельєфу всюди, аж до основи.
Name
base_thickness_mm
Type
number
за замовчуванням 0.1
Description
Товщина плоскої основи позаду рельєфу, в міліметрах, від 0 до 20.
Name
has_closed_back
Type
boolean
за замовчуванням true
Description
Чи закривати задню частину брелока. false залишає задню частину відкритою, у вигляді оболонки.
Name
relief_curve
Type
string
за замовчуванням linear
Description
Крива, яка перетворює значення карти глибини на висоту рельєфу.
Доступні значення:
- linear
- gamma
- s-curve
Name
curve_param
Type
number
за замовчуванням 1.0
Description
Інтенсивність кривої, до 10. Використовується кривими gamma та s-curve, крива linear ігнорує це значення. 0 використовує значення за замовчуванням.
Name
invert_depth
Type
boolean
за замовчуванням false
Description
Чи інвертувати карту глибини, щоб темніші ділянки ставали вищим рельєфом.
Name
smoothing
Type
number
за замовчуванням 0.24
Description
Наскільки згладжувати карту глибини перед тим, як Meshy побудує рельєф, від 0 до 10.
Name
relief_scale
Type
number
за замовчуванням 1.0
Description
Наскільки масштабувати рельєф і його текстуру всередині контуру, відносно центру, до 10. Значення понад 1 збільшує об'єкт, а значення менше 1 зменшує його. Це не змінює висоту рельєфу. 0 використовує значення за замовчуванням.
Name
depth_threshold
Type
number
за замовчуванням 0.1
Description
Значення карти глибини, нижче якого Meshy встановлює глибину на нуль, від 0 до 1.
Name
remove_background
Type
boolean
за замовчуванням true
Description
Чи обводити контур брелока за об'єктом, щоб брелок повторював форму об'єкта. false замість цього використовує контур badge_shape. Meshy також використовує badge_shape, коли не вдається знайти контур об'єкта.
Це окремий параметр від параметра remove_background прототипу, який визначає, чи має зображення прототипу прозорий фон.
Name
export_resolution
Type
integer
за замовчуванням 512
Description
Роздільна здатність сітки експортованої моделі, від 64 до 512. Meshy будує геометрію з карти глибини в 512 пікселів, тому детальніша сітка лише додасть грані без додаткової деталізації. 0 використовує значення за замовчуванням.

`output`

Необов'язково. Встановлює формат файлу, який повертає збірка.

Name
format
Type
string
за замовчуванням glb
Description
Формат файлу, який повертає збірка.
Доступні значення:
- glb: один файл model.glb, у model_urls.glb
- obj: zip-файл з model.obj, model.mtl та texture.png, у model_urls.obj
- zip: zip-файл з усіма файлами, які генерує Meshy, у model_urls.bundle_zip

Результати

Поле result містить ID нового завдання збірки. Отримайте завдання або стримте його, доки status не стане SUCCEEDED. Потім завантажте файл з єдиного запису в model_urls.

Режими збою

Name
400 - Bad Request
Description
Запит не може бути виконаний. Наприклад:
- input_task_id відсутній або не є дійсним ID завдання.
- Статус завдання прототипу не SUCCEEDED. Якщо воно ще виконується, зачекайте та повторіть спробу. Якщо воно завершилося невдало або було скасоване, створіть нове завдання прототипу.
- Завдання прототипу виконалося успішно, але не містить зображення. Створіть нове завдання прототипу.
- Поле options виходить за межі діапазону або не є доступним значенням.
Повідомлення про помилку вказує, яку саме проблему виявлено.
Name
401 - Unauthorized
Description
API-ключ відсутній або недійсний. Перевірте заголовок Authorization.
Name
402 - Payment Required
Description
Застосовується одне з наведеного:
- На акаунті недостатньо кредитів.
- API-ключ, робоча область або учасник досягли ліміту кредитів.
- Акаунт перебуває на безкоштовному плані.
Перевірте свої кредити та план, потім повторіть спробу.
Name
404 - Not Found
Description
input_task_id не відповідає жодному завданню прототипу Keychain, створеному вашим акаунтом через API. Прототип, створений у веб-застосунку, також повертає 404. Надішліть ID result з відповіді створення прототипу.
Name
429 - Too Many Requests
Description
Досягнуто одного з таких обмежень:
- Ви надіслали більше запитів, ніж дозволяє ваше обмеження частоти. Зачекайте кілька секунд, потім повторіть спробу. Див. Обмеження частоти.
- Забагато ваших завдань перебуває в черзі або виконується. Зачекайте, доки деякі з них завершаться, потім повторіть спробу.
- На необмеженому плані без кредитів ви досягли кількості завдань, які можуть виконуватися без кредитів. Зачекайте завершення завдання або додайте кредити.

GET/openapi/creative-lab/keychain/v1/(prototype|build)/:id

Отримати завдання брелока

Повертає завдання прототипу або збірки. Шлях повинен відповідати етапу завдання. Завдання збірки, запитане через /prototype/:id, повертає 404, так само як і завдання прототипу, запитане через /build/:id.

Щодо полів дивіться Об'єкт завдання прототипу брелока та Об'єкт завдання збірки брелока.

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

Параметри

Name
id
Type
path
Description
ID завдання з відповіді на створення.

Повертає

Об'єкт завдання прототипу або об'єкт завдання збірки, відповідно до етапу в шляху.

Режими збою

Name
400 - Bad Request
Description
id не є дійсним ID завдання. Надішліть ID result з відповіді на створення.
Name
403 - Forbidden
Description
У вашій команді увімкнено IP Filtering, і Meshy позначив зображення завдання прототипу через інтелектуальну власність третіх сторін. Завдання збірки та команди на плані Enterprise не отримують цю помилку. Створіть завдання прототипу із зображення, на використання якого ви маєте права.
Name
404 - Not Found
Description
Жодне завдання брелока з таким ID не належить вашому акаунту, або етап завдання не відповідає шляху. Перевірте ID та використовуйте /prototype або /build відповідно до завдання.
Name
500 - Internal Server Error
Description
Meshy не зміг виконати перевірку на інтелектуальну власність. Повторіть запит.

DELETE/openapi/creative-lab/keychain/v1/(prototype|build)/:id

Видалення завдання брелока

Скасовує завдання брелока. Скасування завдання зі статусом PENDING повертає витрачені кредити. Завдання зі статусом IN_PROGRESS скасовується без повернення коштів, оскільки воркер уже почав його виконання. Завдання з фінальним статусом (SUCCEEDED, FAILED або CANCELED) скасувати не можна.

Шлях має відповідати етапу завдання. Наприклад, DELETE за адресою /prototype/:id з ID завдання етапу build поверне 404.

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).

Параметри шляху

Name
id
Type
path
Description
ID завдання, яке потрібно скасувати.

Повертає

204 No Content з порожнім тілом.

Випадки помилок

Name
400 - Bad Request
Description
Застосовується одне з наведеного:
- id не є дійсним ID завдання. Надішліть ID result з відповіді на створення.
- Завдання вже має фінальний статус (SUCCEEDED, FAILED або CANCELED), тому його не можна скасувати.
Name
404 - Not Found
Description
Жодне завдання брелока з цим ID не належить вашому акаунту, або етап завдання не відповідає шляху. Перевірте ID та використовуйте /prototype чи /build відповідно до завдання.

GET/openapi/creative-lab/keychain/v1/(prototype|build)/:id/stream

Потокова передача задачі Keychain

Передає оновлення задачі Keychain у вигляді Server-Sent Events (SSE). Шлях має відповідати етапу задачі. Якщо ні, наприклад ID задачі build за адресою /prototype/:id/stream, потік надсилає одну подію error зі status_code: 404 і закривається.

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.
// 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-keychain-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***"
  }
}

Параметри

Name
id
Type
path
Description
ID задачі з відповіді на створення.

Повертає

Потік об'єктів задачі prototype або build. Кожна подія містить повний об'єкт задачі, так само як його повертає Отримати задачу Keychain. Поки задача має статус PENDING або IN_PROGRESS, її вихідні поля все ще порожні (null, [] або {}), а finished_at дорівнює null.

Якщо IP Filtering блокує результат задачі, потік натомість надсилає одну подію error зі status_code, який повернув би запит get.

GET/openapi/creative-lab/keychain/v1/(prototype|build)

Список завдань Keychain

Повертає ваші завдання Keychain одного етапу, по одній сторінці за раз. Шлях вибирає етап. /prototype повертає лише завдання прототипу, а /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=***"
    ]
  }
]

Параметри шляху

Name
stage
Type
path
Обов'язковий
Description
Етап для отримання списку, prototype або build.

Параметри запиту

Name
page_num
Type
integer
за замовчуванням 1
Description
Сторінка для повернення, від 1 до 255. Значення 0 повертає першу сторінку. Значення поза межами від 0 до 255 повертає 400.
Name
page_size
Type
integer
за замовчуванням 10
Description
Кількість завдань на сторінку, до 100. Значення від 101 до 255 повертає 100 завдань, а 0 використовує значення за замовчуванням. Значення поза межами від 0 до 255 повертає 400.
Name
sort_by
Type
string
за замовчуванням -created_at
Description
Порядок сортування.
Доступні значення:
- -created_at: спочатку найновіші
- +created_at: спочатку найстаріші

Повертає

Масив об'єктів завдання прототипу або об'єктів завдання збірки, що відповідають етапу, вказаному у шляху.

Об'єкт задачі прототипу брелока у Keychain

Задача прототипу створює кольорове концептуальне зображення з фото. Щоб перетворити зображення на 3D-модель, передайте ID задачі в кінцеву точку build як input_task_id.

Властивості

Example Keychain Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-keychain-prototype",
  "name": "",
  "name_text": "Luna",
  "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 задачі. Не покладайтеся на його формат.
Name
type
Type
string
Description
Тип задачі, завжди creative-lab-keychain-prototype.
Name
name
Type
string
Description
Значення name, яке ви надіслали під час створення задачі, або "", якщо ви його не надіслали.
Name
name_text
Type
string
Description
Ім'я, яке Meshy додав до брелока, після видалення пробілів на краях та прихованих символів форматування. Пропускається, якщо ви не надіслали name_text. Щоб перевірити, чи ваш HTTP-клієнт правильно закодував текст, порівняйте його з тим, що ви надіслали.
Name
status
Type
string
Description
Статус задачі.
Доступні значення:
- PENDING: очікує в черзі
- IN_PROGRESS: генерує результат
- SUCCEEDED: завершено, з результатом
- FAILED: завершено, з причиною в task_error
- CANCELED: завершено, без результату
Name
progress
Type
integer
Description
Відсоток виконаної роботи, від 0 до 100. Дорівнює 0, поки задача не почалася, і 100, коли вона успішно завершена.
Name
created_at
Type
timestamp
Description
Час створення задачі, у мілісекундах Unix.
Name
started_at
Type
timestamp
Description
Час, коли воркер почав виконувати задачу, у мілісекундах Unix. До цього моменту — null.
Name
finished_at
Type
timestamp
Description
Час, коли задача досягла фінального статусу, у мілісекундах Unix. До цього моменту — null.
Name
expires_at
Type
timestamp
Description
Час, коли закінчується термін дії результату задачі, у мілісекундах Unix. Це 3 дні після finished_at, або 3 дні після created_at, поки задача не завершена. Для облікових записів Enterprise, які зберігають результати API необмежено довго, це приблизно через 100 років. Див. Зберігання ресурсів.
Name
preceding_tasks
Type
integer
Description
Позиція задачі в черзі, поки вона має статус PENDING. 1 означає, що вона почнеться наступною. 0 після того, як задача залишає чергу, і завжди 0 у результатах списку.
Name
task_error
Type
object
Description
Причина, чому задача завершилася невдачею. null, якщо status не дорівнює FAILED. Див. Помилки.
Name
consumed_credits
Type
integer
Description
Кількість кредитів, списаних за задачу, після будь-якого повернення коштів. Запит, що повертає помилку, не оплачується. Для невдалої задачі значення 0, оскільки Meshy повертає кошти. Скасування повертає кошти за задачу лише поки вона має статус PENDING. Якщо Meshy не може прочитати суму списання, у відповіді get або stream це поле пропускається, а запит списку повертає 500. У такому разі повторіть запит.
Name
image_urls
Type
array of strings
Description
URL-адреси для завантаження концептуального зображення. Масив містить одну URL-адресу після успішного завершення задачі, а до цього моменту — порожній.

Об'єкт завдання збірки брелока (Keychain)

Завдання збірки генерує 3D-брелок з успішного завдання прототипу. Воно повертає один файл моделі у форматі, який ви запросили.

Властивості

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

Name
id
Type
string
Description
ID завдання. Не покладайтеся на його формат.
Name
type
Type
string
Description
Тип завдання, завжди creative-lab-keychain-build.
Name
name
Type
string
Description
name, яке ви надіслали під час створення завдання, або "", якщо ви його не надсилали.
Name
status
Type
string
Description
Статус завдання.
Доступні значення:
- PENDING: очікує в черзі
- IN_PROGRESS: генерує результат
- SUCCEEDED: завершено, з результатом
- FAILED: завершено, з причиною в task_error
- CANCELED: завершено, без результату
Name
progress
Type
integer
Description
Відсоток виконаної роботи, від 0 до 100. Дорівнює 0, доки завдання не почнеться, і 100, коли воно успішно завершиться.
Name
created_at
Type
timestamp
Description
Час створення завдання, у мілісекундах Unix.
Name
started_at
Type
timestamp
Description
Час, коли воркер почав виконувати завдання, у мілісекундах Unix. До цього — null.
Name
finished_at
Type
timestamp
Description
Час, коли завдання досягло кінцевого статусу, у мілісекундах Unix. До цього — null.
Name
expires_at
Type
timestamp
Description
Час, коли результат завдання стає недійсним, у мілісекундах Unix. Це 3 дні після finished_at, або 3 дні після created_at, доки завдання не завершиться. Для облікових записів Enterprise, які зберігають результати API безстроково, це приблизно на 100 років пізніше. Див. Зберігання ресурсів.
Name
preceding_tasks
Type
integer
Description
Позиція завдання в черзі, поки воно має статус PENDING. 1 означає, що воно виконається наступним. 0 після того, як завдання покидає чергу, і завжди 0 у результатах списку.
Name
task_error
Type
object
Description
Причина, чому завдання не вдалося виконати. null, якщо status не дорівнює FAILED. Див. Помилки.
Name
consumed_credits
Type
integer
Description
Кількість кредитів, списаних за завдання, після будь-якого повернення коштів. За запит, який повертає помилку, кошти не списуються. Невдале завдання має значення 0, оскільки Meshy повертає кошти за нього. Скасування повертає кошти за завдання, лише доки воно має статус PENDING. Якщо Meshy не може прочитати інформацію про списання, поле відсутнє у відповіді на get-запит або stream, а запит списку повертає 500. У такому разі повторіть запит.
Name
model_urls
Type
object
Description
URL-адреси для завантаження файлу моделі, з одним записом для output.format, який ви запросили. {}, доки завдання не завершиться успішно.
- Name
  glb
  Type
  string
  Description
  URL-адреса для завантаження файлу GLB. Присутня, коли output.format дорівнює glb.
- Name
  obj
  Type
  string
  Description
  URL-адреса для завантаження zip-файлу з model.obj, model.mtl та texture.png. Присутня, коли output.format дорівнює obj.
- Name
  bundle_zip
  Type
  string
  Description
  URL-адреса для завантаження zip-файлу з усіма файлами, які генерує Meshy. Присутня, коли output.format дорівнює zip.