Creative Lab API для магнита на холодильник

Превратите фотографию в пригодный для 3D-печати магнит на холодильник с цветным рельефом и плоской задней стороной — в два этапа. Задача прототипа создаёт цветное концептуальное изображение по фотографии. Задача сборки превращает это изображение в рельефную 3D-модель и принимает идентификатор задачи прототипа в качестве 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

Создание задачи прототипа Fridge Magnet

Генерирует одно цветное концептуальное изображение из фотографии. Чтобы собрать 3D-модель, передайте ID этой задачи в эндпоинт сборки как 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 в эндпоинт сборки как 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

Создание задачи сборки Fridge Magnet

Генерирует 3D-печатаемый магнит на холодильник из успешно выполненной прототипной задачи. Meshy превращает концептуальное изображение прототипа в рельеф на основе карты глубины и возвращает один файл модели в выбранном вами формате. Поля задачи описаны в разделе Объект задачи сборки Fridge Magnet.

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, не являющийся одной из ваших прототипных задач Fridge Magnet, созданных через 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 не соответствует ни одной прототипной задаче Fridge Magnet, созданной вашим аккаунтом через 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, и 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 с 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
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/fridge-magnet/v1/(prototype|build)/:id/stream

Потоковая передача задачи Fridge Magnet

Передаёт обновления задачи Fridge Magnet в виде 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. Каждое событие содержит полный объект задачи, как его возвращает Получение задачи Fridge Magnet. Пока задача находится в состоянии PENDING или IN_PROGRESS, её выходные поля всё ещё пусты (null, [] или {}), а finished_at равно null.

Если IP Filtering блокирует результат задачи, поток отправляет вместо него одно событие error с status_code, которое вернул бы get-запрос.

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

Получение списка задач Fridge Magnet

Возвращает ваши задачи Fridge Magnet одного этапа, по одной странице за раз. Путь определяет этап. /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
Ссылки для скачивания концептуального изображения. Массив содержит одну ссылку после успешного завершения задачи, и пуст до этого момента.

Объект задачи сборки магнита на холодильник

Задача сборки генерирует 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 не может определить сумму списания, в ответе на get-запрос или в потоковом ответе это поле отсутствует, а запрос списка возвращает 500. В этом случае повторите запрос.
Name
model_urls
Type
object
Description
Ссылки на скачивание файла модели — по одной записи для запрошенного вами output.format. {}, пока задача не выполнена успешно.
- Name
  glb
  Type
  string
  Description
  Ссылка на скачивание файла GLB. Присутствует, если output.format равен glb.
- Name
  obj
  Type
  string
  Description
  Ссылка на скачивание zip-файла с model.obj, model.mtl и texture.png. Присутствует, если output.format равен obj.
- Name
  bundle_zip
  Type
  string
  Description
  Ссылка на скачивание zip-файла со всеми файлами, сгенерированными Meshy. Присутствует, если output.format равен zip.