API Hoạt hình

Các endpoint để khám phá các Hoạt hình có sẵn và áp dụng chúng cho các nhân vật đã được gắn rig.

POST/openapi/v1/animations

Tạo tác vụ Hoạt hình

endpoint này cho phép bạn tạo một tác vụ mới để áp dụng một hành động hoạt hình cụ thể cho một nhân vật đã được rigging trước đó. Bao gồm các tùy chọn hậu xử lý.

Tham số

Name
rig_task_id
Type
string
Bắt buộc
Description
id của một tác vụ rigging đã hoàn tất thành công (từ POST /openapi/v1/rigging). Nhân vật từ tác vụ này sẽ được tạo hoạt hình.
Name
action_id
Type
integer
Bắt buộc
Description
Mã định danh của hành động hoạt hình cần áp dụng. Xem Tham chiếu Thư viện hoạt hình để biết danh sách đầy đủ các hoạt hình có sẵn.
Name
post_process
Type
object
Description
Hậu xử lý tùy chọn cho đầu ra hoạt hình. Bỏ qua để nhận các tệp hoạt hình tiêu chuẩn.

Chỉ áp dụng khi post_process is set

Name
operation_type
Type
string
Bắt buộc
Description
Loại thao tác cần thực hiện. Các giá trị có sẵn: change_fps, fbx2usdz, extract_armature.
Name
fps
Type
integer
mặc định 30
Description
Tốc độ khung hình mục tiêu. Chỉ áp dụng khi operation_type là change_fps. Các giá trị được phép: 24, 25, 30, 60.

Trả về

Thuộc tính result của phản hồi chứa id tác vụ của tác vụ hoạt hình mới được tạo.

Chế độ lỗi

Name
400 - Bad Request
Description
Yêu cầu không được chấp nhận. Nguyên nhân phổ biến:
- Thiếu tham số: Thiếu rig_task_id hoặc action_id.
- Tác vụ rig không hợp lệ: rig_task_id không hợp lệ hoặc tham chiếu đến một tác vụ đã thất bại/không tồn tại.
- ID hành động không hợp lệ: action_id không tương ứng với một hoạt hình hợp lệ.
Name
401 - Unauthorized
Description
xác thực thất bại. Vui lòng kiểm tra khóa API của bạn.
Name
402 - Payment Required
Description
Không đủ tín dụng để thực hiện tác vụ này.
Name
404 - Not Found
Description
Không tìm thấy tác vụ rigging được chỉ định bởi rig_task_id.
Name
429 - Too Many Requests
Description
Bạn đã vượt quá giới hạn tốc độ của mình.

Request

POST

/openapi/v1/animations

# Animate a rigged model with required params only
curl https://api.meshy.ai/openapi/v1/animations \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "rig_task_id": "018b314a-a1b5-716d-c222-2f1776f7f579",
    "action_id": 92
  }'

# With post-processing to change FPS
curl https://api.meshy.ai/openapi/v1/animations \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "rig_task_id": "018b314a-a1b5-716d-c222-2f1776f7f579",
    "action_id": 92,
    "post_process": {
      "operation_type": "change_fps",
      "fps": 24
    }
  }'

Response

{
  "result": "018c425b-b2c6-727e-d333-3c1887i9h791"
}

GET/openapi/v1/animations/:id

Truy xuất một tác vụ Hoạt hình

endpoint này cho phép bạn truy xuất một tác vụ hoạt hình khi có id tác vụ hợp lệ. Tham khảo Đối tượng tác vụ Hoạt hình để xem các thuộc tính được bao gồm.

Tham số

Name
id
Type
path
Description
Mã định danh duy nhất của tác vụ hoạt hình cần truy xuất.

Trả về

Phản hồi chứa đối tượng tác vụ Hoạt hình. Xem phần Đối tượng tác vụ Hoạt hình để biết chi tiết.

Request

GET

/openapi/v1/animations/018c425b-b2c6-727e-d333-3c1887i9h791

curl https://api.meshy.ai/openapi/v1/animations/018c425b-b2c6-727e-d333-3c1887i9h791 
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "id": "018c425b-b2c6-727e-d333-3c1887i9h791",
  "type": "animate",
  "status": "SUCCEEDED",
  "created_at": 1747032440896,
  "progress": 100,
  "started_at": 1747032441210,
  "finished_at": 1747032457530,
  "expires_at": 1747291657530,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 3,
  "result": {
    "animation_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/Animation_Reaping_Swing_withSkin.glb?Expires=...",
    "animation_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/Animation_Reaping_Swing_withSkin.fbx?Expires=...",
    "processed_usdz_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/processed.usdz?Expires=...",
    "processed_armature_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/processed_armature.fbx?Expires=...",
    "processed_animation_fps_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018c425b-b2c6-727e-d333-3c1887i9h791/output/processed_60fps.fbx?Expires=..."
  },
  "preceding_tasks": 0
}

DELETE/openapi/v1/animations/:id

Xóa tác vụ Hoạt hình

endpoint này xóa vĩnh viễn một tác vụ hoạt hình, bao gồm tất cả các mô hình và dữ liệu liên quan. Hành động này không thể hoàn tác.

Tham số đường dẫn

Name
id
Type
path
Description
ID của tác vụ hoạt hình cần xóa.

Trả về

Trả về 200 OK khi thành công.

Request

DELETE

/openapi/v1/animations/018b314a-a1b5-716d-c222-2f1776f7f579

curl --request DELETE \
  --url https://api.meshy.ai/openapi/v1/animations/018b314a-a1b5-716d-c222-2f1776f7f579 \
  -H "Authorization: Bearer ${YOUR_API_KEY}"

Response

// Returns 200 Ok on success.

GET/openapi/v1/animations/:id/stream

Truyền trực tuyến một tác vụ Hoạt hình

endpoint này truyền trực tuyến các cập nhật theo thời gian thực cho một tác vụ Hoạt hình bằng Server-Sent Events (SSE).

Tham số

Name
id
Type
path
Description
Mã định danh duy nhất của tác vụ Hoạt hình cần truyền trực tuyến.

Trả về

Trả về một luồng Các đối tượng tác vụ Hoạt hình dưới dạng Server-Sent Events.

Đối với các tác vụ PENDING hoặc IN_PROGRESS, luồng phản hồi sẽ chỉ bao gồm các trường progress và status cần thiết.

Request

GET

/openapi/v1/animations/018c425b-b2c6-727e-d333-3c1887i9h791/stream

curl -N https://api.meshy.ai/openapi/v1/animations/018c425b-b2c6-727e-d333-3c1887i9h791/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": "018c425b-b2c6-727e-d333-3c1887i9h791",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018c425b-b2c6-727e-d333-3c1887i9h791",
  "progress": 50,
  "status": "IN_PROGRESS"
}

event: message
data: { // Example of a SUCCEEDED task stream item, mirroring The Animation Task Object structure
  "id": "018c425b-b2c6-727e-d333-3c1887i9h791",
  "type": "animate",
  "status": "SUCCEEDED",
  "created_at": 1747032440896,
  "progress": 100,
  "started_at": 1747032441210,
  "finished_at": 1747032457530,
  "expires_at": 1747291657530,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 3,
  "result": {
    "animation_glb_url": "https://assets.meshy.ai/.../Animation_Reaping_Swing_withSkin.glb?...",
    "animation_fbx_url": "https://assets.meshy.ai/.../Animation_Reaping_Swing_withSkin.fbx?...",
    "processed_usdz_url": "https://assets.meshy.ai/.../processed.usdz?...",
    "processed_armature_fbx_url": "https://assets.meshy.ai/.../processed_armature.fbx?...",
    "processed_animation_fps_fbx_url": "https://assets.meshy.ai/.../processed_60fps.fbx?..."
  },
  "preceding_tasks": 0
}

Đối tượng Tác vụ Hoạt hình

Đối tượng Tác vụ Hoạt hình đại diện cho đơn vị công việc để áp dụng một hoạt hình (animation) cho một nhân vật đã được gắn rig.

Thuộc tính

Name
id
Type
string
Description
Định danh duy nhất cho tác vụ.
Name
type
Type
string
Description
Loại của tác vụ Hoạt hình. Giá trị là animate.
Name
status
Type
string
Description
Trạng thái của tác vụ. Các giá trị có thể: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
progress của tác vụ (0-100).
Name
created_at
Type
timestamp
Description
Dấu thời gian (mili giây kể từ epoch) khi tác vụ được tạo.
Một dấu thời gian biểu thị số mili giây đã trôi qua kể từ ngày 1 tháng 1 năm 1970 UTC, tuân theo tiêu chuẩn RFC 3339. Ví dụ, Thứ Sáu, ngày 1 tháng 9 năm 2023 12:00:00 PM GMT được biểu thị là 1693569600000. Điều này áp dụng cho tất cả dấu thời gian trong Meshy API.
Name
started_at
Type
timestamp
Description
Dấu thời gian (mili giây kể từ epoch) khi tác vụ bắt đầu xử lý. 0 nếu chưa bắt đầu.
Name
finished_at
Type
timestamp
Description
Dấu thời gian (mili giây kể từ epoch) khi tác vụ hoàn tất. 0 nếu chưa hoàn tất.
Name
expires_at
Type
timestamp
Description
Dấu thời gian (mili giây kể từ epoch) khi các asset kết quả của tác vụ hết hạn.
Name
task_error
Type
object
Description
Chi tiết lỗi cho các tác vụ thất bại. Xem Lỗi để biết tham chiếu đầy đủ về đối tượng task_error.
Name
consumed_credits
Type
integer
Description
Số tín dụng được tiêu thụ bởi tác vụ này. Có mặt khi trạng thái tác vụ là PENDING, IN_PROGRESS, hoặc SUCCEEDED. Trả về 0 cho các tác vụ FAILED (tín dụng được hoàn lại khi thất bại).
Name
result
Type
object
Description
Chứa các URL Hoạt hình đầu ra nếu tác vụ SUCCEEDED.
- Name
  animation_glb_url
  Type
  string
  Description
  URL có thể tải xuống cho Hoạt hình ở định dạng GLB.
- Name
  animation_fbx_url
  Type
  string
  Description
  URL có thể tải xuống cho Hoạt hình ở định dạng FBX.
- Name
  processed_usdz_url
  Type
  string
  Description
  URL có thể tải xuống cho Hoạt hình đã xử lý ở định dạng USDZ.
- Name
  processed_armature_fbx_url
  Type
  string
  Description
  URL có thể tải xuống cho bộ xương đã xử lý ở định dạng FBX.
- Name
  processed_animation_fps_fbx_url
  Type
  string
  Description
  URL có thể tải xuống cho Hoạt hình với FPS đã thay đổi ở định dạng FBX (ví dụ: nếu thao tác change_fps đã được sử dụng).
Name
preceding_tasks
Type
integer
Description
Số lượng tác vụ đứng trước trong hàng đợi. Chỉ có ý nghĩa nếu trạng thái là PENDING.

Example Animation Task Object

{
  "id": "018c425b-b2c6-727e-d333-3c1887i9h791",
  "type": "animate",
  "status": "SUCCEEDED",
  "created_at": 1747032440896,
  "progress": 100,
  "started_at": 1747032441210,
  "finished_at": 1747032457530,
  "expires_at": 1747291657530,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 3,
  "result": {
    "animation_glb_url": "https://assets.meshy.ai/.../Animation_Reaping_Swing_withSkin.glb?...",
    "animation_fbx_url": "https://assets.meshy.ai/.../Animation_Reaping_Swing_withSkin.fbx?...",
    "processed_usdz_url": "https://assets.meshy.ai/.../processed.usdz?...",
    "processed_armature_fbx_url": "https://assets.meshy.ai/.../processed_armature.fbx?...",
    "processed_animation_fps_fbx_url": "https://assets.meshy.ai/.../processed_60fps.fbx?..."
  },
  "preceding_tasks": 0
}