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

# Comfy Router で Rigging を使用する

> Comfy Router 経由で meshy/rigging を呼び出します。エンドポイント、リクエスト形状、Router が返すレスポンスについて説明します。

`meshy/rigging` の API リファレンス。Meshy から Comfy Router によって提供されます。

**入力：** 3D · **出力：** 3D

## クイックスタート

[Comfy ワークスペース](https://platform.comfy.org/profile/api-keys?onboarding=router)でキーを作成し、`COMFY_API_KEY` としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK（`pip install comfy-sdk` と `npm install @comfyorg/sdk`）を使用しています。cURL のスニペットは、同じ呼び出しを生の HTTP で実行するものです。

**モデル ID:** `meshy/rigging`

**エンドポイント:** `POST https://api.comfy.org/v2/models/meshy/rigging`

> [tab] 結果を待つ
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # 環境変数から COMFY_API_KEY を読み取ります。
> # SDK は自動的に冪等性キーを作成し、自動リトライのために再利用します。
> 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";
>
> // 環境変数から COMFY_API_KEY を読み取ります。
> // SDK は自動的に冪等性キーを作成し、自動リトライのために再利用します。
> 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\"}"
> ```

> [tab] キューに送信して後で取得する
>
> 同じボディを `POST https://api.comfy.org/v2/models/meshy/rigging/requests` に送信します。Router は実行が受け付けられ次第 `201` と `request_id` を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも取得できます。ステータス、キャンセル、結果の取得については [キュー配信](https://docs.comfy.org/ja/development/comfy-router/queue.md) で詳しく説明しています。
>
> ```python Python theme={null}
> import asyncio
> from comfy_sdk import AsyncComfy
>
> # 環境変数から COMFY_API_KEY を読み取ります。
> # submit() の呼び出しごとに独自の Idempotency-Key を発行し、自動リトライのために再利用します。
> async def main():
>     async with AsyncComfy() as client:
>         handle = await client.models.submit(
>             "meshy/rigging",
>             {
>                 "height_meters": 1.8,
>                 "input_task_id": "0193abcd-0000-0000-0000-000000000000",
>             },
>         )
>         print("request_id:", handle.request_id)  # モデル ID と合わせれば、別のプロセスに必要なのはこれだけです
>
>         # リクエストが完了するまでポーリングし、サーバーが指定した Retry-After だけ待機します。
>         async for update in handle.iter_events():
>             print(update.status, update.queue_position)
>
>         # プロバイダー自身のペイロードで、models.run() が返すのと同じ値です。
>         # 失敗またはキャンセル済みのリクエストは、ここで型付きの Router エラーを発生させます。
>         result = await handle.get()
>
>     print(result)
>
> asyncio.run(main())
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 環境変数から COMFY_API_KEY を読み取ります。
> // submit() の呼び出しごとに独自の Idempotency-Key を発行し、自動リトライのために再利用します。
> const handle = await comfy.models.submit("meshy/rigging", {
>   height_meters: 1.8,
>   input_task_id: "0193abcd-0000-0000-0000-000000000000",
> });
> console.log("requestId:", handle.requestId); // モデル ID と合わせれば、別のプロセスに必要なのはこれだけです
>
> // リクエストが完了するまでポーリングし、サーバーが指定した Retry-After だけ待機します。
> for await (const update of handle.events()) {
>   console.log(update.status, update.queuePosition);
> }
>
> // models.run() が返すのと同じ結果です。失敗またはキャンセル済みのリクエストは、ここで reject されます。
> const result = await handle.get();
>
> console.log(result.data);
> ```
>
> ```bash cURL theme={null}
> # 1. 送信。Router は request_id、status_url、response_url、cancel_url とともに 201 を返します。
> curl https://api.comfy.org/v2/models/meshy/rigging/requests \
>   -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\"}"
>
> # 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定した Retry-After 秒だけ待機します。
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/meshy/rigging/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 取得。モデル本来の出力とともに 200、まだ実行中はステータスボディとともに 202 を返します。
> curl https://api.comfy.org/v2/models/meshy/rigging/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## スキーマ

### 入力

**height\_meters** `number` (default: 1.7)

キャラクターモデルのおおよその高さ（メートル単位）。正の数である必要があります。

範囲: `0` ～ `…`

**include\_fingers** `boolean` (default: false)

キャラクターの手に指のボーンを追加するかどうか。Biped リグのみで有効です。texture\_image\_url を指定した場合、quadruped リグの場合、または quad-topology の input\_task\_id を指定した場合、Meshy はリクエストを 400 で拒否し、指なしでのみリギングできるモデルの場合は 422 で拒否します（課金なし）。指のボーンはクレジットコストを変えません。デフォルトは false です。

**input\_task\_id** `string`

リギングが必要な入力タスク。model\_url が指定されていない場合は必須です。

**model\_url** `string`

テクスチャ付きのヒューマノイド GLB ファイルへの公開アクセス可能な URL または Data URI。input\_task\_id が指定されていない場合は必須です。

**skeleton\_template** `string` (default: "meshyrig")

リギング済みキャラクターのスケルトン。ボーン名と階層を設定します。Biped リグのみで有効です。meshyrig 以外の値（または include\_fingers が true）を指定すると、出力ファイルはメートル単位になり、センチメートル単位のデフォルトの 24 ボーン meshyrig ファイルの代わりにそのスケルトンのボーンが使用されます。このリグから作成したアニメーションタスクも同じスケルトンを使用します。それ以外の値は拒否されます。デフォルトは meshyrig です。

有効な値: `meshyrig`、`mixamo`、`ue5_mannequin`、`max_biped`、`unity_humanoid`、`maya_human_ik`、`blender_rigify_basic_human`、`cc5_hd_neutral_base`、`daz_genesis9`

**texture\_image\_url** `string`

モデルの UV 展開済みベースカラーテクスチャ画像。公開アクセス可能な URL または Data URI。.png 形式に対応しています。

Router が `GET /v2/models/meshy/rigging/openapi.json` で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する際に使用するドキュメントと同じものです。

### 出力

**created\_at** `integer`

タスクが作成された時刻のタイムスタンプ（ミリ秒単位）。

形式: `int64`

**expires\_at** `integer`

タスク結果が期限切れになる時刻のタイムスタンプ（ミリ秒単位）。

形式: `int64`

**finished\_at** `integer`

タスクが完了した時刻のタイムスタンプ（ミリ秒単位）。未完了の場合は 0。

形式: `int64`

**id** `string` *required*

タスクの一意の識別子。

**preceding\_tasks** `integer`

先行するタスクの数。ステータスが PENDING の場合のみ意味を持ちます。

**progress** `integer`

タスクの進捗状況 (0～100)。未開始の場合は 0、成功した場合は 100。

範囲: `0` ～ `100`

**result** `object`

タスクが SUCCEEDED の場合、出力アセットの URL を含みます。

**result.basic\_animations** `object`

デフォルトのアニメーションの URL を含みます。

**result.basic\_animations.running\_armature\_glb\_url** `string`

ランニングアニメーションのアーマチュアを GLB 形式でダウンロードするための URL。

**result.basic\_animations.running\_fbx\_url** `string`

ランニングアニメーションを FBX 形式でダウンロードするための URL（スキン付き）。

**result.basic\_animations.running\_glb\_url** `string`

ランニングアニメーションを GLB 形式でダウンロードするための URL（スキン付き）。

**result.basic\_animations.walking\_armature\_glb\_url** `string`

ウォーキングアニメーションのアーマチュアを GLB 形式でダウンロードするための URL。

**result.basic\_animations.walking\_fbx\_url** `string`

ウォーキングアニメーションを FBX 形式でダウンロードするための URL（スキン付き）。

**result.basic\_animations.walking\_glb\_url** `string`

ウォーキングアニメーションを GLB 形式でダウンロードするための URL（スキン付き）。

**result.rigged\_character\_fbx\_url** `string`

リギング済みキャラクターを FBX 形式でダウンロードするための URL。

**result.rigged\_character\_glb\_url** `string`

リギング済みキャラクターを GLB 形式でダウンロードするための URL。

**started\_at** `integer`

タスクが開始された時刻のタイムスタンプ（ミリ秒単位）。未開始の場合は 0。

形式: `int64`

**status** `string` *required*

有効な値: `SUCCEEDED`

**task\_error** `object`

タスクが失敗した場合にエラーメッセージを含むエラーオブジェクト。

**task\_error.message** `string`

詳細なエラーメッセージ。

**type** `string`

リギングタスクのタイプ。

有効な値: `rig`

## 例

### 入力

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

### 出力

```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"
}
```

## 出荷前の確認

SDK は `Idempotency-Key` を生成し、自動リトライで再利用します。手動リトライでは元のキーを再利用してください。Router は最大 10 分間接続を保持できます。

リクエストが失敗すると、Router は理由を説明する `X-Comfy-Error-Type` レスポンスヘッダーを送信します。`422` は、プロバイダーを呼び出す前に Router が入力を拒否したことを意味し、`413` はリクエスト本文が Router の受け入れ可能なサイズを超えていたことを意味します。生成されたアセットは [結果 URL の有効期限](https://docs.comfy.org/ja/development/comfy-router/reference.md#結果アセット) があるため、早めにダウンロードしてください。

上記のフィールド説明に記載されているサイズ制限は、プロバイダーの仕様から引用した、そのフィールドに対するプロバイダー自身の上限です。Router はリクエスト本文全体に対して別の上限を適用し、base64 エンコードされたメディアもこれにカウントされます。[リクエスト本文のサイズ](https://docs.comfy.org/ja/development/comfy-router/limitations.md) を参照してください。

このページは、Comfy Router 経由で呼び出す 1 つのパートナーモデルについて説明しています。同じ `comfy-sdk` / `@comfyorg/sdk` パッケージには、Comfy Cloud 上で ComfyUI のワークフローグラフ全体を実行するための 2 つ目のクライアントも含まれています: `Comfy(api_key=...)` / `new Comfy({ apiKey })`、および `client.workflows`、`client.assets`、`client.jobs`。[Comfy SDKs](https://docs.comfy.org/ja/development/api-development/sdks.md) を参照してください。

> [card] [ヘッダー](https://docs.comfy.org/ja/development/comfy-router/headers.md)
>
> 認証、冪等性、リクエスト ID、エラー分類、リトライ間隔、支出上限。

> [card] [Router API の利用](https://docs.comfy.org/ja/development/comfy-router/api.md)
>
> モデルの検出、バリデーションエラー、リトライ、課金。

> [card] [制限事項](https://docs.comfy.org/ja/development/comfy-router/limitations.md)
>
> Router が現在対応していないことと、代替手段。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.