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

# Pika Sfx を Comfy Router で使用する

> Comfy Router 経由で pika/pika-sfx を呼び出す: エンドポイント、リクエスト形状、Router が返すレスポンス。

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

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

## クイックスタート

[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:** `pika/pika-sfx`

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

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

> [tab] キューに送信して後で収集する
>
> 同じボディを `POST https://api.comfy.org/v2/models/pika/pika-sfx/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(
>             "pika/pika-sfx",
>             {
>                 "duration": 2,
>                 "prompt": "a wooden door creaking open",
>             },
>         )
>         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("pika/pika-sfx", {
>   duration: 2,
>   prompt: "a wooden door creaking open",
> });
> 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 は 201 と request_id、status_url、response_url、cancel_url を返します。
> curl https://api.comfy.org/v2/models/pika/pika-sfx/requests \
>   -H "X-API-Key: $COMFY_API_KEY" \
>   -H "Idempotency-Key: $(uuidgen)" \
>   -H "Content-Type: application/json" \
>   -d "{\"duration\": 2, \"prompt\": \"a wooden door creaking open\"}"
>
> # 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが示す Retry-After 秒だけ待機します。
> REQUEST_ID="<request_id from the 201 body>"
> curl -i https://api.comfy.org/v2/models/pika/pika-sfx/requests/$REQUEST_ID/status \
>   -H "X-API-Key: $COMFY_API_KEY"
>
> # 3. 収集。200 はモデル固有の出力、実行中は 202 とステータスボディを返します。
> curl https://api.comfy.org/v2/models/pika/pika-sfx/requests/$REQUEST_ID \
>   -H "X-API-Key: $COMFY_API_KEY"
> ```

## スキーマ

### 入力

**duration** `number` (default: 10)

サウンドエフェクトの長さ（秒単位）。1〜20。

範囲: `1` から `20`

**prompt** `string` *required*

サウンドエフェクトの説明。

**seed** `integer` (default: -1)

再現可能な出力のためのシード。-1 から 2147483647。-1 を指定するとランダムなシードが選ばれます。

範囲: `-1` から `2147483647`

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

### 出力

**error** `object`

`failed` のジョブで設定されます。

**error.code** `string`

invalid\_input、content\_moderation、provider\_error などの機械可読な失敗コード。

**error.message** `string`

診断用のテキスト。

**id** `string`

ステータスのポーリングに使用するジョブID。

**model\_id** `string`

ジョブが実行した Pika カタログエントリ。

**output** `object`

完了したジョブのメディア。`status` が `completed` のときに設定されます。

**output.audio** `object`

生成済みのメディアファイル1件。

**output.audio.content\_type** `string`

ファイルの MIME タイプ。

**output.audio.url** `string`

生成されたファイルのダウンロード URL。

**output.media\_type** `string`

ファイルを格納するフィールド: video または audio。

**output.video** `object`

生成済みのメディアファイル1件。

**output.video.content\_type** `string`

ファイルの MIME タイプ。

**output.video.url** `string`

生成されたファイルのダウンロード URL。

**status** `string`

ジョブのステータス: queued、running、completed、failed。

**usage** `object`

Pika がジョブについて報告したユニット数。

## 例

### 入力

```json theme={null}
{
  "duration": 2,
  "prompt": "a wooden door creaking open"
}
```

### 出力

```json theme={null}
{
  "id": "media_2d8e4b71-9c05-4f3a-b6d2-81e7a5c09f44",
  "output": {
    "audio": {
      "content_type": "audio/mpeg",
      "url": "https://example.invalid/pika/audio.mp3"
    },
    "media_type": "audio"
  },
  "status": "completed"
}
```

## 出荷前の確認

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.