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

# Meshy 7 を Comfy Router で使用する

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

`meshy/meshy-7` の API リファレンスです。Comfy Router が Meshy から提供しています。

**入力：** テキスト · **出力：** 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/meshy-7`

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

> [tab] 結果を待つ
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # 環境変数から COMFY_API_KEY を読み取ります。
> # SDK は自動的に冪等キーを作成し、自動リトライのために再利用します。
> with Comfy() as client:
>     result = client.models.run(
>         "meshy/meshy-7",
>         {
>             "art_style": "realistic",
>             "mode": "preview",
>             "prompt": "a red cube",
>         },
>     )
>
> print(result)
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 環境変数から COMFY_API_KEY を読み取ります。
> // SDK は自動的に冪等キーを作成し、自動リトライのために再利用します。
> const { data } = await comfy.models.run("meshy/meshy-7", {
>   art_style: "realistic",
>   mode: "preview",
>   prompt: "a red cube",
> });
>
> console.log(data);
> ```
>
> ```bash cURL theme={null}
> curl https://api.comfy.org/v2/models/meshy/meshy-7 \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"art_style\": \"realistic\", \"mode\": \"preview\", \"prompt\": \"a red cube\"}"
> ```

> [tab] キューに送信して後で取得する
>
> 同じボディを `POST https://api.comfy.org/v2/models/meshy/meshy-7/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/meshy-7",
>             {
>                 "art_style": "realistic",
>                 "mode": "preview",
>                 "prompt": "a red cube",
>             },
>         )
>         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/meshy-7", {
>   art_style: "realistic",
>   mode: "preview",
>   prompt: "a red cube",
> });
> console.log("requestId:", handle.requestId); // モデル ID と合わせて、別のプロセスが必要とする情報はこれだけです
>
> // リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の間待機します。
> for await (const update of handle.events()) {
>   console.log(update.status, update.queuePosition);
> }
>
> // models.run() が返すのと同じ結果です。失敗またはキャンセル済みのリクエストはここで拒否されます。
> 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/meshy-7/requests \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"art_style\": \"realistic\", \"mode\": \"preview\", \"prompt\": \"a red cube\"}"
>
> # 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒待機します。
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/meshy/meshy-7/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 取得。モデルのネイティブ出力とともに 200、まだ実行中の場合はステータスボディとともに 202 を返します。
> curl https://api.comfy.org/v2/models/meshy/meshy-7/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## スキーマ

### 入力

#### `preview` バリアント

**ai\_model** `string`

実行するMeshyモデル。Comfy Routerのルートではこれはパス（`/v2/models/meshy/{model}`）から供給され、省略するかnullとして送信できます。Routerは検証後にパスのモデルをここへ書き込みます。v1 /proxyルートではMeshyTextTo3DPreviewRequestを参照してください。これはMeshyAiModelに制約します。

**art\_style** `string` (default: "realistic")

オブジェクトの希望するアートスタイルを記述します。

指定可能な値: `realistic`、`sculpture`

**geometry\_resolution** `string` (default: "standard")

生成されるメッシュのジオメトリ解像度。2kと4kは、より細かい表面ディテールのためにUltraパスを実行します。2kと4kには ai\_model meshy-7.1 または latest が必要です。

指定可能な値: `standard`、`2k`、`4k`

**is\_a\_t\_pose** `boolean` (default: false)

非推奨。代わりにpose\_modeを使用してください。モデルをA/Tポーズで生成するかどうか。

**mode** `string` *required*

previewタスクを作成する場合、このフィールドは"preview"に設定する必要があります。

指定可能な値: `preview`

**moderation** `boolean` (default: false)

trueの場合、入力コンテンツは有害な可能性のあるコンテンツについてスクリーニングされます。

**pose\_mode** `string`

生成されるモデルのポーズモードを指定します。

指定可能な値: `a-pose`、`t-pose`、\`\`

**prompt** `string` *required*

3Dモデルがどのようなオブジェクトであるかを記述します。最大800文字。

**should\_remesh** `boolean` (default: false)

remesh フェーズを有効にするかどうかを制御します。false の場合、最高精度の三角形メッシュを返します。Meshy 5 では true、Meshy 6 と 7 では false が既定です。

**symmetry\_mode** `string` (default: "auto")

モデル生成中の対称性の挙動を制御します。

指定可能な値: `off`、`auto`、`on`

**target\_polycount** `integer` (default: 30000)

生成されるモデルの目標ポリゴン数を指定します。有効範囲は100から300,000です。

範囲: `100` から `300000`

**topology** `string` (default: "triangle")

生成されるモデルのトポロジーを指定します。

指定可能な値: `quad`、`triangle`

**ultra\_mode** `boolean` (default: false)

非推奨。代わりに geometry\_resolution を使用してください。true は geometry\_resolution 2k と同等です。ai\_model が meshy-7、meshy-7.1 または latest の場合にのみサポートされます。例外は meshy-7 です。geometry\_resolution 2k には meshy-7.1 または latest が必要なため、meshy-7 では ultra\_mode を true にすることが Ultra パスを要求する方法になります。

#### `refine` バリアント

**ai\_model** `string`

実行するMeshyモデル。Comfy Routerのルートではこれはパス（`/v2/models/meshy/{model}`）から供給され、省略するかnullとして送信できます。Routerは検証後にパスのモデルをここへ書き込みます。v1 /proxyルートではMeshyTextTo3DRefineRequestを参照してください。これはMeshyAiModelに制約します。

**enable\_pbr** `boolean` (default: false)

ベースカラーに加えてPBRマップ（メタリック、ラフネス、ノーマル）を生成します。Sculptureスタイルを使用する場合はenable\_pbrをfalseに設定する必要があることに注意してください。

**mode** `string` *required*

refineタスクを作成する場合、このフィールドは"refine"に設定する必要があります。

指定可能な値: `refine`

**moderation** `boolean` (default: false)

trueの場合、入力コンテンツは有害な可能性のあるコンテンツについてスクリーニングされます。

**preview\_task\_id** `string` *required*

対応するpreviewタスクID。指定されたpreviewタスクのステータスはSUCCEEDEDでなければなりません。

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

テクスチャリングプロセスを導くための2D画像を指定します。.jpg、.jpeg、.png形式、またはbase64エンコードされたデータURIをサポートします。

**texture\_prompt** `string`

テクスチャリングプロセスを導くための追加のテキストプロンプトを指定します。最大800文字。

**texture\_resolution** `string` (default: "2k")

生成されるテクスチャのテクスチャ解像度。2k、4k、8k のいずれかです。4k と 8k には ai\_model meshy-6、meshy-7、meshy-7.1 または latest が必要です。

指定可能な値: `2k`、`4k`、`8k`

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

### 出力

**art\_style** `string`

プレビュータスクの作成に使用された、変更されていない art\_style。

**created\_at** `integer`

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

形式: `int64`

**finished\_at** `integer`

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

形式: `int64`

**id** `string` *required*

タスクの一意の識別子。

**model\_urls** `object`

Meshy によって生成されたテクスチャ付き 3Dモデルファイルのダウンロード可能な URL。

**model\_urls.fbx** `string`

FBX ファイルのダウンロード可能な URL。

**model\_urls.glb** `string`

GLB ファイルのダウンロード可能な URL。

**model\_urls.mtl** `string`

MTL ファイルのダウンロード可能な URL。

**model\_urls.obj** `string`

OBJ ファイルのダウンロード可能な URL。

**model\_urls.usdz** `string`

USDZ ファイルのダウンロード可能な URL。

**negative\_prompt** `string`

後方互換性のために維持されている非推奨のフィールド。

**preceding\_tasks** `integer`

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

**progress** `integer`

タスクの進捗。開始されていない場合は 0、成功した場合は 100。

範囲: `0` から `100`

**prompt** `string`

タスクの作成に使用された、変更されていないプロンプト。

**started\_at** `integer`

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

形式: `int64`

**status** `string` *required*

取り得る値: `SUCCEEDED`

**task\_error** `object`

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

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

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

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

テクスチャリング処理のガイドに使用されたテクスチャ画像のダウンロード可能な URL。

**texture\_prompt** `string`

リファイン段階でテクスチャリング処理をガイドするために提供された追加のテキストプロンプト。

**texture\_richness** `string`

後方互換性のために維持されている非推奨のフィールド。

**texture\_urls** `object[]`

タスクから生成されたテクスチャ URL オブジェクトの配列。

**texture\_urls\[].base\_color** `string`

ベースカラーマップ画像のダウンロード可能な URL。

**texture\_urls\[].metallic** `string`

メタリックマップ画像のダウンロード可能な URL。

**texture\_urls\[].normal** `string`

ノーマルマップ画像のダウンロード可能な URL。

**texture\_urls\[].roughness** `string`

ラフネスマップ画像のダウンロード可能な URL。

**thumbnail\_url** `string`

モデルファイルのサムネイル画像のダウンロード可能な URL。

**type** `string`

Text to 3D タスクの種類。

取り得る値: `text-to-3d-preview`、`text-to-3d-refine`

**video\_url** `string`

プレビュービデオのダウンロード可能な URL を返す非推奨のフィールド。

## 例

### 入力

```json theme={null}
{
  "art_style": "realistic",
  "mode": "preview",
  "prompt": "a red cube"
}
```

### 出力

```json theme={null}
{
  "art_style": "realistic",
  "created_at": 1767225600000,
  "finished_at": 1767225719000,
  "id": "018f2c7a-4b1e-7c3d-9a05-6e2f8b41d0c9",
  "model_urls": {
    "fbx": "https://example.invalid/meshy/text-to-3d/model.fbx",
    "glb": "https://example.invalid/meshy/text-to-3d/model.glb",
    "mtl": "https://example.invalid/meshy/text-to-3d/model.mtl",
    "obj": "https://example.invalid/meshy/text-to-3d/model.obj",
    "usdz": "https://example.invalid/meshy/text-to-3d/model.usdz"
  },
  "progress": 100,
  "prompt": "a red cube",
  "started_at": 1767225601000,
  "status": "SUCCEEDED",
  "thumbnail_url": "https://example.invalid/meshy/text-to-3d/thumbnail.png",
  "type": "text-to-3d-preview"
}
```

## 出荷前の確認

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.