API ремешинга

API ремешинга позволяет выполнять ремешинг и экспортировать существующие 3D-модели, сгенерированные другими API Meshy (например, Изображение в 3D или Текст в 3D), в различные форматы. В этом разделе приведены сведения о том, как использовать API ремешинга.


POST/openapi/v1/remesh

Создать задачу ремешинга

Этот эндпоинт создает новую задачу ремешинга.

Параметры

  • Name
    input_task_id
    Type
    string
    Обязательный
    Description

    ID завершенной задачи Изображение в 3D или Текст в 3D, которую вы хотите ремешить. Эта задача должна быть одной из следующих: Предпросмотр Текст в 3D, Уточнение Текст в 3D, Изображение в 3D или Ретекстурирование. Кроме того, она должна иметь статус 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.

  • Name
    resize_longest_side
    Type
    number
    устаревший
    по умолчанию 0
    Description

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

  • Name
    auto_size
    Type
    boolean
    устаревший
    по умолчанию false
    Description

    При значении true сервис использует AI-зрение, чтобы автоматически оценить реальную высоту объекта и соответствующим образом изменить размер модели. Вместо этого мы рекомендуем использовать специализированный Resize API.

Применяется только когда 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.

  • 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

POST
/openapi/v1/remesh
# 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"
}

GET/openapi/v1/remesh/:id

Получить задачу Ремешинга

Этот эндпоинт получает задачу ремешинга по ее ID.

Параметры

  • Name
    id
    Type
    path
    Description

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

Возвращает

Объект задачи Ремешинга.

Request

GET
/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f
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,
}

DELETE/openapi/v1/remesh/:id

Удалить задачу ремешинга

Этот эндпоинт безвозвратно удаляет задачу ремешинга, включая все связанные модели и данные. Это действие необратимо.

Параметры пути

  • Name
    id
    Type
    path
    Description

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

Возвращает

Возвращает 200 OK при успешном выполнении.

Request

DELETE
/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f
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.

GET/openapi/v1/remesh

Список задач Ремешинг

Этот эндпоинт позволяет получить список задач Ремешинг.

Параметры

  • 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

GET
/openapi/v1/remesh
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
  }
]

GET/openapi/v1/remesh/:id/stream

Потоковая передача задачи Ремешинга

Этот эндпоинт передает обновления в реальном времени для задачи Ремешинга с использованием Server-Sent Events (SSE).

Параметры

  • Name
    id
    Type
    path
    Description

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

Возвращает

Возвращает поток объектов задачи Ремешинга в виде Server-Sent Events.

Для задач PENDING или IN_PROGRESS поток ответа будет включать только необходимые поля progress и status.

Request

GET
/openapi/v1/remesh/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream
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

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

  • 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
}