lowpoly буде вимкнено 30 жовт. 2026 р.. Перейдіть на іншу модель до цих дат, щоб уникнути помилок у запитах. Усі застарілі функції

Creative Lab Fridge Magnet API

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

  • POST /openapi/creative-lab/fridge-magnet/v1/prototype
  • POST /openapi/creative-lab/fridge-magnet/v1/build
POST/openapi/creative-lab/fridge-magnet/v1/prototype

Створити задачу прототипу магніта на холодильник

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

Request

POST
/openapi/creative-lab/fridge-magnet/v1/prototype
# Stage 1: generate a colorized fridge magnet concept image
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/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": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9"
}
Prototype example
Start with a source photo, then generate the prototype image used by the fridge magnet build stage.
Source landscape photo used as the Creative Lab Fridge Magnet input
Prototype input
Creative Lab Fridge Magnet 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
    remove_background
    Type
    boolean
    за замовчуванням false
    Description

    Чи видаляти фон із зображення прототипу. true повертає прозорий RGBA PNG, що зберігає весь магніт, тож ви можете розмістити його на будь-якому фоні. Побудова також починається із зображення без фону. Якщо Meshy не може видалити фон, повертається зображення з фоном, і задача все одно завершується успішно.

    Параметр remove_background для побудови є окремим.

Повернення

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

Режими збою

  • Name
    400 - Bad Request
    Description

    Запит не може бути виконаний. Наприклад:

    • Відсутній image_url.
    • Зображення не є файлом JPG, JPEG, PNG або WebP.
    • Зображення занадто мале, перевищує 20 МБ або перевищує максимальну кількість пікселів.
    • Meshy не може завантажити зображення, наприклад тому, що URL повертає 404 або час очікування вичерпано.
    • Data URI не є дійсним base64.
    • Зображення позначене як NSFW.

    Повідомлення про помилку вказує, яку проблему виявлено. Виправте запит і надішліть його знову.

  • Name
    401 - Unauthorized
    Description

    API-ключ відсутній або недійсний. Перевірте заголовок Authorization.

  • Name
    402 - Payment Required
    Description

    Застосовується одне з наступного:

    • На обліковому записі недостатньо кредитів.
    • API-ключ, робоча область або учасник досягли ліміту кредитів.
    • Обліковий запис на безкоштовному тарифному плані.

    Перевірте свої кредити та тарифний план, потім повторіть спробу.

  • Name
    403 - Forbidden
    Description

    У вашій команді увімкнено IP Filtering, і Meshy позначив зображення через інтелектуальну власність третіх осіб. Надішліть зображення, на використання якого ви маєте права.

  • Name
    429 - Too Many Requests
    Description

    Досягнуто одного з таких обмежень:

    • Ви надіслали більше запитів, ніж дозволяє ваше обмеження частоти. Зачекайте кілька секунд, потім повторіть спробу. Див. Обмеження частоти.
    • Забагато ваших задач у черзі або виконується. Зачекайте, доки деякі з них завершаться, потім повторіть спробу.
    • На необмеженому тарифному плані без залишку кредитів ви досягли кількості задач, які можуть виконуватися без кредитів. Зачекайте завершення задачі або додайте кредити.
  • Name
    500 - Internal Server Error
    Description

    Meshy зіткнувся з помилкою сервера, наприклад через неможливість виконати перевірку на інтелектуальну власність для зображення. Meshy не створює задачу та повертає будь-які стягнуті кредити. Повторіть запит.

POST/openapi/creative-lab/fridge-magnet/v1/build

Створення завдання на побудову магніта на холодильник

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

Request

POST
/openapi/creative-lab/fridge-magnet/v1/build
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
    "options": {
      "badge_shape": "rounded-rect",
      "size_mm": 60,
      "relief_height_mm": 3.3
    },
    "output": {
      "format": "glb"
    }
  }'

Response

{
  "result": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0"
}
Build example
The build task turns the selected prototype image into a 3D-printable fridge magnet model.
Creative Lab Fridge Magnet build model preview
Build model preview

Параметри

  • Name
    input_task_id
    Type
    string
    Обов'язковий
    Description

    ID завдання прототипу, яке потрібно побудувати. Це має бути завдання, яке створив ваш акаунт за допомогою POST /openapi/creative-lab/fridge-magnet/v1/prototype, зі статусом SUCCEEDED.

    ID, який не є одним із ваших завдань прототипу магніта на холодильник, створених через API, повертає 404, зокрема й прототип, створений у веб-застосунку.

  • Name
    name
    Type
    string
    Description

    Назва завдання, до 100 символів. Вона повертається в полі name завдання. Довша назва повертає 400.

options

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

  • Name
    badge_shape
    Type
    string
    за замовчуванням rounded-rect
    Description

    Контур магніта, коли Meshy не обводить його за суб'єктом. Meshy використовує це значення, коли remove_background має значення false, або коли не вдається знайти контур суб'єкта.

    Доступні значення:

    • circle
    • rounded-rect
    • hexagon
    • shield
    • star
  • Name
    size_mm
    Type
    number
    за замовчуванням 60
    Description

    Довжина сторони обмежувального квадрата магніта, в міліметрах, до 400. 0 використовує значення за замовчуванням.

  • Name
    relief_height_mm
    Type
    number
    за замовчуванням 3.3
    Description

    Максимальна висота рельєфу над основою, в міліметрах, від 0 до 20.

  • Name
    relief_offset_mm
    Type
    number
    за замовчуванням 0
    Description

    Наскільки опустити рельєф, в міліметрах, від 0 до 20. Meshy віднімає це значення від висоти рельєфу всюди, аж до основи.

  • Name
    base_thickness_mm
    Type
    number
    за замовчуванням 2.0
    Description

    Товщина плоскої основи позаду рельєфу, в міліметрах, від 0 до 20. Базова товщина 2 мм дає магніту достатньо тіла, щоб триматися на холодильнику, тож рельєф не здається крихким.

  • 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 не відповідає жодному завданню прототипу магніта на холодильник, створеному вашим акаунтом через API. Прототип, створений у веб-застосунку, також повертає 404. Надішліть ID result з відповіді на створення прототипу.

  • Name
    429 - Too Many Requests
    Description

    Досягнуто одне з таких обмежень:

    • Ви надіслали більше запитів, ніж дозволяє ваше обмеження частоти. Зачекайте кілька секунд, потім повторіть спробу. Див. Обмеження частоти.
    • Занадто багато ваших завдань перебувають у черзі або виконуються. Зачекайте, доки деякі завершаться, потім повторіть спробу.
    • На необмеженому плані без залишку кредитів ви досягли кількості завдань, які можуть виконуватися без кредитів. Зачекайте завершення завдання або додайте кредити.
GET/openapi/creative-lab/fridge-magnet/v1/(prototype|build)/:id

Отримати задачу магніта на холодильник

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

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

Request

GET
/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9
# Prototype
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

# Build
curl https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Prototype Response

{
  "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
  "type": "creative-lab-fridge-magnet-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543210000,
  "started_at": 1729543215000,
  "finished_at": 1729543242000,
  "expires_at": 1729802442000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 6,
  "image_urls": [
    "https://assets.meshy.ai/***/concept.png?Expires=***"
  ]
}

Build Response

{
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/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/fridge-magnet/v1/(prototype|build)/:id

Видалення завдання «Магніт на холодильник»

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

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

Request

DELETE
/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9
curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/prototype/01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 204 No Content on success (empty body).

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

  • Name
    id
    Type
    path
    Description

    Ідентифікатор завдання, яке потрібно скасувати.

Повертає

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

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

  • Name
    400 - Bad Request
    Description

    Застосовується один із цих випадків:

    • id не є дійсним ідентифікатором завдання. Надішліть ідентифікатор result з відповіді на створення.
    • Завдання вже має фінальний статус (SUCCEEDED, FAILED або CANCELED), тому його не можна скасувати.
  • Name
    404 - Not Found
    Description

    Жодне завдання «Магніт на холодильник» з таким ідентифікатором не належить вашому акаунту, або етап завдання не відповідає шляху. Перевірте ідентифікатор і використовуйте /prototype чи /build відповідно до завдання.

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

Отримання потокових оновлень завдання «Магніт на холодильник»

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

Request

GET
/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/stream
curl -N https://api.meshy.ai/openapi/creative-lab/fridge-magnet/v1/build/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/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": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}

Параметри

  • Name
    id
    Type
    path
    Description

    ID завдання з відповіді на створення.

Повертає

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

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

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

Отримати список завдань «Магніт на холодильник»

Повертає ваші завдання «Магніт на холодильник» одного етапу, по одній сторінці за раз. Шлях визначає етап. /prototype повертає лише завдання прототипу, а /build повертає лише завдання збірки.

Request

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

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

Response (List Prototype Tasks)

[
  {
    "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
    "type": "creative-lab-fridge-magnet-prototype",
    "name": "",
    "status": "SUCCEEDED",
    "progress": 100,
    "created_at": 1729543210000,
    "started_at": 1729543215000,
    "finished_at": 1729543242000,
    "expires_at": 1729802442000,
    "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: спочатку найстаріші

Повертає

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

Об'єкт завдання прототипу Fridge Magnet

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

Властивості

Example Fridge Magnet Prototype Task Object

{
  "id": "01a3d8f1-8c2e-7d04-b223-3f3776a1c8c9",
  "type": "creative-lab-fridge-magnet-prototype",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543210000,
  "started_at": 1729543215000,
  "finished_at": 1729543242000,
  "expires_at": 1729802442000,
  "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-fridge-magnet-prototype.

  • 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
    image_urls
    Type
    array of strings
    Description

    URL-адреси для завантаження концептуального зображення. Масив містить один URL після успішного завершення завдання, а до того він порожній.

Об'єкт задачі побудови магніта на холодильник

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

Властивості

Example Fridge Magnet Build Task Object

{
  "id": "01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0",
  "type": "creative-lab-fridge-magnet-build",
  "name": "",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729543250000,
  "started_at": 1729543258000,
  "finished_at": 1729543285000,
  "expires_at": 1729802485000,
  "preceding_tasks": 0,
  "task_error": null,
  "consumed_credits": 30,
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/01b4e9a2-9d3f-8e15-c334-4f4887b2d9d0/output/model.glb?Expires=***"
  }
}
  • Name
    id
    Type
    string
    Description

    ID задачі. Не покладайтеся на його формат.

  • Name
    type
    Type
    string
    Description

    Тип задачі, завжди creative-lab-fridge-magnet-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 не може прочитати суму стягнення, відповідь на запит отримання або потокову передачу не містить це поле, а запит списку повертає 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.