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

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

POST/openapi/v1/convert

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

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

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

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

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

Задача, которая всё ещё находится в статусе PENDING, удаляется, а кредиты, списанные при создании, возвращаются.

Задачу, которая уже находится в статусе IN_PROGRESS, удалить нельзя: запрос отклоняется с кодом 409 Conflict, а задача продолжает выполняться. Кредиты за задачу, выполнение которой уже начато воркером, не подлежат возврату, поэтому удаление в процессе выполнения приведёт к потере и кредитов, и результата. Дождитесь, пока она перейдёт в статус SUCCEEDED, FAILED или CANCELED, и только после этого удаляйте её.

Задача в финальном статусе (SUCCEEDED, FAILED или CANCELED) удаляется без возврата кредитов.

Возвращает

Возвращает 200 OK при успешном выполнении или 409 Conflict, если задача находится в статусе IN_PROGRESS.

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

// 200 OK on success, with an empty body.
//
// 409 Conflict when the task is IN_PROGRESS — the task is left running:
{
  "message": "Task is IN_PROGRESS and cannot be deleted. Credits for a task the worker has already started are not refundable; wait for it to reach SUCCEEDED, FAILED or CANCELED, then delete it."
}

GET/openapi/v1/convert

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

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

Параметры

Name
page_num
Type
integer
по умолчанию 1
Description
Номер страницы для пагинации.

Name
page_size
Type
integer
по умолчанию 10
Description
Ограничение размера страницы. Максимально допустимое значение — 100 элементов.

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
}

Объект Convert Task

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

Свойства

id · string

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

type · string

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

model_urls · object

Ссылки для скачивания сконвертированных файлов модели. 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 кредит за задачу конвертации). Для задач со статусом FAILED возвращает 0.

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

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

Параметры

Возвращаемые значения

Режимы сбоя

Request

Response

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

Параметры

Возвращает

Request

Response

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

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

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

Возвращает

Request

Response

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

Параметры

Возвращает

Request

Response

Стриминг задачи конвертации

Параметры

Возвращает

Request

Response Stream

Объект Convert Task

Свойства