アニメーション API

利用可能なアニメーションを検出し、リグ付きキャラクターに適用するためのエンドポイント。

POST/openapi/v1/animations

Create an Animation Task

このエンドポイントを使用すると、以前にリギングされたキャラクターにアニメーションを適用する新しいタスクを作成できます。適用できるのは、アニメーションライブラリのプリセットアクション（action_id）、複数のプリセットアクションを1つのファイルにマージしたもの（action_ids）、またはText to Motion APIで生成したモーションクリップ（motion_task_id）のいずれかです。後処理オプションも含まれます。

パラメータ

Name
rig_task_id
Type
string
必須
Description
正常に完了したリギングタスク（POST /openapi/v1/riggingから取得）のidです。このタスクのキャラクターにアニメーションが適用されます。
Name
action_id
Type
integer
Description
適用するプリセットアニメーションアクションの識別子です。利用可能なアニメーションの完全な一覧はAnimation Library Referenceを参照してください。action_id、action_ids、motion_task_idのうちいずれか1つを指定してください。
Name
action_ids
Type
array of integers
Description
一度に適用する複数のプリセットアニメーションアクションです。アクションごとに1つのアニメーションクリップを含む単一ファイルとして返されます。これはゲームエンジンのステートマシンからキャラクターを制御する場合に便利です。Animation Library Referenceから1〜10個のaction_idの値を指定してください。idは一意である必要があります。アクションごとに3クレジットかかります。action_id、action_ids、motion_task_idのうちいずれか1つを指定してください。
単一要素のaction_idsを渡すことは、その値をaction_idとして渡すことと同等です。
Name
motion_task_id
Type
string
Description
プリセットアクションの代わりに適用する、正常に完了したText to Motionタスクのidです。生成されたクリップはリギング済みキャラクターにリターゲットされ、そのクリップは作成時点でスナップショットが取られるため、元となったタスクが後で期限切れになったり削除されたりしても、このタスクには影響しません。元となったタスクのアセットは3日間保持されるため、期限が切れる前にクリップを適用してください。二足歩行のリグが必要です。action_id、action_ids、motion_task_idのうちいずれか1つを指定してください。
Name
post_process
Type
object
Description
アニメーション出力に対するオプションの後処理です。省略した場合は標準のアニメーションファイルが得られます。

次の場合のみ適用 post_process is set

Name
operation_type
Type
string
必須
Description
実行する操作の種類です。使用可能な値: change_fps、fbx2usdz、extract_armature。
Name
fps
Type
integer
デフォルト 30
Description
目標のフレームレートです。operation_typeがchange_fpsの場合にのみ適用されます。使用可能な値: 24、25、30、60。

action_idsを使用すると、タスクはアクションごとに1ファイルではなく、マージされた1つのファイルを返します。animation_glb_urlとanimation_fbx_urlはそれぞれ、要求されたすべてのアクションを個別のクリップとして含む単一のアセットを指します。

クリップの順序: idの数値順ではなく、action_ids配列の順序です。
クリップ名: ライブラリ内のアニメーション名で、Meshyウェブアプリからキャラクターの全アニメーションを単一ファイルとしてエクスポートしたときに得られる名前と一致します。要求された2つのidが同じクリップ名に解決される場合、後の方には一意性を保つためにaction_idがサフィックスとして付加されます。
後処理: 個々のクリップではなく、マージされたファイルに対して適用されます。

motion_task_idを使用する場合、リターゲット処理の結果はGLBのみのアニメーションになることがあります。post_processを要求したにもかかわらずFBXが利用できない場合、タスクはtask_errorで失敗し、クレジットは自動的に返金されます。post_processを指定していない場合はタスクは成功し、animation_fbx_urlは空になります。

返り値

レスポンスのresultプロパティには、新しく作成されたアニメーションタスクのタスクidが含まれます。

失敗モード

Name
400 - Bad Request
Description
リクエストが受け入れられませんでした。一般的な原因:
- パラメータ不足: rig_task_idが指定されていない、またはaction_id、action_ids、motion_task_idのいずれも指定されていません。
- パラメータの競合: action_id、action_ids、motion_task_idのうち複数が指定されました — これらは互いに排他的です。
- 無効なリグタスク: rig_task_idが無効であるか、失敗した、または存在しないタスクを参照しています。
- 無効なアクションID: action_id、またはaction_idsのいずれかの要素が、有効なアニメーションに対応していません。
- アクションが多すぎる: action_idsに10個を超えるidが含まれています。
- 重複したアクション: action_idsに同じidが複数回含まれています。
- モーションタスクが未完了: motion_task_idのタスクがまだSUCCEEDEDになっていません。
- サポートされていないリグ: motion_task_idには二足歩行のリグが必要です。四足歩行のリグは拒否されます。
Name
401 - Unauthorized
Description
認証に失敗しました。APIキーを確認してください。
Name
402 - Payment Required
Description
このタスクを実行するためのクレジットが不足しています。
Name
404 - Not Found
Description
rig_task_idで指定されたリギングタスクが見つからないか、motion_task_idで指定されたモーションタスクが見つからないか、またはモーションクリップの期限が切れています（元となったタスクのアセットは3日間保持されます）。
Name
429 - Too Many Requests
Description
レート制限を超えました。

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 several preset actions and get one file with one clip per 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",
    "action_ids": [10, 25, 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

アニメーションタスクを取得する

このエンドポイントでは、有効なタスクidを指定してアニメーションタスクを取得できます。含まれるプロパティについてはThe Animation Task Objectを参照してください。

パラメータ

Name
id
Type
path
Description
取得するアニメーションタスクの一意の識別子。

戻り値

レスポンスにはAnimation Taskオブジェクトが含まれます。詳細はThe Animation Task Objectセクションを確認してください。

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

アニメーションタスクの削除

このエンドポイントは、関連するすべてのモデルとデータを含め、アニメーションタスクを完全に削除します。この操作は取り消せません。

パスパラメータ

Name
id
Type
path
Description
削除するアニメーションタスクのID。

タスクステータス

まだ PENDING の状態のタスクは削除され、作成時に消費されたクレジットは返金されます。

すでに IN_PROGRESS のタスクは削除できません。リクエストは 409 Conflict で拒否され、タスクは実行され続けます。ワーカーがすでに処理を開始しているタスクのクレジットは返金対象外のため、実行中に削除するとクレジットと結果の両方を失うことになります。SUCCEEDED、FAILED、CANCELED のいずれかの状態になるのを待ってから削除してください。

終了状態（SUCCEEDED、FAILED、CANCELED）にあるタスクは返金なしで削除されます。

返り値

成功時は 200 OK を返し、タスクが IN_PROGRESS の場合は 409 Conflict を返します。

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

// 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/animations

アニメーションタスク一覧の取得

呼び出し元のアニメーションタスクのページネーションされた一覧を、新しい順に返します。page_num と page_size による標準的なページネーションが利用できます。

APIを通じて作成されたタスクはAPIを通じて管理される点にご注意ください。これらはウェブアプリのMy Assetsには表示されません。IDを紛失したタスクを探す際にはこのエンドポイントを使用してください。

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

Animationタスクをストリーミングする

このエンドポイントは、Server-Sent Events (SSE) を使用してAnimationタスクのリアルタイム更新をストリーミングします。

パラメータ

Name
id
Type
path
Description
ストリーミングするAnimationタスクの一意の識別子です。

戻り値

The Animation Task Objects のストリームをServer-Sent Eventsとして返します。

PENDING または IN_PROGRESS のタスクの場合、レスポンスストリームには必要な progress および status フィールドのみが含まれます。

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

Animation Task オブジェクトは、リギングされたキャラクターにアニメーションを適用するための作業単位を表します。

プロパティ

Name
id
Type
string
Description
タスクの一意の識別子。
Name
type
Type
string
Description
Animation タスクのタイプ。値は animate です。
Name
status
Type
string
Description
タスクのステータス。可能な値: PENDING、IN_PROGRESS、SUCCEEDED、FAILED、CANCELED。
Name
progress
Type
integer
Description
タスクの進行状況（0〜100）。
Name
created_at
Type
timestamp
Description
タスクが作成された時点のタイムスタンプ（エポックからのミリ秒数）。
タイムスタンプは、RFC 3339 標準に従って、 1970年1月1日 UTC からの経過ミリ秒数を表します。例えば、2023年9月1日金曜日12:00:00 PM GMT は 1693569600000 と表されます。これは Meshy API 内の すべての タイムスタンプに適用されます。
Name
started_at
Type
timestamp
Description
タスクの処理が開始された時点のタイムスタンプ（エポックからのミリ秒数）。開始されていない場合は 0。
Name
finished_at
Type
timestamp
Description
タスクが完了した時点のタイムスタンプ（エポックからのミリ秒数）。完了していない場合は 0。
Name
expires_at
Type
timestamp
Description
タスクの結果アセットが期限切れになる時点のタイムスタンプ（エポックからのミリ秒数）。
Name
task_error
Type
object
Description
失敗したタスクのエラー詳細。task_error オブジェクトの完全なリファレンスについては Errors を参照してください。
Name
consumed_credits
Type
integer
Description
このタスクによって消費されたクレジット数。タスクのステータスが PENDING、IN_PROGRESS、または SUCCEEDED の場合に存在します。FAILED タスクの場合は 0 を返します（失敗時はクレジットが払い戻されます）。
Name
result
Type
object
Description
タスクが SUCCEEDED の場合、出力アニメーションの URL を含みます。
- Name
  animation_glb_url
  Type
  string
  Description
  GLB 形式のアニメーションのダウンロード可能な URL。action_ids を使用して作成されたタスクの場合、この単一ファイルには要求されたすべてのアクションが個別のクリップとして含まれます。
- Name
  animation_fbx_url
  Type
  string
  Description
  FBX 形式のアニメーションのダウンロード可能な URL。action_ids を使用して作成されたタスクの場合、この単一ファイルには要求されたすべてのアクションが個別のクリップとして含まれます。
- Name
  processed_usdz_url
  Type
  string
  Description
  USDZ 形式で処理されたアニメーションのダウンロード可能な URL。
- Name
  processed_armature_fbx_url
  Type
  string
  Description
  FBX 形式で処理されたアーマチュアのダウンロード可能な URL。
- Name
  processed_animation_fps_fbx_url
  Type
  string
  Description
  FPS が変更された（例えば change_fps 操作が使用された場合の）FBX 形式のアニメーションのダウンロード可能な URL。
Name
preceding_tasks
Type
integer
Description
キュー内の先行タスクの数。ステータスが 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
}

GET/openapi/v1/animations/library

List Animations

ライブラリ内のすべてのアニメーションを action_id の順に返します。レスポンスはページ分割ではなく完全なリストなので、1回の呼び出しでアクションピッカーに必要なデータをすべて取得できます。フィルタを使うと結果を絞り込めます。すべて省略すると全件を取得します。

同じカタログを目で見て、各アクションのアニメーションプレビューを確認しながら閲覧したい場合は、アニメーションライブラリのリファレンスを参照してください。

このエンドポイントは無料です — クレジットを消費しません。

パラメータ

Name
search
Type
string
Description
name または key に対する大文字小文字を区別しない部分一致検索です。文字通りに照合されるため、% や _ はワイルドカードではなく通常の文字として扱われます。
Name
category
Type
string
Description
category の完全一致です。
使用可能な値：
- WalkAndRun
- BodyMovements
- DailyActions
- Fighting
- Dancing
Name
sub_category
Type
string
Description
sub_category の完全一致です。単独で指定することも可能です — サブカテゴリ名はカテゴリ間で一意ではないため（Transitioning は Fighting と DailyActions の両方に存在します）、category を指定しない場合、このフィルタはそのサブカテゴリが現れるすべての箇所にマッチします。
Name
action_ids
Type
string
Description
返却対象とする action_id のカンマ区切りリストで、閲覧ではなく特定のIDを解決するために使用します。最大200個のIDを受け付けます。どのアニメーションにも存在しないIDはレスポンスから単純に省かれるため、保存済みのIDがまだ有効かどうかを確認する用途にも使えます。

フィルタの組み合わせ

フィルタは組み合わせて適用されます — 各フィルタが結果をさらに絞り込むため、アニメーションはすべての条件を満たした場合にのみ返されます。1つのフィルタ内では、複数の値のいずれかにマッチします：search は name または key にマッチし、action_ids はリスト内のいずれかのIDにマッチします。

つまり、重複がない組み合わせの場合はエラーではなく空の配列が返されます。アクション 92 は「Double Combo Attack」という Fighting のアニメーションです：

?action_ids=92&category=Fighting はアクション 92 を返します。
?action_ids=92&category=Dancing は [] を返します — これは Dancing のアニメーションではないためです。
?action_ids=92&search=walk は [] を返します — その名前は walk にマッチしないためです。

カテゴリに関わらず特定のアニメーションを取得するには、action_ids を単独で指定してください。

戻り値

The Animation Objects のリストを返します。

ここで返される action_id はすべて、上記のアニメーションタスクの作成で受け付けられ、そこで受け付けられるIDはすべてここで返されます。廃止されたアニメーションは両方に存在しません。ライブラリをキャッシュする場合は、廃止されたIDがピッカーに残り続けないよう、定期的に更新してください。

Request

GET

/openapi/v1/animations/library

curl "https://api.meshy.ai/openapi/v1/animations/library?category=Fighting" \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

[
  {
    "action_id": 4,
    "name": "Attack",
    "key": "Attack",
    "category": "Fighting",
    "sub_category": "AttackingwithWeapon",
    "preview_url": "https://cdn.meshy.ai/webapp-assets/feature-demo/animation/preview/biped/Attack.gif"
  },
  {
    "action_id": 92,
    "name": "Double Combo Attack",
    "key": "Double_Combo_Attack",
    "category": "Fighting",
    "sub_category": "AttackingwithWeapon",
    "preview_url": "https://cdn.meshy.ai/webapp-assets/feature-demo/animation/preview/biped/Double_Combo_Attack.gif"
  }
]

Animationオブジェクト

Name
action_id
Type
integer
Description
アニメーションタスクを作成する際に action_id として渡す値です。一意で安定していますが、連番ではありません — 廃止されたアニメーションは番号に欠番を生じさせるため、id の範囲が連続していると仮定しないでください。
Name
name
Type
string
Description
表示用の人間が読める形式のラベルです。一意ではありません。異なるバリアントが同じ名前を共有している場合があるため、識別には action_id または key を使用してください。
Name
key
Type
string
Description
アニメーション用の一意で安定したスラッグです。数値以外の識別子を自分のストレージのキーとして使用する必要がある場合に使用してください。
Name
category
Type
string
Description
トップレベルのグルーピングです。例: Fighting。
Name
sub_category
Type
string
Description
カテゴリ内のグルーピングです。例: AttackingwithWeapon。
Name
preview_url
Type
string
Description
アクションをプレビューするアニメーションGIFのURLで、自作のピッカーに直接表示するのに適しています。

Example Animation Object

{
  "action_id": 92,
  "name": "Double Combo Attack",
  "key": "Double_Combo_Attack",
  "category": "Fighting",
  "sub_category": "AttackingwithWeapon",
  "preview_url": "https://cdn.meshy.ai/webapp-assets/feature-demo/animation/preview/biped/Double_Combo_Attack.gif"
}