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>
Текстурування зображенням може працювати не оптимально, якщо між оригінальним asset і завантаженим зображенням є суттєві відмінності геометрії. Для керування процесом текстурування можна використовувати лише один із 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: Генерує сітку з переважанням чотирикутників.
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 або 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 для завантаження зображення metallic map.
Якщо завдання створено з enable_pbr: false, цю властивість буде пропущено.
Name
normal
Type
string
Description
URL для завантаження зображення карти нормалей.
Якщо завдання створено з enable_pbr: false, цю властивість буде пропущено.
Name
roughness
Type
string
Description
URL для завантаження зображення roughness map.
Якщо завдання створено з enable_pbr: false, цю властивість буде пропущено.
Name
emission
Type
string
Description
URL для завантаження зображення emission map.
Якщо завдання створено з 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 (кредити повертаються в разі збою).