API Изображение в 3D

API Изображение в 3D — это функция, которая позволяет интегрировать возможности Meshy по преобразованию изображений в 3D в ваше собственное приложение. В этом разделе вы найдёте всю информацию, необходимую для начала работы с этим API.

POST/openapi/v1/image-to-3d

Создание задачи Изображение в 3D

Этот эндпоинт позволяет создать новую задачу Изображение в 3D. См. Объект задачи Изображение в 3D, чтобы узнать, какие свойства включены в объект задачи Изображение в 3D.

Задача выполняется в фоновом режиме. О том, сколько времени это обычно занимает, см. Время обработки.

Параметры

Требуется только один из параметров: input_task_id или image_url. Если указаны оба, приоритет имеет input_task_id.

Name
input_task_id
Type
string
Обязательный
Description
ID завершённой задачи генерации изображения, результат которой должен использоваться в качестве входного изображения. Эта задача должна быть одной из следующих: Текст в изображение или Изображение в изображение. Кроме того, она должна быть запущена через API, иметь статус SUCCEEDED и выдавать ровно одно изображение.

Name
image_url
Type
string
Обязательный
Description
Предоставьте изображение, которое Meshy будет использовать для создания модели. В настоящее время поддерживаются форматы .jpg, .jpeg, .png и .webp.
Максимальный размер файла: 20 МБ.
Есть два способа предоставить изображение:
- Публично доступный URL: URL, доступный из публичного интернета.
- Data URI: data URI изображения в кодировке base64. Пример data URI: data:image/jpeg;base64,<ваши данные изображения в кодировке base64>.

Name
model_type
Type
string
по умолчанию standard
Description
Укажите тип генерации 3D-сетки.
Доступные значения:
- standard: Обычная высокодетализированная генерация 3D-сетки.
- smart-topology: Выберите модель Smart Topology с помощью ai_model (meshy-t2).
- lowpoly (устаревшее, будет упразднено 30 октября 2026 года): Генерирует низкополигональную сетку, оптимизированную для более чистых полигонов. Вместо этого рекомендуем Meshy T2: smart-topology с meshy-t2.
Когда выбран smart-topology, параметры should_remesh, save_pre_remeshed_model и decimation_mode игнорируются, и принимается только topology: triangle.
lowpoly будет упразднён 30 октября 2026 года. После этой даты запросы с model_type: "lowpoly" будут возвращать ошибку. Рекомендуем перейти на Meshy T2 (model_type: "smart-topology" с ai_model: "meshy-t2"). Когда выбран lowpoly, параметры ai_model, topology, target_polycount, should_remesh и save_pre_remeshed_model игнорируются.
Name
ai_model
Type
string
по умолчанию latest
Description
ID используемой модели. Доступные значения зависят от model_type.
Обычная генерация (model_type: standard):
- meshy-6-lite, meshy-6, meshy-7.1, latest (Meshy 7.1)
- meshy-7 (устаревшее): используйте вместо этого meshy-7.1.
Генерация Smart Topology (model_type: smart-topology):
- meshy-t2 (по умолчанию): модель Smart Topology — более чистая topology, естественным образом разделённые части, вывод в виде треугольников и число граней, которое можно задать с помощью target_polycount.
Name
geometry_resolution
Type
string
по умолчанию standard
Description
Проход генерации геометрии. 2k запускает проход Ultra с разрешением 2048³; 4k запускает его с разрешением 4096³ для максимальной детализации поверхности.
Доступные значения: standard, 2k, 4k
Требуется meshy-7.1 или latest.
Name
ultra_mode
Type
boolean
⚠ устаревший
по умолчанию false
Description
Используйте вместо этого geometry_resolution. ultra_mode: true эквивалентно geometry_resolution: "2k".
Name
should_texture
Type
boolean
по умолчанию true
Description
Определяет, будут ли генерироваться текстуры. Установка значения false пропускает этап текстурирования, предоставляя сетку без текстур.

Применяется только когда should_texture = true

Name
enable_pbr
Type
boolean
по умолчанию false
Description
Генерировать PBR-карты (металличность, шероховатость, нормали) в дополнение к базовому цвету. Карта излучения (emission) также включается, когда ai_model равен meshy-6, за исключением случая texture_resolution: 8k. meshy-6-lite, meshy-7.1, meshy-t2 и latest не создают карту излучения.
Name
texture_resolution
Type
string
по умолчанию 2k
Description
Разрешение текстуры базового цвета. Одно из значений: 2k (2048×2048), 4k (4096×4096) или 8k (8192×8192). Более высокое разрешение позволяет захватить больше деталей поверхности.
4k и 8k недоступны с ai_model meshy-6-lite. При 8k карта излучения не создаётся.
Name
hd_texture
Type
boolean
⚠ устаревший
по умолчанию false
Description
Используйте вместо этого texture_resolution — эквивалент texture_resolution: "4k". Если заданы оба параметра, приоритет имеет texture_resolution.
Name
texture_prompt
Type
string
Description
Предоставьте текстовый prompt для управления процессом текстурирования. Максимум 800 символов.
Name
texture_image_url
Type
string
Description
Предоставьте 2D-изображение для управления процессом текстурирования. В настоящее время поддерживаются форматы .jpg, .jpeg, .png и .webp.
Максимальный размер файла: 20 МБ.
Есть два способа предоставить изображение:
- Публично доступный URL: URL, доступный из публичного интернета
- Data URI: data URI изображения в кодировке base64. Пример data URI: data:image/jpeg;base64,<ваши данные изображения в кодировке base64>
Текстурирование по изображению может работать неоптимально, если между исходным ассетом и загруженным изображением есть существенные различия в геометрии. Для управления процессом текстурирования может использоваться только один из параметров texture_image_url или texture_prompt. Если указаны оба параметра, то по умолчанию для текстурирования модели будет использоваться texture_prompt. Текстурирование с помощью текста или изображения будет стоить 10 кредитов за задачу.

Name
should_remesh
Type
boolean
по умолчанию false (Meshy 6 and Meshy 7 models), true (others)
Description
Управляет включением этапа ремешинга. Для получения модели наивысшего качества рекомендуем установить should_remesh в значение false.

Применяется только когда should_remesh = true

Name
topology
Type
string
по умолчанию triangle
Description
Укажите topology генерируемой модели.
Доступные значения:
- quad: Генерировать сетку с преобладанием четырёхугольников.
- triangle: Генерировать децимированную треугольную сетку.
Вывод Smart Topology — только треугольный. Запрос quad вместе с ai_model: meshy-t2 возвращает ошибку.
Name
decimation_mode
Type
integer
Description
Включить адаптивную децимацию, задав уровень числа полигонов. Если установлено, target_polycount игнорируется.
Доступные значения:
- 1: Адаптивный — ультра число полигонов.
- 2: Адаптивный — высокое число полигонов.
- 3: Адаптивный — среднее число полигонов.
- 4: Адаптивный — низкое число полигонов.
Name
save_pre_remeshed_model
Type
boolean
по умолчанию false
Description
Если установлено значение true, Meshy также сохраняет дополнительный файл GLB до завершения этапа ремешинга.

Name
target_polycount
Type
integer
Description
Целевое число полигонов (граней) в результирующей модели. Фактическое число может отличаться от целевого в зависимости от геометрии.
target_polycount действует в двух независимых случаях:
- Ремешинг — с should_remesh: true для модели standard. Сетка подвергается ремешингу (децимации) до приблизительно указанного числа. Диапазон от 100 до 300 000, значение по умолчанию — 30 000. Если задан decimation_mode, он имеет приоритет, и target_polycount игнорируется.
- Smart Topology — с model_type: smart-topology и ai_model: meshy-t2. Модель генерируется сразу с этим числом граней; этап ремешинга не выполняется, и should_remesh не требуется. Диапазон от 100 до 15 000, значение по умолчанию — 4 000.

Name
symmetry_mode
Type
string
⚠ устаревший
по умолчанию auto
Description
Устаревший параметр. Больше не влияет на результат.
Поле symmetry_mode управляет поведением симметрии в процессе генерации модели.
Допустимые значения:
- off: Отключает симметрию.
- auto: Автоматически определяет и применяет симметрию на основе входной геометрии.
- on: Принудительно применяет симметрию при генерации.
Name
pose_mode
Type
string
по умолчанию ""
Description
Укажите режим позы для генерируемой модели.
Доступные значения:
- a-pose: Сгенерировать модель в позе A.
- t-pose: Сгенерировать модель в позе T.
- "" (пустая строка): Без конкретной позы.
Name
is_a_t_pose
Type
boolean
⚠ устаревший
по умолчанию false
Description
Используйте вместо этого pose_mode. Указывает, нужно ли генерировать модель в позе A/T.
Name
surface_mode
Type
string
⚠ устаревший
Description
Больше не влияет на результат. Он выбирал режим генерации модели, который с тех пор был упразднён; используйте вместо этого ai_model.
Допустимые значения: organic и hard; любое другое значение возвращает 400.
Name
image_enhancement
Type
boolean
по умолчанию true
Description
Оптимизирует входное изображение для получения лучших результатов. Установите false, чтобы сохранить точный внешний вид входного изображения без какой-либо стилевой обработки.
Поддерживается только когда ai_model равен meshy-6, meshy-7.1 или latest. Указание этого параметра с meshy-6-lite или с model_type: smart-topology возвращает ошибку.
Name
remove_lighting
Type
boolean
по умолчанию true
Description
Удаляет блики и тени из текстуры базового цвета, создавая более чистый результат, который лучше работает при пользовательских настройках освещения.
Действует только когда ai_model равен meshy-6. meshy-7.1 и latest принимают этот параметр, но игнорируют его. Указание этого параметра с meshy-6-lite или с model_type: smart-topology возвращает ошибку.
Name
moderation
Type
boolean
по умолчанию false
Description
Если установлено значение true, входной контент будет автоматически проверен на наличие потенциально вредоносного содержимого. Если вредоносный контент обнаружен, задача не перейдёт к этапу генерации.
Проверке подвергается контент из параметров image_url, texture_image_url и texture_prompt.
Name
target_formats
Type
string[]
Description
Указывает, какие форматы 3D-файлов включить в результат. Будут сгенерированы и возвращены только запрошенные форматы, что может сократить время выполнения задачи. Если параметр не указан, включаются все поддерживаемые форматы.
Доступные значения: glb, obj, fbx, stl, usdz, 3mf
Если параметр не указан, генерируются все форматы, кроме 3mf. 3mf включается только при явном указании.
Name
auto_size
Type
boolean
по умолчанию false
Description
Если установлено значение true, сервис использует AI-зрение для автоматической оценки реального размера объекта по высоте и соответствующего изменения размера модели. Начало координат по умолчанию будет bottom, если явно не указано origin_at.
Name
alpha_thumbnail
Type
boolean
по умолчанию false
Description
Если установлено значение true, задача дополнительно рендерит версию превью с прозрачным фоном (RGBA) и возвращает её как alpha_thumbnail_url в ответе GET. Существующее поле thumbnail_url остаётся без изменений.
Name
multi_view_thumbnails
Type
boolean
по умолчанию false
Description
Если установлено значение true, задача дополнительно рендерит четыре миниатюры с основных ракурсов (спереди, справа, сзади, слева) и возвращает их в поле thumbnail_urls в ответе GET. Существующее поле thumbnail_url остаётся без изменений и по-прежнему указывает на вид спереди, поэтому существующие клиенты не затрагиваются.
Добавляет примерно 3 секунды к задержке выполнения задачи.

Применяется только когда auto_size = true

Name
origin_at
Type
string
по умолчанию bottom
Description
Положение начала координат при включённом auto_size.
Доступные значения: bottom, center.

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

Свойство result ответа содержит id задачи вновь созданной задачи Изображение в 3D.

Режимы сбоя

Name
400 - Bad Request
Description
Запрос был неприемлем. Частые причины:
- Отсутствует параметр: Должен быть указан либо image_url, либо input_task_id.
- Недопустимая входная задача: input_task_id должен ссылаться на задачу Текст в изображение или Изображение в изображение со статусом SUCCEEDED, которая выдаёт ровно одно изображение.
- Недопустимый формат изображения: Указанный image_url имеет неподдерживаемый формат (.jpg, .jpeg, .png, .webp).
- Недоступный URL: Не удалось скачать image_url (404 или timeout).
- Изображение слишком большое: Изображение image_url или texture_image_url превышает 20 МБ.
- Недопустимый Data URI: Строка base64 некорректна.
- Недопустимое сочетание параметров: enable_pbr поддерживается только когда should_texture равен true.
- Неподдерживаемая модель для low poly: ai_model: "meshy-6-lite" не поддерживает model_type: "lowpoly".
- Неподдерживаемая модель для Ultra: geometry_resolution требует meshy-7.1 или latest.
- Неподдерживаемая модель для параметров изображения: image_enhancement или remove_lighting указаны вместе с ai_model: "meshy-6-lite" или model_type: "smart-topology".
Name
401 - Unauthorized
Description
Ошибка аутентификации. Пожалуйста, проверьте свой API-ключ.
Name
402 - Payment Required
Description
Недостаточно кредитов для выполнения этой задачи.
Name
429 - Too Many Requests
Description
Вы превысили ограничение частоты запросов.

Request

POST

/openapi/v1/image-to-3d

# Simple request with required params
curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -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>"
  }'

# With Ultra 4K geometry, remesh, PBR, and A-pose
curl https://api.meshy.ai/openapi/v1/image-to-3d \
  -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>",
    "ai_model": "meshy-7.1",
    "geometry_resolution": "4k",
    "enable_pbr": true,
    "should_remesh": true,
    "target_polycount": 100000,
    "should_texture": true,
    "pose_mode": "a-pose",
    "target_formats": ["glb"]
  }'

Response

{
  "result": "018a210d-8ba4-705c-b111-1f1776f7f578"
}

GET/openapi/v1/image-to-3d/:id

Получить задачу «Изображение в 3D»

Этот эндпоинт позволяет получить задачу «Изображение в 3D» по действительному id задачи. Обратитесь к разделу Объект задачи «Изображение в 3D», чтобы узнать, какие свойства включены в объект задачи «Изображение в 3D».

Параметры

Name
id
Type
path
Description
Уникальный идентификатор задачи «Изображение в 3D», которую нужно получить.

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

Ответ содержит объект задачи «Изображение в 3D». Подробности см. в разделе Объект задачи «Изображение в 3D».

Request

GET

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {
    "message": ""
  },
  "consumed_credits": 30
}

DELETE/openapi/v1/image-to-3d/:id

Удаление задачи Изображение в 3D

Этот эндпоинт безвозвратно удаляет задачу Изображение в 3D, включая все связанные модели и данные. Это действие необратимо.

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

Name
id
Type
path
Description
ID задачи Изображение в 3D, которую нужно удалить.

Статус задачи

Задача, которая всё ещё находится в статусе PENDING, удаляется, а кредиты, списанные при её создании, возвращаются.

Задачу, которая уже находится в статусе IN_PROGRESS, удалить нельзя: запрос отклоняется с кодом 409 Conflict, и задача продолжает выполняться. Кредиты за задачу, которую воркер уже начал выполнять, не подлежат возврату, поэтому удаление её в процессе выполнения обойдётся вам и в кредиты, и в результат. Дождитесь, пока она перейдёт в статус SUCCEEDED, FAILED или CANCELED, и только затем удаляйте.

Задача в финальном статусе (SUCCEEDED, FAILED или CANCELED) удаляется без возврата кредитов.

Возвращает

Возвращает 200 OK при успехе или 409 Conflict, если задача находится в статусе IN_PROGRESS.

Request

DELETE

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS — the task is left running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}

GET/openapi/v1/image-to-3d

List Image to 3D Tasks

Этот эндпоинт позволяет получить список задач «Изображение в 3D».

Параметры

Необязательные атрибуты

Name
page_num
Type
integer
Description
Номер страницы для пагинации. Начинается со значения по умолчанию 1.
Name
page_size
Type
integer
Description
Ограничение размера страницы. По умолчанию 10 элементов. Максимально допустимое значение — 100 элементов.
Name
sort_by
Type
string
Description
Поле для сортировки. Доступные значения:
- +created_at: Сортировка по времени создания в порядке возрастания.
- -created_at: Сортировка по времени создания в порядке убывания.

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

Возвращает список объектов задачи «Изображение в 3D» с пагинацией.

Request

GET

/openapi/v1/image-to-3d

curl https://api.meshy.ai/openapi/v1/image-to-3d?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "type": "image-to-3d",
    "model_urls": {
      "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
      "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
      "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
      "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
      "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
    },
    "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
    "thumbnail_urls": {
      "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
      "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
      "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
      "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
    },
    "texture_prompt": "",
    "progress": 100,
    "started_at": 1692771667037,
    "created_at": 1692771650657,
    "expires_at": 1692771679037,
    "finished_at": 1692771669037,
    "status": "SUCCEEDED",
    "texture_urls": [
      {
        "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
        "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
        "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
        "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
        "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
      }
    ],
    "preceding_tasks": 0,
    "task_error": {
      "message": ""
    },
    "consumed_credits": 30
  }
]

GET/openapi/v1/image-to-3d/:id/stream

Стриминг задачи Изображение в 3D

Этот эндпоинт передаёт обновления в реальном времени для задачи Изображение в 3D с использованием Server-Sent Events (SSE).

Параметры

Name
id
Type
path
Description
Уникальный идентификатор задачи Изображение в 3D, для которой требуется поток обновлений.

Возвращает

Возвращает поток объектов задачи Изображение в 3D в виде Server-Sent Events.

Для задач со статусом PENDING или IN_PROGRESS поток ответа будет содержать только необходимые поля progress и status.

Request

GET

/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream

curl -N https://api.meshy.ai/openapi/v1/image-to-3d/018a210d-8ba4-705c-b111-1f1776f7f578/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Error event example
event: error
data: {
  "status_code": 404,
  "message": "Task not found"
}

// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "model_urls": {
  "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
  "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
  "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
  "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
  "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
  "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {
    "message": ""
  },
  "consumed_credits": 30
}

Объект задачи Изображение в 3D

Объект задачи «Изображение в 3D» — это рабочая единица, которую Meshy отслеживает для генерации 3D-модели из входного изображения. Объект имеет следующие свойства:

Свойства

Name
id
Type
string
Description
Уникальный идентификатор задачи. Хотя в качестве деталей реализации мы используем k-sortable UUID для идентификаторов задач, вам не следует делать никаких предположений о формате id.
Name
type
Type
string
Description
Тип задачи «Изображение в 3D». Значение — image-to-3d.
Name
model_urls
Type
object
Description
Доступная для скачивания ссылка на файл текстурированной 3D-модели, сгенерированной Meshy. Свойство для формата будет опущено, если формат не был сгенерирован, вместо возврата пустой строки.
- Name
  glb
  Type
  string
  Description
  Доступная для скачивания ссылка на файл GLB.
- Name
  fbx
  Type
  string
  Description
  Доступная для скачивания ссылка на файл FBX.
- Name
  obj
  Type
  string
  Description
  Доступная для скачивания ссылка на файл OBJ.
- Name
  usdz
  Type
  string
  Description
  Доступная для скачивания ссылка на файл USDZ.
- Name
  mtl
  Type
  string
  Description
  Доступная для скачивания ссылка на файл MTL, возвращаемая вместе с экспортом OBJ при наличии текстур.
- Name
  stl
  Type
  string
  Description
  Доступная для скачивания ссылка на файл STL.
- Name
  3mf
  Type
  string
  Description
  Доступная для скачивания ссылка на файл 3MF. Присутствует только если 3mf был запрошен через target_formats.
- Name
  pre_remeshed_glb
  Type
  string
  Description
  Доступная для скачивания ссылка на исходный вывод GLB до ремеша.
  Доступно только если задача была создана с одновременными should_remesh: true и save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Доступная для скачивания ссылка на изображение-миниатюру файла модели. Эквивалентно thumbnail_urls.front, если оно присутствует; сохранено для обратной совместимости.
Name
alpha_thumbnail_url
Type
string
Description
Доступная для скачивания ссылка на версию thumbnail_url с прозрачным фоном (RGBA). Присутствует только если задача была создана с alpha_thumbnail: true и прозрачное превью было успешно отрендерено; в противном случае это поле опускается.
Name
thumbnail_urls
Type
object
Description
Доступные для скачивания ссылки на четыре миниатюры сгенерированной 3D-модели, сделанные с четырёх основных ракурсов. Каждое значение — это подписанная ссылка на PNG-изображение размером 512×512, отрендеренное с теми же материалами и освещением, что и thumbnail_url. Полезно для предварительного просмотра модели с разных ракурсов в пакетных конвейерах без скачивания GLB.
Присутствует только если задача была создана с multi_view_thumbnails: true и достигла статуса SUCCEEDED. Более старые задачи и задачи, созданные без этой опции, не будут включать это поле.
- Name
  front
  Type
  string
  Description
  Вид спереди, поворот на 0° вокруг вертикальной оси (соответствует thumbnail_url).
- Name
  right
  Type
  string
  Description
  Вид справа, поворот на 90°.
- Name
  back
  Type
  string
  Description
  Вид сзади, поворот на 180°.
- Name
  left
  Type
  string
  Description
  Вид слева, поворот на 270°.
Name
texture_prompt
Type
string
Description
Текстовый prompt, который использовался для управления процессом текстурирования.
Name
texture_image_url
Type
string
Description
Доступная для скачивания ссылка на изображение текстуры, которое использовалось для управления процессом текстурирования.
Name
ultra_mode
Type
boolean
⚠ устаревший
Description
Устаревшее; используйте вместо этого geometry_resolution.
Name
geometry_resolution
Type
string
Description
Уровень Ultra, с которым выполнялась задача (2k или 4k); опускается для standard.
Name
progress
Type
integer
Description
Прогресс выполнения задачи. Если задача ещё не началась, это свойство будет равно 0. Как только задача завершится успешно, оно станет равным 100.
Name
started_at
Type
timestamp
Description
Временная метка начала выполнения задачи, в миллисекундах. Если задача ещё не началась, это свойство будет равно 0.
Временная метка представляет собой количество миллисекунд, прошедших с 1 января 1970 года по UTC, в соответствии со стандартом RFC 3339. Например, пятница, 1 сентября 2023 года, 12:00:00 по GMT представляется как 1693569600000. Это применимо ко всем временным меткам в Meshy API.
Name
created_at
Type
timestamp
Description
Временная метка создания задачи, в миллисекундах.
Name
expires_at
Type
timestamp
Description
Временная метка истечения срока действия результата задачи, в миллисекундах.
Name
finished_at
Type
timestamp
Description
Временная метка завершения задачи, в миллисекундах. Если задача ещё не завершена, это свойство будет равно 0.
Name
status
Type
string
Description
Статус задачи. Возможные значения: одно из PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
texture_urls
Type
array
Description
Массив объектов URL текстур, сгенерированных задачей. Обычно он содержит только один объект URL текстуры. Каждый объект URL текстуры имеет следующие свойства:
- Name
  base_color
  Type
  string
  Description
  Доступная для скачивания ссылка на изображение карты базового цвета.
- Name
  metallic
  Type
  string
  Description
  Доступная для скачивания ссылка на изображение карты металличности.
  Если задача создана с enable_pbr: false, это свойство будет опущено.
- Name
  normal
  Type
  string
  Description
  Доступная для скачивания ссылка на изображение карты нормалей.
  Если задача создана с enable_pbr: false, это свойство будет опущено.
- Name
  roughness
  Type
  string
  Description
  Доступная для скачивания ссылка на изображение карты шероховатости.
  Если задача создана с enable_pbr: false, это свойство будет опущено.
- Name
  emission
  Type
  string
  Description
  Доступная для скачивания ссылка на изображение карты эмиссии.
  Если задача создана с enable_pbr: false, или ai_model имеет значение meshy-6-lite, meshy-7.1, meshy-t2 или latest, это свойство будет опущено.
Name
preceding_tasks
Type
integer
Description
Количество предшествующих задач.
Значение этого поля имеет смысл только если статус задачи — PENDING.
Name
task_error
Type
object
Description
Детали ошибки для неудавшихся задач. См. раздел Ошибки для полного описания объекта task_error.
Name
consumed_credits
Type
integer
Description
Количество кредитов, израсходованных этой задачей. Присутствует, если статус задачи — PENDING, IN_PROGRESS или SUCCEEDED. Возвращает 0 для задач со статусом FAILED (кредиты возвращаются при сбое).

Example Image to 3D Task Object

{
  "id": "018a210d-8ba4-705c-b111-1f1776f7f578",
  "type": "image-to-3d",
  "model_urls": {
    "glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.glb?Expires=***",
    "fbx": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.fbx?Expires=***",
    "obj": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.obj?Expires=***",
    "usdz": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.usdz?Expires=***",
    "stl": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/model.stl?Expires=***",
    "pre_remeshed_glb": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/pre_remeshed_model.glb?Expires=***"
  },
  "thumbnail_url": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview.png?Expires=***",
  "thumbnail_urls": {
    "front": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_front.png?Expires=***",
    "right": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_right.png?Expires=***",
    "back": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_back.png?Expires=***",
    "left": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/preview_left.png?Expires=***"
  },
  "texture_prompt": "",
  "texture_image_url": "",
  "progress": 100,
  "started_at": 1692771667037,
  "created_at": 1692771650657,
  "expires_at": 1692771679037,
  "finished_at": 1692771669037,
  "status": "SUCCEEDED",
  "texture_urls": [
    {
      "base_color": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0.png?Expires=***",
      "metallic": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_metallic.png?Expires=XXX",
      "normal": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_normal.png?Expires=XXX",
      "roughness": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_roughness.png?Expires=XXX",
      "emission": "https://assets.meshy.ai/***/tasks/018a210d-8ba4-705c-b111-1f1776f7f578/output/texture_0_emission.png?Expires=XXX"
    }
  ],
  "preceding_tasks": 0,
  "task_error": {
    "message": ""
  },
  "consumed_credits": 30
}