> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-matt-sdk-0-3-0-run-kind.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# 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](https://platform.comfy.org/profile/api-keys) 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`

<Tabs>
  <Tab title="Wait for the result">
    <CodeGroup>
      ```python Python theme={null}
      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)
      ```

      ```typescript TypeScript theme={null}
      import { comfy } from "@comfyorg/sdk";

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

      console.log(data);
      ```

      ```bash cURL theme={null}
      curl https://api.comfy.org/v2/models/meshy/animations \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"action_id\": 92, \"post_process\": {\"fps\":60,\"operation_type\":\"change_fps\"}, \"rig_task_id\": \"0193abcd-0000-0000-0000-000000000000\"}"
      ```
    </CodeGroup>
  </Tab>

  <Tab title="Queue and collect later">
    <Note>
      Queued delivery is rolling out per workspace. Until yours is enabled, the submit route answers `403` with `X-Comfy-Error-Type: not_enabled`. Nothing about the request is wrong, and the same body works through the synchronous route in the meantime.
    </Note>

    The same body, sent to `POST https://api.comfy.org/v2/models/meshy/animations/requests`. Router answers `201` with a `request_id` as soon as the run is admitted, and the result is collected once it is ready, from this process or another one. [Queued delivery](/development/comfy-router/queue) walks through status, cancellation and collection.

    <CodeGroup>
      ```python Python theme={null}
      from comfy_sdk import Comfy

      # Reads COMFY_API_KEY from the environment.
      # Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      with Comfy() as client:
          handle = client.models.submit(
              "meshy/animations",
              {
                  "action_id": 92,
                  "post_process": {
                      "fps": 60,
                      "operation_type": "change_fps",
                  },
                  "rig_task_id": "0193abcd-0000-0000-0000-000000000000",
              },
          )
          print("request_id:", handle.request_id)  # with the model ID, all another process needs

          # Poll until the request completes, waiting the Retry-After the server names.
          for update in handle.iter_events():
              print(update.status, update.queue_position)

          # The provider's own payload, the same value models.run() returns.
          # A request that failed or was cancelled raises the typed Router error here.
          result = handle.get()

      print(result)
      ```

      ```typescript TypeScript theme={null}
      import { comfy } from "@comfyorg/sdk";

      // Reads COMFY_API_KEY from the environment.
      // Each submit() call mints its own Idempotency-Key and reuses it for automatic retries.
      const handle = await comfy.models.submit("meshy/animations", {
        action_id: 92,
        post_process: {
          fps: 60,
          operation_type: "change_fps",
        },
        rig_task_id: "0193abcd-0000-0000-0000-000000000000",
      });
      console.log("requestId:", handle.requestId); // with the model ID, all another process needs

      // Poll until the request completes, waiting the Retry-After the server names.
      for await (const update of handle.events()) {
        console.log(update.status, update.queuePosition);
      }

      // The same result models.run() returns. A request that failed or was cancelled rejects here.
      const result = await handle.get();

      console.log(result.data);
      ```

      ```bash cURL theme={null}
      # 1. Submit. Router answers 201 with request_id, status_url, response_url and cancel_url.
      curl https://api.comfy.org/v2/models/meshy/animations/requests \
        -H "X-API-Key: $COMFY_API_KEY" \
        -H "Idempotency-Key: $(uuidgen)" \
        -H "Content-Type: application/json" \
        -d "{\"action_id\": 92, \"post_process\": {\"fps\":60,\"operation_type\":\"change_fps\"}, \"rig_task_id\": \"0193abcd-0000-0000-0000-000000000000\"}"

      # 2. Poll until status is COMPLETED, waiting the Retry-After seconds each response names.
      REQUEST_ID="<request_id from the 201 body>"
      curl -i https://api.comfy.org/v2/models/meshy/animations/requests/$REQUEST_ID/status \
        -H "X-API-Key: $COMFY_API_KEY"

      # 3. Collect. 200 with the model's native output, 202 with the status body while it is still running.
      curl https://api.comfy.org/v2/models/meshy/animations/requests/$REQUEST_ID \
        -H "X-API-Key: $COMFY_API_KEY"
      ```
    </CodeGroup>
  </Tab>
</Tabs>

## Schema

### Input

<ParamField body="action_id" type="integer" required>
  The identifier of the animation action to apply.
</ParamField>

<ParamField body="post_process" type="object">
  Parameters for post-processing animation files.
</ParamField>

<ParamField body="post_process.fps" type="integer" default="30">
  The target frame rate. Default is 30. Applicable only when operation\_type is change\_fps.

  Possible values: `24`, `25`, `30`, `60`
</ParamField>

<ParamField body="post_process.operation_type" type="string" required>
  The type of operation to perform.

  Possible values: `change_fps`, `fbx2usdz`, `extract_armature`
</ParamField>

<ParamField body="rig_task_id" type="string" required>
  The id of a successfully completed rigging task (from POST /openapi/v1/rigging). The character from this task will be animated.
</ParamField>

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

<ResponseField name="created_at" type="integer">
  Timestamp of when the task was created, in milliseconds.

  Format: `int64`
</ResponseField>

<ResponseField name="expires_at" type="integer">
  Timestamp of when the task result expires, in milliseconds.

  Format: `int64`
</ResponseField>

<ResponseField name="finished_at" type="integer">
  Timestamp of when the task was finished, in milliseconds. 0 if not finished.

  Format: `int64`
</ResponseField>

<ResponseField name="id" type="string" required>
  Unique identifier for the task.
</ResponseField>

<ResponseField name="preceding_tasks" type="integer">
  The count of preceding tasks. Only meaningful when status is PENDING.
</ResponseField>

<ResponseField name="progress" type="integer">
  Progress of the task (0-100).

  Range: `0` to `100`
</ResponseField>

<ResponseField name="result" type="object">
  Contains the output animation URLs if the task SUCCEEDED.
</ResponseField>

<ResponseField name="result.animation_fbx_url" type="string">
  Downloadable URL for the animation in FBX format.
</ResponseField>

<ResponseField name="result.animation_glb_url" type="string">
  Downloadable URL for the animation in GLB format.
</ResponseField>

<ResponseField name="result.processed_animation_fps_fbx_url" type="string">
  Downloadable URL for the animation with changed FPS in FBX format.
</ResponseField>

<ResponseField name="result.processed_armature_fbx_url" type="string">
  Downloadable URL for the processed armature in FBX format.
</ResponseField>

<ResponseField name="result.processed_usdz_url" type="string">
  Downloadable URL for the processed animation in USDZ format.
</ResponseField>

<ResponseField name="started_at" type="integer">
  Timestamp of when the task was started, in milliseconds. 0 if not started.

  Format: `int64`
</ResponseField>

<ResponseField name="status" type="string" required>
  Possible values: `SUCCEEDED`
</ResponseField>

<ResponseField name="task_error" type="object">
  Error object that contains the error message if the task failed.
</ResponseField>

<ResponseField name="task_error.message" type="string">
  Detailed error message.
</ResponseField>

<ResponseField name="type" type="string">
  Type of the Animation task.

  Possible values: `animate`
</ResponseField>

## Examples

### Input

```json theme={null}
{
  "action_id": 92,
  "post_process": {
    "fps": 60,
    "operation_type": "change_fps"
  },
  "rig_task_id": "0193abcd-0000-0000-0000-000000000000"
}
```

### Output

```json theme={null}
{
  "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](/development/comfy-router/reference#result-assets).

<CardGroup cols={3}>
  <Card title="Headers" icon="list" href="/development/comfy-router/headers">
    Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.
  </Card>

  <Card title="Using the Router API" icon="code" href="/development/comfy-router/api">
    Model discovery, validation errors, retries, and billing.
  </Card>

  <Card title="Limitations" icon="triangle-exclamation" href="/development/comfy-router/limitations">
    What Router does not do today, and what to use instead.
  </Card>
</CardGroup>