API Мульти-изображение в 3D — это функция, которая позволяет интегрировать возможности Meshy по преобразованию мульти-изображений в 3D в ваше собственное приложение. В этом разделе вы найдете всю необходимую информацию для начала работы с этим API.
Этот эндпоинт позволяет создать новую задачу Мульти-изображение в 3D. Обратитесь к разделу
Объект задачи Мульти-изображение в 3D, чтобы узнать, какие
свойства включены в объект задачи Мульти-изображение в 3D.
Параметры
Требуется только один из параметров input_task_id или image_urls. Если указаны оба, приоритет имеет input_task_id.
Name
input_task_id
Type
string
Обязательный
Description
ID завершённой задачи генерации изображения, чей результат (1-4 изображения) должен быть использован в качестве входных данных. Эта задача должна быть одной из следующих: Текст в изображение, Изображение в изображение, Текст в изображение Мультивид или Изображение в изображение Мультивид. Кроме того, она должна быть выполнена через API и иметь статус SUCCEEDED.
Name
image_urls
Type
array
Обязательный
Description
Предоставьте от 1 до 4 изображений для использования Meshy при создании модели. На данный момент поддерживаются форматы .jpg, .jpeg и .png. Для наилучшего результата все изображения должны показывать один и тот же объект с разных углов.
Есть два способа предоставить каждое изображение:
Публично доступный URL: URL, доступный из публичного интернета.
Data URI: изображение, закодированное в base64 в виде data URI. Пример data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Для meshy-7 (или latest) первое изображение используется как основной (передний) вид. Порядок остальных изображений не важен.
Включает генерацию Ultra для геометрии более высокой точности с более тонкой детализацией поверхности.
Поддерживается только когда ai_model — meshy-7 (или latest).
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-7 и latest не создают карту излучения.
Name
texture_resolution
Type
string
по умолчанию 2k
Description
Разрешение текстуры базового цвета. Одно из значений: 2k (2048×2048), 4k (4096×4096) или 8k (8192×8192). Более высокое разрешение позволяет захватить больше деталей поверхности.
4k и 8k требуют ai_modelmeshy-6, meshy-7 или latest. При 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.
Есть два способа предоставить изображение:
Публично доступный URL: URL, доступный из публичного интернета
Data URI: изображение, закодированное в base64 в виде data URI. Пример data URI: data:image/jpeg;base64,<your base64-encoded image data>
Текстурирование по изображению может работать неоптимально, если между исходным ассетом и загруженным изображением есть существенные различия в геометрии. Только один из параметров texture_image_url или texture_prompt может использоваться для управления процессом текстурирования. Если указаны оба параметра, по умолчанию для текстурирования модели будет использоваться texture_prompt.
Name
texture_image_urls
Type
string[]
Description
Предоставьте от 1 до 4 изображений, показывающих один и тот же объект с разных ракурсов, для управления текстурированием. Первое изображение — основной (передний) вид; порядок остальных ракурсов (слева, сзади, справа) не важен.
Каждый элемент принимает те же форматы, что и texture_image_url (публично доступный URL или base64 data URI, .jpg/.jpeg/.png).
Эти изображения управляют только текстурой и не зависят от image_urls — эти два списка могут содержать разные изображения и разное количество изображений.
Требует ai_modelmeshy-7 или latest. Не может использоваться совместно с texture_image_url или texture_prompt.
Name
should_remesh
Type
boolean
по умолчанию false (meshy-6), true (others)
Description
Управляет включением этапа ремешинга. Для получения модели наивысшего качества рекомендуем установить should_remesh в значение false.
Применяется только когда should_remesh = true
Name
topology
Type
string
по умолчанию triangle
Description
Укажите topology создаваемой модели.
Доступные значения:
quad: создать сетку с преимущественно четырёхугольными полигонами.
triangle: создать децимированную треугольную сетку.
Name
target_polycount
Type
integer
по умолчанию 30,000
Description
Укажите целевое число полигонов в создаваемой модели. Фактическое число полигонов может отличаться от целевого в зависимости от сложности геометрии.
Допустимый диапазон значений зависит от уровня пользователя:
от 100 до 300 000 (включительно)
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
symmetry_mode
Type
string
⚠ устаревший
по умолчанию auto
Description
Устаревшее. Этот параметр больше не влияет на результат.
Поле symmetry_mode управляет поведением симметрии во время процесса генерации модели.
Допустимые значения:
off: отключает симметрию.
auto: автоматически определяет и применяет симметрию на основе входной геометрии.
on: принудительно применяет симметрию при генерации.
Name
pose_mode
Type
string
по умолчанию ""
Description
Укажите mode позы для создаваемой модели.
Доступные значения:
a-pose: сгенерировать модель в позе A.
t-pose: сгенерировать модель в позе T.
"" (пустая строка): без определённой позы.
Name
is_a_t_pose
Type
boolean
⚠ устаревший
по умолчанию false
Description
Используйте вместо этого pose_mode. Определяет, генерировать ли модель в позе A/T.
Name
image_enhancement
Type
boolean
по умолчанию true
Description
Оптимизирует входные изображения для получения лучших результатов. Установите значение false, чтобы сохранить точный внешний вид входных изображений без какой-либо стилевой обработки.
Поддерживается только когда ai_model — meshy-6, meshy-7 или latest.
Name
remove_lighting
Type
boolean
по умолчанию true
Description
Убирает подсветки и тени с текстуры базового цвета, обеспечивая более чистый результат, который лучше работает при пользовательских настройках освещения.
Поддерживается только когда ai_model — meshy-6, meshy-7 или latest.
Name
moderation
Type
boolean
по умолчанию false
Description
Если установлено значение true, входной контент будет автоматически проверен на наличие потенциально опасного содержимого. При обнаружении опасного содержимого задача не перейдёт к генерации.
Будут проверены каждое изображение из image_urls и текст из 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_urls, либо input_task_id.
Недопустимая входная задача: input_task_id должен ссылаться на задачу Текст в изображение, Изображение в изображение или вариант Мультивид со статусом SUCCEEDED.
Недопустимое количество изображений: image_urls должен содержать от 1 до 4 изображений, а texture_image_urls — от 1 до 4.
Недопустимый формат изображения: одно или несколько изображений в image_urls имеют неподдерживаемый формат.
Конфликтующие входные данные текстуры: texture_image_urls не может использоваться совместно с texture_image_url или texture_prompt и требует should_texture: true.
Неподдерживаемая модель для мультивидовой текстуры: texture_image_urls требует ai_modelmeshy-7 или latest.
Недоступный URL: один или несколько элементов image_urls или texture_image_urls не удалось загрузить.
Name
401 - Unauthorized
Description
Ошибка аутентификации. Пожалуйста, проверьте свой API-ключ.
Name
402 - Payment Required
Description
Недостаточно кредитов для выполнения этой задачи.
Name
429 - Too Many Requests
Description
Вы превысили ограничение частоты запросов.
Request
POST
/openapi/v1/multi-image-to-3d
# Simple requestcurlhttps://api.meshy.ai/openapi/v1/multi-image-to-3d \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_urls": [ "<your publicly accessible image url or base64-encoded data URI>", "<your second publicly accessible image url or base64-encoded data URI>" ] }'# With PBR texturing and GLB formatcurlhttps://api.meshy.ai/openapi/v1/multi-image-to-3d \-XPOST \-H"Authorization: Bearer ${YOUR_API_KEY}" \-H'Content-Type: application/json' \-d'{ "image_urls": [ "<your publicly accessible image url or base64-encoded data URI>", "<your second publicly accessible image url or base64-encoded data URI>" ], "should_texture": true, "enable_pbr": true, "target_formats": ["glb"] }'
Этот эндпоинт позволяет получить задачу Мульти-изображение в 3D, используя действительный id задачи.
Обратитесь к Объект задачи Мульти-изображение в 3D, чтобы увидеть,
какие свойства включены в объект задачи Мульти-изображение в 3D.
Параметры
Name
id
Type
path
Description
Уникальный идентификатор задачи Мульти-изображение в 3D для получения.
Объект задачи Мульти-изображение в 3D — это рабочая единица, которую Meshy отслеживает для генерации 3D-модели из нескольких изображений (от 1 до 4 включительно). Изображения должны относиться к одному и тому же объекту, в идеале с разных ракурсов или под разными углами.
Объект имеет следующие свойства:
Свойства
Name
id
Type
string
Description
Уникальный идентификатор задачи. Хотя в качестве деталей реализации мы используем k-sortable UUID для идентификаторов задач, вам не следует делать никаких предположений о формате id.
Name
type
Type
string
Description
Тип задачи Мульти-изображение в 3D. Значение — multi-image-to-3d.
Name
model_urls
Type
object
Description
Скачиваемый URL текстурированного файла 3D-модели, сгенерированного Meshy. Свойство для формата будет опущено, если формат не был сгенерирован, вместо возврата пустой строки.
Name
glb
Type
string
Description
Скачиваемый URL файла GLB.
Name
fbx
Type
string
Description
Скачиваемый URL файла FBX.
Name
obj
Type
string
Description
Скачиваемый URL файла OBJ.
Name
usdz
Type
string
Description
Скачиваемый URL файла USDZ.
Name
mtl
Type
string
Description
Скачиваемый URL файла MTL, возвращаемого вместе с экспортом OBJ при наличии текстур.
Name
stl
Type
string
Description
Скачиваемый URL файла STL.
Name
3mf
Type
string
Description
Скачиваемый URL файла 3MF. Присутствует только в том случае, если 3mf был запрошен через target_formats.
Name
pre_remeshed_glb
Type
string
Description
Скачиваемый URL исходного вывода GLB до выполнения reмеша.
Доступно только в том случае, если задача была создана с одновременным should_remesh: true и save_pre_remeshed_model: true.
Name
thumbnail_url
Type
string
Description
Скачиваемый URL миниатюры файла модели. Эквивалентен thumbnail_urls.front, если присутствует, сохранён для обратной совместимости.
Name
alpha_thumbnail_url
Type
string
Description
Скачиваемый URL версии thumbnail_url с прозрачным фоном (RGBA). Присутствует только в том случае, если задача была создана с alpha_thumbnail: true и прозрачное превью было успешно отрендерено; в противном случае это поле опускается.
Name
thumbnail_urls
Type
object
Description
Скачиваемые URL для четырёх миниатюр сгенерированной 3D-модели с видами по сторонам света. Каждое значение — это подписанный URL 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_urls
Type
string[]
Description
Скачиваемые URL референсных изображений текстуры, использованных при создании задачи, в порядке их предоставления. Присутствует только в том случае, если задача была создана с texture_image_urls.
Name
ultra_mode
Type
boolean
Description
Отражает значение ultra_mode, с которым была создана задача. Присутствует только для задач meshy-7 (или latest), в которых явно задано ultra_mode; в противном случае опускается.
Name
progress
Type
integer
Description
Прогресс выполнения задачи. Если задача ещё не начата, это свойство будет равно 0. После успешного завершения задачи оно станет равно 100.
Name
started_at
Type
timestamp
Description
Временная метка начала выполнения задачи, в миллисекундах. Если задача ещё не начата, это свойство будет равно 0.
Временная метка представляет собой количество миллисекунд, прошедших с 1 января 1970 года UTC, согласно
стандарту RFC 3339. Например, пятница, 1 сентября 2023 года, 12:00:00 по Гринвичу представлена как 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
Скачиваемый URL изображения карты базового цвета.
Name
metallic
Type
string
Description
Скачиваемый URL изображения карты металличности.
Если задача создана с enable_pbr: false, это свойство будет опущено.
Name
normal
Type
string
Description
Скачиваемый URL изображения карты нормалей.
Если задача создана с enable_pbr: false, это свойство будет опущено.
Name
roughness
Type
string
Description
Скачиваемый URL изображения карты шероховатости.
Если задача создана с enable_pbr: false, это свойство будет опущено.
Name
emission
Type
string
Description
Скачиваемый URL изображения карты свечения.
Если задача создана с enable_pbr: false или ai_model равен meshy-5, это свойство будет опущено.
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 (при неудаче кредиты возвращаются).