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
Ідентифікатор завдання Конвертувати, яке потрібно видалити.

Повертає

Повертає 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
}

Об’єкт завдання Конвертувати

Об’єкт завдання Конвертувати представляє завдання конвертації формату.

Properties

id · рядок

Унікальний ідентифікатор завдання.

type · рядок

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

model_urls · об’єкт

URL-адреси для завантаження конвертованих файлів моделі. Лише формати, зазначені в target_formats, матимуть URL-адреси. Інші властивості форматів будуть порожніми рядками.

progress · ціле число

progress завдання (0-100).

status · рядок

Статус завдання. Можливі значення: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.

preceding_tasks · ціле число

Кількість попередніх завдань. Має значення лише коли статус — PENDING.

created_at · мітка часу

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

started_at · мітка часу

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

finished_at · мітка часу

Мітка часу, коли завдання було завершено, у мілісекундах. 0, якщо не завершено.

task_error · об’єкт

Об’єкт помилки, якщо завдання завершилося невдало. Докладніше див. Помилки.

consumed_credits · ціле число

Кількість кредитів, спожитих цим завданням (1 кредит за завдання конвертації). Повертає 0 для завдань FAILED.