lowpoly буде вимкнено 30 жовт. 2026 р.. Перейдіть на іншу модель до цих дат, щоб уникнути помилок у запитах.
Multi-Image to 3D API
Multi-Image to 3D API — це функція, яка дозволяє інтегрувати можливості Mульти-зображення у 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 та .webp. Для найкращих результатів усі зображення мають зображувати один і той самий об'єкт під різними кутами.
Максимальний розмір файлу: 20 МБ на зображення.
Існує два способи надання кожного зображення:
Загальнодоступне URL: URL, доступний із загального інтернету.
Data URI: закодований у base64 data URI зображення. Приклад data URI: data:image/jpeg;base64,<your base64-encoded image data>.
Для 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-карти (металевість, шорсткість, нормалі) на додаток до базового кольору. Карта випромінювання (emission map) також включається, коли 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,<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/.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: Генерувати сітку з переважанням чотирикутників.
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
Вкажіть режим пози для створеної моделі.
Доступні значення:
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 vision для автоматичної оцінки реальної висоти об'єкта та відповідної зміни розміру моделі. Початок координат за замовчуванням матиме значення 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 завдання.
Зверніться до The Multi-Image to 3D Task Object, щоб побачити, які
властивості включені в об'єкт завдання Мульти-зображення у 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-сортований UUID як деталь реалізації, вам не слід робити жодних припущень щодо формату id.
Name
type
Type
string
Description
Тип завдання Мульти-зображення у 3D. Значення — multi-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_urls
Type
string[]
Description
Посилання для завантаження еталонних зображень текстур, які використовувалися для створення завдання, у порядку, в якому вони були надані. Присутнє лише тоді, коли завдання було створене з texture_image_urls.
Рівень 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 за 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
Масив об'єктів посилань на текстури, згенерованих завданням. Зазвичай він містить лише один об'єкт посилання на текстуру. Кожне посилання на текстуру має такі властивості:
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 чи 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 (кредити повертаються у разі невдачі).