Use Animations with Comfy Router

Call meshy/animations through Comfy Router: endpoint, request shape and the response Router returns.

API Reference for meshy/animations, served by Comfy Router from Meshy.

Quick start

Create a key in your Comfy workspace and export it as COMFY_API_KEY. The Python and TypeScript snippets use the Comfy SDKs (pip install comfy-sdk, npm install @comfyorg/sdk); the cURL snippet is the same call over raw HTTP.

Model ID: meshy/animations

Endpoint: POST https://api.comfy.org/v2/models/meshy/animations

Python

from comfy_sdk import Comfy

# Reads COMFY_API_KEY from the environment.
# The SDK automatically creates an idempotency key and reuses it for automatic retries.
with Comfy() as client:
    result = client.models.run(
        "meshy/animations",
        {
            "action_id": 92,
            "post_process": {
                "fps": 60,
                "operation_type": "change_fps",
            },
            "rig_task_id": "0193abcd-0000-0000-0000-000000000000",
        },
    )

print(result)

Schema

Input

action_id · integer · required

The identifier of the animation action to apply.

post_process · object

Parameters for post-processing animation files.

post_process.fps · integer · default: "30"

The target frame rate. Default is 30. Applicable only when operation_type is change_fps.

Possible values: 24, 25, 30, 60

post_process.operation_type · string · required

The type of operation to perform.

Possible values: change_fps, fbx2usdz, extract_armature

rig_task_id · string · required

The id of a successfully completed rigging task (from POST /openapi/v1/rigging). The character from this task will be animated.

Generated from the schema Router serves at GET /v2/models/meshy/animations/openapi.json, the same document it validates a call against before the request reaches the provider.

Output

created_at · integer

Timestamp of when the task was created, in milliseconds.

Format: int64

expires_at · integer

Timestamp of when the task result expires, in milliseconds.

Format: int64

finished_at · integer

Timestamp of when the task was finished, in milliseconds. 0 if not finished.

Format: int64

id · string · required

Unique identifier for the task.

preceding_tasks · integer

The count of preceding tasks. Only meaningful when status is PENDING.

progress · integer

Progress of the task (0-100).

Range: 0 to 100

result · object

Contains the output animation URLs if the task SUCCEEDED.

result.animation_fbx_url · string

Downloadable URL for the animation in FBX format.

result.animation_glb_url · string

Downloadable URL for the animation in GLB format.

result.processed_animation_fps_fbx_url · string

Downloadable URL for the animation with changed FPS in FBX format.

result.processed_armature_fbx_url · string

Downloadable URL for the processed armature in FBX format.

result.processed_usdz_url · string

Downloadable URL for the processed animation in USDZ format.

started_at · integer

Timestamp of when the task was started, in milliseconds. 0 if not started.

Format: int64

status · string · required

Possible values: SUCCEEDED

task_error · object

Error object that contains the error message if the task failed.

task_error.message · string

Detailed error message.

type · string

Type of the Animation task.

Possible values: animate

Examples

Input

{
  "action_id": 92,
  "post_process": {
    "fps": 60,
    "operation_type": "change_fps"
  },
  "rig_task_id": "0193abcd-0000-0000-0000-000000000000"
}

Output

{
  "created_at": 1767225600000,
  "expires_at": 1767830400000,
  "finished_at": 1767225648000,
  "id": "018f2c7a-4b1e-7c3d-9a05-6e2f8b41d0c9",
  "progress": 100,
  "result": {
    "animation_fbx_url": "https://example.invalid/meshy/animations/animation.fbx",
    "animation_glb_url": "https://example.invalid/meshy/animations/animation.glb"
  },
  "started_at": 1767225601000,
  "status": "SUCCEEDED",
  "type": "animate"
}

Before you ship

The SDKs create an Idempotency-Key and reuse it for automatic retries. For manual retries, reuse the original key. Router can hold the connection for up to 10 minutes.

When a request fails, Router sends an X-Comfy-Error-Type response header explaining why. A 422 means Router rejected the input before calling the provider. Download generated assets promptly because result URLs can expire.

Headers

Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.

Using the Router API

Model discovery, validation errors, retries, and billing.

Limitations

What Router does not do today, and what to use instead.