lowpoly будет отключён 30 окт. 2026 г.. Перейдите на другую модель до этих дат, чтобы избежать ошибок в запросах. Все устаревшие функции

API кирпичных фигурок Creative Lab

Превратите фото в коллекционную 3D-минифигурку в стиле кирпичиков за два этапа. Задача прототипа создаёт концептуальное изображение из фото. Задача сборки превращает это изображение в текстурированную 3D-модель и использует ID задачи прототипа в качестве input_task_id.

  • POST /openapi/creative-lab/brick-figure/v1/prototype
  • POST /openapi/creative-lab/brick-figure/v1/build

POST/openapi/creative-lab/brick-figure/v1/prototype

Создание задачи прототипа Brick Figure

Генерирует одно концептуальное изображение в кирпичном стиле из фотографии. Чтобы построить 3D-модель, передайте ID этой задачи в эндпоинт построения как input_task_id. Описание полей задачи см. в разделе Объект задачи прототипа Brick Figure.

Request

POST
/openapi/creative-lab/brick-figure/v1/prototype
# Stage 1: generate a brick-style concept image
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/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"
}

Параметры

  • 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 возвращает прозрачный PNG в формате RGBA, чтобы вы могли разместить объект на любом фоне. Построение также начинается с изображения без фона. Если Meshy не может удалить фон, он возвращает изображение с фоном, и задача всё равно завершается успешно.

Возвращаемые значения

Поле 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/brick-figure/v1/build

Создание задачи сборки Brick Figure

Создаёт текстурированную 3D-минифигурку на основе успешно выполненной задачи прототипа. Описание полей см. в разделе Объект задачи сборки Brick Figure.

Request

POST
/openapi/creative-lab/brick-figure/v1/build
# Stage 2: chain build off a succeeded prototype task
curl https://api.meshy.ai/openapi/creative-lab/brick-figure/v1/build \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578"
  }'

Response

{
  "result": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb"
}

Параметры

  • Name
    input_task_id
    Type
    string
    Обязательный
    Description

    ID задачи прототипа, которую нужно собрать. Это должна быть задача, созданная вашим аккаунтом с помощью POST /openapi/creative-lab/brick-figure/v1/prototype, со статусом SUCCEEDED.

    Если указан ID, не относящийся к вашим задачам прототипа Brick Figure из API, возвращается 404 — это касается и прототипа, созданного в веб-приложении.

  • Name
    name
    Type
    string
    Description

    Название задачи, до 100 символов. Оно возвращается в поле name задачи. Более длинное название приводит к 400.

Возвращаемые значения

Поле result содержит ID новой задачи сборки. Получите задачу или получайте её поток, пока status не станет SUCCEEDED. Затем загрузите текстурированный GLB из model_urls.glb. Чтобы получить OBJ, загрузите model_urls.obj вместе с файлом материала из model_urls.mtl.

Режимы сбоя

  • Name
    400 - Bad Request
    Description

    Запрос не может быть выполнен. Например:

    • input_task_id отсутствует или не является корректным ID задачи.
    • Статус задачи прототипа не SUCCEEDED. Если она всё ещё выполняется, подождите и повторите попытку. Если она завершилась неудачей или была отменена, создайте новую задачу прототипа.
    • Задача прототипа выполнена успешно, но без изображения. Создайте новую задачу прототипа.

    В сообщении об ошибке указывается, какая именно проблема обнаружена.

  • Name
    401 - Unauthorized
    Description

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

  • Name
    402 - Payment Required
    Description

    Применимо одно из следующего:

    • На аккаунте недостаточно кредитов.
    • API-ключ, рабочая область или участник достигли лимита кредитов.
    • Аккаунт находится на бесплатном плане.

    Проверьте количество кредитов и план, затем повторите попытку.

  • Name
    404 - Not Found
    Description

    input_task_id не соответствует ни одной задаче прототипа Brick Figure, созданной вашим аккаунтом через API. Прототип, созданный в веб-приложении, также возвращает 404. Отправьте ID result из ответа на создание прототипа.

  • Name
    429 - Too Many Requests
    Description

    Достигнуто одно из следующих ограничений:

    • Вы отправили больше запросов, чем допускает ваше ограничение частоты. Подождите несколько секунд и повторите попытку. См. Ограничения частоты.
    • Слишком много ваших задач находится в очереди или выполняется. Дождитесь завершения части из них и повторите попытку.
    • На безлимитном плане без оставшихся кредитов вы достигли числа задач, которые могут выполняться без кредитов. Дождитесь завершения задачи или пополните кредиты.

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

Получить задачу Brick Figure

Возвращает задачу прототипа или сборки. Путь должен соответствовать стадии задачи. Задача сборки, запрошенная через /prototype/:id, возвращает 404, и то же самое происходит с задачей прототипа, запрошенной через /build/:id.

Описание полей см. в разделах Объект задачи прототипа Brick Figure и Объект задачи сборки Brick Figure.

Request

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

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

Prototype Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-brick-figure-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-brick-figure-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,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?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

    Задача Brick Figure с таким ID не принадлежит вашему аккаунту, либо стадия задачи не соответствует пути. Проверьте ID и используйте /prototype или /build в соответствии с задачей.

  • Name
    500 - Internal Server Error
    Description

    Meshy не смог выполнить проверку интеллектуальной собственности. Повторите запрос.


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

Удаление задачи Brick Figure

Отменяет задачу Brick Figure. Отмена задачи со статусом PENDING возвращает кредиты. Задача со статусом IN_PROGRESS отменяется без возврата средств, так как обработчик уже приступил к её выполнению. Задачу с финальным статусом (SUCCEEDED, FAILED или CANCELED) отменить нельзя.

Путь должен соответствовать этапу задачи. Например, DELETE на /prototype/:id с ID задачи этапа build вернёт 404.

Request

DELETE
/openapi/creative-lab/brick-figure/v1/prototype/018a210d-8ba4-705c-b111-1f1776f7f578
curl --request DELETE \
  --url https://api.meshy.ai/openapi/creative-lab/brick-figure/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

    Задача Brick Figure с таким ID не принадлежит вашему аккаунту, либо этап задачи не соответствует пути. Проверьте ID и используйте /prototype или /build для соответствия задаче.


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

Трансляция задачи Brick Figure

Транслирует обновления задачи Brick Figure в виде Server-Sent Events (SSE). Путь должен соответствовать этапу задачи. Если это не так, например ID задачи build используется в /prototype/:id/stream, поток отправляет одно событие error со значением status_code: 404 и закрывается.

Request

GET
/openapi/creative-lab/brick-figure/v1/build/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/stream
curl -N https://api.meshy.ai/openapi/creative-lab/brick-figure/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-brick-figure-build",
  "status": "SUCCEEDED",
  "progress": 100,
  "created_at": 1729123500000,
  "started_at": 1729123510000,
  "finished_at": 1729123535000,
  "expires_at": 1729382735000,
  "task_error": null,
  "consumed_credits": 30,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}

Параметры

  • Name
    id
    Type
    path
    Description

    ID задачи из ответа на создание.

Возвращает

Поток объектов задачи prototype или build. Каждое событие содержит полный объект задачи, как его возвращает Получить задачу Brick Figure. Пока задача находится в статусе PENDING или IN_PROGRESS, её выходные поля всё ещё пусты (null, [] или {}), а finished_at равно null.

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


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

Список задач фигурки из кирпичиков

Возвращает ваши задачи фигурки из кирпичиков для одного этапа, по одной странице за раз. Путь определяет этап. /prototype возвращает только задачи прототипа, а /build возвращает только задачи сборки.

Request

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

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

Response (List Prototype Tasks)

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "creative-lab-brick-figure-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: сначала старые

Возвращает

Массив объектов задачи прототипа или объектов задачи сборки, соответствующих этапу, указанному в пути.


Объект задачи прототипа фигурки из кирпичиков

Задача прототипирования создаёт концептуальное изображение в стиле кирпичиков из фотографии. Чтобы превратить изображение в 3D-модель, передайте ID задачи в эндпоинт сборки в качестве input_task_id.

Свойства

Example Brick Figure Prototype Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "creative-lab-brick-figure-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
    id
    Type
    string
    Description

    ID задачи. Не полагайтесь на его формат.

  • Name
    type
    Type
    string
    Description

    Тип задачи, всегда creative-lab-brick-figure-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 не может прочитать информацию о списании, ответ на запрос получения или потоковый ответ не содержит это поле, а запрос списка возвращает 500. В этом случае повторите запрос.

  • Name
    image_urls
    Type
    array of strings
    Description

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


Объект задачи сборки фигурки из брикетов

Задача сборки генерирует текстурированную 3D-минифигурку из успешно выполненной задачи-прототипа. Поля model_urls, thumbnail_url и texture_urls имеют тот же формат, что и в объекте задачи Изображение в 3D.

Свойства

Example Brick Figure Build Task Object

{
  "id": "019c320e-9a8f-7a1c-9c11-2a1876f8a9bb",
  "type": "creative-lab-brick-figure-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,
  "prompt": "",
  "negative_prompt": "",
  "texture_prompt": "",
  "texture_image_url": "",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.glb?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.obj?Expires=***",
    "mtl": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/model.mtl?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/preview.png?Expires=***",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/019c320e-9a8f-7a1c-9c11-2a1876f8a9bb/output/texture_0.png?Expires=***"
    }
  ]
}
  • Name
    id
    Type
    string
    Description

    ID задачи. Не полагайтесь на его формат.

  • Name
    type
    Type
    string
    Description

    Тип задачи, всегда creative-lab-brick-figure-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
    prompt
    Type
    string
    Description

    Всегда "" для задачи сборки фигурки из брикетов.

  • Name
    negative_prompt
    Type
    string
    Description

    Всегда "" для задачи сборки фигурки из брикетов, как и prompt.

  • Name
    texture_prompt
    Type
    string
    Description

    Всегда "" для задачи сборки фигурки из брикетов, как и prompt.

  • Name
    texture_image_url
    Type
    string
    Description

    Всегда "" для задачи сборки фигурки из брикетов, как и prompt.

  • Name
    model_urls
    Type
    object
    Description

    URL-адреса для скачивания 3D-модели в виде текстурированного GLB и в виде файла OBJ с соответствующим файлом MTL.

    • Name
      glb
      Type
      string
      Description

      URL для скачивания текстурированного файла GLB.

    • Name
      obj
      Type
      string
      Description

      URL для скачивания файла OBJ, содержащего геометрию и UV-развёртку.

    • Name
      mtl
      Type
      string
      Description

      URL для скачивания файла материала MTL, идущего в паре с obj. Используйте его вместе с obj и текстурой из texture_urls[0].base_color.

  • Name
    thumbnail_url
    Type
    string
    Description

    URL для скачивания изображения предварительного просмотра модели.

  • Name
    texture_urls
    Type
    array
    Description

    Карты текстур в виде массива с одним объектом, содержащим карту базового цвета.

    • Name
      base_color
      Type
      string
      Description

      URL для скачивания карты базового цвета.