API лампы Creative Lab

Фото, на основе которого создаётся абажур, в виде публичного URL или data URI (data:image/jpeg;base64,<закодированные в base64 данные вашего изображения>).

Изображение должно быть файлом JPG, JPEG, PNG или WebP размером не более 20 МБ.

Тип объекта на фото, который определяет, как Meshy его стилизует.

Доступные значения:

• character: отдельный персонаж или объект, например фигурка, животное или маскот
• landscape: внешняя сцена или панорама, например гора, городской пейзаж или лес

Название задачи, до 100 символов. Оно возвращается в поле name задачи. Более длинное название возвращает 400.

Удалять ли фон с изображения прототипа. true возвращает прозрачный PNG в формате RGBA, чтобы вы могли разместить объект на любом фоне. Meshy также строит 3D-модель по изображению без фона. Если Meshy не удаётся удалить фон, используется изображение с фоном, и задача всё равно завершается успешно.

Запрос не может быть выполнен. Например:

• Отсутствует image_url.
• Изображение не является файлом JPG, JPEG, PNG или WebP.
• Изображение слишком маленькое, превышает 20 МБ или превышает максимальное количество пикселей.
• Meshy не может загрузить изображение, например потому что URL возвращает 404 или истекает время ожидания.
• Data URI не является корректным base64.
• Изображение было помечено как NSFW.
• image_subject не равен character или landscape.

В сообщении об ошибке указано, какая именно проблема обнаружена. Исправьте запрос и отправьте его снова.

API-ключ отсутствует или недействителен. Проверьте заголовок Authorization.

Применимо одно из следующего:

• На счёте недостаточно кредитов.
• API-ключ, рабочая область или участник достигли лимита кредитов.
• Аккаунт использует бесплатный план.

Проверьте кредиты и план, затем повторите попытку.

В вашей команде включена функция IP Filtering, и Meshy пометил изображение как содержащее стороннюю интеллектуальную собственность. Отправьте изображение, на использование которого у вас есть права.

Достигнут один из следующих лимитов:

• Вы отправили больше запросов, чем допускает ваше ограничение частоты. Подождите несколько секунд, затем повторите попытку. См. Ограничения частоты.
• Слишком много ваших задач находится в очереди или выполняется. Дождитесь завершения некоторых из них, затем повторите попытку.
• На безлимитном плане без оставшихся кредитов вы достигли максимального количества задач, которые могут выполняться без кредитов. Дождитесь завершения задачи или пополните кредиты.

В Meshy произошла ошибка сервера, например из-за невозможности выполнить проверку изображения на интеллектуальную собственность. Meshy не создаёт задачу и возвращает любые списанные кредиты. Повторите запрос.

ID задачи-прототипа для сборки. Это должна быть задача, созданная вашим аккаунтом через POST /openapi/creative-lab/lamp/v1/prototype, со статусом SUCCEEDED.

ID, который не соответствует ни одной из ваших задач-прототипов лампы через API, возвращает 404, включая прототипы, созданные в веб-приложении.

Название задачи, до 100 символов. Возвращается в поле name задачи. Более длинное название приводит к ошибке 400.

Размер наибольшего измерения абажура в миллиметрах, от 50 до 400. Meshy равномерно масштабирует модель, чтобы она соответствовала этому размеру. 0 использует значение по умолчанию, а любое другое значение вне диапазона возвращает 400.

Толщина стенки абажура в миллиметрах, до 10. 0 использует значение по умолчанию, а отрицательное значение или значение больше 10 возвращает 400.

Процент высоты модели, который нужно срезать плоско снизу, от 1 до 100. Плоское дно позволяет абажуру стоять на столе принтера и оставляет место для крепления. Значение вне диапазона возвращает 400.

Пресет светильника, который определяет, как Meshy строит нижнюю часть.

Доступные значения:

• bambu_mh001_60mm: абажур с открытым дном и базовой пластиной с отверстием для крепления диаметром 60 мм, оба — в model_urls.lamp_stl, а крепление — в model_urls.base_stl
• none: единый герметичный абажур в model_urls.lamp_stl, без model_urls.base_stl

Насколько сместить отверстие крепления вдоль оси X от центра абажура, в миллиметрах, от -80 до 80. Применяется только если light_source_preset не равен none.

Насколько сместить отверстие крепления вдоль оси Z (по глубине) от центра абажура, в миллиметрах, от -80 до 80. Применяется только если light_source_preset не равен none.

Поворот вокруг оси X, применяемый к модели перед обработкой в Meshy, в градусах, от -360 до 360. Meshy применяет три поворота как углы Эйлера XYZ относительно центра модели.

Поворот вокруг оси Y, применяемый к модели перед обработкой в Meshy, в градусах, от -360 до 360.

Поворот вокруг оси Z, применяемый к модели перед обработкой в Meshy, в градусах, от -360 до 360.

Добавлять ли файл result.json в zip-архив с названием выполненного пайплайна, предупреждениями и путями к файлам. Требует, чтобы output.format был установлен в zip. Значение true вместе с stl возвращает 400.

Файлы, которые возвращает сборка.

Доступные значения:

• stl: model_urls.lamp_stl — абажур с базовой пластиной, если указан пресет крепления, и model_urls.base_stl, если light_source_preset не равен none
• zip: один zip-файл в model_urls.bundle_zip, содержащий lamp.stl, а также base.stl и result.json, если они применимы

Запрос не может быть выполнен. Например:

• input_task_id отсутствует или не является действительным ID задачи.
• Статус задачи-прототипа не SUCCEEDED. Если она всё ещё выполняется, подождите и повторите попытку. Если она завершилась неудачей или была отменена, создайте новую задачу-прототип.
• Задача-прототип завершилась успешно, но не содержит 3D-модели. Создайте новую задачу-прототип.
• Поле options выходит за допустимый диапазон или содержит недопустимое значение.
• output.format не равен stl или zip, либо include_result_json установлен в true без zip.

В сообщении об ошибке указывается, какая именно проблема обнаружена.

API-ключ отсутствует или недействителен. Проверьте заголовок Authorization.

Применимо одно из следующего:

• На аккаунте недостаточно кредитов.
• API-ключ, рабочая область или участник достигли лимита кредитов.
• Аккаунт использует бесплатный план.

Проверьте свои кредиты и план, затем повторите попытку.

input_task_id не соответствует ни одной задаче-прототипу лампы, созданной вашим аккаунтом через API. Прототип, созданный в веб-приложении, также возвращает 404. Отправьте ID из поля result ответа на создание прототипа.

Достигнут один из следующих лимитов:

• Вы отправили больше запросов, чем допускает ваше ограничение частоты. Подождите несколько секунд, затем повторите попытку. См. Ограничения частоты.
• Слишком много ваших задач находится в очереди или выполняется. Дождитесь завершения некоторых из них, затем повторите попытку.
• На безлимитном плане без оставшихся кредитов вы достигли количества задач, которые могут выполняться без кредитов. Дождитесь завершения задачи или добавьте кредиты.

ID задачи из ответа при создании.

id не является допустимым ID задачи. Отправьте ID result из ответа при создании.

В вашей команде включена функция IP Filtering, и Meshy пометила изображение задачи прототипа как нарушающее права интеллектуальной собственности третьих лиц. Для задач сборки и команд на плане Enterprise эта ошибка не возникает. Создайте задачу прототипа на основе изображения, права на использование которого принадлежат вам.

Задача Lamp с таким ID не принадлежит вашему аккаунту, либо стадия задачи не соответствует указанному пути. Проверьте ID и используйте /prototype или /build в соответствии с задачей.

Meshy не удалось выполнить проверку интеллектуальной собственности. Повторите запрос.

ID задачи, которую нужно отменить.

Применимо одно из следующего:

• id не является допустимым ID задачи. Отправьте ID result из ответа на создание задачи.
• Задача уже имеет финальный статус (SUCCEEDED, FAILED или CANCELED), поэтому её нельзя отменить.

Задача Lamp с таким ID не принадлежит вашему аккаунту, либо этап задачи не соответствует указанному пути. Проверьте ID и используйте /prototype или /build в соответствии с этапом задачи.

ID задачи из ответа на создание.

Этап для вывода списка, prototype или build.

Страница для возврата, от 1 до 255. 0 возвращает первую страницу. Значение вне диапазона от 0 до 255 возвращает 400.

Количество задач на странице, до 100. Значение от 101 до 255 возвращает 100 задач, а 0 использует значение по умолчанию. Значение вне диапазона от 0 до 255 возвращает 400.

Порядок сортировки.

Доступные значения:

• -created_at: сначала новые
• +created_at: сначала старые

ID задачи. Не полагайтесь на его формат.

Тип задачи, всегда creative-lab-lamp-prototype.

Значение name, отправленное вами при создании задачи, или "", если вы его не отправляли.

Статус задачи.

Доступные значения:

• PENDING: ожидание в очереди
• IN_PROGRESS: генерация результата
• SUCCEEDED: завершено, с результатом
• FAILED: завершено, с причиной в task_error
• CANCELED: завершено, без результата

Процент выполненной работы, от 0 до 100. Равен 0, пока задача не началась, и 100, когда она завершена успешно.

Время создания задачи, в миллисекундах Unix.

Время, когда воркер начал выполнение задачи, в миллисекундах Unix. До этого момента — null.

Время, когда задача достигла финального статуса, в миллисекундах Unix. До этого момента — null.

Время истечения срока действия результата задачи, в миллисекундах Unix. Это 3 дня после finished_at, либо 3 дня после created_at, пока задача не завершена. Для аккаунтов Enterprise, которые хранят результаты API бессрочно, это примерно на 100 лет позже. См. Хранение ресурсов.

Позиция задачи в очереди, пока она находится в статусе PENDING. 1 означает, что она будет следующей. 0 после того, как задача покидает очередь, и всегда 0 в результатах списка.

Причина сбоя задачи. null, если status не равен FAILED. См. Ошибки.

Количество кредитов, списанных за задачу, с учётом любого возврата. Запрос, вернувший ошибку, не оплачивается. Для неудачной задачи значение равно 0, так как Meshy возвращает кредиты. Отмена возвращает кредиты за задачу только пока она находится в статусе PENDING. Если Meshy не может определить сумму списания, в ответе на get-запрос или стрим это поле отсутствует, а запрос списка возвращает 500. В этом случае повторите запрос.

URL-адреса для скачивания 3D-модели, сгенерированной из концептуального изображения. {}, пока задача не завершена успешно.

URL-адрес для скачивания изображения-превью 3D-модели. "", пока задача не завершена успешно.

URL-адреса для скачивания концептуального изображения. После успешного завершения задачи массив содержит один URL, до этого момента он пуст.

ID задачи. Не полагайтесь на его формат.

Тип задачи, всегда creative-lab-lamp-build.

Значение name, отправленное вами при создании задачи, или "", если вы его не отправляли.

Статус задачи.

Доступные значения:

• PENDING: ожидание в очереди
• IN_PROGRESS: генерация результата
• SUCCEEDED: финальный статус, с результатом
• FAILED: финальный статус, с указанием причины в task_error
• CANCELED: финальный статус, без результата

Процент выполненной работы, от 0 до 100. Равен 0, пока задача не началась, и 100, когда она успешно завершена.

Время создания задачи, в миллисекундах Unix.

Время начала выполнения задачи воркером, в миллисекундах Unix. До этого момента — null.

Время достижения задачей финального статуса, в миллисекундах Unix. До этого момента — null.

Время истечения срока действия результата задачи, в миллисекундах Unix. Это значение равно finished_at плюс 3 дня, либо created_at плюс 3 дня, пока задача не завершена. Для аккаунтов Enterprise, которые хранят результаты API бессрочно, это значение — примерно на 100 лет позже. См. Хранение ресурсов.

Позиция задачи в очереди, пока она имеет статус PENDING. 1 означает, что она будет выполнена следующей. После выхода задачи из очереди значение равно 0, и в результатах списков оно всегда равно 0.

Причина сбоя задачи. Равно null, если status не равен FAILED. См. Ошибки.

Количество кредитов, списанных за задачу, с учётом любого возврата. Запрос, вернувший ошибку, не оплачивается. Для неудавшейся задачи значение равно 0, так как Meshy возвращает кредиты. Отмена задачи приводит к возврату кредитов только пока она находится в статусе PENDING. Если Meshy не может прочитать информацию о списании, в ответе на get-запрос или в потоковом ответе это поле отсутствует, а запрос списка возвращает 500. В этом случае повторите запрос.

URL-адреса для скачивания печатаемых файлов. Набор ключей зависит от output.format и options.light_source_preset.