> ## 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 で V3.5 を使用する

> Comfy Router 経由で pixverse/v3.5 を呼び出す: エンドポイント、リクエストの形状、Router が返すレスポンス。

`pixverse/v3.5` の API リファレンスです。Pixverse から Comfy Router が提供しています。

**入力:** テキスト · **出力:** ビデオ

## クイックスタート

[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 のスニペットは同じ呼び出しを raw HTTP で行うものです。

**モデル ID:** `pixverse/v3.5`

**エンドポイント:** `POST https://api.comfy.org/v2/models/pixverse/v3.5`

> [tab] 結果を待つ
>
> ```python Python theme={null}
> from comfy_sdk import Comfy
>
> # 環境から COMFY_API_KEY を読み取ります。
> # SDK は自動的に冪等性キーを作成し、自動リトライで再利用します。
> with Comfy() as client:
>     result = client.models.run(
>         "pixverse/v3.5",
>         {
>             "aspect_ratio": "16:9",
>             "duration": 5,
>             "prompt": "a single red maple leaf falling onto still water",
>             "quality": "360p",
>         },
>     )
>
> print(result)
> ```
>
> ```typescript TypeScript theme={null}
> import { comfy } from "@comfyorg/sdk";
>
> // 環境から COMFY_API_KEY を読み取ります。
> // SDK は自動的に冪等性キーを作成し、自動リトライで再利用します。
> const { data } = await comfy.models.run("pixverse/v3.5", {
>   aspect_ratio: "16:9",
>   duration: 5,
>   prompt: "a single red maple leaf falling onto still water",
>   quality: "360p",
> });
>
> console.log(data);
> ```
>
> ```bash cURL theme={null}
> curl https://api.comfy.org/v2/models/pixverse/v3.5 \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"aspect_ratio\": \"16:9\", \"duration\": 5, \"prompt\": \"a single red maple leaf falling onto still water\", \"quality\": \"360p\"}"
> ```

> [tab] キューに入れて後で収集する
>
> 同じボディを `POST https://api.comfy.org/v2/models/pixverse/v3.5/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(
>             "pixverse/v3.5",
>             {
>                 "aspect_ratio": "16:9",
>                 "duration": 5,
>                 "prompt": "a single red maple leaf falling onto still water",
>                 "quality": "360p",
>             },
>         )
>         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("pixverse/v3.5", {
>   aspect_ratio: "16:9",
>   duration: 5,
>   prompt: "a single red maple leaf falling onto still water",
>   quality: "360p",
> });
> 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/pixverse/v3.5/requests \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"aspect_ratio\": \"16:9\", \"duration\": 5, \"prompt\": \"a single red maple leaf falling onto still water\", \"quality\": \"360p\"}"
>
> # 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒だけ待機します。
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/pixverse/v3.5/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 収集。モデル固有の出力とともに 200、まだ実行中ならステータスボディとともに 202 を返します。
> curl https://api.comfy.org/v2/models/pixverse/v3.5/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## スキーマ

### 入力

**aspect\_ratio** `string` *required*

指定可能な値: `16:9`、`4:3`、`1:1`、`3:4`、`9:16`、`2:3`、`3:2`、`21:9`

**duration** `integer` *required*

範囲: `1` から `15`

**generate\_audio\_switch** `boolean` (default: false)

**model** `string`

PixVerse のテキストから動画へのモデル識別子。Comfy Router のルート `POST /v2/models/pixverse/{model}` では、このフィールドはパスから供給されるため省略できます。

**motion\_mode** `string`

指定可能な値: `normal`、`fast`

**negative\_prompt** `string`

**prompt** `string` *required*

**quality** `string` *required*

指定可能な値: `360p`、`540p`、`720p`、`1080p`

**seed** `integer`

**style** `string`

指定可能な値: `anime`、`3d_animation`、`clay`、`comic`、`cyberpunk`

**template\_id** `integer`

**water\_mark** `boolean`

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

### 出力

**ErrCode** `integer`

**ErrMsg** `string`

**Resp** `object` *required*

**Resp.create\_time** `string`

**Resp.credits** `integer`

**Resp.id** `integer`

**Resp.modify\_time** `string`

**Resp.negative\_prompt** `string`

**Resp.outputHeight** `integer`

**Resp.outputWidth** `integer`

**Resp.prompt** `string`

**Resp.resolution\_ratio** `integer`

**Resp.seed** `integer`

**Resp.size** `integer`

**Resp.status** `integer` *required*

指定可能な値: `1`、`5`、`6`、`7`、`8`

**Resp.style** `string`

**Resp.url** `string` *required*

## 例

### 入力

```json theme={null}
{
  "aspect_ratio": "16:9",
  "duration": 5,
  "prompt": "a single red maple leaf falling onto still water",
  "quality": "360p"
}
```

### 出力

```json theme={null}
{
  "ErrCode": 0,
  "ErrMsg": "",
  "Resp": {
    "credits": 1,
    "id": 4242,
    "status": 1,
    "url": "https://example.invalid/pixverse/v6/out.mp4"
  }
}
```

## 出荷前の確認

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.