> ## Documentation Index
> Fetch the complete documentation index at: https://docs.comfy.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Use Rigging with Comfy Router

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

API Reference for `meshy/rigging`, 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/rigging`

**Endpoint:** `POST https://api.comfy.org/v2/models/meshy/rigging`

<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/rigging",
          {
              "height_meters": 1.8,
              "input_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/rigging", {
    height_meters: 1.8,
    input_task_id: "0193abcd-0000-0000-0000-000000000000",
  });

  console.log(data);
  ```

  ```bash cURL theme={null}
  curl https://api.comfy.org/v2/models/meshy/rigging \
    -H "X-API-Key: $COMFY_API_KEY" \
    -H "Idempotency-Key: $(uuidgen)" \
    -H "Content-Type: application/json" \
    -d "{\"height_meters\": 1.8, \"input_task_id\": \"0193abcd-0000-0000-0000-000000000000\"}"
  ```
</CodeGroup>

## Schema

### Input

<ParamField body="height_meters" type="number" default="1.7">
  The approximate height of the character model in meters. Must be a positive number.

  Range: `0` to `…`
</ParamField>

<ParamField body="input_task_id" type="string">
  The input task that needs to be rigged. Required if model\_url is not provided.
</ParamField>

<ParamField body="model_url" type="string">
  A publicly accessible URL or Data URI to a textured humanoid GLB file. Required if input\_task\_id is not provided.
</ParamField>

<ParamField body="texture_image_url" type="string">
  The model's UV-unwrapped base color texture image. Publicly accessible URL or Data URI. Supports .png format.
</ParamField>

Generated from the schema Router serves at `GET /v2/models/meshy/rigging/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). 0 if not started, 100 if succeeded.

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

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

<ResponseField name="result.basic_animations" type="object">
  Contains URLs for default animations.
</ResponseField>

<ResponseField name="result.basic_animations.running_armature_glb_url" type="string">
  Downloadable URL for running animation armature in GLB format.
</ResponseField>

<ResponseField name="result.basic_animations.running_fbx_url" type="string">
  Downloadable URL for running animation in FBX format (with skin).
</ResponseField>

<ResponseField name="result.basic_animations.running_glb_url" type="string">
  Downloadable URL for running animation in GLB format (with skin).
</ResponseField>

<ResponseField name="result.basic_animations.walking_armature_glb_url" type="string">
  Downloadable URL for walking animation armature in GLB format.
</ResponseField>

<ResponseField name="result.basic_animations.walking_fbx_url" type="string">
  Downloadable URL for walking animation in FBX format (with skin).
</ResponseField>

<ResponseField name="result.basic_animations.walking_glb_url" type="string">
  Downloadable URL for walking animation in GLB format (with skin).
</ResponseField>

<ResponseField name="result.rigged_character_fbx_url" type="string">
  Downloadable URL for the rigged character in FBX format.
</ResponseField>

<ResponseField name="result.rigged_character_glb_url" type="string">
  Downloadable URL for the rigged character in GLB 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 Rigging task.

  Possible values: `rig`
</ResponseField>

## Examples

### Input

```json theme={null}
{
  "height_meters": 1.8,
  "input_task_id": "0193abcd-0000-0000-0000-000000000000"
}
```

### Output

```json theme={null}
{
  "created_at": 1767225600000,
  "expires_at": 1767830400000,
  "finished_at": 1767225712000,
  "id": "018f2c7a-4b1e-7c3d-9a05-6e2f8b41d0c9",
  "progress": 100,
  "result": {
    "basic_animations": {
      "running_glb_url": "https://example.invalid/meshy/rigging/running.glb",
      "walking_glb_url": "https://example.invalid/meshy/rigging/walking.glb"
    },
    "rigged_character_fbx_url": "https://example.invalid/meshy/rigging/character.fbx",
    "rigged_character_glb_url": "https://example.invalid/meshy/rigging/character.glb"
  },
  "started_at": 1767225601000,
  "status": "SUCCEEDED",
  "type": "rig"
}
```

## 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>