API gắn khung xương (rigging)

API gắn khung xương (rigging) cho phép bạn thêm khung xương (bộ xương) vào các mô hình người 3D theo cách lập trình, liên kết lưới với nó để chúng sẵn sàng cho hoạt hình. Để áp dụng hoạt hình cho một nhân vật đã được rig, hãy xem API Hoạt hình.

Xin lưu ý rằng hiện tại, rigging theo cách lập trình chỉ hoạt động tốt với các asset người tiêu chuẩn (hai chân) có các chi và cấu trúc cơ thể được xác định rõ ràng.

POST/openapi/v1/rigging

Tạo tác vụ Rigging

endpoint này cho phép bạn tạo một tác vụ rigging mới cho một mô hình 3D nhất định. Khi hoàn tất thành công, nó cung cấp một nhân vật đã được rigging ở các định dạng tiêu chuẩn và tùy chọn thêm các hoạt ảnh đi bộ/chạy cơ bản.

Hiện tại, auto-rigging không phù hợp với các mô hình sau:

Các lưới chưa có texture
Các asset không dạng người
Các asset dạng người có cấu trúc chi và cơ thể không rõ ràng

Khi sử dụng input_task_id, các mô hình có hơn 300.000 mặt không được hỗ trợ cho rigging. Vui lòng sử dụng API Remesh để giảm số lượng mặt trước khi rigging.

Khi sử dụng model_url, khuôn mặt của nhân vật phải hướng về trục +Z (hướng tiến tiêu chuẩn của glTF). Các mô hình hướng theo trục khác sẽ khiến ước tính tư thế thất bại.

Tham số

Chỉ bắt buộc một trong hai input_task_id hoặc model_url. Nếu cung cấp cả hai, input_task_id sẽ có độ ưu tiên.

Name
input_task_id
Type
string
Bắt buộc
Description
Tác vụ đầu vào cần được rigging. Hiện chúng tôi hỗ trợ các mô hình dạng người có texture.

Name
model_url
Type
string
Bắt buộc
Description
Vui lòng cung cấp một mô hình 3D để Meshy thực hiện rigging thông qua URL có thể truy cập công khai hoặc Data URI. Hiện chúng tôi hỗ trợ các tệp GLB dạng người có texture (định dạng .glb).

Name
height_meters
Type
number
mặc định 1.7
Description
Chiều cao xấp xỉ của mô hình nhân vật tính bằng mét. Điều này hỗ trợ độ chính xác khi chia tỷ lệ và rigging. Nó phải là một số dương.
Name
texture_image_url
Type
string
Description
Ảnh texture màu cơ sở đã được unwrap UV của mô hình. URL có thể truy cập công khai hoặc Data URI. Hiện chúng tôi hỗ trợ định dạng .png.

Trả về

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

Các trường hợp lỗi

Name
400 - Bad Request
Description
Yêu cầu không thể chấp nhận. Nguyên nhân phổ biến:
- Thiếu tham số: Phải cung cấp model_url hoặc input_task_id.
- Định dạng mô hình không hợp lệ: model_url trỏ đến một tệp có phần mở rộng không được hỗ trợ (chỉ hỗ trợ .glb).
- URL không thể truy cập: Không thể tải xuống model_url.
- Tác vụ đầu vào không hợp lệ: input_task_id không tham chiếu đến một tác vụ API hợp lệ.
- Vượt quá số lượng mặt: Mô hình đầu vào có hơn 300.000 mặt. Vui lòng sử dụng API Remesh để giảm số lượng mặt trước khi rigging.
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
422 - Unprocessable Entity
Description
Ước tính tư thế thất bại. Mô hình được cung cấp có thể không phải là một nhân vật dạng người hợp lệ.
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/rigging

# Rig a model from a URL
curl https://api.meshy.ai/openapi/v1/rigging \
  -X POST \
  -H "Authorization: Bearer ${YOUR_API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
    "model_url": "YOUR_MODEL_URL_OR_DATA_URI",
    "height_meters": 1.8
  }'

Response

{
  "result": "018b314a-a1b5-716d-c222-2f1776f7f579"
}

GET/openapi/v1/rigging/:id

Truy xuất một tác vụ rigging

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

Tham số

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

Giá trị trả về

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

Request

GET

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

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

Response

{
  "id": "018b314a-a1b5-716d-c222-2f1776f7f579",
  "type": "rig",
  "status": "SUCCEEDED",
  "created_at": 1747032400453,
  "progress": 100,
  "started_at": 1747032401314,
  "finished_at": 1747032418417,
  "expires_at": 1747291618417,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 5,
  "result": {
    "rigged_character_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Character_output.fbx?Expires=...",
    "rigged_character_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Character_output.glb?Expires=...",
    "basic_animations": {
      "walking_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Walking_withSkin.glb?Expires=...",
      "walking_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Walking_withSkin.fbx?Expires=...",
      "walking_armature_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Walking_withSkin_armature.glb?Expires=...",
      "running_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Running_withSkin.glb?Expires=...",
      "running_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Running_withSkin.fbx?Expires=...",
      "running_armature_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Running_withSkin_armature.glb?Expires=..."
    }
  },
  "preceding_tasks": 0
}

DELETE/openapi/v1/rigging/:id

Xóa một tác vụ rigging

Endpoint này xóa vĩnh viễn một tác vụ rigging, 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ể đảo ngược.

Tham số đường dẫn

Name
id
Type
path
Description
ID của tác vụ rigging cần xóa.

Trả về

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

Request

DELETE

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

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

Response

// Returns 200 Ok on success.

GET/openapi/v1/rigging/:id/stream

Truyền trực tuyến một tác vụ Rigging

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ụ Rigging bằng Server-Sent Events (SSE).

Tham số

Name
id
Type
path
Description
Định danh duy nhất của tác vụ Rigging cần truyền trực tuyến.

Trả về

Trả về một luồng Các đối tượng tác vụ Rigging 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/rigging/018b314a-a1b5-716d-c222-2f1776f7f579/stream

curl -N https://api.meshy.ai/openapi/v1/rigging/018b314a-a1b5-716d-c222-2f1776f7f579/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": "018b314a-a1b5-716d-c222-2f1776f7f579",
  "progress": 0,
  "status": "PENDING"
}

event: message
data: {
  "id": "018b314a-a1b5-716d-c222-2f1776f7f579",
  "progress": 50,
  "status": "IN_PROGRESS"
}

event: message
data: { // Example of a SUCCEEDED task stream item, mirroring The Rigging Task Object structure
  "id": "018b314a-a1b5-716d-c222-2f1776f7f579",
  "type": "rig",
  "status": "SUCCEEDED",
  "created_at": 1747032400453,
  "progress": 100,
  "started_at": 1747032401314,
  "finished_at": 1747032418417,
  "expires_at": 1747291618417,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 5,
  "result": {
    "rigged_character_fbx_url": "https://assets.meshy.ai/.../Character_output.fbx?...",
    "rigged_character_glb_url": "https://assets.meshy.ai/.../Character_output.glb?...",
    "basic_animations": {
      "walking_glb_url": "https://assets.meshy.ai/.../Animation_Walking_withSkin.glb?...",
      "walking_fbx_url": "https://assets.meshy.ai/.../Animation_Walking_withSkin.fbx?...",
      "walking_armature_glb_url": "https://assets.meshy.ai/.../Animation_Walking_withSkin_armature.glb?...",
      "running_glb_url": "https://assets.meshy.ai/.../Animation_Running_withSkin.glb?...",
      "running_fbx_url": "https://assets.meshy.ai/.../Animation_Running_withSkin.fbx?...",
      "running_armature_glb_url": "https://assets.meshy.ai/.../Animation_Running_withSkin_armature.glb?..."
    }
  },
  "preceding_tasks": 0
}

Đối tượng Tác vụ Gắn xương

Đối tượng Tác vụ Gắn xương đại diện cho đơn vị công việc để gắn xương cho một nhân vật.

Thuộc tính

Name
id
Type
string
Description
Mã định danh duy nhất cho tác vụ.
Name
type
Type
string
Description
Loại tác vụ Rigging. Giá trị là rig.
Name
status
Type
string
Description
Trạng thái của tác vụ. Các giá trị có thể có: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
progress của tác vụ (0-100). 0 nếu chưa bắt đầu, 100 nếu đã thành công.
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 và có thể bị xóa.
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 đủ của đối tượng task_error.
Name
consumed_credits
Type
integer
Description
Số lượng 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 asset đầu ra nếu tác vụ SUCCEEDED, nếu không thì là null.
- Name
  rigged_character_fbx_url
  Type
  string
  Description
  URL có thể tải xuống cho nhân vật đã được rigging ở định dạng FBX.
- Name
  rigged_character_glb_url
  Type
  string
  Description
  URL có thể tải xuống cho nhân vật đã được rigging ở định dạng GLB.
- Name
  basic_animations
  Type
  object (optional)
  Description
  Chứa các URL cho hoạt hình (animation) mặc định. (ví dụ: nếu generate_basic_animations được đặt ngầm định là true hoặc được bật theo mặc định).
  Name
  walking_glb_url
  Type
  string
  Description
  URL có thể tải xuống cho hoạt hình (animation) đi bộ ở định dạng GLB (có da).
  Name
  walking_fbx_url
  Type
  string
  Description
  URL có thể tải xuống cho hoạt hình (animation) đi bộ ở định dạng FBX (có da).
  Name
  walking_armature_glb_url
  Type
  string
  Description
  URL có thể tải xuống cho bộ xương hoạt hình (animation) đi bộ ở định dạng GLB.
  Name
  running_glb_url
  Type
  string
  Description
  URL có thể tải xuống cho hoạt hình (animation) chạy ở định dạng GLB (có da).
  Name
  running_fbx_url
  Type
  string
  Description
  URL có thể tải xuống cho hoạt hình (animation) chạy ở định dạng FBX (có da).
  Name
  running_armature_glb_url
  Type
  string
  Description
  URL có thể tải xuống cho bộ xương hoạt hình (animation) chạy ở định dạng GLB.
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 Rigging Task Object

{
  "id": "018b314a-a1b5-716d-c222-2f1776f7f579",
  "type": "rig",
  "status": "SUCCEEDED",
  "created_at": 1747032400453,
  "progress": 100,
  "started_at": 1747032401314,
  "finished_at": 1747032418417,
  "expires_at": 1747291618417,
  "task_error": {

    "message": ""

  },

  "consumed_credits": 5,
  "result": {
    "rigged_character_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Character_output.fbx?Expires=...",
    "rigged_character_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Character_output.glb?Expires=...",
    "basic_animations": {
      "walking_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Walking_withSkin.glb?Expires=...",
      "walking_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Walking_withSkin.fbx?Expires=...",
      "walking_armature_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Walking_withSkin_armature.glb?Expires=...",
      "running_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Running_withSkin.glb?Expires=...",
      "running_fbx_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Running_withSkin.fbx?Expires=...",
      "running_armature_glb_url": "https://assets.meshy.ai/0630d47c-84b8-4d37-bc02-69e45d9272c1/tasks/018b314a-a1b5-716d-c222-2f1776f7f579/output/Animation_Running_withSkin_armature.glb?Expires=..."
    }
  },
  "preceding_tasks": 0
}