API Конвертировать

API Конвертировать позволяет конвертировать существующие 3D-модели в различные форматы файлов.

POST/openapi/v1/convert

Создать задачу конвертации

Этот эндпоинт создает новую задачу конвертации формата.

Параметры

Требуется только один из input_task_id или model_url. Если указаны оба, input_task_id имеет приоритет.

Name
input_task_id
Type
string
Обязательный
Description
ID завершенной задачи Meshy, модель которой вы хотите конвертировать. Задача должна иметь статус SUCCEEDED.

Name
model_url
Type
string
Обязательный
Description
Общедоступный URL или Data URI, указывающий на файл 3D-модели. Поддерживаемые форматы: .glb, .gltf, .obj, .fbx, .stl. Для Data URI используйте MIME type: application/octet-stream.

Name
target_formats
Type
string[]
Обязательный
Description
Список выходных форматов для конвертированной модели. Доступные значения: glb, fbx, obj, usdz, blend, stl, 3mf.

Возвращает

Свойство result ответа содержит id вновь созданной задачи конвертации.

Возможные ошибки

400 - Bad Request

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

Отсутствующий параметр: Необходимо указать либо model_url, либо input_task_id.
Отсутствует target_formats: Необходимо указать хотя бы один целевой формат.
Недопустимая входная задача: input_task_id должен ссылаться на успешно выполненную задачу.
Недопустимый формат модели: model_url указывает на файл с неподдерживаемым расширением.
Недоступный URL: Не удалось загрузить model_url.

401 - Unauthorized

Аутентификация не удалась. Проверьте ваш API-ключ.

402 - Payment Required

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

429 - Too Many Requests

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

Request

POST

/openapi/v1/convert

curl https://api.meshy.ai/openapi/v1/convert \
-X POST \
-H "Authorization: Bearer ${YOUR_API_KEY}" \
-H 'Content-Type: application/json' \
-d '{
    "input_task_id": "018a210d-8ba4-705c-b111-1f1776f7f578",
    "target_formats": ["fbx", "stl"]
  }'

Response

{
  "result": "0193bfc5-ee4f-73f8-8525-44b398884ce9"
}

GET/openapi/v1/convert/:id

Получить задачу Конвертировать

Этот эндпоинт получает задачу Конвертировать по ее ID.

Параметры

Name
id
Type
path
Description
ID задачи Конвертировать, которую нужно получить.

Возвращает

Объект задачи Конвертировать.

Request

GET

/openapi/v1/convert/:id

curl https://api.meshy.ai/openapi/v1/convert/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "convert",
  "model_urls": {
      "glb": "",
      "fbx": "https://assets.meshy.ai/.../model.fbx?Expires=...",
      "obj": "",
      "usdz": "",
      "stl": "https://assets.meshy.ai/.../model.stl?Expires=..."
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
  "consumed_credits": 1
}

DELETE/openapi/v1/convert/:id

Удалить задачу Конвертировать

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

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

Name
id
Type
path
Description
ID задачи конвертации, которую нужно удалить.

Возвращает

В случае успеха возвращает 200 OK.

Request

DELETE

/openapi/v1/convert/:id

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/convert/a43b5c6d-7e8f-901a-234b-567c890d1e2f \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 200 Ok on success.

GET/openapi/v1/convert

Список задач Конвертировать

Этот эндпоинт позволяет получить список задач Конвертировать.

Параметры

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/convert

curl https://api.meshy.ai/openapi/v1/convert?page_size=10 \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
    "type": "convert",
    "model_urls": {
      "fbx": "https://assets.meshy.ai/.../model.fbx?Expires=...",
      "stl": "https://assets.meshy.ai/.../model.stl?Expires=..."
    },
    "progress": 100,
    "status": "SUCCEEDED",
    "created_at": 1699999999000,
    "started_at": 1700000000000,
    "finished_at": 1700000001000,
    "task_error": null,
    "consumed_credits": 1
  }
]

GET/openapi/v1/convert/:id/stream

Потоковая передача задачи Конвертировать

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

Параметры

Name
id
Type
path
Description
Уникальный идентификатор задачи конвертации для потоковой передачи.

Возвращает

Возвращает поток объектов задачи Конвертировать как Server-Sent Events.

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

Request

GET

/openapi/v1/convert/:id/stream

curl -N https://api.meshy.ai/openapi/v1/convert/a43b5c6d-7e8f-901a-234b-567c890d1e2f/stream \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response Stream

// Message event examples illustrate task progress.
event: message
data: {
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "0193bfc5-ee4f-73f8-8525-44b398884ce9",
  "type": "convert",
  "model_urls": {
    "fbx": "https://assets.meshy.ai/.../model.fbx?Expires=...",
    "stl": "https://assets.meshy.ai/.../model.stl?Expires=..."
  },
  "progress": 100,
  "status": "SUCCEEDED",
  "created_at": 1699999999000,
  "started_at": 1700000000000,
  "finished_at": 1700000001000,
  "task_error": null,
  "consumed_credits": 1
}

Объект задачи Конвертировать

Объект задачи Конвертировать представляет задание по конвертации формата.

Свойства

id · string

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

type · string

Тип задачи. Значение — convert.

model_urls · object

Загружаемые URL для конвертированных файлов модели. URL будут только у форматов, указанных в target_formats. Свойства других форматов будут пустыми строками.

progress · integer

progress задачи (0-100).

status · string

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

preceding_tasks · integer

Количество предшествующих задач. Имеет смысл только когда статус — PENDING.

created_at · timestamp

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

started_at · timestamp

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

finished_at · timestamp

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

task_error · object

Объект ошибки, если задача завершилась неудачно. Подробнее см. Ошибки.

consumed_credits · integer

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