Animation API

Endpoint untuk menemukan Animasi yang tersedia dan menerapkannya pada karakter yang memiliki rig.

POST/openapi/v1/animations

Create an Animation Task

Endpoint ini memungkinkan Anda membuat tugas baru untuk menerapkan animasi ke karakter yang sebelumnya sudah di-rig — baik berupa aksi preset dari pustaka animasi (action_id) atau klip gerakan yang Anda hasilkan dengan Text to Motion API (motion_task_id). Termasuk opsi pasca-pemrosesan.

Parameter

Name
rig_task_id
Type
string
Wajib
Description
id dari tugas rigging yang berhasil diselesaikan (dari POST /openapi/v1/rigging). Karakter dari tugas ini akan dianimasikan.
Name
action_id
Type
integer
Description
Pengenal dari aksi animasi preset yang akan diterapkan. Lihat Referensi Pustaka Animasi untuk daftar lengkap animasi yang tersedia. Berikan tepat satu dari action_id atau motion_task_id.
Name
motion_task_id
Type
string
Description
id dari tugas Text to Motion yang berhasil diselesaikan, untuk diterapkan sebagai pengganti aksi preset. Klip yang dihasilkan akan di-retarget ke karakter yang sudah di-rig, dan klip tersebut diambil snapshot-nya pada saat pembuatan, sehingga tugas ini tidak terpengaruh jika tugas sumbernya kemudian kedaluwarsa atau dihapus. Aset dari tugas sumber disimpan selama 3 hari — terapkan klip tersebut sebelum kedaluwarsa. Membutuhkan rig biped. Berikan tepat satu dari action_id atau motion_task_id.
Name
post_process
Type
object
Description
Pasca-pemrosesan opsional untuk hasil animasi. Abaikan parameter ini untuk menerima berkas animasi standar.

Hanya berlaku ketika post_process is set

Name
operation_type
Type
string
Wajib
Description
Jenis operasi yang akan dilakukan. Nilai yang tersedia: change_fps, fbx2usdz, extract_armature.
Name
fps
Type
integer
default 30
Description
Frame rate target. Hanya berlaku jika operation_type adalah change_fps. Nilai yang diizinkan: 24, 25, 30, 60.

Dengan motion_task_id, proses retarget dapat menghasilkan animasi yang hanya berformat GLB. Jika Anda meminta post_process dan FBX tidak tersedia, tugas akan gagal dengan task_error dan kredit Anda akan dikembalikan secara otomatis; tanpa post_process, tugas akan berhasil dan animation_fbx_url akan kosong.

Hasil Pengembalian

Properti result pada respons berisi id tugas dari tugas animasi yang baru dibuat.

Mode Kegagalan

Name
400 - Bad Request
Description
Permintaan tidak dapat diterima. Penyebab umum:
- Parameter hilang: rig_task_id tidak ada, atau baik action_id maupun motion_task_id tidak diberikan.
- Parameter yang bertentangan: baik action_id maupun motion_task_id diberikan — keduanya saling eksklusif.
- Tugas rig tidak valid: rig_task_id tidak valid atau merujuk pada tugas yang gagal/tidak ada.
- ID aksi tidak valid: action_id tidak sesuai dengan animasi yang valid.
- Tugas motion belum siap: tugas motion_task_id belum SUCCEEDED.
- Rig tidak didukung: motion_task_id membutuhkan rig biped; rig quadruped ditolak.
Name
401 - Unauthorized
Description
Autentikasi gagal. Silakan periksa kunci API Anda.
Name
402 - Payment Required
Description
Kredit tidak cukup untuk melakukan tugas ini.
Name
404 - Not Found
Description
Tugas rigging yang ditentukan oleh rig_task_id tidak ditemukan, tugas motion yang ditentukan oleh motion_task_id tidak ditemukan, atau klip motion telah kedaluwarsa (aset tugas sumber disimpan selama 3 hari).
Name
429 - Too Many Requests
Description
Anda telah melampaui batas laju Anda.

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
  }'

# Apply a generated Text to Motion clip instead of a preset action
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",
    "motion_task_id": "018c425b-b2c6-727e-d333-3c1887i9h791"
  }'

# 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

Mengambil Tugas Animasi

Endpoint ini memungkinkan Anda mengambil tugas animasi berdasarkan id tugas yang valid. Lihat The Animation Task Object untuk melihat properti apa saja yang disertakan.

Parameter

Name
id
Type
path
Description
Pengenal unik untuk tugas animasi yang akan diambil.

Returns

Respons berisi objek Animation Task. Periksa bagian The Animation Task Object untuk detailnya.

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

Hapus Tugas Animasi

Endpoint ini menghapus tugas animasi secara permanen, termasuk semua model dan data yang terkait. Tindakan ini tidak dapat dibatalkan.

Parameter Path

Name
id
Type
path
Description
ID dari tugas animasi yang akan dihapus.

Nilai Kembali

Mengembalikan 200 OK jika berhasil.

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

List Animation Tasks

Mengembalikan daftar tugas Animasi milik pemanggil yang telah dipaginasi, dengan urutan terbaru lebih dulu. Paginasi standar melalui page_num dan page_size.

Perhatikan bahwa tugas yang dibuat melalui API dikelola melalui API — tugas tersebut tidak muncul di My Assets pada aplikasi web. Gunakan endpoint ini untuk menemukan tugas yang ID-nya sudah tidak Anda miliki lagi.

Request

GET

/openapi/v1/animations

curl "https://api.meshy.ai/openapi/v1/animations?page_num=1&page_size=20" \
-H "Authorization: Bearer ${YOUR_API_KEY}"

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

Streaming Task Animasi

Endpoint ini melakukan streaming pembaruan secara real-time untuk task Animasi menggunakan Server-Sent Events (SSE).

Parameter

Name
id
Type
path
Description
Pengidentifikasi unik untuk task Animasi yang akan di-streaming.

Returns

Mengembalikan stream dari The Animation Task Objects sebagai Server-Sent Events.

Untuk task dengan status PENDING atau IN_PROGRESS, stream respons hanya akan menyertakan field progress dan status yang diperlukan.

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
}

The Animation Task Object

Objek Animation Task merepresentasikan unit kerja untuk menerapkan animasi pada karakter yang telah memiliki rig.

Properties

Name
id
Type
string
Description
Pengenal unik untuk task ini.
Name
type
Type
string
Description
Jenis task Animation. Nilainya adalah animate.
Name
status
Type
string
Description
Status task. Nilai yang mungkin: PENDING, IN_PROGRESS, SUCCEEDED, FAILED, CANCELED.
Name
progress
Type
integer
Description
Progress dari task (0-100).
Name
created_at
Type
timestamp
Description
Stempel waktu (dalam milidetik sejak epoch) saat task dibuat.
Stempel waktu merepresentasikan jumlah milidetik yang telah berlalu sejak 1 Januari 1970 UTC, mengikuti standar RFC 3339. Sebagai contoh, Jumat, 1 September 2023 12:00:00 PM GMT direpresentasikan sebagai 1693569600000. Hal ini berlaku untuk semua stempel waktu di Meshy API.
Name
started_at
Type
timestamp
Description
Stempel waktu (dalam milidetik sejak epoch) saat task mulai diproses. 0 jika belum dimulai.
Name
finished_at
Type
timestamp
Description
Stempel waktu (dalam milidetik sejak epoch) saat task selesai. 0 jika belum selesai.
Name
expires_at
Type
timestamp
Description
Stempel waktu (dalam milidetik sejak epoch) saat aset hasil task ini kedaluwarsa.
Name
task_error
Type
object
Description
Detail kesalahan untuk task yang gagal. Lihat Kesalahan untuk referensi lengkap objek task_error.
Name
consumed_credits
Type
integer
Description
Jumlah kredit yang digunakan oleh task ini. Muncul saat status task adalah PENDING, IN_PROGRESS, atau SUCCEEDED. Mengembalikan 0 untuk task FAILED (kredit dikembalikan jika gagal).
Name
result
Type
object
Description
Berisi URL animasi hasil jika task SUCCEEDED.
- Name
  animation_glb_url
  Type
  string
  Description
  URL yang dapat diunduh untuk animasi dalam format GLB.
- Name
  animation_fbx_url
  Type
  string
  Description
  URL yang dapat diunduh untuk animasi dalam format FBX.
- Name
  processed_usdz_url
  Type
  string
  Description
  URL yang dapat diunduh untuk animasi yang telah diproses dalam format USDZ.
- Name
  processed_armature_fbx_url
  Type
  string
  Description
  URL yang dapat diunduh untuk armature yang telah diproses dalam format FBX.
- Name
  processed_animation_fps_fbx_url
  Type
  string
  Description
  URL yang dapat diunduh untuk animasi dengan FPS yang telah diubah dalam format FBX (misalnya, jika operasi change_fps digunakan).
Name
preceding_tasks
Type
integer
Description
Jumlah task sebelumnya dalam antrean. Hanya bermakna jika status adalah 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
}