Remesh API
Remesh API позволяет выполнять ремешинг и экспортировать существующие 3D-модели, созданные другими API Meshy (такими как Изображение в 3D или Текст в 3D), в различные форматы. В этом разделе приведены сведения о том, как использовать Remesh API.
Create a Remesh Task
Этот эндпоинт создаёт новую задачу ремешинга.
Для конвертации формата и изменения размера используйте специализированные Convert API и Resize API. Устаревшие параметры ниже продолжат работать, но для новых интеграций мы рекомендуем использовать новые эндпоинты.
Параметры
Требуется указать только один из параметров: input_task_id или model_url. Если указаны оба, приоритет имеет input_task_id.
- Name
- input_task_id
- Type
- string
- Обязательный
- Description
ID завершённой задачи Изображение в 3D или Текст в 3D, которую вы хотите подвергнуть ремешингу. Эта задача должна быть одной из следующих: Text to 3D Preview, Text to 3D Refine, Image to 3D или Retexture. Кроме того, её статус должен быть
SUCCEEDED.
- Name
- model_url
- Type
- string
- Обязательный
- Description
Пожалуйста, предоставьте 3D-модель для ремешинга Meshy через общедоступный URL или data URI. Поддерживаемые форматы:
.glb,.gltf,.obj,.fbx,.stl.Для Data URI используйте MIME type:
application/octet-stream.
- Name
- target_formats
- Type
- string[]
- по умолчанию ["glb"]
- Description
Список целевых форматов для модели после ремешинга. Если не указан, генерируется только GLB.
Доступные значения:
glb,fbx,obj,usdz,blend,stl,3mf.
- 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
- resize_height
- Type
- number
- ⚠ устаревший
- по умолчанию 0
- Description
Изменить размер модели до определённой высоты, измеряемой в метрах. Рекомендуем вместо этого использовать специализированный Resize API.
auto_size,resize_heightиresize_longest_sideявляются взаимоисключающими.
- Name
- resize_longest_side
- Type
- number
- ⚠ устаревший
- по умолчанию 0
- Description
Изменить размер модели так, чтобы наибольшее измерение ограничивающего параллелепипеда равнялось указанному значению в метрах. Рекомендуем вместо этого использовать специализированный Resize API.
auto_size,resize_heightиresize_longest_sideявляются взаимоисключающими.
- Name
- auto_size
- Type
- boolean
- ⚠ устаревший
- по умолчанию false
- Description
При значении
trueсервис использует AI-зрение для автоматической оценки реальной высоты объекта и соответствующего изменения размера модели. Рекомендуем вместо этого использовать специализированный Resize API.auto_size,resize_heightиresize_longest_sideявляются взаимоисключающими.
auto_size = true- Name
- origin_at
- Type
- string
- ⚠ устаревший
- по умолчанию bottom
- Description
Положение начала координат. Рекомендуем вместо этого использовать специализированный Resize API.
Доступные значения:
bottom,center.
- Name
- convert_format_only
- Type
- boolean
- ⚠ устаревший
- Description
Если
true, сервис изменит только формат входного файла модели, игнорируя другие входные параметры, такие какtopology,resize_heightиtarget_polycount. Рекомендуем вместо этого использовать специализированный Convert API.Если
convert_format_onlyустановлен вtrue, необходимо указатьtarget_formats.
- Name
- alpha_thumbnail
- Type
- boolean
- по умолчанию false
- Description
При значении
trueзадача дополнительно рендерит версию предпросмотра с прозрачным фоном (RGBA) и возвращает её какalpha_thumbnail_urlв ответе GET. Существующее полеthumbnail_urlостаётся без изменений.
Возвращаемые данные
Свойство result ответа содержит id вновь созданной задачи ремешинга.
Режимы сбоя
- Name
400 - Bad Request- Description
Запрос был неприемлем. Распространённые причины:
- Отсутствует параметр: должен быть указан либо
model_url, либоinput_task_id. - Недопустимая входная задача:
input_task_idдолжен ссылаться на успешную задачу от поддерживаемой модели. - Недопустимый формат модели:
model_urlуказывает на файл с неподдерживаемым расширением. - Недоступный URL: не удалось загрузить
model_url. - Недопустимый topology: параметр
topologyнедопустим. - Взаимоисключающие параметры:
auto_sizeиresize_heightне могут быть заданы одновременно.
- Отсутствует параметр: должен быть указан либо
- Name
401 - Unauthorized- Description
Ошибка аутентификации. Пожалуйста, проверьте свой API-ключ.
- Name
402 - Payment Required- Description
Недостаточно кредитов для выполнения этой задачи.
- Name
429 - Too Many Requests- Description
Вы превысили ограничение частоты.
Request
# Basic remesh with custom formats and resize
curl https://api.meshy.ai/openapi/v1/remesh \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"target_formats": ["glb", "fbx"],
"topology": "quad",
"target_polycount": 50000,
"resize_height": 1.0,
"origin_at": "bottom"
}'
# Quad remesh with auto-size
curl https://api.meshy.ai/openapi/v1/remesh \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
"input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
"target_formats": ["glb", "fbx"],
"topology": "quad",
"target_polycount": 50000,
"auto_size": true
}'
Response
{
"result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}
Получить задачу ремешинга
Этот эндпоинт получает задачу ремешинга по её ID.
Параметры
- Name
- id
- Type
- path
- Description
ID задачи ремешинга, которую нужно получить.
Возвращает
Объект задачи ремешинга.
Request
curl https://api.meshy.ai/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
{
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "remesh",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
"fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
"usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
"blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
"stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
},
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000001000,
"task_error": null,
}
Удалить задачу Ремешинга
Этот эндпоинт безвозвратно удаляет задачу ремешинга, включая все связанные модели и данные. Это действие необратимо.
Параметры пути
- Name
- id
- Type
- path
- Description
ID задачи ремешинга, которую нужно удалить.
Возвращает
Возвращает 200 OK при успешном выполнении.
Request
curl --request DELETE \
--url https://api.meshy.ai/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
// Returns 200 Ok on success.
List Remesh Tasks
Этот эндпоинт позволяет получить список задач ремешинга.
Параметры
- Name
- page_num
- Type
- integer
- по умолчанию 1
- Description
Номер страницы для пагинации.
- Name
- page_size
- Type
- integer
- по умолчанию 10
- Description
Ограничение размера страницы. Максимально допустимое значение —
50элементов.
- Name
- sort_by
- Type
- string
- Description
Поле для сортировки.
Доступные значения:
+created_at: Сортировка по времени создания в порядке возрастания.-created_at: Сортировка по времени создания в порядке убывания.
Возвращает
Возвращает пагинированный список объектов задач ремешинга.
Request
curl https://api.meshy.ai/openapi/v1/remesh?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response
[
{
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "remesh",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
"fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
"usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
"blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
"stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
},
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000001000,
"task_error": null
}
]
Стриминг задачи ремешинга
Этот эндпоинт передает обновления в реальном времени для задачи ремешинга с помощью Server-Sent Events (SSE).
Параметры
- Name
- id
- Type
- path
- Description
Уникальный идентификатор задачи ремешинга для стриминга.
Возвращает
Возвращает поток объектов задачи ремешинга в виде Server-Sent Events.
Для задач со статусом PENDING или IN_PROGRESS поток ответа будет содержать только необходимые поля progress и status.
Request
curl -N https://api.meshy.ai/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"
Response Stream
// Error event example
event: error
data: {
"status_code": 404,
"message": "Task not found"
}
// Message event examples illustrate task progress.
// For PENDING or IN_PROGRESS tasks, the response stream will not include all fields.
event: message
data: {
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"progress": 0,
"status": "PENDING"
}
event: message
data: {
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "remesh",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
"fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
"usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
"blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
"stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
},
"progress": 100,
"status": "SUCCEEDED",
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000001000,
"task_error": null,
}
Объект задачи Ремешинга
Объект задачи Ремешинга представляет собой единицу работы, которую Meshy использует для ремешинга и экспорта существующей 3D-модели в различные форматы. Объект имеет следующие свойства:
Свойства
- Name
- id
- Type
- string
- Description
Уникальный идентификатор задачи. Хотя в качестве деталей реализации мы используем k-сортируемый UUID для идентификаторов задач, вам не следует делать каких-либо предположений о формате id.
- Name
- type
- Type
- string
- Description
Тип задачи Ремешинга. Значение —
remesh.
- 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
blend- Type
- string
- Description
Скачиваемый URL файла Blender.
- Name
stl- Type
- string
- Description
Скачиваемый URL файла STL.
- Name
3mf- Type
- string
- Description
Скачиваемый URL файла 3MF. Присутствует, только если
3mfбыл запрошен черезtarget_formats.
- Name
- thumbnail_url
- Type
- string
- Description
Скачиваемый URL превью-изображения, отрендеренного из ремешированной модели.
- Name
- alpha_thumbnail_url
- Type
- string
- Description
Скачиваемый URL версии
thumbnail_urlс прозрачным фоном (RGBA). Присутствует, только если задача была создана сalpha_thumbnail: trueи прозрачное превью было успешно отрендерено; в противном случае это поле отсутствует.
- Name
- progress
- Type
- integer
- Description
Progress задачи. Если задача ещё не начата, это свойство будет
0. Как только задача завершится успешно, оно станет100.
- Name
- status
- Type
- string
- Description
Статус задачи. Возможные значения:
PENDING,IN_PROGRESS,SUCCEEDED,FAILED.
- Name
- preceding_tasks
- Type
- integer
- Description
Количество предшествующих задач.
Значение этого поля имеет смысл только если статус задачи —
PENDING.
- Name
- created_at
- Type
- timestamp
- Description
Временная метка создания задачи, в миллисекундах.
- Name
- started_at
- Type
- timestamp
- Description
Временная метка начала выполнения задачи, в миллисекундах. Если задача ещё не начата, это свойство будет
0.
- Name
- finished_at
- Type
- timestamp
- Description
Временная метка завершения задачи, в миллисекундах. Если задача ещё не завершена, это свойство будет
0.
- Name
- task_error
- Type
- object
- Description
Детали ошибки для неудавшихся задач. См. Ошибки для полного описания объекта
task_error.
- Name
- consumed_credits
- Type
- integer
- Description
Количество кредитов, потраченных на эту задачу. Присутствует, если статус задачи —
PENDING,IN_PROGRESSилиSUCCEEDED. Возвращает0для задач со статусомFAILED(кредиты возвращаются при неудаче).
Example Remesh Task Object
{
"id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
"type": "remesh",
"model_urls": {
"glb": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.glb?Expires=***",
"fbx": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.fbx?Expires=***",
"obj": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.obj?Expires=***",
"usdz": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.usdz?Expires=***",
"blend": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.blend?Expires=***",
"stl": "https://assets.meshy.ai/***/tasks/0193bfc5-ee4f-73f8-8525-44b398884ce9/output/model.stl?Expires=***"
},
"progress": 100,
"status": "SUCCEEDED",
"preceding_tasks": 0,
"created_at": 1699999999000,
"started_at": 1700000000000,
"finished_at": 1700000001000,
"task_error": {
"message": ""
},
"consumed_credits": 5
}