lowpoly будет отключён 30 окт. 2026 г.. Перейдите на другую модель до этих дат, чтобы избежать ошибок в запросах.
Multi-Image to 3D API
Multi-Image to 3D API — это функция, которая позволяет вам интегрировать возможности 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 и .webp. Для наилучшего результата все изображения должны изображать один и тот же объект с разных ракурсов.
Максимальный размер файла: 20 МБ на изображение.
Есть два способа предоставить каждое изображение:
Общедоступный URL: URL, доступный из публичного интернета.
Data URI: закодированный в base64 data URI изображения. Пример data URI: data:image/jpeg;base64,<ваши закодированные в base64 данные изображения>.
Для meshy-7.1 (или latest) первое изображение используется как основной (фронтальный) вид. Порядок остальных изображений не имеет значения.
meshy-7 (устаревшее): используйте вместо неё meshy-7.1.
Name
geometry_resolution
Type
string
по умолчанию standard
Description
Этап генерации геометрии. 2k запускает Ultra-проход с разрешением 2048³. Требует meshy-7.1 или latest.
Доступные значения: standard, 2k
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-карты (metallic, roughness, normal) в дополнение к базовому цвету. Карта эмиссии также включается, когда ai_model имеет значение meshy-6, за исключением случая texture_resolution: 8k. meshy-6-lite, meshy-7.1 и latest не создают карту эмиссии.
Name
texture_resolution
Type
string
по умолчанию 2k
Description
Разрешение текстуры базового цвета. Одно из значений: 2k (2048×2048), 4k (4096×4096) или 8k (8192×8192). Более высокое разрешение позволяет передать больше деталей поверхности.
4k и 8k требуют, чтобы ai_model имел значение meshy-6, meshy-7.1 или 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 и .webp.
Максимальный размер файла: 20 МБ.
Есть два способа предоставить изображение:
Общедоступный URL: URL, доступный из публичного интернета
Data URI: закодированный в base64 data URI изображения. Пример data URI: data:image/jpeg;base64,<ваши закодированные в base64 данные изображения>
Текстурирование по изображению может работать неоптимально при значительных различиях геометрии между исходным ассетом и загруженным изображением. Для управления процессом текстурирования можно использовать только один из параметров: 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/.webp).
Максимальный размер файла: 20 МБ на изображение.
Эти изображения управляют только текстурированием и не зависят от image_urls — оба списка могут содержать разные изображения и разное количество изображений.
Требует, чтобы ai_model имел значение meshy-7.1 или latest. Нельзя комбинировать с texture_image_url или texture_prompt.
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: сгенерировать сетку с преобладанием четырёхугольников.
Укажите целевое число полигонов в сгенерированной модели. Фактическое число полигонов может отличаться от целевого в зависимости от сложности геометрии.
Допустимый диапазон: от 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
Укажите режим позы для сгенерированной модели.
Доступные значения:
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.1 или latest. Указание этого параметра с meshy-6-lite возвращает ошибку.
Name
remove_lighting
Type
boolean
по умолчанию true
Description
Удаляет блики и тени с текстуры базового цвета, что даёт более чистый результат, лучше подходящий для использования с пользовательскими настройками освещения.
Поддерживается только если ai_model имеет значение meshy-6, meshy-7.1 или latest. Указание этого параметра с meshy-6-lite возвращает ошибку.
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_model имел значение meshy-7.1 или latest.
Недоступный URL: один или несколько элементов image_urls или texture_image_urls не удалось загрузить.
Слишком большое изображение: одно или несколько изображений в image_urls, texture_image_url или texture_image_urls превышают 20 МБ.
Неподдерживаемое разрешение для мульти-изображения: geometry_resolution: "4k" недоступно для этого эндпоинта; используйте 2k или standard.
Неподдерживаемая модель для параметров изображения: image_enhancement или remove_lighting задан вместе с ai_model: "meshy-6-lite".
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 Ultra 2K geometry, 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>" ], "ai_model": "meshy-7.1", "geometry_resolution": "2k", "should_texture": true, "enable_pbr": true, "target_formats": ["glb"] }'
Этот эндпоинт позволяет получить задачу Мульти-изображение в 3D по указанному действительному id задачи.
Обратитесь к разделу Объект задачи Мульти-изображение в 3D, чтобы узнать, какие
свойства включены в объект задачи Мульти-изображение в 3D.
Параметры
Name
id
Type
path
Description
Уникальный идентификатор задачи Мульти-изображение в 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.
// 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."}
Объект задачи Мульти-изображение в 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 до операции 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
texture_image_urls
Type
string[]
Description
Загружаемые URL для референсных изображений текстуры, которые использовались при создании задачи, в порядке их предоставления. Присутствует только если задача была создана с texture_image_urls.
Name
ultra_mode
Type
boolean
⚠ устаревший
Description
Устаревшее; используйте вместо этого geometry_resolution.
Name
geometry_resolution
Type
string
Description
Уровень Ultra, с которым выполнялась задача (2k); опускается для 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 по Гринвичу представляется как 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-6-lite, meshy-7.1, или 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 (кредиты возвращаются при неудаче).