Creative Lab — API лампы

Исходное фото, которое Meshy использует в качестве визуального референса для абажура. В настоящее время поддерживаются форматы .jpg, .jpeg, .png и .webp.

Есть два способа предоставить изображение:

• Публично доступный URL: URL, доступный из публичного интернета.
• Data URI: закодированный в base64 data URI изображения. Пример data URI: data:image/jpeg;base64,<your base64-encoded image data>.

Подсказка категории объекта, которая выбирает prompt стилизации. Доступные значения:

• character (по умолчанию) — одиночный персонаж/объект (фигурка, животное, талисман и т.д.).
• landscape — уличная сцена/панорама (гора, городской пейзаж, лес и т.д.).

Необязательное название задачи для отображения. Максимум 100 символов.

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

Запрос был некорректным. Распространённые причины:

• Отсутствует параметр: требуется image_url.
• Недопустимый формат изображения: указанный image_url не соответствует поддерживаемому формату (.jpg, .jpeg, .png, .webp).
• Размеры изображения вне допустимого диапазона: изображение слишком маленькое, превышает максимальный размер файла или превышает максимальное количество пикселей.
• Недоступный URL: не удалось загрузить image_url (404 или timeout).
• Недопустимый Data URI: строка base64 некорректно сформирована.
• Контент отмечен модерацией: входное изображение было отмечено модерацией NSFW или модерацией интеллектуальной собственности.
• Недопустимое значение image_subject: не является одним из character / landscape.

Ошибка аутентификации. Пожалуйста, проверьте ваш API-ключ.

Недостаточно кредитов для выполнения этой задачи.

Вы превысили ограничение частоты запросов.

ID задачи прототипа, созданной через этот же эндпоинт OpenAPI. Прототип должен быть создан с тем же API-ключом, должен достичь статуса SUCCEEDED и должен был создать 3D-модель.

Задачи прототипов, созданные через веб-приложение, не принимаются — эндпоинт сборки принимает только задачи прототипов, созданные через POST /openapi/creative-lab/lamp/v1/prototype, и отклоняет любой другой источник с кодом 404.

Необязательное название задачи для отображения. Максимум 100 символов.

Целевой максимальный размер ограничивающего параллелепипеда абажура, в миллиметрах. Сетка равномерно масштабируется, чтобы соответствовать этому значению. Диапазон: [50, 400].

Толщина стенки полого абажура, в миллиметрах. Диапазон: (0, 10].

Процент высоты модели, срезаемый ровно снизу, чтобы абажур устойчиво стоял на печатной платформе и имел отверстие для крепления. Диапазон: [1, 100].

Пресет крепления источника света, определяющий способ построения нижней части. Доступные значения:

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

Смещение отверстия крепления на базовой пластине по оси X относительно центра абажура, в миллиметрах. Имеет значение только когда light_source_preset ≠ none. Диапазон: [-80, 80].

Смещение отверстия крепления на базовой пластине по оси Z (глубина) относительно центра абажура, в миллиметрах. Имеет значение только когда light_source_preset ≠ none. Диапазон: [-80, 80].

Поворот вокруг оси X, применяемый к модели перед обработкой, в градусах. Три поворота применяются как углы Эйлера XYZ относительно центра модели. Диапазон: [-360, 360].

Поворот вокруг оси Y, применяемый к импортированной сетке перед обработкой, в градусах. Диапазон: [-360, 360].

Поворот вокруг оси Z, применяемый к импортированной сетке перед обработкой, в градусах. Диапазон: [-360, 360].

Если true и output.format равен zip, включает файл result.json процессора лампы (название конвейера, предупреждения и пути к артефактам) внутрь пакета. Игнорируется, если output.format равен stl.

Пакет артефактов, возвращаемый сборкой. Доступные значения:

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

Запрос был некорректен. Распространённые причины:

• Отсутствует параметр: input_task_id обязателен.
• Недопустимый UUID: input_task_id не является допустимым UUID.
• Родительская задача не завершена успешно: указанная задача прототипа ещё не достигла статуса SUCCEEDED.
• Нет модели: задача прототипа завершилась успешно, но не создала 3D-модель.
• Параметры вне диапазона: одно из полей options вышло за пределы допустимого диапазона или набора значений.

Ошибка аутентификации. Пожалуйста, проверьте ваш API-ключ.

Недостаточно кредитов для выполнения этой задачи.

Указанная задача прототипа не существует, принадлежит другому пользователю или была создана через веб-приложение (в цепочку сборки могут входить только задачи прототипов, созданные в режиме API).

Вы превысили ограничение частоты.

Уникальный идентификатор задачи lamp для получения.

Уникальный идентификатор задачи лампы, которую нужно отменить.

Задача уже находится в конечном состоянии и не может быть отменена.

Задача не существует, принадлежит другому пользователю, либо её этап не соответствует пути URL.

Уникальный идентификатор задачи лампы, для которой запрашивается поток.

Либо prototype, либо build. Коллекция возвращает только задачи, этап которых соответствует URL — запрос /prototype никогда не возвращает задачи сборки, и наоборот.

Номер страницы для пагинации.

Ограничение размера страницы. Максимально допустимое значение — 100 элементов.

Поле для сортировки. Доступные значения:

• +created_at: сортировка по времени создания в порядке возрастания.
• -created_at: сортировка по времени создания в порядке убывания.

Уникальный идентификатор задачи. Хотя в качестве деталей реализации мы используем k-сортируемый UUID для идентификаторов задач, вам не следует делать каких-либо предположений о формате id.

Тип задачи. Значение — creative-lab-lamp-prototype.

Название задачи, указанное при её создании. Пустая строка, если название не было указано.

Статус задачи. Возможные значения: одно из PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Прогресс задачи. Если задача ещё не начата, это свойство будет равно 0. Как только задача завершится успешно, оно станет равно 100.

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

Временная метка начала выполнения задачи, в миллисекундах. Если задача ещё не начата, это свойство будет равно 0.

Временная метка завершения задачи, в миллисекундах. Если задача ещё не завершена, это свойство будет равно 0.

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

Количество предшествующих задач.

Детали ошибки для неудавшихся задач. См. Ошибки для полного описания объекта task_error.

Количество кредитов, потраченных на эту задачу. Присутствует, когда статус задачи — PENDING, IN_PROGRESS или SUCCEEDED. Возвращает 0 для задач со статусом FAILED (кредиты возвращаются при неудаче).

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

Ссылка для скачивания отрендеренного превью 3D-модели. Пустая строка, пока задача не завершится успешно.

Ссылки для скачивания кандидатов концептуального изображения, сгенерированных этой задачей прототипа. В настоящее время API всегда возвращает ровно одного кандидата; поле представляет собой массив, чтобы будущие версии могли предоставлять несколько кандидатов без обратной несовместимости.

Уникальный идентификатор задачи.

Тип задачи. Значение — creative-lab-lamp-build.

Название задачи, указанное при её создании. Пустая строка, если название не было указано.

Статус задачи. Возможные значения: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

Прогресс выполнения задачи. Если задача ещё не запущена, значение будет 0. Как только задача успешно завершится, значение станет 100.

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

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

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

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

Количество задач, стоящих в очереди перед текущей. Имеет значение только при статусе PENDING.

Детали ошибки для неудавшихся задач. См. Ошибки для полного описания объекта task_error.

Количество кредитов, израсходованных на выполнение этой задачи. Для задач со статусом FAILED возвращает 0 (кредиты возвращаются при неудаче).

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