API Мульти-изображение в 3D — это функция, которая позволяет интегрировать возможности Мульти-изображение в 3D от Meshy в ваше собственное приложение. В этом разделе вы найдете всю информацию,
необходимую для начала работы с этим 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: Data URI изображения, закодированный в base64. Пример Data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Name
ai_model
Type
string
по умолчанию latest
Description
ID модели для использования. Доступные значения: meshy-5, meshy-6, latest (Meshy 6).
Name
should_texture
Type
boolean
по умолчанию true
Description
Определяет, генерируются ли текстуры. Установка значения false пропускает фазу текстурирования, предоставляя сетку без текстур.
Применяется только когда should_texture = true
Name
enable_pbr
Type
boolean
по умолчанию false
Description
Генерировать PBR-карты (metallic, roughness, normal) в дополнение к базовому цвету. Карта эмиссии также включается, когда ai_model равен meshy-6 или latest.
Name
hd_texture
Type
boolean
по умолчанию false
Description
Генерировать текстуру базового цвета в разрешении 4K (4096×4096) для более высокой детализации.
Поддерживается только когда ai_model равен meshy-6 или latest. PBR-карты всегда генерируются в 2K.
Name
texture_prompt
Type
string
Description
Предоставьте текстовый prompt для управления процессом текстурирования. Максимум 600 символов.
Name
texture_image_url
Type
string
Description
Предоставьте 2D-изображение для управления процессом текстурирования. В настоящее время мы поддерживаем форматы .jpg, .jpeg и .png.
Есть два способа предоставить изображение:
Публично доступный URL: URL, доступный из публичного интернета
Data URI: Data URI изображения, закодированный в base64. Пример Data URI: data:image/jpeg;base64,<your base64-encoded image data>
Текстурирование по изображению может работать неоптимально, если между исходным ассетом и загруженным изображением есть существенные различия в геометрии. Для управления процессом текстурирования можно использовать только одно из texture_image_url или texture_prompt. Если предоставлены оба параметра, то по умолчанию для текстурирования модели будет использоваться texture_prompt.
Name
should_remesh
Type
boolean
по умолчанию false (meshy-6), true (others)
Description
Управляет включением фазы ремешинга. При значении false API возвращает треугольную сетку с максимальной точностью.
Применяется только когда should_remesh = true
Name
topology
Type
string
по умолчанию triangle
Description
Укажите topology сгенерированной модели.
Доступные значения:
quad: Генерировать сетку с преобладанием четырехугольников.
Укажите целевое число полигонов в сгенерированной модели. Фактическое число полигонов может отклоняться от целевого в зависимости от сложности геометрии.
Допустимый диапазон значений зависит от уровня пользователя:
От 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
Укажите pose_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 или latest.
Name
remove_lighting
Type
boolean
по умолчанию true
Description
Удаляет блики и тени из текстуры базового цвета, создавая более чистый результат, который лучше работает с пользовательскими настройками освещения.
Поддерживается только когда ai_model равен meshy-6 или 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 изображений.
Недопустимый формат изображения: Одно или несколько изображений в image_urls имеют неподдерживаемые форматы.
Недоступный URL: Одно или несколько 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 requestcurl https://api.meshy.ai/openapi/v1/multi-image-to-3d \ -X POST \ -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 formatcurl https://api.meshy.ai/openapi/v1/multi-image-to-3d \ -X POST \ -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-сортируемый 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 до remesh.
Доступно только когда задача была создана с 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
progress
Type
integer
Description
progress задачи. Если задача еще не запущена, это свойство будет 0. После успешного выполнения задачи оно станет 100.
Name
started_at
Type
timestamp
Description
Временная метка момента запуска задачи, в миллисекундах. Если задача еще не запущена, это свойство будет 0.
Временная метка представляет количество миллисекунд, прошедших с 1 января 1970 года UTC, в соответствии со
стандартом RFC 3339.
Например, пятница, 1 сентября 2023 г., 12:00:00 PM 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
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 (кредиты возвращаются при сбое).